Overview
The Cegid ORLI Connector enables OpCon to automate and monitor jobs within the Cegid ORLI commercial management application. The connector runs as a Windows batch program executed by the Windows Agent, and receives job definitions passed as arguments by OpCon at run time.
What is it?
The Cegid ORLI Connector is a Windows-based integration component that bridges OpCon and the Cegid ORLI application. Job definitions are entered in OpCon as Windows jobs using the Cegid ORLI job subtype. When OpCon runs a job, it passes the definition as arguments to the connector, which then communicates with the Cegid ORLI application using REST APIs with SOAP data structures.
- Use this connector when you need OpCon to start jobs in the Cegid ORLI application and monitor them through completion
- Use this connector when you need to retrieve files, logs, or status information from a previously submitted Cegid ORLI job
- Use this connector when you need to retrieve technical data from a Cegid ORLI job execution for troubleshooting purposes
Supported job types
The connector supports five job types that map to the available Cegid ORLI operations:
| Job type | Description |
|---|---|
| executeRequest | Starts a job in the Cegid ORLI application. After submission, the connector monitors execution status until completion and extracts job information and logs into the OpCon job output |
| requestFiles | Retrieves the list of files generated by a previously submitted executeRequest job |
| requestLog | Retrieves the log files created during a previously submitted executeRequest job |
| requestStatus | Returns the current status of a previously submitted executeRequest job |
| requestTechnicalData | Retrieves technical data about a previously submitted executeRequest job, typically used for troubleshooting |
How it works
When OpCon schedules a Cegid ORLI job, the connector performs the following steps:
- Retrieves an authorization token from the configured token URL using the credentials in
Connector.config - Sets the token in the header of the REST API call
- Builds the required SOAP envelope and submits it to the Cegid ORLI web services endpoint using a POST request
- Parses the returned XML data using the XPATH library
- Returns status and log information to the OpCon job output
Authentication uses token-based authorization. The connector retrieves a token before each operation and includes it in the request header.
Current version
Version 25.0 — This release is a complete rewrite replacing SOAP web service requests with REST API calls using SOAP data structures, and introduces token-based authentication.
Related topics: