Cameo Collaborator 18.0 SP4 Documentation
Publishing a model from the graphical user interface is a quick way to share it on a web portal with other team members or stakeholders. Cameo Collaborator Publisher allows you to specify all the basic publishing settings, such as the scope and location of a published project. But before you begin, make sure that your computer is prepared for publishing projects and you are able to log on to Cameo Collaborator.
Before publishing large models
If you intend to publish a large model, increase the default JVM heap size of your modeling tool (Maximum Heap Size or Xmx property).
Publishing a project to Cameo Collaborator
If you want to publish a project using the graphical user interface, open Cameo Collaborator Publisher dialog and specify all required publishing settings as described below.
Make sure that the versions of Cameo Collaborator and Cameo Collaborator Publisher plugin are compatible. You cannot publish a project:
- To Cameo Collaborator 18.0 SP2 or an earlier version of the product using Cameo Collaborator Publisher 18.0 SP3.
- To Cameo Collaborator 18.0 SP3 using Cameo Collaborator Publisher 18.0 SP2 or an earlier version of the plugin.
To publish a project to Cameo Collaborator from the graphical user interface
- Start your modeling tool and open the model you want to publish to Cameo Collaborator.
- From the main menu, select Tools > Publish to Cameo Collaborator.
- In the open dialog, provide the following properties:
- User name and Password for signing in to Cameo Collaborator.
Server name - the Cameo Collaborator server name. If the connection between the server and the modeling tool is encrypted, make sure that you type https in front of the server address.
Publish to - The pChoosing where to store the published project.. If you don't know which to select, see
Site URL name - If you set the Publish to property to Repository/Site, type in the URL name of the desired site. Otherwise, leave the box empty.What is my site URL name?
The site URL name appears in the site URL as shown in the following example.
- In the Project name on server box, specify one of the following:
If you want to publish the project directly to the selected place of a server repository (see the step c), specify the project name only, e.g., use case diagram. Note that the project name in Cameo Collaborator may differ from the original project name in your modeling tool.
If you want to publish the project to the folder or subfolder previously created in the selected place of a server repository, provide the path to that project and then specify the project name. Use "/" to separate path components, e.g., Requirements/use case diagram or Requirements/Loan registration/use case diagram.
- Scope - the project scope for publishing. Click and select one or more packages you want to publish. If you want to publish the entire model, leave the Scope box as it is.
Template - the template that defines the appearance and content of a published project. You can choose from the list of predefined templates and Creating custom project templates stored in your model, or click to select a custom template stored in other location.
If you update a published project by republishing it, specify the same template that you used before. Otherwise you will not be able to navigate between comments and commented items.
Diagram image file format:
- The .svg format is suitable for publishing with high resolution.
- The .png format is better for smaller resolutions, besides it is supported in all browsers.
- If you choose to use both formats at once, the best image file format will be selected depending on the browser being used.
If you publish a project using the .svg format, diagrams may not be displayed when browsing the project in Internet Explorer 9, 10, and 11. This issue occurs randomly and can be solved by refreshing the web page.
- In the same dialog:
Select the Disable comments check box if do not want reviewers to comment in the published project.
Select the Update previously published project check box if you want the current project to replace the former project that has been published with the same name. If you select this check box when publishing a project for the first time, the project will be published as new.
Click the Publish button.
Publishing TWC projects
After publishing a project stored in the Teamwork Cloud, make sure to commit project changes to the server. It is necessary, because the template used in your model during publishing needs to be stored in the server as well. Otherwise, updating a published project will corrupt the navigation between comments and commented items.
The Cameo Collaborator Publisher dialog with specified publishing settings.
Wait until Cameo Collaborator Publisher informs you that the project is successfully published as publishing a large project may take some time. For example, it takes approximately one hour to publish a project with 200,000 elements. If you update an existing project, its version number in Cameo Collaborator is increased by one. Furthermore, a new version of the project includes all the comments from the previous version, unless the commented item no longer exists or the comments are disabled in the new version.
Copying published projects
In Alfresco, do not try to copy a published project or the folder that contains one or more published projects. A copy of a published project is considered a shortcut to the copied project. Therefore, if you need to have a standalone copy of a published project, publish the same project twice using a different name.