Operation
What is it?
The PeopleSoft Connector lets you define OpCon jobs that start or track existing PeopleSoft batch processes through the PeopleTools Process Scheduler. Enterprise Manager includes job sub-type definitions for the PeopleTools Process Scheduler. Select the PeopleSoft job sub-type from the list when the Windows job type has been selected.
The PeopleSoft Connector does not create job definitions in the PeopleSoft database. It only uses existing PeopleSoft jobs.
PeopleSoft job definitions
The PeopleSoft Connector defines two job types that the PeopleTools Process Scheduler can process:
- START — Starts a defined PeopleSoft job and tracks the job to completion.
- TRACK — Tracks a job already started by the PeopleTools Scheduler to completion.
To define a PeopleSoft job, select a job type of Windows and then a job sub-type of PeopleSoft. The PeopleSoft definition screen appears.
START job definition
The START job type definition contains the following fields:
| Field | Description |
|---|---|
| Connector Path | Required. Contains the installed location of the PeopleSoft Connector. This is a global property value containing the root installation directory. The default value is PeopleSoftPath. If more than one connector is installed on the same system, define an additional global property and update this field. |
| Job Type | Required. The job type that the connector should process. Select START from the list. |
| Run Control ID | Optional. A grouping value associated with the PeopleSoft user name. |
| Process Type | Required. The type of job to process. Select the value from the list. The connector supports the following job types: Application Engine, COBOL SQL, Crystal, PSJob, SQR Report. |
| Process Name | Required. The name of the job in the Process Scheduler to run. |
| PeopleSoft User Name | Required. The name of a PeopleSoft user that has the required privileges to run the defined job. |
| PeopleSoft User Password | Required. The password of the PeopleSoft user that has the required privileges to run the defined job. Define this value in an encrypted global property. |
TRACK job definition
The TRACK job type definition contains the following fields:
| Field | Description |
|---|---|
| Connector Path | Required. Contains the installed location of the PeopleSoft Connector. This is a global property value containing the root installation directory. The default value is PeopleSoftPath. If more than one connector is installed on the same system, define an additional global property and update this field. |
| Job Type | Required. The job type that the connector should process. Select START from the list. |
| Run Control ID | Optional. A grouping value associated with the PeopleSoft user name. |
| Process Type | Required. The type of job to process. Select the value from the list. The connector supports the following job types: Application Engine, COBOL SQL, Crystal, PSJob, SQR Report. |
| Process Name | Required. The name of the job in the Process Scheduler to run. |
| Schedule Date | The date the job runs in the Process Scheduler. The value can be an OpCon property containing the appropriate value, or a date formatted as MM/DD/YYYY. |
| Schedule Time | Optional. Used to refine the search for the correct job to track in the Process Scheduler. The format of the time is hh:MM:SSAM or PM. |
| Server Name | Optional. Used to refine the search for the correct job to track in the Process Scheduler. The name of the server where the job runs. |
| PeopleSoft User Name | Required. The name of a PeopleSoft user that has the required privileges to run the defined job. |
| PeopleSoft User Password | Required. The password of the PeopleSoft user that has the required privileges to run the defined job. Define this value in an encrypted global property. |
Job finished processing
The successful completion code of PeopleSoft jobs is 9. To check for a successful completion, set the failure criteria to NE (Not Equal) to 9.
PeopleSoft job codes
| Code | Text | Description |
|---|---|---|
| 1 | Cancel | Job was cancelled by PeopleSoft. |
| 2 | Delete | Job was deleted by PeopleSoft. |
| 3 | Error | Job errored. |
| 4 | Hold | Job is placed on Hold by PeopleSoft. |
| 5 | Queued | Job is queued with PeopleSoft. |
| 6 | Initiated | Job is initiated by PeopleSoft. |
| 7 | Processing | Job is running in PeopleSoft. |
| 8 | Cancelled | Job was Cancelled by PeopleSoft. |
| 9 | Success | Job ran successfully. |
| 10 | Not Successful | Job run failed. |
Logging
The default logging implemented by the connector consists of a maximum cycle of five log files. The log files contain information about the PeopleSoft Connector and any jobs run by the PeopleSoft Connector. The log files (peoplesoft.log) are located in the installation_dir\log directory. Information is appended into the log files. Any error messages and return codes can be viewed in these log files.
All information produced by the OpCon job is available in the job output and can be retrieved using the OpCon JORS capability. When the job fails, the jde and jdedebug logs are appended to the OpCon job output and can be retrieved using JORS. When used in conjunction with the Event Notification System, the error logs can be attached to emails that can be sent to defined email or group email addresses.
FAQs
What completion code means a PeopleSoft job ran successfully? The successful completion code is 9. Set the failure criteria for the OpCon job to NE (Not Equal) to 9.
What is the difference between START and TRACK? START starts a defined PeopleSoft job and tracks it to completion. TRACK tracks a PeopleSoft job that has already been started by the PeopleTools Scheduler to completion.
Where are the connector log files?
The log files are named peoplesoft.log and are located in the installation_dir\log directory. The connector keeps a maximum cycle of five log files.
How do I retrieve job output and error logs in OpCon? Use the OpCon JORS capability. When a job fails, the jde and jdedebug logs are appended to the OpCon job output and can be retrieved using JORS.
Where should I store the PeopleSoft user password? Define the PeopleSoft User Password value in an encrypted global property.
Which PeopleSoft process types are supported? The connector supports Application Engine, COBOL SQL, Crystal, PSJob, and SQR Report.
Glossary
START job type — A PeopleSoft Connector job that starts a defined PeopleSoft job and tracks it to completion.
TRACK job type — A PeopleSoft Connector job that tracks a PeopleSoft job already started by the PeopleTools Scheduler to completion.
Process Type — The category of PeopleSoft batch process. Supported values are Application Engine, COBOL SQL, Crystal, PSJob, and SQR Report.
Process Name — The name of the job in the Process Scheduler to run.
Run Control ID — An optional grouping value associated with the PeopleSoft user name.
JORS — Job Output Retrieval System. The OpCon capability used to retrieve job output and appended log files.
peoplesoft.log — The connector log file located in the installation_dir
\logdirectory. Up to five log files are retained in a rolling cycle.