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 jobs 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 |
If the technical data cannot be retrieved, the job is reported as failed even when the job itself finished successfully. The log and the file list retrieved on the same completion path do not behave this way — an error retrieving either is recorded in the job log and leaves the job result unchanged. Select Extract Technical Data where its diagnostic value outweighs that risk.
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 |
The status is written to the OpCon job output.
This operation reports whether the status request succeeded, not what the status was. It finishes OK whenever the Cegid ORLI application responds — including when the response carries an error — so its completion code cannot be used to branch on the monitored job's outcome. Use the completion code of the executeRequest job itself for that.
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
Every Cegid ORLI job requires a failure criteria definition. Which codes a job can return depends on the operation it runs.
executeRequest codes
executeRequest submits a job and polls it until the Cegid ORLI application reports that processing has finished, so it reports the outcome of the job itself. The connector waits for the FINISHED_PROCESS value to reach X, then reads PROCESS_STATUS and LOG_STATUS to determine the code it returns:
| Code | OpCon status | Description |
|---|---|---|
0 | JOB_FINISHED_OK | The job finished with a process status of 9 and a log status of 0, with no log status present, or with a log status the connector does not recognize |
1 | JOB_FINISHED_WITH_WARNING | The job finished with a process status of 9 and a log status of 1 |
2 | JOB_FAILED | The job finished with a process status of 9 and a log status of 2, or the connector could not reach the application, could not authenticate, or received an error in response |
6 | JOB_FAILED | The job returned a process status of 6 |
7 | JOB_DELETED | The job returned a process status of 7 |
8 | JOB_STOPPED | The job returned a process status of 8 |
A log status the connector does not recognize is reported as 0, finished OK. An unmapped status from the Cegid ORLI application is therefore indistinguishable from a successful one in the OpCon result. Where the outcome matters, confirm it in the job log rather than relying on the completion code alone.
Codes for the retrieval operations
requestFiles, requestLog, requestStatus, and requestTechnicalData report whether the request succeeded, not the state of the job they asked about. They return two codes:
| Code | OpCon status | Description |
|---|---|---|
0 | JOB_FINISHED_OK | The request succeeded |
2 | JOB_FAILED | The connector could not reach the application, could not authenticate, or received an error in response |
Configuration errors
The connector reports the following codes before it attempts any request. Both mean that Connector.config is incomplete, and neither indicates a problem with the network or with the Cegid ORLI application:
| Code | Description |
|---|---|
99 | The ORLI_USER_PASSWORD setting is missing from Connector.config |
401 | The ORLI_USER_PASSWORD setting is present but empty |
To configure success criteria, set the Failure Criteria to Equal To 0 for any operation, or to Equal To 1 for an executeRequest job where a warning should be treated as success.
Logging and job output
The connector writes its log files into the log/ subdirectory of the installation directory, inside a subdirectory named for the current month. Each file is named for the connector and the date, with an index — for example log\2026-09\cegidorli_2026-09-16.0.log. A new file starts each day, and the index increments when a file reaches 100 MB. There is no separate current log file to look for: the dated file is the one being written.
Log files contain processing messages, return codes, and error details for each connector run.
Log files are retained indefinitely unless you configure pruning. Include the log directory in whatever disk monitoring you apply to the connector host.
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. Every Cegid ORLI job requires 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 means the ORLI_USER_PASSWORD setting is missing from Connector.config. The connector reports it before attempting any request, so it does not indicate a network or application problem. Code 401 means the setting is present but empty. Add or correct the encoded password value.
What does code 2 mean?
Code 2 covers every failure the connector reports against the Cegid ORLI application: it could not reach the endpoint, it could not authenticate, or the application returned an error. Check the job log for the message the connector recorded, then verify the ORLI_TOKEN_URL and ORLI_WEB_SERVICES_ENDPOINT values in Connector.config and 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_PROCESS — The Cegid ORLI value that tells the connector processing has finished. The connector polls an executeRequest job until it reaches X, then reads PROCESS_STATUS and LOG_STATUS to determine the completion code it returns to OpCon.
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: