Operation
The Cegid ORLI job subtype in Enterprise Manager lets you define jobs that communicate with the Cegid ORLI application. Each job definition specifies the operation type and the parameters required for that operation.
What is it?
The Cegid ORLI job subtype provides a structured interface for configuring jobs that interact with the Cegid ORLI application through OpCon. When OpCon runs a job, it passes the definition as arguments to the Cegid ORLI Connector, which submits the request to the Cegid ORLI application.
- Use the executeRequest operation to start a job in the Cegid ORLI application and monitor it through completion
- Use the requestStatus, requestFiles, requestLog, or requestTechnicalData operations to retrieve information about a previously submitted executeRequest job
- The connector monitors executeRequest jobs until completion and adds status and log information to the OpCon job output automatically
Define a Cegid ORLI job
To define a Cegid ORLI job in Enterprise Manager, complete the following steps:
- In Enterprise Manager, open the Job Master and select or create a schedule.
- Select the Add button to create a new job.
- In the Job Type list, select Windows.
- In the Job Sub-Type list, select Cegid ORLI. The Cegid ORLI Definition screen is displayed.
- Complete the General Information fields.
- Select the tab for the operation you want to run and complete the required fields.
- Define the Failure Criteria for the job.
- Select the Save button.
General information fields
All Cegid ORLI job types require the following general fields:
| Field | Required | Description |
|---|---|---|
| User Id | Yes | The Windows batch user under which the connector runs |
| Connector Path | Yes | The global property containing the connector installation directory. Default value is OrliPath |
| User Name | No | Maintained for compatibility. The user value in Connector.config is used instead |
| Language Profile | No | The language to use when generating output. Must be a value defined in the Cegid ORLI application. If not specified, the default language for the user profile is used |
| Operation | Yes | The Cegid ORLI operation to run. Select one of: requestFiles, requestLog, requestStatus, requestTechnicalData, or executeRequest |
Operation-specific fields
executeRequest
Use this operation to start a job in the Cegid ORLI application.
| Field | Required | Description |
|---|---|---|
| Func Name | Yes | The name of the job to run in the Cegid ORLI application |
| Filter Name | No | A filter that defines output parameters for this request. If not specified, the default filter from the user profile is used |
| Extract Technical Data | No | When selected, retrieves technical data from the job and adds it to the OpCon job output |
requestFiles
Use this operation to retrieve the list of files generated by a previously submitted executeRequest job.
| Field | Required | Description |
|---|---|---|
| Request Number | Yes | The request number of the previously completed executeRequest job |
The retrieved file list can be viewed using the OpCon job output retrieval capability.
requestLog
Use this operation to retrieve the log files created during a previously submitted executeRequest job.
| Field | Required | Description |
|---|---|---|
| Request Number | Yes | The request number of the previously completed executeRequest job |
The retrieved log files can be viewed using the OpCon job output retrieval capability.
requestStatus
Use this operation to retrieve the current status of a previously submitted executeRequest job.
| Field | Required | Description |
|---|---|---|
| Request Number | Yes | The request number of the previously completed executeRequest job |
This operation performs a single status check. Set the Failure Criteria to the expected successful completion code.
requestTechnicalData
Use this operation to retrieve technical data about a previously submitted executeRequest job. Use this operation when a job fails and you need additional diagnostic information.
| Field | Required | Description |
|---|---|---|
| Request Number | Yes | The request number of the previously completed executeRequest job |
The retrieved technical data can be viewed using the OpCon job output retrieval capability.
Failure criteria
All Cegid ORLI job types require a failure criteria definition. The connector maps Cegid ORLI FINISHED_PROCESSING return codes to OpCon job statuses as follows:
| Code | OpCon status | Description |
|---|---|---|
0 | JOB_FINISHED_OK | The job completed processing with PROCESS_STATUS 9 and LOG_STATUS 0.0, or with PROCESS_STATUS 9 and no LOG_STATUS present |
1 | JOB_FINISHED_WITH_WARNING | The job completed processing with PROCESS_STATUS 9 and LOG_STATUS 1.0 |
2 | JOB_FAILED | The job failed during processing with PROCESS_STATUS 9 and LOG_STATUS 2.0 |
6 | JOB_FAILED | The job failed (Cegid code 6 returned) |
7 | JOB_DELETED | The job was deleted (Cegid code 7 returned) |
8 | JOB_STOPPED | The job stopped (Cegid code 8 returned) |
99 | Connection failure | The connector could not connect to the Cegid ORLI application |
To configure success criteria: set the Failure Criteria to Equal To 0 (finished successfully) or Equal To 1 (finished with warning treated as success).
Logging and job output
The connector writes log information to rotating log files in the log/ subdirectory of the installation directory. The log cycle retains a maximum of five files named cegidorli.log through cegidorli.log.5. New log entries are appended to the current log file. Error messages, return codes, and job information are all written to these log files.
FAQs
What is the request number and where do I find it?
The request number is assigned by the Cegid ORLI application when an executeRequest job is submitted. The connector writes it to the OpCon job output when the executeRequest job completes. Use this number in requestFiles, requestLog, requestStatus, and requestTechnicalData jobs.
Do I need to set a Failure Criteria for every job type?
Yes. All five job types require a Failure Criteria definition. For most jobs, set Failure Criteria to Equal To 0 to mark the job as complete when it finishes successfully.
What does code 99 mean?
Code 99 indicates that the connector could not connect to the Cegid ORLI application. Check the ORLI_TOKEN_URL and ORLI_WEB_SERVICES_ENDPOINT values in Connector.config and verify network connectivity to the Cegid ORLI server.
What is the difference between requestLog and requestTechnicalData?
requestLog retrieves the log files produced during the job execution (processing logs). requestTechnicalData retrieves lower-level technical information about the execution request, typically used when a job fails and standard log information is not sufficient to diagnose the problem.
Where can I view the files and logs returned by requestFiles and requestLog?
The returned file lists and log contents are added to the OpCon job output and can be viewed using the OpCon job output retrieval capability (JORS).
What does the Language Profile field do?
The Language Profile field specifies the language the Cegid ORLI application uses when generating output for the job. The value must match a language profile defined in the Cegid ORLI application. If left blank, the Cegid ORLI application uses the default language associated with the authenticated user profile.
Glossary
executeRequest — The Cegid ORLI operation that starts a job in the application and monitors it through completion.
requestFiles — The Cegid ORLI operation that retrieves the list of files generated by a previously submitted executeRequest job.
requestLog — The Cegid ORLI operation that retrieves the log files from a previously submitted executeRequest job.
requestStatus — The Cegid ORLI operation that returns the current status of a previously submitted executeRequest job.
requestTechnicalData — The Cegid ORLI operation that retrieves diagnostic technical data from a previously submitted executeRequest job.
Func Name — The name of the job to run in the Cegid ORLI application, as defined within the Cegid ORLI environment.
Filter Name — An optional parameter that defines which output parameters are returned for a request. Defined within the Cegid ORLI application.
FINISHED_PROCESSING — The Cegid ORLI return code that the connector evaluates to determine job completion status. Mapped to OpCon job statuses by the connector.
Request Number — The identifier assigned by Cegid ORLI when an executeRequest job is submitted. Required by the requestFiles, requestLog, requestStatus, and requestTechnicalData operations.
Related topics: