Creating a Custom Run Control Page
This step is the same regardless of whether you will ultimately use the Run Control page with an SQR or App Engine program. Do the following in Application Designer:
Creating the Run Control Record
- Open Record definition PRCSRUNCNTL and make a copy by using "Save As" and giving the Record a new name (for example, "MY_PRCS_RC").
- When prompted to save a copy of the PeopleCode associated with PRCSRUNCNTL, choose "Yes".
- Update the following Record PeopleCode definitions on your new Run Control Record, replacing references to PRCSRUNCNTL with your custom Run Control Record name:
- OPRID.RowInit
- RUN_CNTL_ID.SaveEdit
- LANGUAGE_CD.RowInit
- LANGUAGE_OPTION.FieldChange
- Add any desired additional fields to your custom Run Control Record (for example, "STRM").
- Build the Record.
Creating the Run Control Page
- Create a new Page definition and save it with a new name (for example, "MY_PRCS_RC").
- Insert a Subpage onto your page, and choose "PRCSRUNCNTL_SBP".
- On the Insert Subpage dialog, change the "Subpage Record Name Substitution" value to your custom Run Control Record (i.e., "MY_PRCS_RC").
- Drag your custom Run Control fields onto the Page (i.e., "STRM").
- Note: You do not need to add the default Run Control fields onto the page (OPRID, RUN_CNTL_ID, etc). These values will be populated automatically through PeopleCode.
Creating the Run Control Component
- Create a new Component definition.
- Set the Component Search Record to your custom Run Control Record (i.e., "MY_PRCS_RC").
- Save the Component with a new name (for example, "My PRCS_RC").
- Register your Component using the Registration Wizard (Tools > Register Component).
Creating the Process Definition
In this step, we create a Process definition entry for our SQR or App Engine program, and associate the process definition with our custom Run Control component.
- In the PIA, navigate to: PeopleTools, Process Scheduler, Processes
- Click the "Add a New Value" tab and enter the Process Type and Process Name.
- Note: The Process Name must exactly match the name of your App Engine program, or in the case of an SQR, must exactly match the file name of your SQR file (without the ".sqr" extension suffix).
- On the "Process Definition Options" tab:
- Add your custom Run Control Component under the "Component" grid area on the bottom left of the page.
- Add whichever Process Groups are appropriate to grant process security to the appropriate persons.
You should now be able to navigate to your Run Control page in the PIA, fill out the Run Control parameters, and schedule your process to run on the Process Scheduler.
Retrieving Run Control Parameters
Now that we have a way to provide Run Control parameters via a Run Control page, we need to be able retrieve and use those parameters from within a program. This part of the process is different for App Engine and SQR programs.
Run Control Parameters in App Engine Programs
The standard way to store Run Control parameters in an App Engine program is to use a State Record. To set up the State Record:
- A requirement in naming State Records is that they must have "_AET" as their suffix. Make a copy of your Run Control record, giving it a new name (for example, "MY_PRCS_AET").
- When prompted to save a copy of the PeopleCode associated with the original Record, choose "No".
- Change the Record Type from "SQL Table" to "Derived/Work". A Derived/Work Record doesn't persist any data to the database. Instead, it acts as an in-memory data structure while the program is running on the Process Scheduler.
- Open your App Engine program, and navigate to: File, Definition Properties
- On the "State Records" tab search for your State Record definition, and click the "Add" button to move the definition from the left-hand panel to the right-hand panel.
Now that the State Record is created and associated with the App Engine program, we need to populate it.
- Add an SQL step as the first step in the App Engine program. To populate the State Record with values from the Run Control Record, we use the Meta-SQL %Select function. For example:
%Select(OPRID, RUN_CNTL_ID, LANGUAGE_CD, LANGUAGE_OPTION, STRM)
FROM PS_MY_PRCS_RC
WHERE OPRID = %OperatorId
AND RUN_CNTL_ID = %RunControl
MessageBox(0, "", 0 , 0, "STRM=" | MY_PRCS_AET.STRM);
Run Control Parameters in SQR Programs
In an SQR program, there are no State Records. Typically, Run Control parameter values are simply stored using variables. The following steps will allow you to retrieve the Run Control parameters in an SQR program. Please refer to the SQR code sample following the step descriptions to see this in action.
- Make sure you have added an include statement to include "stdapi.sqc" in your SQR program. This delivered SQC provides routines which update the Process Scheduler with process status, as well as facilitating the retrieval of the Operator ID and Run Control ID values for the currently running SQR process instance.
- Ensure that the very first step of your program is to run the "Stdapi-Init" procedure, and that the very last step of your program is to run the "Stdapi-Term" procedure.
- Create a procedure to retrieve Run Control parameters, referencing the Operator ID and Run Control ID as "$prcs_oprid" and "$prcs_run_cntl_id" variables respectively. The "Stdapi-Init" procedure initializes these variables.
The following code sample illustrates the steps above:
! Program Name: MYPRCS.SQR
! Program Descr: My SQR Process
! Author: Mark Stramaglia
#include 'stdapi.sqc' ! Update status and get system parameters
BEGIN-PROGRAM
DO Stdapi-Init
DO Get-Run-Control-Parameters
DO Main-Process
DO Stdapi-Term
END-PROGRAM
BEGIN-PROCEDURE Get-Run-Control-Paramters
BEGIN-SELECT
RC.STRM
LET $strm = &RC.STRM
FROM PS_MY_PRCS_RC RC
WHERE RC.OPRID = $prcs_oprid
AND RC.RUN_CNTL_ID = $prcs_run_cntl_id
END-SELECT
END-PROCEDURE Get-Run-Control-Parameters
BEGIN-PROCEDURE Main-Process
SHOW 'STRM=' $strm
END-PROCEDURE Main-Process
