Process Streams

This page may contain multiple incoming links - Please use your browser back button to return to the previous page.

1 Roles Required
2 Creating Process Streams
- 2.1 Selecting the Job Stream Steps
- 2.2 Selecting the Job Stream Dependencies
3 Example of Joint Interest Billing (JIB) job stream:

Roles Required

For users to access the Process Streams screen, they must be granted one of the following security roles

PWSQL_82_JOB_STREAM_MAINT
PWSQL_50_SUPER_USER

For users to modify process streams created by other users, they must be granted the following security role:

PWSQL_90_JOB_STREAM_ADMIN

Creating Process Streams

Some processes or reports, such as JIBs (Joint Interest Billings) or Flatten Reporting Hierarchy, can be set up as a Process Stream whereby a process will start once a previous one is complete. This saves the time and effort of running each process individually and allows you to schedule when the process will run.

You can also set up a process stream if you want a single process to run at a regular interval or at specific times and dates.

1. Navigate to the menu and select Administration → Process Streams

On the Job Stream block fill in the following fields:

Field	Description

Field	Description
Job Stream ID	Auto assigned by the system.
Description	Enter a description for the Job Stream.
Queue	Enter the queue for the job, typically DAY or NIGHT or select from the List of Values.
Status	ACTIVE (the job stream will run any scheduled jobs) INACTIVE (no jobs will run)
Created By	Auto populates with your User ID
User Maintainable	If checked, another user other than the create user can also run this job stream.

Press CTRL + S or click the Save icon to save your input. Then press Page Down to enter in the schedule for the process stream.
In the Schedule block fill in the following fields OR go to Step 6. and set up the schedule using the Frequency button:

Field	Description

Field	Description
Scheduled Start Date	Enter the Job Stream start date and time (you can have multiple start times throughout a month, i.e. weekly) Format DD-MON-YYYY HH:MM:00 (24 hr clock)
Run Start Date	No entry required. Auto populates with the date and time the job stream started.
Run End Date	No entry required. Auto populates with the date and time the job stream finished.
Status	Auto populates with one of the following statuses: Scheduled – the job stream is waiting for the next time scheduled to run Pending – the job stream has started and is waiting to run Error – the job stream started and has encountered an error Inactive – the job stream is scheduled but won’t run Running – the job stream is running Complete – the job stream has finished running
Printer	Auto populates from your User Defaults
Run User	Auto populates with your User ID after the job has run.

Press CTRL+S or click on the Save icon to save your input.
Optional. To set up the schedule using the Frequency button:

Select the Frequency button in the bottom right hand corner.
Enter Start and End dates and the frequency. Select OK.
Press CTRL+S or click on the Save icon to save your input.

Selecting the Job Stream Steps

1. Select the Steps tab and fill in the following fields in the Job Stream Steps block:

Field	Description

Field	Description
Step ID	Auto populates when the record is saved.
Module	Enter the module id of the report / process that is scheduled to run or choose form the Modules List of Values.
Module Description	Auto populates from the Module ID.
Max Start Time	The maximum time this step should start. It will not start if the max start time has been reached.

Press CTRL+S or click on the Save icon to save your input.
Fill in the following fields in the Job Stream Step Parameters block for EACH module. These are the same parameters you would enter in the process submission screen.

Field	Description

Field	Description
Option Description	Auto populates from the process submission screen for the module.
Option value	Enter the value required for the parameter.
Req'd	Auto populates from the process submission screen for the module. If flagged as required, you must enter an Option Value
Effective Date	Auto populates from the Schedule block of the Job Stream tab.

Press CTRL+S or click on the Save icon to save your input.

Selecting the Job Stream Dependencies

Optional. Set up any conditions for modules to run in the Dependencies tab (i.e. Module only runs if a prior one is successful).

Field	Description

Field	Description
Module	Auto populates from the Module ID highlighted on the previous tab.
Parent Step ID	Enter the step ID that the module is dependent on or choose form the List of Values drop down.
Parent Step Module	Auto populates when the Parent Step ID is entered.
Acceptable Status	The status of the parent job that will allow the job stream to continue with this step. Select from the drop down box: Complete – If the parent job completed successfully, this step will run. Error - If the parent job did not complete successfully, this step will not run. Warning - If there are concerns with the parent job running.

Press CTRL+S or click on the save icon to save your input.
Output from the Process Stream, once it has run, can be viewed in the Process Monitor.

Process Streams

Roles Required

Creating Process Streams

Selecting the Job Stream Steps

Selecting the Job Stream Dependencies

Example of Joint Interest Billing (JIB) job stream: