What is a Composition? A Composition is a way to publish and display runs, deployments, and workstations in a simplified tiled view for Express Users to consume in the Express User Interface (EUI). For more information on the Express User Interface, please see this KB. For more information on managing the Express User Interface, please see this KB.
Note, to publish a Composition, please make sure that you have the necessary permissions to build composite assets and configure deployment runs. If you're not sure if you have the necessary permissions, contact your Project Owner or Team Manager for more details. If you're a Project Owner, please see this KB for guidance on managing the Express User Interface.
How to Publish Compositions
Compositions can be published from Scenarios. By simply clicking on the relevant Component, this will take you to the relevant Component Dashboard. The Publish button is located in the upper right of the screen, adjacent to the Release and Rerun buttons.
After clicking the Publish button, you will be taken to the Composition Creation Menu as shown below.
Click on the first tile below to select the Cloudspace, a name, and an optional description for the composition as shown below. Save any changes by clicking the done icon at the bottom of the tile
In the second tile you can select your Operating System template, additional system settings, additional storage disks, and any desired networking changes. Likewise, be sure to save any changes by clicking done.
Click the third and final tile to add any custom properties and key-value pairs to your composition. Click the plus icon to the right to add each new key-value pair. Again, be sure to save any changes by clicking done.
With those changes saved, your new Composition is fully published! To view all the compositions that have been published in your Project, locate the Compositions button under Manage in the navigation bar on the left of the screen.
Clicking this button will take you to the Compositions Dashboard displayed below.
You have three options to manage these Compositions, accessed via the ellipsis on the right side of each tile. You can edit a Composition, copy a Composition, or delete a Composition.
How to Publish from a Deployed Run
Express Users can also connect to active runs that have already been deployed, by users with sufficient permissions. To publish the active run, the user must click on the relevant active run, which will take you to the run Dashboard.
The Publish button is located in the upper right of the dashboard, adjacent to the Release and Rerun buttons. Clicking this button will publish the active run, and Express Users will be able to see and connect to the run in the Express User Interface.
Unlike ordinary compositions, Express Users will not be able to deploy or undeploy these published active runs. The only option for the Express User will be to connect to the host.
Also unlike ordinary Compositions, these published runs are not managed from the Composition Management screen. Composition Publishers or other administrators will need to return to the same run dashboard to make any changes.
To remove a Published Run from Express User Interface, the Composition Publisher or administrator can return to the same run dashboard and click Unpublish.
Note Releasing or Rerunning a Published Run will also remove the "Published" state from the run, and remove it from the Express User Interface. If Redeploying/Rerunning a Published Run, be sure to remember to toggle the Publish button once the run is live again.
Learn more about Compositions via our Youtube video series:
If you're having trouble publishing a composition, or need additional assistance. Don't hesitate to open a helpdesk ticket via email@example.com.