Integrate Showpad

  • Updated

The Showpad Standard integration with the Optimizely Content Marketing Platform (CMP) lets you send CMP assets such as images, videos, and other file types to Showpad with associated labels and tags and keep those assets in Showpad synchronized with the CMP version throughout the full asset lifecycle: create, update, delete.

Integration features

  • Uni-directional integration from CMP to Showpad
  • Label or folder-based publishing
  • Publish assets one at a time or in bulk
  • Set permissions for the assets
  • Publish assets to specific Showpad libraries
  • Upload new version assets from the CMP while retaining their unique Showpad link
  • Update assets metadata (title, labels, library, permissions) to have it reflected in Showpad
  • Deleted assets in the CMP are removed from Showpad

Requirements

  • Cloud-based Showpad Instance
  • A Showpad Service account supporting OAuth 2.0
  • Admin access to Showpad

Configure Showpad

You need the following to configure the Showpad integration.

  • Access to your Showpad instance – To roll out and test the integration, the Solution Consultant needs access to your Showpad production instance or a developer instance if available (recommended).
  • Create a Showpad service account – Create a service account in Showpad with Administrator access. This main account makes API calls from CMP to your Showpad platform. Actions performed through the integration are tied to the service account user. Create the service account user and use an identifiable name, such as CMP Service Account.
  • Set up OAuth 2.0 in Showpad – You can do this in Showpad in the API section under Integration (Admin permissions required). The service account needs to have the following access:

    integrate-showpad-1.png

  • Register a CMP Application – The application manages the authentication of the CMP service account to make API calls. See Obtain the Client ID and Secret to register your client application for guidelines to configure.
  • Configure integration Webhooks – Additionally, a publishing webhook needs to be configured for the integration to pick up the updates from the library. Fill out the following information and the webhook needs to subscribe to library-specific events.

    integrate-showpad-2.png

    integrate-showpad-3.png

You can publish to Showpad by using a specific label or by moving an asset to a specific library folder in CMP.

Publish a folder

To publish a folder, create a dedicated folder in the Library section of your CMP instance. Content added to this folder is pushed to Showpad. Follow the steps below to create the Publishing folder for your Showpad integration

  1. Go to your library in CMP.

    integrate-showpad-4.png

  2. Click Create Folder.

    integrate-showpad-5.png

  3. Enter a name for your folder and click Create

    integrate-showpad-6.png

  4. Share the folder name with your solutions consultant

    integrate-showpad-7.png

You can preselect the Publishing Folder from the workflow settings as your default publishing destination. Select a Workflow and scroll down to the Push to Library option. From there, select your Publishing Folder as the primary publishing destination. Assets pushed from tasks using this workflow go into the selected destination.

Integrate-showpad-a.png

Label Publishing

A label can be used to publish CMP assets to Showpad; ie: Label group: "Sync to" and label value: "Showpad". The label needs to be configured in the CMP. The following process shows how to set up a Publishing label. 

  1. Go to your Fields settings page.

    integrate-showpad-8.png

  2. Click Add Field. The Create a New Field view displays.

    integrate-showpad-9.png

  3. Fill out the Create a New Field view as follows:

    • Select Label for Field Type.
    • Select Single-Select (preferred) or Multi-Select.
    • Enter an intuitive name in the Field Name so your publishers and users know what this label is used for.

    integrate-showpad-10.png

Tag and label setup

For labels to be sent as tags to Showpad with assets, align the taxonomy between the CMP and Showpad. Showpad tags need to be created as labels in the CMP. Update your CMP taxonomy accordingly.

Appending Label on the CMP Side

integrate-showpad-11.png

Tags Appended on the Showpad side

integrate-showpad-12.png

Asset Permissions

Showpad lets you add permissions for different asset types (see the example below for a PDF asset). To let you set permissions settings from the CMP, the integration treats them as a set of permissions options that a label value can identify. For example, the permission set below can be identified as External permissions. From the CMP, when you select the External permissions label for an asset Synced to Showpad, the asset inherits these properties in Showpad. 

integrate-showpad-13.png

As an example, your permissions sets may look like the below configuration. The images are from Showpad.

Internal Permission External Permission Custom Permission
image003.png image004.png image002.png

You can set up labels from the Fields setting page by following the method shown in the Label Publishing section. The labels in the following image were set up based on the image above, which shows the permission groups in Showpad. All three labels are grouped under one field called Set Asset permission.

integrate-showpad-14.png

Showpad libraries

You can publish to Showpad libraries from CMP. On the CMP end, the Showpad libraries are added as labels by following the process shown in the Label Publishing section. Your libraries should be put under one label group. While publishing from the CMP, select the desired Showpad library from the label. By default, Showpad's global library is set as the publishing destination. The following image groups two Showpad libraries Global and Integration Library under the field Showpad Library.

  • Showpad Libraries

    integrate-showpad-15.png

  • Setting up the Libraries as labels in CMP

    integrate-showpad-16.png

  • The libraries are coming up as selectable labels for CMP assets

    integrate-showpad-17.png

Deployment  

The Optimizely Solution Expert Services team completes the deployment of the integration. The solution consultant working on your project works with you during onboarding to deploy the integration to your CMP instance. With the CMP configuration completed, they will be able to:

  • Library/Division – Map the CMP Showpad library label to Showpad libraries 
  • Labels/Tags – Map the CMP taxonomy to the Showpad taxonomy
  • Permissions – Map the CMP Showpad permissions group to the right permissions in Showpad
  • Trigger – Configure webhooks callback URL to trigger the integration

Publishing methods

Folder publishing method

For folder publishing, the asset is uploaded into the Publishing Folder or sent to the publishing folder from a CMP task. This will trigger the push to Showpad.

Publishing assets from the task into the Publishing Folder

  1. In a task, collaborate with your team to create the final asset. Upload the asset in the Content section of the task.
  2. Choose the assets to send to the Publishing Folder from the task level. By default, your assets are pushed into the library (Publishing Folder).
    • Go to the Content section of the task.
    • Select List view.
    • Select the assets that you do not want to push into the library.
    • Open the option menu (...) and select Save to Library.
      Integrate-showpad-b.png
  3. Select desired labels or tags for your assets.
  4. Select the Showpad permission group and Showpad library to which you want to send the assets.
  5. Ensure that the asset is published in the Publishing Folder in CMP when completing this task by going into the list view and checking the asset cards.

    Integrate-showpad-c.png

  6. Complete the workflow which pushes the assets into the Publishing Folder in the library.
  7. Within a few moments, the assets will display in your Showpad Library.

    Integrate-showpad-d.png

Upload the assets directly into the Publishing Folder

  1. Go to the Publishing Folder in the CMP library.

    Integrate-showpad-e.png

  2. Upload assets directly and tag the assets with the required labels.

    Integrate-showpad-f.png

  3. After you save, the assets are uploaded into the Publishing Folder.
  4. A few moments later, the assets are pushed into Showpad with the labels.

    Integrate-showpad-g.png

Label publishing method

After you add the publishing label to an asset in the library, it is pushed to Showpad. You can add labels to assets from the task level, too.

Label publishing from a task

  1. From the task, add the publishing label to the assets you want to send to Showpad.
  2. Ensure the asset is sent to the library.

    Integrate-showpad-h.png

  3. Complete the task.
  4. After the asset is in the library with the publishing label, it is pushed to Showpad.

    Integrate-showpad-i.png

Label Publishing directly from the library

  1. From the CMP library, pick an asset that you would like to send to Showpad and add the publishing label.

    Integrate-showpad-j.png

  2. When the label is saved, the asset is pushed to Showpad.

    Integrate-showpad-k.png

Update

Assets in the CMP library that were pushed to Showpad can be updated and have their changes reflected in Showpad. The update includes changing the title and labels or uploading a new version from the CMP. After the updates are made, the integration will automatically sync the changes to Showpad as long as the Sync conditions remain true (folder publishing or label publishing).

Delete

You can remove assets from Showpad and CMP in a few ways.

  • You can configure the integration to delete an asset in Showpad if you delete the asset from the CMP library. Deletion applies to folder and label publishing.
    • Label publishing – Removing the label from the asset also deletes it in Showpad. Appending the label again publishes it back to Showpad as a new asset or version.
    • Folder publishing – Moving an asset out of the folders synchronized with Showpad also deletes it in Showpad. However, moving the asset back into a corresponding folder publishes it back to Showpad as a new asset or version.