Installation

Requirements

You should take care of the following list of necessary components for all computers that intend to run Companion for Delivery:

  • JDK 11.x or JDK 17.x (JAVA_HOME must be properly set)
  • Maven 3.x (mvn should be accessible through the PATH variable)
  • Companion for Delivery license
  • Excel 2010 or higher (not needed for continuous integration server)
  • STEP License REST API activated on development environment for Companion for Delivery deployment and tests
  • Access to Cantor domain
    • Nexus for dependencies : https://ccs-nexus.cantor.fr/
    • Companion license server for version : https://ccs-licensing.cantor.fr
    • Stepdoc server : https://companion-stepdoc.cantor.fr and https://companion-stepdoc-kc.cantor.fr

WARNING

If you use a proxy, you may have problems accessing Cantor domain when using Companion for Delivery.
In case of problem contact us.

License

From existing project

Install the Companion for Delivery license by opening a terminal in the project folder then launch the following command:

mvn c4d:license-install -Dfile=<path to the Companion for Delivery license file>

Without creating a project

Open the Maven settings.xml file (see the Maven documentationopen in new window for details on file location) and add the following lines:

<profiles>
    <profile>
        <id>c4d-dev</id>
        <pluginRepositories>
            <pluginRepository >
                <id>nexus.cantor</id>
                <name>Cantor Nexus</name>
                <url>https://ccs-nexus.cantor.fr/content/groups/public/</url>
            </pluginRepository >
        </pluginRepositories>
    </profile>
</profiles>
<activeProfiles>
    <activeProfile>c4d-dev</activeProfile>
</activeProfiles>

Then install the Companion for Delivery license by opening a terminal window then launch the following command:

mvn fr.cantor.c4d:c4d-maven-plugin:license-install -Dfile=<path to the Companion for Delivery license file>

WARNING

You should be aware that each license is attached to a single computer. You should then purchase one license per developer.

Data sent to our license server

No data from STEP configuration is sent to our license server.

  • Companion license server : Only computer information and project name are sent to our server, in order to deliver license usage token

Deployment

Minimum requirement

The STEP RESTAPI license has to be installed on all instances that will be used to deploy Companion project.

Companion for Delivery Datamodel

TIP

You need to update ${step-context} and ${step-workspace} into each xml file before import

Import companion-init.step.xml or use c4dSetup file into STEP. This will create necessary elements in order to make Companion for Delivery able to deploy onto STEP server.

It creates the following objects:

  • CompanionConfiguration (UserType): Companion for Delivery configuration product type
  • Companion (AttributeGroup): Companion for Delivery attribute group
  • Companion.LockOwner (Attribute): Companion for Delivery lock attribute
  • Inbound Integration Endpoints (SetupGroup): Companion for Delivery IEP setup group
  • CompanionConfiguration (Product): Companion for Delivery configuration product
  • CompanionIIEP (IntegrationEndpoints): Companion for Delivery IEP definition

Then import companion-tests-init.step.xml or use c4dTestsSetup file into STEP. It will create the Companion for Delivery necessary objects for test suite.

It contains the following object definitions:

  • CompanionTests (UserType): Companion for Delivery test product type
  • Companion.Tests (AttributeGroup): Companion for Delivery test attribute group
  • Companion.Tests.Timestamp (Attribute): Companion for Delivery test timestamp attribute
  • Companion.Tests.ExecutionReport (Attribute): Companion for Delivery test execution report attribute
  • CompanionTestBRs (SetupGroup): Companion for Delivery test business rules setup group
  • CompanionTests (Product): Companion for Delivery test product

WARNING

After import check if CompanionConfiguration and CompanionTests are completely approved.

Last Updated: