STEPdoc in Companion for Delivery (c4d)

There are three possible data sources to generate the documentation

From a given input file:

mvn c4d:documentation -D"username=<username>" -D"password=<password>" -Dclient=<client> -tag=<tag>
                      -DinputFile=<inputFile>

From an export configuration of a STEP tag:

mvn c4d:documentation -D"username=<username>" -D"password=<password>" -Dclient=<client> -Dtag=<tag>
                          -DstepUrl=<stepUrl> -DstepUsername=<stepUsername> -DstepPassword=<stepPassword> 
                          -DstepContext=<stepContext> -DstepWorkspace=<stepWorkspace> -DstepConfigId=<stepConfigId> 
                          -DstepRestApiVersion=<stepRestApiVersion>

From a Companion for Delivery project:

mvn c4d:documentation -D"username=<username>" -D"password=<password>" -Dclient=<client> -Dtag=<tag>

Generate project documentation from packaged files located in target directory.
To execute this goal, you need to use c4d:compile and c4d:package before.

Parameters

Mandatory parameters to upload documentation:

  • username: Username of an account with the right to push documentation
  • password: Password of an account with the right to push documentation
  • client: Client name provided by Cantor
  • tag: Name of the tag to be overwritten for example: dev, test, prod
  • projectName: Project name, by default if it is launched from a c4d project filled with its name otherwise is empty.
  • version: Project version, by default if it is launched from a c4d project filled with its version otherwise is empty.

Additional parameters to generate documentation from a given input file:

  • inputFile: Path to a STEPXML file

Additional settings for generating documentation from a step environment :

  • stepUrl: URL to the environment
  • stepUsername: Username to access the environment
  • stepPassword: Password to access the environment
  • stepContext: STEP context used for the export
  • stepWorkspace: STEP workspace used for the export
  • stepConfigId: Id of the export configuration
  • stepRestApiVersion: (default= V2) STEP Rest API version used to retrieve environments.

Optional parameters :

  • color: (default= #3eaf7d) Replace the main colour of the site with another colour.

Example of export configuration

Documentation from Step enable to generate documentation from a Step instance with an Export Manager Configuration.
This feature is available with STEP Rest API V1 from 3.4.0 and STEP Rest API V2 from 3.7.0/STEP 10.0.

To generate documentation of a STEP instance you need to configure and export configuration. Here is an example in AdvancedStepXml

<?xml version='1.0'?>
<STEP-ProductInformation>
    <!-- Context -->
    <DimensionList ExportSize="All"/>
    <ContextList ExportSize="All"/>
    
    <!-- Datamodel -->
    
    <UserTypes ExportSize="All"/>
    <AttributeGroupList ExportSize="All"/>
    <AttributeList ExportSize="All"/>
    <UnitList ExportSize="All"/>
    <ListOfValuesGroupList ExportSize="All"/>
    <ListsOfValues ExportSize="All"/>
    <CrossReferenceTypes ExportSize="All"/>
    <Keys/>
    
    <!-- Integration -->
    
    <STEPWorkflows ExportSize="All"/>
    <BusinessLibraries ExportSize="All"/>
    <BusinessRules ExportSize="All"/>

    <!-- Datas -->
    <!-- Products with attributesLinks-->
    
    <!-- Remove this tag if you dont want to document node from Primary Product Hierarchy -->
    <Products ExportSize="Selected" FlattenHierarchy="true">
        <!-- Specify the product you need to export for documentation -->
        <FilterUserType ID="TYPE_PRODUIT_1"/>
        <FilterUserType ID="TYPE_PRODUIT_2"/>
        <Product>
            <Name/>
            <AttributeLink>
                <MetaData/>
            </AttributeLink>
        <Product/>
        </Product>
    </Products>


    <!-- Classifications with attributesLinks-->

    <Classifications ExportSize="Minimum" FlattenHierarchy="true">
        <Classification IncludeParent='true'>
            <AttributeLink>
                <MetaData/>
            </AttributeLink>
        </Classification>
    </Classifications>


</STEP-ProductInformation>

You can configure manually the Export Manager Configuration inside the Step Workbench with Advanced STEPXML.
You have to copy paste this Advanced Step XML configuration and set FilterUserType for the Primary Product Hierarchy
node you want to document.

WARNING

Inside Export Manager Configuration template you have to define the product user types (TYPE_PRODUIT_1, TYPE_PRODUIT_2) that will be exported.
Otherwise with an inappropriate configuration all products existing in Step could be exported or documentation will not be complete.

Last Updated: