✨ Fisheries Electronic Software Workflows
15 SEPTEMBER 2010 NEW ZEALAND GAZETTE, No. 119 3189
Appendix 3—Electronic Software Workflows
This appendix will define the operational workflows to which the electronic software must comply. The FishServe API will consist of several services and each service will consist of several methods that the User Interface can utilise to comply with the following workflows. For more detailed information on how these methods will operate refer to the FishServe API Software Development Kit (SDK) documentation for more technical information. At the time of this appendix being written, the method names were in line with the FishServe API SDK Documentation, which may change over the course of the standard Software Development Life Cycle (SDLC).
1. Form Data Entry Workflow
The Form Data Entry Workflow is a combination of operations that can be performed prior to submission of the form to FishServe. The form is required to be signed before it can be submitted to FishServe.
a. Create Operation
The Create Operation is the process in which the user selects to create a new form for data entry. The User Interface will use the ReturnService and invoke the CreateReturn method, upon successful completion of this method a form instance will be created in the client database. The form status will be set to "In Progress" for processing. This is a secure operation and will require the Access Identifier to be present, prior to completion of the operation. This operation will only be performed once at the beginning of the lifecycle of the form.
b. Open Operation
The Open Operation is the process in which the user will open a specific form instance from the database in edit mode. The User Interface will use the ReturnService and invoke the OpenReturn method, upon successful completion of this method a form instance will be returned from the client database in edit mode. This is a secure operation and will require the Access Identifier to be present prior to completion of the operation.
c. Save Operation
The Save Operation is the process in which the user will save his changes on a specific form instance that was placed in edit mode to be persisted to the database. These changes will not be committed until the Endorse Operation or Sign Operation has been performed on the form. The changes are held as temporary instance of the form until committed. The User Interface will use the ReturnService and invoke the SaveReturn method, upon successful completion of this method a form instance will be returned from the client database in edit mode with the user changes so that further changes could be made. The form status will be set to "In Progress" for processing, if not already set. This operation requires the Open operation to be performed prior to its execution; this is to prevent loss of data based on concurrency of the database. This operation can only be performed on forms with a status of "In Progress", "Signed" and "Rejected".
Next Page →
NZ Gazette 2010, No 119
✨ LLM interpretation of page content
🌾
Fisheries Electronic Software Requirements Circular 2010
(continued from previous page)
🌾 Primary Industries & Resources14 September 2010
Fisheries, Regulations, Electronic Software, Reporting, CE EDT, MFish, FishServe