permalinkConfigure Workshop tabs

Workshop tabs enable you to use Workshop to create object view tabs with advanced capabilities and features. You may want to use Workshop tabs to:

• Have full flexibility over the layout of your tab.
• Flexibly and dynamically load information using Workshop Variables.
• Display simulations or model-backed results using Scenarios.

permalinkCreate a new Workshop tab

There are two ways to add a new Workshop tab to your object view: building a new managed module tab in Workshop, or embedding an existing module.

• Add new tab: If you choose to add a new tab, a new managed Workshop module will be created and displayed in the tab. The permissions of this module will be kept in sync with the object view, but this module cannot be reused outside of Object View.
• Embed existing Workshop module: If you want to use an existing Workshop module in a new tab, you must first save the new module in the correct Project folder to define the default permissions. Once you have saved your module, find it in your available resources to add it to your object view.

Once you save your new Workshop tab, it will contain a default properties widget (built in Workshop) for that object.

permalinkEdit a Workshop tab

To edit a Workshop tab, select Edit module in the configuration sidebar. This will open the Workshop editor with your new module in a separate browser tab.

Once you save and publish your Workshop edits, refresh the object view or switch to preview mode to view the changes.

If you are editing a managed module, you can save the module and publish the object view directly in the Workshop header, then use the preview button to go back to the object view editor.

permalinkConfigure parameters

Workshop tabs support using passing parameters as variables in the embedded Workshop module.

When adding a new Workshop tab on an object view, the current object is passed as an object set parameter to Workshop’s module interface variables with the external ID object. In Workshop, you must use module interface variables in order to use the object ID.

Additionally, the view editor can configure other parameters to pass to the embedded Workshop module:

• Property of the current object.
• Static value, a free-text field that is parsed as string/numeric/etc. on Workshop.
• Linked objects, an object set of the objects linked to the current object instance.

To use these parameters as variables in the embedded Workshop module, you must first define them in the variables panel in Workshop. Then, in the variable Settings panel, add an external ID matching the parameter name and make sure the variable is enabled for use in the module interface.

permalinkPermissions

You must have permissions to the underlying Workshop module to view it as a tab. If you don’t have the proper permissions, you will see a message showing that the module is not available for you to access.

To ensure you have the correct permissions for your modules, we recommend saving the underlying Workshop module in a Project folder to which you have access