Add components to pages

The package’s screens are Lightning components. A Salesforce administrator adds them to record pages, the home page, app pages and the utility bar with the Lightning App Builder, and sets their properties.

Add a component

In Setup, open Lightning App Builder, then open the page you want to change, or create a new one.
Find the component in the Custom section of the component list, and drag it onto the page.
Select the component and set its properties in the panel on the right.
Click Save, then Activate if the page is new.

Users need the Metaforce Access permission set to see the components, see Install and connect.

Components

Component	Where it fits	What it shows
`MFWED_TemplateTreeCmp`	Record page	The Select Template card, see Letters and documents
`MFWED_DocumentListCmp`	Record page	Documents in Distribution or Archived Documents, depending on its Metaforce Database property
CP Editor Sessions List	Record page, home page	Documents Under Construction
SmartForms List	Record page, home page	The Smartforms card for sending a form, see Smartforms
Smartforms In Process List	Record page, home page	Smartforms In Process
Smartforms Completed List	Record page, home page	Archived Smartforms
Smartform Attachments	Record page	The files of a form
CP Data Table Value Mapping	Data Table Value record page	The editor for Field Mapping
CP Configuration	App page, home page, tab	Metaforce Configuration, see The Configuration screen
CP Data Template Builder	App page, home page, tab	The data template builder, see Data templates
Smartform Object Mapping List	Home page, tab	The mapping editor, see Smartform field mapping
CP Dynamo Attributes and CP Viewpoint Attributes	Record page, home page	The field lists of the Dynamo and Viewpoint databases
Smartform Status Bar	Utility bar	A Metaforce Status card with the latest Smartform event
`MFSMF_InteractiveLogin`	Any page	The Log in and Open buttons

The Metaforce Application tab already contains the Log in and Open buttons and the Metaforce Configuration card, so you usually do not add those yourself.

The record components need a record. If you place one on the home page, the document list shows No SObjectType or RecordId found. Please place the component on a record page, not the home page. In the Smartform send dialog, the Contacts list is filled on Account, Contact, Case, Opportunity, Event and Task records. On other records, choose participants from Users.

Properties

Select Template (`MFWED_TemplateTreeCmp`)

Property	Meaning
Show buttons and checkboxes	On (the default) shows the Preview, Create and Edit buttons and a checkbox for each template. Off hides them and shows the same actions on each row of the tree.
Metaforce logic file name	The name of the Metaforce logic file. The default is `Salesforce`.
Show all templates	Shows every user selectable template, not only those whose `SOBJECT` keyword matches the record.
Developer	Adds tools for administrators: Dynamo Create, Email XML Data, Show XML Data and a data service choice.
Matching field name	The field on the record whose value is compared with the `FIELDVALUES` keyword of a template.
Show Description column first	Shows the Description column before the Name column.

Document list (`MFWED_DocumentListCmp`)

Property	Meaning
Fields to query	The Salesforce fields to read from the record, comma separated, for example `["Id","SSN__c"]`.
Field mapping for search criteria, metaforce field (key) and Salesforce field (value)	Links a Metaforce field to a Salesforce field, so the list finds the documents of this record. For example `{"SSN":"SSN__c"}`.
Key to sort on	The field to sort by, for example `JOBID`. The default is `ArchiveDate`.
Sort order	`ASC` or `DESC`. The default is `DESC`.
Metaforce Database	`Dynamo` for Documents in Distribution, `Viewpoint` for Archived Documents. The default is `Dynamo`.
Page size	The number of documents on a page. The default is 8.

The columns of this list come from the Metaforce Metadata Field setting, see The Configuration screen.

CP Editor Sessions List

Property	Meaning
Show Document Classification	Adds a Classification column.
Show information from related SObject	Adds a column with a value from a related record.
Column heading for the related SObject(s)	The heading of that column. The default is `Identification`.
List of related SObject fields.	The fields to show, in the form `Object1:Field1,Object2:Field2`. The default is `Account:AccountNumber,Contact:SSN__c`.
Show information on user created this WebEditor session.	Adds a column with a value from the user who started the session.
Column heading for the creating user	The heading of that column. The default is `Username`.
Name of the field to show from the User	The user field to show. The default is `Username`.
Show name of user created this WebEditor session.	Adds a Created By column.

Smartform Attachments

Property	Meaning
API Name of Field (e.g., Case.SmfId__c)	The field on the record that holds the id of the Smartform.
Title for Attachments Section	The title of the card. The default is `Smartforms Attachments`.
Filename Column Label	The heading of the file name column. The default is `Filename`.
Property Name Column Label	The heading of the property column. The default is `Property Name`.
Action Column Label	The heading of the column with the Preview and Download buttons.

The component also works in the Salesforce mobile app, where it shows each file as a card.

Data Table Value mapping

Place CP Data Table Value Mapping on the record page of the Data Table Value object. It has no properties. See Smartforms.