Deployment record
Deployment record
Embedded Files
Overview
Overview
The Deployment record is a child-record to the Layout Builder and can be found under the subtab Deployments. This record is used to quickly deploy your layout to one or several records in your account. If you want to enable the same PDF on multiple records you simply create one deployment record per record type.
The record and its features are similar to the included workflow action Order PDF Form with some major differences.
If you copy existing layouts or export/import layouts between accounts, these records will automatically be included whilst the workflows need to be handled manually.
This record is only applicable for the UI. If you want to send a scheduled PDF for example you should use workflow instead.
The same goes if you need to trigger other actions after having created the PDF, for example setting a check box. Then workflow is more flexible.
The aim of this chapter is to explain how this record work and how you should configure the record.
Configuration
Configuration
To add a new or make changes to an existing deployent record, navigate to the Deployments subtab from your Layout Builder record.
To create a new one, click on the New Deployment button.
To edit an existing one, click on the Edit link on that row.
As shown in image at the start of this chapter, the deployment record contains several fields divided into for separate groups.
General
Status
Email information
Behaviour
The first two will be described in more depth here as they are specific for this record type. The latter two however bares a lot of resemblance to one of the workflow actions included. For that reason, that part of the configuration will be covered in the Paramater Configuration chapter.
Since the deployment record works as an alternative to workflow, the below fields are used to control many of the aspects that otherwise would have been set in the workflow definition.
General
Inactive: Standard field used to inactive the record. If a deployment should not be active the Deployment Status (see below) should also be updated.
Parent Layout: A link to the layout. One layout can have none, one or multiple deployment records.
Record Type: Select the record type on which this deployment should be active. If the same layout should be deployed on multiple records you need to create multiple deployment records, one for each record type.
Roles: If the button should only be seen by specific roles you can select those roles in this multi-select field. If no selection is made the deployment runs for all roles.
Button label: Add the name of the button that will be displayed on your record.
If you want your button to be translated based on the user's language settings, you can reference a translation collection and a specific key in your account.
For example: custcollection_scl_translations,SCL_MY_PRINT_BUTTON
Condition: If the button should only be visible when some specific criteria are being met, you can create a saved search condition.
The search should be based on the same record type as the deployment.
The button will only show for the records that are included in your search's result.
Status
Owner: Used when deployment is in testing mode. If you are the registered owner, only you will see the button when status is set to Testing.
Deployment Status: Can be set to Not Running, Testing and Released.
Event: Set if the button should be displayed on your record in View mode, Edit mode or both.
Page updated
Report abuse