Reusable Attribute Transforms

Important Nexla Help Center Update:

Nexla's Zendesk Help Center pages are being deprecated and will soon no longer be available.

Nexla Documentation is now the home for Nexla's User Guides, with improved formatting and categories that are easier to navigate, providing a better overall user experience.

Please update any bookmarks to the new Nexla Documentation site (docs.nexla.com/user-guides).

_______________________________________________

This article provides information about how to create, use, and share reusable attribute transforms in Nexla.

The Nexset Designer includes many pre-built, ready-to-use transform functions, but some data flows may require custom attribute transform functions beyond those already included in Nexla. For these data transformations, Nexla users can create a custom reusable attribute transform function using Python, JavaScript, or JSON. Once created, these functions can be accessed from the pulldown Function menu in the Nexset Designer for use in subsequent data flows, which avoids the need to recreate custom attribute transforms each time they are applied. Reusable attribute transforms can also be shared with others in the user's organization.

Contents:

1. Create a Reusable Attribute Transform
     1.1 Define the Attribute Transform Function
     1.2 Test the Attribute Transform Function
     1.3 Save the Reusable Attribute Transform
2. Use a Reusable Attribute Transform
3. Share a Reusable Attribute Transform
4. Edit a Reusable Attribute Transform

1. Create a Reusable Attribute Transform

1. Hover over on the toolbar on the left side of the screen, and select from the menu that appears. This opens the Reusable Transforms library.
   
   
   
   
2. Click in the top right corner of the screen to access the reusable transform creation screen.
   
   

1.1 Define the Attribute Transform Function

1. Select "Attribute Transform" from the Transform Type pulldown menu.
   
   
2. Enter a name for the custom attribute transform in the Name field.
   
   
   
   
3. Enter a description of the custom attribute transform in the Description field.
   

   Text entered in this field will appear as the transform function summary in the Function pulldown menu in the Nexset Designer.

   
   
   
4. Under the tab, select the desired language to be used for coding the transform—Python, JavaScript, or JSON—from the Code Language pulldown menu.
   
   
   
   
5. Under Function Arguments, one function argument is automatically supplied. However, the name and description of this argument can be changed in the corresponding text fields.
   

   For each argument, text in the Name field will be displayed over the corresponding pulldown menu in the Nexset Designer.

   
   
   
6. Optional: To include additional arguments in the function, click at the bottom of the Function Arguments list, and enter an appropriate name and description for each added argument.
   
   
   
   
   
   
7. Optional: To delete an argument from the Function Arguments list, click the icon to the right of it.
   
   
8. In the text field at the bottom of the tab, enter the desired transform code using the language selected in Step 6.
   

   The attribute transform function signature follows the format of transformAttribute (input, metadata, args). An attribute transform function receives the entire record as input. Typically, at least one argument that contains the name of the input attribute value to be transformed should be defined.

   
   
   

1.2 Test the Attribute Transform Function

1. Once the attribute transform function code has been entered, select the tab to test the transform.
   
   
2. Sample records for transform function testing can be entered in two ways:
   
   
   • To test using a sample record from an existing Nexset, select the desired Nexset from the "Use Sample from Nexset" pulldown menu.
     
     
     
     
   • To manually enter a sample record for testing, enter the desired sample in JSON format in the text field under "Or Enter One Input Sample".
     
     
     
     
3. In the gray Argument Values box, specify the values to which each function argument should be applied using the corresponding pulldown menus and/or text fields.
   

   The Argument Values box also provides a preview of the fields that users will see when applying the custom transform in the Nexset Designer.

   
   
   
4. Click to to the right of the Test Data tab to generate a test preview of the function output in the Generated Output panel.
   
   
   
   

1.3 Save the Reusable Attribute Transform

1. Once the transform function is complete and generates the desired result, click in the top right corner of the screen to save the custom reusable attribute transform.
   

   The reusable attribute transform will now be accessible to the owner from the Function menu in the Nexset Designer. To learn how to share reusable attribute transforms with other users, see Section 3.

2. Use a Reusable Attribute Transform

1. In the Nexset Designer, click in the Nexset Rules panel, and select from the menu that appears.
   
   
   

   To add a reusable transform to an existing Transform rule group, click at the bottom of the rule group.

2. Enter a name for the output attribute in the Output Attribute field.
   
   
   
   
3. Use the Function pulldown menu to select the desired reusable transform.
   

   Available reusable transforms are listed under the "Reusable Attribute Transform Code" category located at the bottom of the Function list.

   
   
   
4. Populate the required fields, and click to generate output samples in the Nexset Output panel.
   
   
5. Click in the top right corner of the screen at any point to save the current transform progress. Once the transform is complete, click to save the transform and close the Nexset Designer.
   
   

3. Share a Reusable Attribute Transform

1. Access the Reusable Transforms library as indicated in Section 1, Step 1.
   
   
2. Optional: To choose whether to view only owned (created) reusable transforms or all accessible reusable transforms, use the menu on the right at the top of the list.
   
   
   
   
3. Click on the reusable attribute transform to be shared. This will open a side window containing information about the transform.
   
   
   
   
4. Select the tab to view the Access Management screen.
   
   
5. Use the pulldown menu on the left to select the user with whom the reusable transform should be shared.
   

   To share the transform with all users in the organization, select the option.

6. Choose whether to grant the user(s) with whom the transform will be shared Collaborator or Administrator access, select the appropriate access type from the pulldown menu on the right.
   

   A user designated as a Collaborator will be granted read-only access to the transform. Collaborators can view and use shared transforms but cannot edit or share them.
   A user designated as an Administrator will be granted full access to the transform. Administrators can view, use, edit, and share transforms.

   
   
   
7. Click to share the transform with the selected user(s).
   

   The shared reusable attribute transform will now be accessible to the selected user(s) from the Function menu in the Nexset Designer.

4. Edit a Reusable Attribute Transform

Important: Reusable attribute transforms are only referenced when applied to any Nexset; therefore, any changes to a reusable attribute transform are automatically applied to any Nexsets referring to that transform. 

1. To edit an existing reusable attribute transform, access the Reusable Transforms library as indicated in Section 1, Step 1.
   

   Users can only edit owned reusable attribute transforms and those to which they have been granted Administrator access.

2. Click on the transform to be edited, and select from the menu that appears.
   
   
   
   
3. In the Edit Reusable Transform screen, users can make any necessary edits to the transform name, description, and/or definition.
   
   
   
   
4. Once all necessary edits are complete, click in the top right corner of the screen to save the changes to the reusable attribute transform.