PeopleSoft Task

PeopleSoft Task

Overview

Note

These instructions assume the user has a working knowledge of PeopleSoft.

The PeopleSoft task allows you to send commands to a PeopleSoft system and gather status information and output back from PeopleSoft. The PeopleSoft task uses Stonebranch's proprietary Universal Connector for PeopleSoft (UPPS) to communicate with PeopleSoft . Universal Connector for PeopleSoft allows Universal Controller to connect to a PeopleSoft system and manage PeopleSoft background processing tasks.

Before You Begin

To run a PeopleSoft task, you must first complete the following:

Built-In Variables

The following built-in variables can be used in a PeopleSoft task to pass data where appropriate:

Creating a PeopleSoft Task

Step 1

From the Automation Center navigation pane, select Tasks > PeopleSoft Tasks. The PeopleSoft Tasks list displays a list of all currently defined PeopleSoft tasks.
 
To the right of the list, PeopleSoft Task Details for a new PeopleSoft task displays.
 

Step 2

Enter/select Details for a new PeopleSoft task, using the field descriptions below as a guide.

  • Required fields display an asterisk ( * ) after the field name.

  • Default values for fields, if available, display automatically.

To display more of the Details fields on the screen, you can either:

  • Use the scroll bar.

  • Temporarily hide the list above the Details.

  • Click the

     button above the list to display a pop-up version of the Details.

Step 3

Click the 

button. The task is added to the database, and all buttons and tabs in the Task Details are enabled.

Note

To open an existing record on the list, either:

  • Click a record in the list to display its record Details below the list. (To clear record Details below the list, click the New button that displays above and below the Details.)

  • Clicking the Details icon next to a record name in the list, or right-click a record in the list and then click Open in the Action menu that displays, to display a pop-up version of the record Details.

  • Right-click a record in the a list, or open a record and right-click in the record Details, and then click Open In Tab in the Action menu that displays, to display the record Details under a new tab on the record list page (see Record Details as Tabs).

PeopleSoft Task Details

The following PeopleSoft Task Details is for an existing PeopleSoft task.

Depending on the values that you enter / select for these fields, and whether or not the PeopleSoft task has ever been launched, more (or less) fields may display. See the field descriptions, below, for a description of all fields that may display in the PeopleSoft Task Details.
 

PeopleSoft Task Details Field Descriptions

The following table describes the fields, buttons, and tabs that display in the PeopleSoft Task Details.

Field Name

Description

Field Name

Description

General

This section contains general information about the task.

Name

User-defined name of this task (Maximum = 255 alphanumeric characters); variables supported. It is the responsibility of the user to develop a workable naming scheme for tasks.

Version

System-supplied; version number of the current record, which is incremented by the Controller every time a user updates a record. Click the Versions tab to view previous versions. For details, see Record Versioning.

Description

Description of this record. Maximum length is 255 characters.

Member of Business Services

User-defined; Allows you to select one or more Business Services that this record belongs to.  (You also can Check All or Uncheck All Business Services for this record.)

You can select up to 62 Business Services for any record type, and enter a maximum of 2048 characters for each Business Service.

If the Business Service Visibility Restricted Universal Controller system property is set to true, depending on your assigned (or inherited) Permissions or Roles, Business Services available for selection may be restricted.

Resolve Name Immediately

If enabled, the Instance Name of the task instance will be resolved immediately at trigger/launch time.

Time Zone Preference

User-defined; Allows you to specify the time zone that will be applied to the task.

Options:

  • -- System Default --
    Time zone is based on the value of the Task Time Zone Preference Universal Controller system property: Server or Inherited.
  • Server (xxx)
    Where (xxx) is the time zone ID of the server; time zone is evaluated in the time zone of the server.
  • Inherited
    Time zone is evaluated in the time zone of the Parent Workflow or Trigger / Launch specification in the case there is no Parent Workflow.

Hold on Start

 

If enabled, when the task is launched it appears in the Activity Monitor with a status of Held. The task runs when the user releases it.



Hold Reason

Information about why the task will be put on hold when it starts.

Virtual Resource Priority

Hold Resources on Failure

Agent Details

This section contains assorted detailed information about the Agent / Agent Cluster selected for this task.

Cluster

Utility Agent

Utility Agent Variable

Utility Agent Cluster

Utility Agent Cluster Variable

Utility Credentials

Utility Credentials Variable

PeopleSoft Details

This section contains assorted detailed information about the task.

PeopleSoft Connection

PeopleSoft Connection Variable

PeopleSoft Credentials

PeopleSoft Credentials Variable

Command

Run Control ID

Process Type

Process/Job Name

Server Name

Output Destination Type

Output Destination Format

Output Destination String

Process File Name

Main Schedule Name

Main Job Name

Print Distribution List

Print Parameter List

Print Application Message

Print System Message

Print Job Tree

Report

Content Filter

PeopleSoft Distribution Details

If Command = Schedule Process or Schedule Job; This section contains assorted distribution details about the task.

Report Folder Name

Retention Days

Email Address List

Email Subject

Email Text

Email With Log

Email Web Report

Distribution Options

Result Processing Details

This section contains assorted detailed information about result processing for this task.

Exit Code Processing

Output Type

Scan Output For

Output File (for Exit Code Processing)

Exit Codes

Automatic Output Retrieval

Wait For Output

Failure Only

Start Line

Number of Lines

Scan Text

Output File (for Automatic Output Retrieval)

Retry Options

This section contains specifications for retrying the task.

Maximum Retries

Retry Indefinitely

Retry Interval (Seconds)

Suppress Intermediate Failures

Wait / Delay Options

This section contains specifications for waiting to start and/or delaying on start the task.

Wait To Start

Wait Time

Wait Day Constraint

Wait Duration

Wait Duration In Seconds

Delay On Start

Delay Duration

Delay Duration In Seconds

Workflow Only

Time Options

This section contains time-related specifications for the task.

Late Start

Late Start Type

Late Start Time

Late Start Day Constraint

Late Start Nth Amount

Late Start Duration

Late Finish

Late Finish Type

Late Finish Offset Type

Late Finish Percentage Offset ( + )

Late Finish Duration Offset ( + )

Late Finish Duration Offset Unit

Late Finish Time

Late Finish Day Constraint

Late Finish Nth Amount

Late Finish Duration

Early Finish

Early Finish Type

Early Finish Offset Type

Early Finish Percentage Offset ( - )

Early Finish Duration Offset ( - )

Early Finish Duration Offset Unit

Early Finish Time

Early Finish Day Constraint

Early Finish Nth Amount

Early Finish Duration

User Estimated Duration

Critical Path Options

This section contains Critical Path-related specifications for the task.

CP Duration

CP Duration (Resolved)

CP Duration Unit

Workflow Execution Options

This section contains Execution Restriction specifications for the task if it is within a Workflow.

Execution Restriction

Restriction Period

Before Date

Before Time

After Date

After Time

Date List

Statistics

This section contains time-related statistics for task instances of the task.

First Execution

Last Execution

Last Instance Duration

Lowest Instance Time

Average Instance Time