Accounts Overview

Rebekah Garner
Rebekah Garner
  • Updated

Administrators and Managers with Account-management permission can create a connection between Claravine and another account or platform. An Account will use an API connection to pull data into Claravine or push data from Claravine.

What is the difference between inbound and outbound?

  • Inbound can pull in fields of data from an external solution which prepopulates information for review, modification and enrichment that the user would otherwise need to add manually
  • Outbound can send out fields of data to an external solution to replace or enrich data.

Examples of account types:

 

Inbound

Outbound

Adobe Analytics

Import classifications, not fields of data

Outbound

Adobe Experience Manager

Inbound

Coming Soon

Adobe Workfront

Inbound 

Outbound

Amazon Web Services (AWS) S3

Inbound 

Outbound

Bitly

  Outbound

Box

 

Outbound

Branch

  Outbound

Meta Ads Manager (includes Instagram)

Inbound

Outbound URL

Google Ads (formerly AdWords)

Inbound

 

Google Analytics

Import dimensions, not fields of data

Outbound

Google Campaign Manager 360 (formerly DoubleClick)

Inbound

Outbound URL

Google Cloud Storage

 

Outbound

Microsoft Azure Blob Storage

 

Outbound

Pinterest

Inbound

 

QRCode Monkey

 

Outbound

SFTP (not FTP)

Inbound 

Outbound

Snapchat

Inbound

 

TikTok Ads Manager

Inbound

 

Integration availability varies by contract. Please reach out to your CSM and/or Account Executive for more details.

View an Account

To view an account, navigate to SettingsAccounts. The Accounts page displays.

You can view the following information about Accounts:

  • Name
  • Type
  • Description
  • Date Added

The sort feature is available for all columns. You can sort all columns in ascending or descending order.

  • Create an Account

    To create an Account:

    1. In the Accounts page, click the plus (+) sign to create a new account.
        The Edit New Account menu displays.
      mceclip0.png

    2. Enter the following information for the Account:
      • Name
      • Description

    3. Select one of the following account types:
      Account Types Required Account Information
      Adobe Analytics Company Name
      Username
      API Shared Secret
      Adobe Experience Manager Company Name
      Username
      Hosted URL
      Adobe Workfront General Claravine API access
      AWS S3 AWS Key
      AWS Secret

      User permission either s3:ListAllMyBuckets or enter bucket manually on each template

      (How To Article: Applying Custom Permissions for AWS Accounts)
      Azure Blob Storage Azure Account Name
      Storage Key
      Bitly Auth0 - Log in to authorize Claravine access
      Box Auth0 - Log in to authorize Claravine access
      Branch
      1 Account per App
      Branch Key
      Branch Secret
      Campaign Manager 360 Service Account Key JSON File
      Profile ID
      Connected Email Address
      Ads Manager (Meta) Auth0 - Log in to authorize Claravine access
      Google Ads Customer ID

      Manager Account ID
      Google Analytics Auth0 - Log in to authorize Claravine access
      Google Cloud Storage Service Account Key JSON File
      (How to Article: Applying Custom Permissions for Google Cloud Accounts)
      Pinterest Auth0 - Log in to authorize Claravine access
      QRCode Monkey API Key
      SFTP Host
      (Note: Do not include "sftp://" at the front of the host URL)
      Username
      Password
      Port
      Snapchat Client ID
      Client Secret
      (How to Article: Applying Custom Permissions for Google Cloud Accounts)

      Secrets are securely stored and never viewable.

    4. Click Save.

    Watch the Video

  • Edit an Account

    To edit an Account:

    1. On the Account page, click the name of the Account you want to modify.
      The Edit Account menu displays.
      mceclip0.png

    2. You must enter the Required Account Information to make any changes to the Account.

    3. Click Save.
  • Custom Field Mapping

    All integrations come with a standard set of fields to map data from or to depending upon which type of integration you select. In many cases, this set of fields allows you to sync the majority of data you’d like. However, some products allow you to extend their standard set of fields through additional custom fields or properties — particularly enterprise applications. It’s also common that critical metadata is contained in those custom fields and should be standardized to ensure optimal results.

    In order to target data in these custom fields via an integration, you can use custom field mappings to extend the base set of fields our integrations offer.

    Supported Integrations

    Custom field mappings are available for any integrations where the product allows custom fields or properties to be created. Currently, you can add custom field mappings to the Branch and Adobe Experience Manager integrations.

    If you have data in a custom field you’d like to sync through an integration other than those listed above, please contact your CSM.

    Set Up Custom Mappings

    Custom mappings are linked to each connected account you set up. To learn more about how to set up a connected account, see the Accounts Overview article.

    Below is a video example of adding Custom Field Mapping to an AEM account.


    To set up custom field mappings on a connected account:

    1. Navigate to Settings > Integrations > Accounts.

    2. Click the Account Name to open and edit a current configuration or the blue plus sign in the top right to add a new Account.

    3. Enter Username and Password credentials.

    4. Click Custom Field Mappings to expand the section at the bottom.

    5. Enter the API-friendly name of the field in the Remote Entity field (if you’re unsure, please contact the admin for that system at your organization or your CSM).

    6. Enter a user-friendly name in the Field Label field. This is only used for display when mapping fields on a template.
      Add "custom" at the end of the user-friendly name to make it clear it is a custom field.

    7. Click the Add New button to add multiple custom mappings.

    8. Click Save to save the connected account.

    All done! Now, these custom fields will be available as field mappings when you configure an integration using this connected account.

    Use Custom Mappings in an Integration

    Once you have custom field mappings setup, you can access them while you setup mappings on an integration.

    Below is a video example of adding the AEM Custom Field Mapping into an AEM Template.

    To map data to a newly configured custom field, you will need to:

    1. Navigate to an existing template or create a new template. Read the Create a Template Start to Finish walk-through article.

    2. Navigate to Step 3 - Connect.

    3. Open an existing integration or click the plus sign (+) to add a new Inbound or Outbound integration, depending on if you are bringing data in or sending data out, to add a new Integration.

    4. Click to Add New Mapping.

    5. In the Map from {integration} drop-down list, type-search or scroll through the list to select a new custom field. In the Map to Claravine drop-down list, type-search or scroll select the field in the template to map to.
      Only fields that have been added in Step 2 - Define and Govern will be available to map to.
      mceclip0.png

    6. Click Save to save your template.

    After the save completes, the next scheduled sync will either sync data to/from the custom field depending on what integration you are using.

    Remove Custom Mappings

    To remove a custom field mapping, you will need to:

    1. Navigate to the connected Account.

    2. Click to edit its configuration in the sidebar.

    3. Click to expand the Custom Field Mappings section at the bottom of the edit menu.

    4. Click the delete button next to any of the custom mappings.

    5. Click Save to save the connected account.
      Important Note: Removing custom field mappings will impact any syncs that use a custom field mapping. Please be sure to remove any field mappings to the custom field on all integrations prior to deleting the field mapping itself.

    What's next?

  • Delete an Account

    To delete an Account:

    1. On the Account page, click the name of the Account you want to remove.

    2. Click the Delete button.
      A confirmation message displays.


    3. Click Confirm.

Learn More

Training in Claravine Academy: 

Read the inbound and outbound template configuration Knowledge Base articles:

Comments

0 comments

Article is closed for comments.