Lightning Components
The Dynamo package includes three lightning components to be used in record pages. Through these components, end users can start or continue document workflows based on custom templates:
Dynamo launcher button
Use this component to add document generation capability to selected objects. This component adds a button to the selected object, which users can click to initiate document generation.
Dynamo document list
Use this component when the template has multi-user workflow features like approval or e-signing. Custom templates based on the master template “Blank with e-sign” should use this component. This component adds a list of Dynamo Documents related to the current record, as well as a button to create new documents.
Dynamo Automatic Launcher
This component will automatically redirect the page’s viewer to composing a template in Dynamo. Note that this makes it impossible to view the record page normally!
Adding lightning components to the record page
A Dynamo Component can be added to the record page through Object Manager (setup) or page editor (record page).
From Setup, go to Object Manager, enter the Main Object that the Dynamo button needs to enable
Go to Lightning Record Pages
Choose a Record Page to enable the button
Drag and drop from the left side panel the “Dynamo Launcher Button” or “Dynamo Documents List“ to anywhere in the middle to display the button
Click on the Dynamo box and configure on the right-side panel
Dynamo Launcher Button Attributes
Closer view of the Dynamo Button Launcher component attributes.
Attribute name | Description |
---|---|
Component Title | Defines the title at the top of the component This property supports using an expression to define its custom label. The correct format is: |
Button Label | Defines the label of the Dynamo buton. |
Auto-selected template | The template set here is automatically chosen to be composed, skipping the template list. |
Template List Columns | The template list will deisplay the values of the specified fields for each template ContentVersion record. The value is of format 'fieldAPIName,fieldAPIName2,…'. |
Template Library | The template list will only display files within this Content Library |
Static template filters | If the template list is too long, it can have a filter option by using fields of file records, for example: language, Dynamo main object, or any custom fields. |
Flow starting event ID | The selected template’s Flow will run this Event ID. |
Dynamo Server Instances | Select which dynamo server is used. Will affect available features. |
Set Component Visibility | This section is for the admins to filter out how a button should display on the record page based on the nature of the record (record’s fields) |
Dynamo Documents List Attributes
Closer view of the Dynamo Document List component attributes.
Attribute name | Description |
---|---|
Template | The template set here is composed either when creating a new document or opening an existing one. |
Component Title | Defines the title at the top of the component |
New Button Label | Defines the label of the button for creating new documents. |
Maximum Number of Documents | Defines maximum number of documents. If this number is reached, new documents may not be created. |
Open Dynamo in New Tab | Decide whether the document generation starts in the current or a new browser tab. |
Dynamo Server Instance | Select which dynamo server is used. Will affect available features. |
Set Component Visibility | This section is for the admins to filter out how a button should display on the record page based on the nature of the record (record’s fields) |
Dynamo Automatic Launcher Attributes
Closer view of the Dynamo Automatic Launcher component attributes.
Atrribute name | Description |
---|---|
Template Id Field | API name of the field of the viewed page’s record whose value contains the ID of the ContentDocument record of the template to be composed This property supports using an expression to define its custom label. The correct format is: |
End URL | The user is redirected to this URL after the composing is finished. If the URL doesn’t start with ‘http', it is interpreted as a relative URl within this organization’s home page. This property supports using an expression to define its custom label. The correct format is: |
Flow Starting Event ID | The selected template’s Flow will run this Event ID. This property supports using an expression to define its custom label. The correct format is: |
Set Component Visibility | This section is for the admins to filter out how a button should display on the record page based on the nature of the record (record’s fields) |