Publishing a model from the graphical user interface is a quick way to share it on the web with other team members or stakeholders.

Publishing prerequisites

Recommendations

  • If you intend to publish a large model, increase the default JVM heap size of the Cameo Collaborator Publisher plugin as follows:
    1. Go to the <modeling_tool_installation_directory>/bin directory and open the <modeling_tool_name>.properties file.

    2. Increase the -Xmx value, e.g., -Xmx4000M.

    3. 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


To publish a Cameo Collaborator document


  1. Start your modeling tool and open the model 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.

  2. In the main menu, select Tools > Cameo CollaboratorPublish.
  3. In the Cameo Collaborator Publisher dialog, specify the following properties:
    • Document name - enter the name of the published document. By default, the document name is the same as the model name.
    • Category name - select the Teamwork Cloud category where the published document will be stored.

    • Scope - click  and select the Package or several Packages containing the data you want to publish.

    • Template - select the template for publishing. You can select one of the predefined templates or a custom template used in your model. Click  if you want to select a locally stored template or a template stored in Teamwork Cloud.

      Updating projects

      If you update a published model, specify the same template that you used before. Otherwise, the navigation between comments and commented items will be corrupted. To restore corrupted navigation, update the document again using the initial template.

  4. If needed, change the following options (click the Options button to see the full option list):
    • Select the Comments in project check box, to save Cameo Collaborator comments in the project as model elements.

      Saving comments in the project

      If you choose to save Cameo Collaborator comments in the project when updating a document, you can 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.

    • Select the Enable editing check-box, to allow editing the model from a Cameo Collaborator document.

    • Select the Enable commenting check-box, to allow reviewers to create comments in a Cameo Collaborator document.

    • Select the Update previously published project check-box, to update the document previously published from this model with the same name. If you select this check box when publishing a model for the first time, the model will be published as new.

      Projects reverted to an earlier version

      When publishing, the selected template is automatically used in your model and then committed to Teamwork Cloud. If you update a document from the model that has been reverted to an earlier version (without the template used in it), you will corrupt the navigation between existing comments and commented items. Afterward, navigation cannot be restored.

    • Select the Mark document as OSLC resource check-box, to publish the model as an OSLC resource.

  5. Click the Publish button.


Wait until you get the message that the document is successfully published, as publishing a large document may take some time. In addition, the message allows you to copy or open the document URL. For the URL to work, in the main menu, go to Options > Environment and specify the Cameo Collaborator URL option.

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 Teamwork Cloud project permissions. When you update a document, project permissions are not affected.