Cycle Client
The Cycle Client screen can be accessed by the authorized users to initiate cycle step or a sequence execution in Admin Console. When a user with AC_CYCLEADMIN role logs into Admin Console, Cycle Client tile is displayed in the Admin Console Home page. On clicking Cycle Client tile, Cycle Client screen appears in a new tab. From this screen, a user can give commands to Start or Stop Cycle and view the status of running cycles.
Note: A user with AC_CYCLEADMIN role must be a Rules Palette user. When a valid user logs in to Admin Console, the system checks for the resource accessibility associated with that user role, and loads resources for the user to access and initiate cycle operations from this screen.
The Cycle Client screen has two sections:
- Cycle Command section - User can submit a command for Cycle processing.
- Results section - User can view the submitted task status and results.
Cycle Commands Section
From this section, an authorized user can select the following inputs for Cycle Command and click Submit to submit a task for cycle processing.
Company Name: Based on the resource accessibility permissions associated with the user role in Rules Palette, the primary company list is populated in this drop down for the user to select.
Current System Date: The Current System Date of the selected primary company is displayed.
Advance System Date: User can use this button to move the Current System Date to the next day. When a user clicks Advance System Date, a Pop-up window opens and prompts for confirmation action. On clicking Ok, the advance system date is submitted to the Cycle Client.
Run By: This drop down contains two options, Cycle Step and Sequence. When a user selects Cycle Step option, Cycle Step drop down is displayed with a list of Cycle Step options, else if Sequence is selected, Sequencedrop down is displayed with a list of Sequence names. The user can select any one of these options (Cycle Step / Sequence Name) and click Submit to initiate cycle processing.
Cycle Step and Sequence Option Details
Cycle Step
When a user selects Cycle Step option from the Run By drop down, Cycle Step drop down is displayed with the following options to the user. Based on the Cycle Step option selected by user, the corresponding Command is posted to the Cycle for activity processing on submitting the task (clicking Submit ).
- 01 Pre-Company: If a user selects this option, Command '01' is posted to the Cycle Client to run all the Pre-Company activities in Pending status upto the Current System Date.
- 02 Pre-Plan: If a user selects this option, Command '02' is posted to the Cycle Client to run all the Pre-Plan Activities in Pending status upto the Current System Date.
- 03 Policy: If a user selects this option, Command '03' is posted to the Cycle Client to run all the Policy Activities in Pending status upto the Current System Date.
- 04 Post-Plan: If a user selects this option, Command '04' is posted to the Cycle Client to run all the Pre-Company Activities in Pending status upto the Current System Date.
- 05 Post-Company: If a user selects this option, Command '05' is posted to the Cycle Client to run all the Pre-Company Activities in Pending status upto the Current System Date
- 07 Pre-Client: If a user selects this option, Command '07' is posted to the Cycle Client to run all the Pre-Client Activities in Pending status upto the Current System Date.
- 08 Post Client: If a user selects this option, Command '08' is posted to the Cycle Client to run all the Pre-Company Activities in Pending status upto the Current System Date.
Sequence
When a user selects Sequence option from the Run By drop down, Sequence drop down is displayed with a list of Sequence Name attributes (as configured in the CycleSequence business rules in the Rules Palette). Based on the Sequence Name selected by user, Command 'S' is posted to the Cycle Client to run all the Activities corresponding to the selected Sequence rule on submitting the task (clicking Submit).
Error Messages
When a task is submitted to Cycle on clicking Submit, a Banner message is displayed on top of the Cycle Client screen indicating the current processing status (Success / an Error). The Banner displays error messages when any of the following error conditions occurs on submitting a task to Cycle.
| Error Code | Error Message | Error Condition |
|---|---|---|
| E111 | Exception while submitting the Task to Cycle server | This message is displayed when any runtime error occurs while submitting the task to Cycle. |
| E112 | Cycle Server is not available for submitting the Task. | This message is displayed when the Cycle Agent / Node to which the task is submitted is not up and running. |
| E113 | User not authorized to process task through cycle | This message is displayed if a user who has access to the Cycle Client page in Admin Console, but does not have authorization to the webservice in OIPA, submits a task. |
| E114 | The REST service call made by the user cannot be completed as the service layer is unavailable | This message is displayed in case of service layer failure while submitting a task. |
Cycle Results Section
The tasks submitted to the Cycle are displayed in the Cycle Results section. On clicking Submit when a user submits a task to the Cycle, the submitted task details are displayed in the top row of the results table. For example, if a user attempts to submit a task for a Company which is already in execution currently, the initiation of this new task execution fails and an error icon is displayed in the results table row for that task. On hovering on the error icon, user can view the error message pertaining to the task.
On clicking Refresh, the user can view updated data in the Cycle Results table.
Note: If the property cycleClient.refreshTime is configured, the Cycle Results table gets auto-refreshed in the specified time interval. The Cycle Results section displays the submitted task details for the next one-week in the results table.
The Cycle Results section displays the following details of each submitted task in the cycle results table:
System Date: System Date of the selected primary company.
Cycle Type / Sequence: Cycle Step or Sequence submitted for processing.
Company Name: Name of the Company for which the task has been submitted for processing.
Process GMT:
Status: A submitted task has the following statuses:
- SUBMITTED - this status will be displayed in the UI (Admin Console user interface) when a cycle task is submitted to the server.
- PAUSED - this status is displayed, when a user clicks on Pause icon from UI.
- ERROR - this status is displayed when there is a failure in submitting task to Cycle server.
Percentage Work Completed:
Action: This column displays Action icons, which allows a user to perform the following actions:
- Error - When the Cycle Client fails to process a submitted task successfully, then the error icon is displayed. User can hover on the icon to view the error message.
- Pause - This icon is displayed when a there is an active Cycle is being processed with Running status. If a user clicks on Pausethe Command 'P' is posted to the Cycle Client.
- Resume - this icon is displayed only if a Cycle is in Paused status. If a user clicks on Resume, the Command 'R' is posted to the Cycle Client, and the Cycle processing starts from the point where it was paused.
- Abort - This icon is displayed, when Cycle processing is either in Running / Pause / Resume status. If a user clicks on Abort, the Command 'A' is posted to the Cycle Client.
