On this page
Publishing documents from the graphical user interface is the simplest way to present models to stakeholders, sponsors, customers, and engineering teams. Cameo Collaborator documents can be used not only to review model information and provide feedback but also to edit models directly from the web without using a modeling tool.
Prerequisites
- The Cameo Collaborator Publisher plugin must be installed in your modeling tool.
- Cameo Collaborator for Teamwork Cloud works only with Magic Collaboration Studio projects. If you want to publish a local model, add it to the server.
- You must have the user permissions necessary for document publishing.
Recommendations
- If you intend to publish a large model, increase the default JVM heap size of the Cameo Collaborator Publisher plugin as follows:
Go to the <modeling_tool_installation_directory>/bin directory and open the <modeling_tool_name>.properties file.
Increase the -Xmx value, e.g., -Xmx4000M.
Save and close the file.
- Depending on the size of the model you intend to publish, allocate a sufficient amount of memory to your modeling tool:
2 million element model - 24 GB of RAM
1 million element model - 15 GB of RAM
500k element model - 7 GB of RAM
Publishing tips
- To change the number of decimals displayed in Cameo Collaborator documents, in the main menu, go to Options > Project Options and specify the Decimal Places option. The setting is remembered and used for the documents published from the project.
- You can specify the diagram export options, such as dimensions and building time (the latter applies only to tables and matrices). To learn more, refer to Diagram image export.
Project permissions
When you publish a new document with the Administer Resources permission, it inherits Magic Collaboration Studio project permissions. When you update a document, project permissions are not affected.
To publish a Cameo Collaborator document
Start your modeling tool and open the server project you want to publish.
Publishing from a historical version of a model
You can publish a Cameo Collaborator document from a historic version of a model as well. However, note that the commenting, editing, and comment import functionalities in such a document will be disabled.
- In the main menu, select Tools > Cameo Collaborator > Publish.
- In the Cameo Collaborator Publisher dialog, specify the publishing options.
Click the Publish button.
Wait until you get the message that the document is successfully published.
The message about a successfully published document allows you to copy or open the document URL.
Now you can go to the Resources application, navigate to the category where the document was published, and open the document.
Publishing options
The table below explains all the publishing options available in the Cameo Collaborator Publisher dialog.
| Publishing option | Description |
|---|---|
| Document box | Enter the document name. By default, the document name is the same as the project name. |
| Document type drop-down box | If you want to publish a resource other than a Cameo Collaborator document, select the type of resource you want to publish. Available values are Collaborator (default), OSLC, and 3DEXPERIENCE Systems Traceability. To see this publishing option, click the Options button in the bottom left corner of the Cameo Collaborator Publisher dialog. |
| Category name box | Click |
| Scope box | Click |
| Template drop-down box | Select one of the predefined document templates to be used for publishing. If you want to select a custom template, click If you update a published document, specify the same template that was used when publishing it the first time. Otherwise, the navigation between comments and commented items will be corrupted. To restore corrupted navigation, update the document again using the initial template. |
| Comments in project check box | Select the check box to save Cameo Collaborator comments inside the project as model elements. If you save Cameo Collaborator comments in the project when updating a document, you will be offered the option to migrate the existing comments from the document to the project. However, you will not be able to migrate the comments from the project back to the document. If you clear the Comments in project check box when updating the document, the comments previously saved in the project will no longer be visible in the document. |
| Enable editing check box | Select the check box to allow editing of the model from a Cameo Collaborator document. Note that table legends are displayed only in non-editable Cameo Collaborator documents. |
| Enable commenting check box | Select the check box to allow reviewers to create comments in a Cameo Collaborator document. To see this publishing option, click the Options button in the bottom left corner of the Cameo Collaborator Publisher dialog. |
| Update previously published document check box | Select the check box to update the document previously published from this project. After selecting the check box, click the Document drop-down box and select the document you want to update. To see this publishing option, click the Options button in the bottom left corner of the Cameo Collaborator Publisher dialog. |
Publishing other types of resources
In addition to Cameo Collaborator documents, Cameo Collaborator for Teamwork Cloud allows you to publish other types of resources - OSLC and 3DEXPERIENCE Systems Traceability - described in the sections below.
To publish other types of resources
Start your modeling tool and open the server project you want to publish.
- In the main menu, select Tools > Cameo Collaborator > Publish.
- Click the Options button in the bottom left corner of the Cameo Collaborator Publisher dialog.
- In the Document type drop-down box, select the type of resource you want to publish: OSLC or 3DEXPERIENCE Systems Traceability.
- In the Template drop-down box, make sure to select the template depending on which type of resource you want to publish:
- If you want to publish an OSLC resource, select OSLC.
If you want to publish a 3DEXPERIENCE Systems Traceability resource, select TRA.
When publishing an OSLC or 3DEXPERIENCE Systems Traceability resource, other publishing options are specified automatically and cannot be changed.
- Click the Publish button.
- Wait until you get the message that the document is successfully published.
OSLC resources
Modeling tools with Cameo Data Hub plugin makes it possible to link and share data using Open Services for Lifecycle Collaboration (OSLC) integration. Publishing projects as OSLC resources allows you to see the OSLC UI previews of model elements in the environment of a synchronized tool, e.g., Doors Next Generation.
An OSLC resource in the Resources application.
3DEXPERIENCE Systems Traceability resources
The Cameo Collaborator for Teamwork Cloud allows you to publish 3DEXPERIENCE Systems Traceability resources (TRA) - which can be used in the Systems Traceability app on the 3DEXPERIENCE platform.
