ProcessRequest Class Properties

In this section, we discuss the ProcessRequest class properties. The properties are discussed in alphabetical order.

Description

This property specifies whether or not a log file is attached to the email sent at completion of this job (or process). This property takes a Boolean value.

This property is read-write.

Example

&RQST.EmailAttachLog = False;   /*  Do not attach Log File */

Description

This property specifies the text used in the subject of the email sent at completion of this job (or process). This property takes a string value.

This property is read-write.

Example

&RQST.EmailSubject = "SQR Report:  Cross Reference Listing";

Description

This property specifies the text of the email sent at the completion of this job (or process). This property takes a string value.

This property is read-write.

Example

&RQST.EmailText = "This text will be displayed as the text of this email ";

You can also use the text from a message in the message catalog for this property.

&RQST.EmailText = MsgGetText(65, 117, "Sample text for email with two parameters", &MessageParm1, &MessageParm2);

Description

This property specifies whether an email is sent to recipients of the report after it is posted to the report repository. The URL for the report is included in the email. This option is applicable only when the OutDesType for the request is Web. This property takes a Boolean value: True, the web report should be attached, False otherwise.

This property is read-write.

Description

This property contains the name of a file to be used with file dependant processing, that is, processes which are initiated only after a file becomes available.

For a file dependent process, the FileName property is set to override the file name specified in the process definition. You must specify the complete file path and extension for the file, as a string.

This property works with the RunLocation property. If you don't specify a run location, any value assigned to this property is ignored.

This property is read-write.

Example

The following code example initiates QE_AETESTPRG once the c:\import\ediData.dat file becomes available on PSNT server.

Local ProcessRequest &rqst1;

&rqst1 = CreateProcessRequest();
&rqst1.RunControlId = "2";
&rqst1.ProcessType = "Application Engine";
&rqst1.ProcessName = "QE_AETESTPRG";
&rqst1.RunLocation = "PSNT";
&rqst1.FileName="c:\import\ediData.dat";
&rqst1.Schedule();

Description

This property contains the name of a job that you’ve defined in PeopleSoft Process Scheduler.

To schedule a job, you must assign values to JobName and RunControlID for the Schedule method to succeed.

If you’re scheduling a job, you don’t need to set the ProcessType property.

This property is read-write.

Example

&MYRQST.JobName = "3SQR";

Description

This property enables you to specify a language code for the process or job. If you don't specify a language code, PeopleSoft Process Scheduler first looks in the process run control table to retrieve a language code. If there isn't a value there, PeopleSoft Process Scheduler uses the user's language code specified in the User Definition table.

This property takes a string value.

This property is read-write.

Example

&MYRQST.LanguageCd = "ESP" /* Spanish */

Description

Use the NotifyTextMsgNum property to specify the message that should be displayed to the end user in the Event Notification popup display. This property takes a numeric value.

Note: You must specify both the message set and message number for the message to be displayed to the end user.

This property is read-write.

Example

&RQST.NotifyTextMsgSet = 65;
&RQST.NotifyTextMsgNum = 237;

Description

Use this property to specify the message set of the text message to be displayed to the end user in the Event Notification popup display. This property takes a numeric value.

Note: You must specify both the message set and message number for the message to be displayed to the end user.

This property is read-write.

Example

&RQST.NotifyTextMsgSet = 65;
&RQST.NotifyTextMsgNum = 237;

Description

This property specifies the output destination for the process or job to be scheduled as a string.

Values depend on the setting for the OutDestType property:

  • If OutDestType is FILE, OutDest must be the name of a directory. If the OutDest property isn’t set, it defaults to the setting in the Process profile. If the Process Profile was not updated with a default destination, the Process Scheduler server that picked up the request sets the directory based on the Log/Output Directory setting found in the Process Scheduler Configuration file.

  • If OutDestType is PRINTER, OutDest must be the name of a printer. If the OutDest property isn’t set, it defaults to the setting in the Process profile. If the Process Profile was not updated with a default printer, the Process Scheduler server that picked up the request sets the printer based on the Default Printer setting found in the Process Scheduler Configuration file.

  • If OutDestType is WEB or EMAIL, OutDest should contain the list of User IDs, Role IDs, or email addresses (for email only). If you don't set this property, it's automatically assigned to the person who submitted the request.

  • If OutDestType is WEB, PeopleSoft Process Scheduler uses the OutDest property to determine who has access to the output.

  • If OutDestType is EMAIL, PeopleSoft Process Scheduler uses the OutDest property to determine who to send the report output to.

    In both these cases, to identify whether it’s a User ID or a Role ID, the value has to be preceded by one of the following:

    U: Username or User: Username for a user ID

    R: Rolename or Role: Rolename for a role ID

    If the ID is not preceded by either of these identifiers, Process Scheduler assumes it's an email address.

    Note: Each ID must be separated by a semicolon (;).

    The following are two examples:

    &RQST.OutDest = "U:PTDMO;R:Employee;robert_smith@example.com"
    
    &RQST.OutDest = "User:PS;Role:Employee;sue_line@XYZ.com;simon_gree@example.com"
    
  • For any other value of OutDestType, this property has no effect.

You can specify directory and printer names using the UNC (Uniform Naming Convention) protocol.

This property is read-write.

Example

&MYRQST.OutDest = "C:\TEMP";

Description

This property specifies the output format for the process or job to be scheduled as a string. Values depend on your settings for the ProcessType and OutDestType properties:

The values for OutDestType, OutDestFormat, and OutDest are dependent upon each other as well as on other values.

See Values for Output Type and Format.

This property is read-write.

Example

&MYRQST.OutDestFormat = "RTF";

Description

This property specifies the type of output for the process or job to be scheduled as a string.

If the ProcessRequest object contains an invalid output type for a process, you won't be able to able to successfully schedule a process or job.

The value specified for this property is used only if the Output Destination Type for the defined process or job defined in PeopleSoft Process Scheduler is specified as Any. Otherwise any value specified for this property is ignored.

The values for OutDestType, OutDestFormat, and OutDest are dependent upon each other as well as on other values.

See Values for Output Type and Format.

This property is read-write.

Example

&MYRQST.OutDestType = "FILE";

Description

This property specifies the name of the report folder associated with a job item as a string. If you're specifying a folder, the folder that you specify must have already been created using Report Manager.

This property is read-write.

Description

This property is a system-generated identification number. PeopleSoft Process Scheduler assigns a ProcessInstance at runtime to each process or job it successfully schedules.

This property is read-write.

Example

&MYRQST.Schedule();
If &MYRQST.Status = 0 then
   /* process successfully scheduled */
   &ProcInst = &MYRQST.ProcessInstance;
Else
   /* do error processing */
End-If;

Description

This property specifies the name of a predefined process as a string.

To successfully schedule a process, you must assign values to ProcessName, ProcessType, and RunControlID (that is, for the Schedule method to succeed.)

This property is read-write.

Example

&MYRQST.ProcessName = "XRFWIN";

Description

This property specifies the name of a predefined process type as a string.

To successfully schedule a process, you must assign values to ProcessName, ProcessType, and RunControlID (that is, for the Schedule method to succeed.)

The values for ProcessType depend on the types of processes you have defined in your system. There are generic process types that are delivered with your installation of PeopleSoft. These process types may include the following:

  • Application Engine

  • COBOL

  • Cube

  • nVision

  • SQR

  • WinWord

  • Other

If you define your own processes, you can use the name of that process with the ProcessType property. For example, suppose you create a custom process named "Custom CBL Programs." You could use this as follows:

&MyRqst.ProcessType = "Custom CBL Programs";

Note that spaces are included in the string for ProcessType.

This property is read-write.

Example

Note that spaces are included in the string for ProcessType.

&MYRQST.ProcessType = "Application Engine";

Description

This property returns a string that serves, along with the user ID, as a key that identifies a predefined group of parameters to be used by a process or a job at runtime.

To successfully schedule a process, you must provide values for RunControlID, ProcessName, and ProcessType.

To successfully schedule a job, you must provide values for RunControlID and JobName.

This property is read-write.

Example

&MYRQST.RunControlID = "MYRUNCONTROLID";
or
&MYRQST.RunControlID = PRCSSAMPLEREC.RUN_CNTL_ID;

Description

This property contains a DateTime value that specifies when the scheduled process or job will run.

If you don’t specify a value for this property, and there is no date time set for the pre-defined process or job, the process or job runs as soon as the Schedule method is executed.

This property is read-write.

Example

The following example schedules the process or job to run as soon as the Schedule method is executed:

&MYRQST.RunDateTime = %Datetime;

Description

This property specifies the Process Scheduler Server name the request should be scheduled on. This property takes a string value. Values for RunLocation is a specific server name, such as PSNT.

If no RunLocation is specified, the request is scheduled based on both the default operating system and load balancing options set in the System Settings page.

This property is read-write.

Example

&MYRQST.RunLocation = "SERVER";
or
&MYRQST.RunLocation = "PSNT";

Description

This property specifies the frequency with which a process or job is to be run as a string. The RunRecurrence value you use must be the name of a Recurrence Definition defined in Process Scheduler Manager to successfully schedule a job or process (that is, for the Schedule method to succeed.)

This property is read-write.

Example

&MYRQST.RunRecurrence = "M-F at 5pm";

Description

This property specifies the run status of a process request as a number. This property is used with the UpdateRunStatus method to change the status of a request. Values are:

RunStatus

Description

1

Cancel

2

Delete

3

Error

4

Hold

5

Queued

6

Initiated

7

Processing

8

Cancelled

9

Success

10

Not Successful

11

Posted

12

Unable to post

13

Resend

14

Posting

15

Generated

16

Pending

This property is read-write.

Example

&MYRQST.RunStatus = 1;

Description

This property returns a number based on the result of the last execution of the Schedule method.

Valid returns are:

  • Zero if the method succeeded

  • Non-zero otherwise

This property is read-only.

Example

&MYRQST.Schedule();
If &MYRQST.Status = 0 then
   /* Schedule succeeded. */
Else
   /* Process (job) not scheduled, do error processing */
End-If;

Description

This property contains a timezone value that specifies when the scheduled process or job will run. If no value is used for this property, the server timezone is used. This property takes a string value.

This property is read-write.

Example

&MyRqst.TimeZone = "EST";