CompanionCompanion
Companion for Delivery
Companion for Business
Companion for Integration
Contact us
Log out
Companion for Delivery
Companion for Business
Companion for Integration
Contact us
  • Companion for Integration

    • Introduction
    • Getting Started
    • Configuration
    • Excel templating
    • How it works
  • YAML Configuration

    • Principles
    • Syntax
    • Validation
  • Custom Functions

    • Summary
    • arrayToJSON
    • bool
    • concatValueAndUnit
    • convertUnit
    • currentContextId
    • exportTime
    • eval
    • firstNonEmpty
    • getContextName
    • getEvents
    • getLastEventTime
    • getReferencesByAttributeGroup
    • getStoredValue
    • getWorkspaceId
    • hash
    • hasStoreKey
    • if
    • integer
    • join
    • mergeInheritedValues
    • multiValuesToJSON
    • number
    • nodeList
    • order
    • resolveUnitLabel
    • serializeAssetPushLocationsToJSON
    • serializeAttributeLinksToJSON
    • serializeContextReferenceToJSON
    • serializeContextReferencesToJSON
    • serializeContextValuesToJSON
    • serializeDataContainerToJSON
    • serializeDataContainersToJSON
    • serializeListOfValueValuesToJSON
    • serializeReferencesToJSON
    • serializeReferenceToJSON
    • serializeValuesToJSON
    • store
    • toXML
    • uppercase
  • Execution

    • Summary
    • Composite
    • From STEP
    • Standalone
    • Performance statistics
  • Configuration

    • ActiveMQ extension
    • Amazon AWS extension (SNS, SQS, Kinesis, S3)
    • ElasticSearch/OpenSearch extension
    • File extension (Excel, CSV, JSON, XML, JSONL, XMLL)
    • Kafka extension
    • Kafka Core extension
    • MongoDB/Cosmos DB extension
    • SQL extension
    • REST extension
    • Google Pub/Sub extension
  • c4i SaaS

    • Introduction
    • Managing jobs
    • Managing executions
    • Managing users
    • Changelog
  • Changelog

    • Core features changelog
    • ActiveMQ extension changelog
    • Amazon AWS extension changelog
    • Composite extension changelog
    • ElasticSearch extension changelog
    • File extension changelog
    • Kafka extension changelog
    • Kafka Core extension changelog
    • MongoDB/Cosmos DB extension changelog
    • SQL extension changelog
    • REST extension changelog
    • Google Pub/Sub extension changelog

Standalone execution

It is also possible to run Companion for integration in Standalone mode, outside a STEP environment.

Standalone execution requires a .properties configuration file, which looks a lot like the Composite configuration file.

A line must be added, containing the plugin license file with licenseAssetId, for instance:

pluginId=fr.cantor.c4i.MySQLDelivery
...
licenseAssetId=/Path/to/C4I/License.cat

To run Companion for integration in Standalone mode, prepare your configuration files and then run the following command using Java 11 or above :

java -cp c4i-runtime-<version>-jar-with-dependencies.jar fr.cantor.c4i.C4IStandaloneRunner <properties file> <XML files>

Or, for the composite standalone mode :

java -cp c4i-runtime-<version>-jar-with-dependencies.jar fr.cantor.c4i.CompositeMain <properties file> <XML files>

You can also supply your own logback.xml configuration file using the following command :

java -Dlogback.configurationFile=/path/to/logback.xml ...

Passwords and environment-dependent parameters

Since version 3.19.0, passwords and other environment-dependent parameters are stored in a properties file in your home directory.

In order to configure the parameters, you need to create the following directory : /~/c4i/credentials, then the following file inside this directory: c4i.properties.

This properties file will centralize all the environment-dependent data, with the following format :

myConnection.host=myHost
myConnection.username=username
myConnection.password=password

Then you can reference it through the connection key.

The needed parameters for each extension are listed in the "Configuration" section.

Additionally, you can encode the password using AES (for example with https://emn178.github.io/online-tools/aes/encrypt/. You can leave the default parameters except for setting "Output encoding = Base64").

Then you will need to set the masterPassword property so C4i can decode the password properly.

Scripts location

The property scriptsRootPath can be added to your configuration file to indicate where the scripts are located on your local environment. Otherwise, c4i will look for scripts in the directory where the command is executed

Last Updated: 4/14/26, 2:43 PM
Prev
From STEP
Next
Performance statistics