Salesforce

Component Builder

Printable View
« Go Back
Information
Component Builder
Component-Builder
Article Details

The Component Builder provides users the ability to create custom Components for their CMS. A new Development dropdown menu will appear in the toolbar(?). Hovering over the Development menu displays the Component Builder.

Component List View

This page displays all of the Custom Components that have been created for the CMS.
The 'Manage Custom Components' menu, listing your site's custom components

  1. Name: Component Name
  2. Last Updated: Date/Time the Component was last edited.
  3. By: Last user to update the Component.
  4. Edit: Edit the Component
  5. Delete: Removes the Component (must not be in use), or selected Components.
  6. Status: Toggle the Component On/Off
  7. Add Component: User taken to Add view for setting up a new Component.

Add a New Custom Component

Click Add Component to begin the process for adding a new Component. The CMS guides the User through a 3-Step process for setting up a new Component.

Step 1: Create a Component

Section A: Summary

Summary screen for creating a new component
  1. Template: User can select a pre-existing Component Template for quicker set up of a new Component. Creating Component for the first time? Use a "Blank" Template.
  2. Application: Select if the Component will be used for visionLive (standard CMS) or visionPulse (community engagement). Components will primarily be utilized for visionLive.
  3. Title: Give a descriptive Title for the Component

Section B: Index List Details

The Index List Details page, where you can add content record names and a shortcut icon for your new component
  1. Content Record Name (Singular): Provide a name for the Content Record Type.
  2. Content Record Name (Plural): Provide a name for multiple Content Records.
  3. Custom Shortcut Icon: Browse Image Library and select an icon for the Dashboard Shortcut.
  4. Save and Continue to Step 2.

Step 2: CMS User Display

The information captured and/or displayed by your custom Component is configured during this step. This is similar to the Edit Form Design view that the Form Builder utilizes. Fields can quickly be added, removed, and re-ordered by simply dragging and dropping the fields or using the +/- buttons.

Add a Field

Add the following types of component fields to the custom Component:

List of fields available to add to a custom component
  1. Single Line Text: Short text entry. 70 character max.
  2. Paragraph Text: Long-form text entry. 500 character max.
  3. Single Dropdown: multiple options with a single selection.
  4. Number: Text field that only accepts numeric values.
  5. Rich Text Editor <HTML>: RAD Editor for additional content.
  6. Date/Time: Select a Date/Time value from a Calendar and Time picker.
  7. Phone: Text field that accepts phone number value.
  8. Website: Text field that accepts a valid URL value.
  9. Email: Text field that accepts a valid email value.
  10. Thumbnail: Select an image from Image Library.
  11. Lookup: Choose a record stored in another Custom Component.

Field Settings

Each Component field can be configured by clicking on it, and then switching over to the Field Settings tab. Generally, each Field will have the following options (there may be additional options based on the field type):

List of field settings available for the various component fields

  1. Field Label: Label that will appear in component/front-end view for this field.
  2. Mark as required: Requires a value to be provided.
  3. Check for duplicates: Requires each record to be unique if checked.
  4. Allow search: Can be searched by CMS Users in Component List View.
  5. Instructions for User: Provides instruction for CMS Users adding new items to the Component.
  6. Pre-populated Value: Value is already filled when creating a new item.
  7. Required Error Message: Overwrites default error message that appears if field is left blank.

Step 3: List View

Determine visible fields for both the Component List View for CMS Users as well as the Default List Widget for the Custom Component. By default, the first field listed will be included in both the Index and Default List Widget.

Index View

Index View page, where users can edit the view of their Component List View or Default List Widget view
 
  1. Add a header: Select a field from the dropdown to display it as a header in the Index View.
  2. Heading Title: Edit this field to change the heading display text.
  3. Delete button: removes a heading.
  4. Sort by: By default sorts by Item ID, but can also sort by a given heading value.
  5. Order: Choose Descending or Ascending.

Default List Widget

The Default List Widget setup is identical to the Index View setup, the only difference being that LastModifiedDate and LastModifiedUserID are not available as headings.

Step 4: Publish

Publishing the new Component will create a default Component page along with a widget. (Note the System Variable:  Default Advanced Component Page MUST be populated in order to establish a base page under which flexible component pages will create sub-pages.)  You will be able to view the new widget in the Site Content drop-down menu:

View of the new, custom component under the 'Site Content' 'Components' menu

Step 5: Security Role

To provide regular CMS Users with access to the Custom Component, they will need to be granted the Security Role. The Security Role > Component Level Permissions tab will now display the Custom Component. Checking the box for "Manage" will allow CMS users to Add/Edit/Delete the Custom Component.

The 'Manage' checkbox under Component Level Permissions, which provides access to the new, custom component to CMS users

Step 6: Add Items

After the new component has been published, navigate to its location in the Site Content menu and click on the component. CMS users will see a screen similar to other CMS Components:

The new, custom component, currently empty
 

Adding the Custom Component to the Site

Add the Custom Component Widget to a Page Template

Dragging the new component widget from the top menu into a page template
  1. Create or Edit an existing Page Template. The new Custom Component Widget will be located in its respective alphabetical tab.
  2. Drag and drop the widget into a Column.

Add the Custom Component Widget to a Page

Dragging the new component widget from the left menu into a page
  1. Create or Edit an existing Page. Click on the Widget Library icon in the Control Panel.
  2. Search for or locate the Custom Component Widget.
  3. Drag the Custom Component Widget block from the Control Panel onto the Page.
  4. Drop the Custom Component Widget into the desired area on the Page.

(NOTE: This functionality is limited to Super Users or CMS Users with Templating Security Role)
Powered by