Workfront: Import Data into Claravine

Rebekah Garner
Rebekah Garner
  • Updated

Claravine offers a solution using Workfront Fusion and the Claravine API. Workfront will need access to the Claravine API in order to import data from Workfront into Claravine.

NOTE: The following documentation is an example set of instructions for how to customize the Claravine provided blueprint for you to connect your Workfront project to a Claravine template.


In Claravine

  1. Configure the Claravine template schema to match the fields in your Workfront Custom Form like the example below:
    mceclip1.png

  2. In order to import data from Workfront into Claravine, you will need access to the Claravine API. Request access to the secure REST API from your Claravine CSM. Once enabled, please reference our Knowledge Base article on the Claravine API to create your API Key and Secret.
         mceclip2.png Your API Key and Secret are only displayed during initial creation and cannot be recovered if lost. If the secret is lost, you’ll need to delete the old Key and Secret and create new ones.

  3. Your Claravine CSM will send you a JSON file which contains your blueprint and will be imported into Workfront in step 7 in the next section.

 

In Workfront

  1. In the Workfront Fusion instance, navigate to the Data Stores tab on the left side menu.
    mceclip3.png

  2. Click the Add Data Store button to create a new data store in the top right-hand corner.
      1. Title your data store something unique.
      2. In the Data Structure section, click Add to create a new data structure.
      3. In the Data Structure module; enter a data structure unique name.
      4. Click Add item in Specification. 
          1. Select ProjectID, click Add.
          2. Select DatasetUUID, click Add.
          3. Select TransactionUUID, click Add.

      5. Click Save to save the Data Structure.

      6. In Data storage size in MB field set data storage to 1MB; as scenarios get processed the data will be removed from the store so it does not need to be too big.

      7. Click Save to save the Data Store.
        mceclip4.png

  3. Navigate to the Scenario tab on the left side menu. 
    mceclip5.png

  4. Click Create a New Scenario. Click Skip past the orange services to integrate the page to the blank new scenario.

  5. Click the … More menu.

  6. Click on Import Blueprint to browse and find the Claravine JSON file. Click Save.
    mceclip6.png

  7. To set up your Webhook to trigger for your inciting event, go to the Trigger module and click Add.
    mceclip2.png Make sure you are signed into Workfront in a different tab as a system administrator.
    mceclip7.png
      1. Title your webhook something unique to the Scenario.
      2. In theConnection section, click Add to add the Connection Name "SystemAdminUserClaravine”. Click Continue.
      3. The connection wizard will prompt you to input your organization’s Workfront in the format {organization}.my.workfront.com. Click Continue.
      4. On the “Allow Application” modal, click allow access to access your Adobe Workfront Account.
             mceclip2.pngTo do this you should have a separate tab opened with Workfront as a system administrator. 
      5. Once connected to Workfront, select the inciting event type and event filters in the Record Type section. The  inciting event will launch the Scenario and whether the Record Origin should be a “New”, “Updated”, or “New & Updated” event. 
      6. It’s recommended that you pick a task as the inciting event. In our example scenario we launch based on the update of a task called Push to Claravine from Workfront.
      7. You will need to make sure this task is part of your Workfront project which contains the form with all your metadata.
      8. Optional: You can choose to pick an event filter for your record which will launch the event such as a specific name for a task when completed. This is where you would list “Push to Claravine” as a task name.
      9. Click Save to save the webhook. Example below:
        mceclip8.png

  8. If you chose to go with something other than a task for your webhook trigger, make sure to change the task complete filter or remove it depending on your use case.

  9. In the Set API module, add your Claravine API Key and Secret. Click Ok.
    mceclip9.png

  10. In the Get Custom Form Details module, click Add and select the SystemAdminUserClaravine connection created in step 7b. In the Get Custom Details module, you must pick the custom fields (example fields in the screenshot below) that align to your template in Claravine from your custom form in Workfront.
      1. Make sure to pick all fields.
      2. Pick the project name.
      3. Workfront custom form fields will appear as DE:Form Name.
      4. Click OK. Example fields pictured below:
        mceclip10.png


  11. NOTE: In the GetDataset module where you will be making your API call to retrieve your Claravine template UUIDs (Datasets ID) if you have multiple IDs you will need to properly map them.
      1. Right-click and Run This Module Only.
        mceclip11.png
      2. Enter the Claravine API URL (https://api.claravine.com/v1/datasets) as well as your unique Key and Secret created in Claravine on hand.
      3. In the Key field, enter “x-claravine-key” and in the Key Value field enter your unique key generated in Claravine.
      4. In the Secret field, enter “x-claravine-secret” and in the Secret Value field enter your unique Secret generated from Claravine.
      5. A successful completion will allow you to see the data in the bubble that appears above the module.
      6. Clicking into this bubble under OUTPUT and in DATA and DATASETS you will be able to see all the different Datasets and their corresponding template names once you expand the collection(s).
      7. You will need to make sure you map the correct dataset for each scenario and select the correct custom form details that match to the dataset we are pointing to in Claravine.

  12. In the Set Rows module, you will define the rows as they line up according to your Claravine template schema to match in the same way the example Module is set up. Rows must be input in quotations and separated by commas. Example below:
    mceclip12.png

  13. Link your Data Store to the Data Store you created in step one and click add.
      1. Map your newstate:project Id from the webhook module to the project id spot. 
      2. Map the dataset UUID to the datasetUUID and transaction UUID to the transaction UUID.
      3. You will be able to map datasetUUID after running the module in step 11 however you will have to wait to map transactionID until you do a test run after setting everything up once that is done you can go in and map transaction id from “GetTransaction” under data and in datasets you will select the UUID to map.

  14. In your Unauthenticated Message module add your connection which you set to connect to your Workfront.
      1. The Unauthenticated Message should be mapped to the same custom field where your Status will go.

  15. Set up the Error Message Connection with the same connection to your Workfront as well.

  16. Once set up you need to run the scenario once so that you can get some of the required metadata which will map to your dataset.
      1. Logout of your system administrator account and log in as a different user for this step.
      2. Run a project making sure all custom form details and the correct “Push to Claravine” task are set up.
      3. After running the scenario successfully you can update the transactionUUID field in your data store.

 

What's next? Read the Workfront: Sync Claravine Data into Workfront

Comments

0 comments

Article is closed for comments.