Copado Smart Tips - Commit Metadata Assistant

Updated 2 months ago by Copado Solutions

Copado displays smart tips on the Commit Changes page to show simple warnings and reminders. These tips can be managed by any Copado user with access to Custom Metadata Types.

How to Enable Copado Tips

Copado tips can be enabled at user level. To do this, follow the steps below:

  1. Navigate to the record of the User for which you want to enable this feature.
  2. Select the checkbox Show Copado Tips:
If you cannot see the Show Copado Tips checkbox, make sure you have visibility of this field and the field has been added to the user layout.
  1. To disable it, just deselect the checkbox.

How to Create a New Tip

  1. Go to Setup -> Custom Metadata Types -> Copado Smart Help.
  2. Click on Manage Records and then click on New:

  1. Populate all the relevant fields and click on Save:

  • If Triggering Action has Copado Metadata Grid selection selected, depending on the Triggering Metadata Type Copado will display the tip. For instance, if you have created the tip for Copado metadata grid selection and custom field, the tip will pop up when you select a custom field from the grid:

How to Edit Existing Tips

Copado provides some general out-of-the-box tips for the Commit Changes page that you can update if desired. To do this, follow the steps below:

  1. Go to Setup -> Custom Metadata Types -> Copado Smart Help.
  2. Click on Manage Copado Smart Helps and then find the tip that you want to change.
  3. Click on Edit:

  1. After making the changes, click on Save.

Custom Metadata Types can not be deleted if they're packaged, so there's an Active checkbox field which default value is true, but you can activate or deactivate the Copado Smart Help records that need to be called out with this field:

  • If active, they will be displayed in the Smart Tip message.
  • If inactive, they will not be displayed in the Smart Tip message.
If you cannot see the Active checkbox, make sure you have visibility of this field and the field has been added to the Copado Smart Help layout.

How to Reference Copado Tips in a Custom Visualforce Page Outside of Copado

Copado tips are managed by a global visualforce component, so it is pretty easy to reference them outside of Copado's managed package.

Copy and paste the following code line into your visualforce page right after your Apex form and save it:.

<copado:CopadoSmartHelpComponent />

How did we do?