ÃÛ¶¹ÊÓƵ

DocumentationWorkfrontWorkfront Guide

Data store modules

Last update: Thu Nov 21 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

CREATED FOR:

  • User

An ÃÛ¶¹ÊÓƵ Workfront Fusion data store, similar to a database or a simple table, can store data from scenarios, making it possible to transfer data between individual scenarios or scenario runs. You can use a data store to store new data from various systems during synchronization.

The data store modules enable you to add, replace, update, retrieve, delete, search, or count records in your ÃÛ¶¹ÊÓƵ Workfront Fusion data store.

For information on creating, editing, and troubleshooting data stores, see Data Stores in ÃÛ¶¹ÊÓƵ Workfront Fusion

For a video introduction to data stores in Workfront Fusion, see:

Access requirements

You must have the following access to use the functionality in this article:

ÃÛ¶¹ÊÓƵ Workfront plan*
Pro or higher
ÃÛ¶¹ÊÓƵ Workfront license*
Plan, Work
ÃÛ¶¹ÊÓƵ Workfront Fusion license**

Current license requirement: No Workfront Fusion license requirement.

Or

Legacy license requirement: Workfront Fusion for Work Automation and Integration, Workfront Fusion for Work Automation

Product

Current product requirement: If you have the Select or Prime ÃÛ¶¹ÊÓƵ Workfront plan, your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ Workfront to use functionality described in this article. Workfront Fusion is included in the Ultimate Workfront plan.

Or

Legacy product requirement: Your organization must purchase ÃÛ¶¹ÊÓƵ Workfront Fusion as well as ÃÛ¶¹ÊÓƵ Workfront to use functionality described in this article.

To find out what plan, license type, or access you have, contact your Workfront administrator.

For information on ÃÛ¶¹ÊÓƵ Workfront Fusion licenses, see ÃÛ¶¹ÊÓƵ Workfront Fusion licenses.

Prerequisites

To use Data Store modules, you must first create a data store.

For information on creating data stores, see Data Stores in ÃÛ¶¹ÊÓƵ Workfront Fusion

Data Store modules and their fields

When you configure Data Store modules, Workfront Fusion displays the fields listed below. Along with these, additional Data Store fields might display, depending on factors such as your access level in the app or service. A bolded title in a module indicates a required field.

If you see the map button above a field or function, you can use it to set variables and functions for that field. For more information, see Map information from one module to another in ÃÛ¶¹ÊÓƵ Workfront Fusion.

All Data Store modules are Action type modules.

Add/Replace a Record

This action module adds or replaces a record.

You specify the data store and the record’s key.

The module returns the ID of the record and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

NOTE
The module throws an error when you try to add the record which is already in the data store under the same name and the Overwrite an existing record option is disabled.

When you are configuring this module, the following fields display.

Data store
Select or add the data store where you want to create a record.
Key
Enter the unique key of the record you want the module to add or replace. The key can be used later to retrieve the record. If you leave this field blank, a key is generated automatically.
Overwrite an existing record
Enable this option to overwrite the record. The record you want to overwrite must be specified in the Key field above.
Record
Enter the desired values to the record's fields.

Update a Record

This action module updates a record.

You specify the data store and the record’s key.

The module returns the ID of the record and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Data store
Select or add the data store where you want to create a record.
Key
Enter the unique key of the record you want the module to update.
Insert missing record
Enable this option to create a new record if the record with the specified key doesn't already exist.
Record
Enter the desired values to the record's fields that you want to update.

Get a Record

This action module retrieves a record.

You specify the data store and the record’s key.

The module returns the ID of the record and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

Data store
Select the data store you want to retrieve a record from
Key
Enter the unique key of the record you want the module to retrieve.

Check the Existence of a Record

This action module specifies whether a particular record exists.

You specify the data store and the record’s key.

Data store
Select the data store you want to check for the record existence.
Key
Enter the unique key of the record you want the module to check for existence.

Delete a Record

This action module deletes a record.

You specify the data store and the record’s key.

The module returns the ID of the record and any associated fields, along with any custom fields and values that the connection accesses. You can map this information in subsequent modules in the scenario.

Data store
Select the data store you want to check for the record existence.
Key
Enter the unique key of the record you want the module to delete.

Delete All Records

This action module deletes all records from a particular data store.

You specify the data store.

Data store
Select the data store you want to delete all records from.

Search Records

This search module looks for records in an object in Data Store that match the search query you specify.

You can map this information in subsequent modules in the scenario.

When you are configuring this module, the following fields display.

Data store
Select the data store you want to search.
Filter
Set the filter for the search.
Sort

For each field that you want to sort by, fill in the following fields:

Key

Select the column name you want to sort the results by.

Order

Select whether you want to sort results in the ascending or descending order.

Limit
Set the maximum number of search results Workfront Fusion returns during one execution cycle.
Continue the execution of the route even if the module returns no results
If enabled, the route that this module is part of continues processing even if this module returns no results.

Count Records

This action module numbers the records in a data store.

You specify the data store.

When you are configuring this module, the following fields display.

Data store
Select the data store that contains the records you want to count.
recommendation-more-help
5f00cc6b-2202-40d6-bcd0-3ee0c2316b43