Running Cycle Client

Windows

Running Cycle Client allows you to set how you want a set of pending activities to process. You must use the run.bat file for a Microsoft ® Windows environment.

  1. Open a command line.
  2. Navigate to the path where the application is installed and then to the Cycle.client-<version number>/bin folder. Type 'run'.
  3. Type in the letter or number associated with the command you want to run. Explanations of the commands are below.
  4. Refer to the log files to see messages and errors.

Unix

The shell script file, run.sh, used to start the Cycle Client application, is located in the client/bin subdirectory of the Cycle Client installation directory. It may be run manually, or scheduled using any standard scheduling utility.

  1. Open a shell
  2. Navigate to the path where the application is installed and then to the Cycle.client-<version number>/bin folder.
  3. Type './run.sh'.
  4. Type in the letter or number associated with the command you want to run.
  5. Refer to the log files to see messages and errors.

Commands

P: Pause – Cycle will not process, although it will still check to see if activities should be processed. Then it sees that the status is still in pause, and returns to sleep status.

R: Resume – Takes Cycle out of pause status.

D: Advance System Date – Advances date in the AsSystemDate table. Should be run after command(s) 01 through 08.

A: Abort Current Cycle – This should only be used when there is a serious error. This is a non-recoverable scenario, and a shutdown will occur. Aborting a cycle will mark all records in the database as 99.

S: Sequence Name – Specifies the name of the Cycle Sequence to run.

  • A Cycle Sequence is configured in the system specifying an order of execution for cycle. Type "S SequenceName" where "SequenceName" is the name of the Cycle Sequence to execute.
  • More information on Cycle Sequences can be found in the XML Configuration Guide under "CycleSequence" system rule.

Q: Exit – Exits Cycle.

  1. Pre-Company – Runs only the pre-company portion of Cycle.
    • Cycle will attempt to process all company-level activities with an effective date less than or equal to the current system date, with one of the pending statuses and a processing order of 1000 or less.
    • A non-overridden business error or system error, by default, will abort further processing for the current Company-Level plan and move onto the next Company-Level plan, if one exists. To alter this behavior, view CycleProcessBehavior business rule's configuration.
  2. Pre-Plan – Runs only the pre-plan portion of Cycle.
    • Cycle will attempt to process all plan-level activities with an effective date less than or equal to the current system date, with one of the pending statuses and a processing order of 1000 or less.
    • Plans are executed in parallel using JMS threading.
    • A non-overridden business error or system error, by default, will abort further processing for the current plan and move onto the next plan, if one exists. To alter this behavior, view CycleProcessBehavior business rule's configuration.
  3. Policy – Runs the policy-level portion of Cycle processing.
    • All policy-level activities with an effective date less than or equal to the current system date will be processed in the following order: effective date (ascending), processing order (ascending), creation GMT (ascending).
    • Policies are processed in parallel using JMS threading.
    • A non-overridden business error or system error, by default, will abort further processing for the current policy and move onto the next policy, if one exists.
  4. Post-Plan – Runs only the post-plan portion of Cycle.
    • Cycle will attempt to process all plan-level activities with an effective date less than or equal to the current system date, with one of the pending statuses and a processing order greater than 1000.
    • Plans are executed in parallel using JMS threading.
    • A non-overridden business error or system error, by default, will abort further processing for the current plan and move onto the next plan, if one exists. To alter this behavior, view CycleProcessBehavior business rule's configuration.
  5. Post-Company – Runs only the post-company portion of Cycle.
    • Cycle will attempt to process all company-level activities with an effective date less than or equal to the current system date with one of the pending statuses and a processing order greater than 1000.
    • A non-overridden business error or system error, by default, will abort further processing for the current Company-Level plan and move onto the next Company-Level plan, if one exists.
    • To alter this behavior, view CycleProcessBehavior business rule's configuration.
  6. Pre-Client – Runs only the pre-Client portion of Cycle.
    • Cycle will attempt to process all Client-level activities with an effective date less than or equal to the current system date, with one of the pending statuses and a processing order of 1000 or less.
    • Clients are executed in parallel using JMS threading.
    • A non-overridden business error or system error, by default, will abort further processing for the current client and move onto the next client, if one exists. To alter this behavior, view CycleProcessBehavior business rule's configuration.
  7. Post-Client – Runs only the post-Client portion of Cycle.
    • Cycle will attempt to process all Client-level activities with an effective date less than or equal to the current system date, with one of the pending statuses and a processing order greater than 1000.
    • Clients are executed in parallel using JMS threading.
    • A non-overridden business error or system error, by default, will abort further processing for the current client and move onto the next client, if one exists. To alter this behavior, view CycleProcessBehavior business rule's configuration.