Skip to main content

Cegid CBR Connector Operation

What Is It?​

The Cegid CBR Connector operation section covers how to define Cegid CBR/Y2 jobs in OpCon Enterprise Manager, interpret completion codes, and review job output and logs.

  • Use this when you need to create or update a Cegid CBR/Y2 job definition in Enterprise Manager.
  • Use this when diagnosing a job failure by reviewing completion codes or connector log output.

Cegid CBR/Y2 Job Definitions​

The Cegid CBR/Y2 job subtype is available in Enterprise Manager when a Windows job type is selected.

To define a Cegid CBR/Y2 job, complete the following steps:

  1. In Enterprise Manager, open the Job Master.
  2. Select a Job Type of Windows.
  3. Select a Job Sub-Type of Cegid CBR/Y2.
  4. Complete the fields in the Cegid CBR/Y2 Definition screen.

Job Definition Fields​

FieldRequiredDescription
User IDYesThe Windows batch user that the connector runs under.
Connector PathYesThe installed location of the Cegid CBR/Y2 Connector. References the CBRY2Path global property by default. Update this field if you have defined a different property name for a multi-instance installation.
Database NameYesThe name of the database to use when starting the job. This value maps to the CBR/Y2 environment.
Job ID NumberYesThe ID of the job definition within the CBR/Y2 application.
DomainNoAn optional domain value passed to the CBPEXPORT program.
OtherNoNot currently used.

Setting Failure Criteria​

The standard successful completion code for a Cegid CBR/Y2 job is 0. For older systems, a different integer may indicate success — check the User Defined RC section of Connector.config for your environment.

To configure failure criteria for a standard installation, set the Failure Criteria to Not Equal To, the Value to 0, and the Result to Fail.

Completion Codes​

The following completion codes are returned by the Cegid CBR Connector to OpCon:

CodeDescription
0The job completed successfully.
51CGIMODE returned 51 and no matching string was found in the .TXT file. See the User Defined RC section of Connector.config.
102The job failed.
103CBPEXPORT returned a failure condition.
104The CBPEXPORT or CGIMODE job was cancelled.
105The inputfile.xml was not found by the CGIMODE job.
106The inputfile.xml does not contain an ACTION value.
107The auth.txt file was not found.
109The .DONE file was not found.

A negative or other integer code indicates a value mapped in the User Defined RC section of Connector.config, returned when the .DONE file contains completion code 51 and a description string in the .TXT file matches an entry in that section.

Logging​

The connector writes log output to cegidcbr.log in the <installation_dir>\log\ directory. When a log file reaches 100 MB it rolls, and the rolled file is written to a month-named subdirectory with a date-stamped name — for example log\2026-09\cegidcbr_2026-09-15.0.log.

Log files contain execution messages, return codes, and error details for each connector run.

caution

Rolled log files are retained indefinitely unless you configure pruning. Include the log directory in whatever disk monitoring you apply to the connector host.

Job Output​

The OpCon job log for a Cegid CBR/Y2 job includes the following information:

  • CBRConnector execution messages
  • CBPEXPORT stdout and stderr output
  • CGIMODE stdout and stderr output
  • Contents of the OPCON-<timestamp>-TACHE-<jobid>.DONE file
  • Contents of the OPCON-<timestamp>-TACHE-<jobid>.TXT file

Example Job Output​

14:00:30.102 [main] [CBRConnector] 20161229 14:00:30 : CBR Connector : 16.02.01.00
14:00:30.102 [main] [CBRConnector] 20161229 14:00:30 : -e (environment) : DBTEST
14:00:30.102 [main] [CBRConnector] 20161229 14:00:30 : -j (jobid) : 1234
14:00:30.102 [main] [CBRJobExecutorImpl] 20161229 14:00:30 : Performing CBPEXPORT parameters -DB DBTEST -TASKID 1234 -OUTPUTFOLDER c:\test\cbr\DBTEST\1234 -FOLDER DBTEST
14:00:55.150 [main] [CBRJobExecutorImpl] 20161229 14:00:55 : CBPEXPORT completed successfully with return code 0
14:00:55.197 [main] [CBRJobExecutorImpl] 20161229 14:00:55 : executing CGI mode
14:00:55.197 [main] [CBRJobExecutorImpl] 20161229 14:00:55 : Performing CGIMODE parameters -i c:\test\cbr\DBTEST\1234\inputfile.xml -o c:\test\cbr\CEGID\DBTEST\1234\output.xml -a Purge -auth c:\test\cbr\DBTEST\1234\auth.txt
14:01:40.270 [main] [CBRJobExecutorImpl] 20161229 14:01:40 : CGIMODE completed with return code -11
14:01:40.285 [main] [CBRConnector] 20161229 14:01:40 : CBR Connector Completion code : -11

FAQs​

What does completion code 103 mean?

Code 103 means the CBPEXPORT program returned a failure condition. Check the ExportOK setting in Connector.config to confirm which return codes are considered successful for your CBPEXPORT version. The default values are 0 and 24.

What does completion code 51 mean?

Code 51 means the CGIMODE program returned code 51 and the .TXT file did not contain a matching string from the User Defined RC section of Connector.config. The connector passes the original code through unchanged. Verify that all expected error description strings are defined in that section.

Where do I find the raw CBPEXPORT and CGIMODE output?

The full stdout and stderr for both programs is appended to the OpCon job log. Open the job in the Operations view and select View Job Output.

How do I know if a job completed successfully?

The connector returns 0 to OpCon for a successful job. Set the Failure Criteria to Not Equal To 0 in the job definition. For older systems where a different code indicates success, verify the User Defined RC section and adjust the failure criteria accordingly.

Why does the connector check timestamps before reading the .DONE file?

The connector takes an initial timestamp before calling CGIMODE and compares it to the date and time embedded in the .DONE file. This comparison confirms that the .DONE file was generated by the current run, not a previous one.

Glossary​

Failure criteria — The condition in an OpCon job definition that determines whether a job run is marked as failed. For Cegid CBR/Y2 jobs, this is typically set to Not Equal To 0.

Job Sub-Type — An Enterprise Manager field that selects the specialized input form for a specific connector. For Cegid CBR/Y2 jobs, select Cegid CBR/Y2 after selecting the Windows job type.

Job ID Number — The numeric identifier of a job definition within the Cegid CBR/Y2 application, passed to the connector as the -j argument.

Database Name — The Cegid CBR/Y2 environment name, passed to the connector as the -e argument.

User Defined RC — A Connector.config section that maps Cegid CBR/Y2 error description strings to integer return codes. Used when the .DONE file contains completion code 51.

.DONE file — A file generated by CGIMODE that contains the job completion date, time, and completion code. The connector reads this file to determine the final job status.

.TXT file — A file generated by CGIMODE that contains descriptive completion text. The connector scans this file for matching strings when the .DONE file contains completion code 51.