STEPdoc

What is STEPdoc?

Companion for Business and Companion for Delivery come with STEPdoc, which generates the online documentation for your project, making it easily accessible to your team and stakeholders (multi-tenant platform).

It is possible for each client to publish 5 different documentations (tags) per c4d/c4b license.

Your documentation is then accessible through this url: https://companion-stepdoc.cantor.fropen in new window

Get access to STEPdoc

Access to STEPdoc can be managed through local accounts provided by Cantor or via your SSO. Please see the Contact Us section to request access configuration for the documentation.

Generating STEPdoc in Companion for Business

You can push your changes of a perimeter to the online documentation by clicking on STEPDOC

c4b-documentation-deploy-page

Benefits:

  • Your data model is online at a glance: it is easy to navigate, search and filter
  • Use this online documentation as a support for your meetings with colleagues
  • Deploy your changes on the online documentation to see how it looks before they are applied to your environment

You can check yourself with a sample: Data Model Exampleopen in new window

Login information:

  • email : guest@cantor.fr
  • username : guest@cantor.fr
  • password : cantor

There is different manner to generate STEP online documentation with C4b depending on the configuration that you set on the ENVIRONMENT tab of the UI.

From your Companion project

Uncheck the box Generate documentation from configuration and fill out the following parameters:

  • Documentation
    • Username: the name of user used to log in to the documentation
    • Password: the password of the above user
    • Client: ID of the client that is used to push the documentation online
    • Documentation tag: the name of the tag that will be used to deploy documentation for this environnement

stepdoc

From your STEP environment

Check the box Generate documentation from configuration and fill out the following parameters:

  • Documentation
    • Username: the name of user used to log in to the documentation
    • Password: the password of the above user
    • Client: ID of the client that is used to push the documentation online
    • Documentation tag: the name of the tag that will be used to deploy documentation for this environnement
    • Config ID: the identifier of the STEP Export configuration that will be launched.

TIP

Not sure how to handle the settings? Ask us for support!

Last Updated: