Skip to main content

Use parameters

After you install the Salesforce CMS integration, the following parameter types are available. You can use these to incorporate content from Salesforce CMS into your components and compositions.

Parameter typeDescription
Salesforce CMS Entry SelectorSelect a content entry from Salesforce CMS.

Salesforce CMS Entry Selector

This parameter type allows a Uniform user to select a Salesforce CMS content entry.

Add parameter to component

In order to allow a user to select an entry from Salesforce CMS, you must add a parameter to a component. The parameter is used to store the identifier to the selected entry when the user selects it.

  1. In Uniform, navigate to your component.

  2. Add a new parameter using the parameter type Salesforce CMS Entry Selector.

  3. The following values can be specified:

    NameDescription
    Allowed Content TypesSpecifies which content types will be available to select from when the parameter value is edited. You can select multiple content types in order to allow the user to select from a larger set of entries.
    RequiredIndicates whether the value is required when the component is used.
    parameter-config
    Salesforce CMS Entry Selector parameter with multiple content types selected.

Edit parameter value

When you use a component with a Salesforce CMS Entry Selector parameter, by default no entry will be selected. You are prompted to select an entry.

  1. Click Select.

    edit-value-default
  2. Click the entry you want to select.

    edit-value-selected
    About this step

    A couple of filters are available. The dropdown allows you to filter by content model. The text box allows you to filter by entry content.

  3. Click Accept to save your selection.

  4. You will see details about the document you selected, including the title and some metadata.

    edit-value-saved
    About this step

    After your selected is saved, you are presented with the following options:

    • If you want to unselect the entry, click Unlink.

Configure an enhancer

When an entry is selected, Uniform only stores the identifier for the entry. Your front-end application must retrieve the details for the entry. Uniform provides an enhancer to simplify this process.

tip

Using the enhancer provided by Uniform saves you from having to write logic to interact directly with Salesforce CMS.

How Uniform stores the selected document

The following is an example of what Uniform stores for the parameter. It stores the identifiers for the selected entries.

{
"type": "sfcmsEntrySelector",
"value": "##################"
}

Add the enhancer

Uniform provides an enhancer so you don't need to write the API calls to Salesforce CMS to retrieve data for entries.

tip

For more information about the enhancer, see the package documentation.

  1. In Salesforce CMS, get the following values:

    • Channel ID
    • Instance URL
    • Organization ID
  2. Add the following npm packages to your front-end application:

    @uniformdev/canvas-salesforcecms
  3. In a text editor, open the file where you retrieve the composition definition from Uniform.

    About this step

    You are looking for the code calls the async function getComposition. The code below assumes the object returned is set in a variable composition.

  4. Add the following import statements:

    import { EnhancerBuilder, enhance } from '@uniformdev/canvas';
    import {
    CANVAS_SFCMS_PARAMETER_TYPES,
    createSalesforceCMSClient,
    createSalesforceCMSEnhancer
    } from '@uniformdev/canvas-salesforcecms';
  5. Add the following code:

    const cmsClient = createSalesforceCMSClient({
    channelId: '!!! YOUR SALESFORCE CMS CHANNEL ID !!!',
    instanceUrl: '!!! YOUR SALESFORCE CMS INSTANCE URL !!!',
    organizationId: '!!! YOUR SALESFORCE CMS ORG ID !!!',
    });
    About this step

    We recommend you moving the Salesforce CMS credentials to environment variables rather than hard-coding them in the front-end app.

  6. Add the following code:

    const enhancer = createSalesforceCMSEnhancer({
    client: cmsClient,
    });
  7. Add the following code:

    await enhance({
    composition,
    enhancers: new EnhancerBuilder().parameterType(
    CANVAS_SFCMS_PARAMETER_TYPES,
    enhancer,
    ),
    context: {},
    });
    About this step

    This registers the enhancer to be used for any occurrence of the Salesforce CMS Entry Selector parameter.

Next steps

Now, the parameter value in the composition is mutated to include the field values for the selected Salesforce CMS entry (instead of just being an identifier).