You are viewing an old version of this page. View the current version.

Compare with Current View Page History

Version 1 Next »

If you want to be able to edit a Cameo Collaborator for Teamwork Cloud document, you have to publish it specifically for editing as described below.

Publishing prerequisites

To be able to publish models to Cameo Collaborator for Teamwork Cloud:

  • The Cameo Collaborator Publisher plugin must be installed in your modeling tool.
  • You must log in to Teamwork Cloud.
  • You need to have user permissions to publish models.
  • The model you are trying to publish must be stored in Teamwork Cloud. If you want to publish a local model, first add it to Teamwork Cloud.
  • 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>/plugins/com.nomagic.collaborator.publisher directory and open the publish.properties file.

    2. Increase the -Xmx value, e.g., -Xmx4000M. It is recommended to set a larger heap size value than the one defined for your modeling tool.

    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

Project permissions

When you publish a new document, it inherits Teamwork Cloud project permissions. When you update a document, project permissions are not affected.

Diagram export options

You can specify the diagram export options, such as dimensions and building time (the latter applies only to tables and matrices), in the Project Options dialog. See the Diagram image export page to learn more.


To publish a model to Cameo Collaborator for Teamwork Cloud for editing

  1. Start your modeling tool and open the model you want to publish.

  2. In the main menu, select Tools > Cameo Collaborator > Publish.
  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.

      Working with comments as model elements

      Before selecting to save Cameo Collaborator comments in a project, make sure you understand how to work with comments as model elements.

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

    • Select the Update previously published document check-box, to update a previously published document with the same name. If you select this check box when publishing a document for the first time, it 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 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. Afterwards the navigation cannot be restored.

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

  5. Select the Enable editing check box highlighted below.



  6. Click the Publish button.

Wait until you get the message that the model is successfully published, as publishing a large model may take some time. If you update an existing document, its version number in Cameo Collaborator for TWC is increased by one. A new version of the published document includes all comments from the previous version, unless the commented item no longer exists or comments are disabled.