Introduction

Before a standard Patchworks cross-reference lookup can be applied in field mapping transformations, it must be installed. Follow the steps below to complete this task.

The steps

Step 1 Log into the Patchworks dashboard, then select process flows ~ cross reference lookups from the left-hand navigation bar.

Step 2 Move down to the marketplace section and find the cross reference lookup that you want to install - you can use the search field or step through pages to find your required item. For example:

Step 3 Click the install button associated with the cross-reference lookup that you want to use. The item is installed and added to your installed section at the top of the page. This cross-reference lookup is now ready for use.

Introduction

Cross-reference lookups are accessed and managed from the left-hand navigation bar.

The steps

Step 1 Log into the Patchworks dashboard, then select process flows ~ cross-reference lookups from the left-hand navigation bar.

Step 2 The cross-reference lookup page is displayed, with three main areas to note:

Here, you can:

• Use the create cross reference lookup button to add your own lookup table.

• Access cross reference lookups that you have installed or added.

• Access Patchworks cross reference lookups that are available for you to install.

Introduction

If you prefer to maintain cross-reference lookup values externally, you can easily export cross-reference lookups from Patchworks, update values as required, then import the updated file.

Need to know

Export file format

Cross-reference lookup exports are completed in CSV format, delimited ONLY with a single comma between fields.

The exported file includes two columns with left_value and right_value headers. For example:

left_value,right_value
blue,#33ADFF
red,#FF5733
yellow,#FFF933

Imports

Import approach

When cross-reference lookup values are imported:

• Existing values are checked and updated from the import file

• Existing values are checked against both left and right values

• New values are added

Import file format

To import cross-reference lookup values, the import file must be in the same format as export files above, with the same headers. I.e.:

left_value,right_value
value,value
value,value
value,value

Exporting a cross-reference lookup

To export/download a cross-reference lookup, follow the steps below.

Step 1 Log into the Patchworks dashboard, then select process flows | cross-reference lookups from the left-hand navigation bar.

Step 2 Click the download button associated with the cross-reference lookup that you want to export:

Step 3 The download job is added to a queue and a confirmation message is displayed:

Step 4 When your download is ready, you'll receive an email which includes a link to retrieve the file from the file downloads page. If you can't/don't want to use this link, you can access this page manually by selecting the settings option:

...followed by the file downloads option:

Step 5 On the file downloads page, you'll find any exports that have been completed for your company profile in the last hour.

Step 6 Click the download button for your job - the associated CSV file is saved to the default downloads folder for your browser.

Importing cross-reference lookup values

To import cross-reference lookup values, follow the steps below.

Step 1 Log into the Patchworks dashboard, then select process flows | cross-reference lookups from the left-hand navigation bar.

Step 2 Click the name of the cross-reference lookup that you want to update:

Step 3 Move to the lower values panel and click the import values button:

Step 4 Navigate to the CSV file that you want to import and select it:

Step 5 The file is uploaded and displayed as a button - click this button to complete the import:

Step 6 The import is completed - existing values are updated and new values are added:

Introduction

Cross-reference lookups can be applied as a field mapping transformation, using the map function. The steps below show how this is achieved.

The steps

Step 1 Log into the Patchworks dashboard, then select process flows and open the process flow that you want to update.

Step 2 Access settings for the map shape so you can see existing mapping rules - for example:

Step 3 Find the mapping rule that you want to update with a transformation, and click the transform button:

Step 4 Any existing transformations for this mapping rule are shown. Click the add transform button:

Step 5 Click in the name field to activate a dropdown list of all available transform functions, then select the map function from the other section:

Step 6 Click in the map field to activate a dropdown list of available cross-reference lookups, then select the lookup that you'd like to use. For our example, we'll use a lookup that we added previously which maps long-form colours to hex codes:

Step 7 Use the direction field to choose whether this conversion should take place form left to right or right to left:

Step 8 Use the match type field to choose how data to be transformed should be matched:

Step 9 Use the output type field to choose the data type for the transformed value:

Step 9 Click the add field button:

...then confirm the source field to be transformed:

Step 9 Accept changes and the function is confirmed for the mapping rule:

At this point, the cross-reference lookup transformation is ready to use. When you save the map shape and run the process flow, your transformation is applied.

However, if required, you can add more transformation functions for a mapping rule - follow the steps above and choose the appropriate function in step 5.

Looking at our example scenario, it's useful to add a prefix function to add a # character before any colour field values:

Step 10 Now when your process flow runs, the transformations are applied:

Introduction

If you have your own set of data values that you want to cross-reference, you can add your own cross-reference lookup. Once added, you can .

The steps

Step 1 Log into the Patchworks dashboard, then select process flows ~ cross-reference lookups from the left-hand navigation bar.

Step 2 Click the create cross-reference lookup button:

Step 3 Enter basic details for this lookup:

Step 4 Click the create button to confirm these details. The new lookup is created and you're ready to add your required values.

Step 5 Click the create value button:

Step 6 Enter details for your first value:

Step 7 Click the create button to save this entry.

Step 8 Add more values as needed.

Introduction

Cross-reference lookups are used for cases where sets of static values are commonly known by another value. For example:

Weight measurements

Months of the year

If you have source data which includes values that always need to be changed to an alternative term, a cross-reference lookup can be used to transform required data fields.

For example, you might have an incoming payload which has a 'renewal month' field with values in the form 'January', 'February', 'March', etc. but also have a target connection which only accepts months in abbreviated form - 'Jan', 'Feb', 'Mar', etc.

In this scenario, you could add 12 replace for any field that needs this conversion - but a more efficient approach is to add one map transformation function (associated with the appropriate cross-reference lookup) to required fields.

Patchworks provides a range of cross-reference lookups which you can and , or you can add your own.

In this section