JavaScript UDFs

Access level for JavaScript UDF feature and UDF code is determined by the User defined functions privilege.

For more information, see Overview of Authorization.

For more information, see Privileges and Roles Reference.

This feature is enabled by default. See Dataprep Project Settings Page.

Fundamental objects:

Error handling:

Data types:

Array types:

Other supported objects and collections:

Supported JavaScript value properties

Parsing functions:

URI encoding functions:

Internationalization functions:

The following tables indicate how Alteryx data types are converted to JavaScript data types during input and also for output back to Alteryx data types.

For more information on the string values for Alteryx data types, see Valid Data Type Strings.

The following metadata objects must be defined as part of your JavaScript UDF:

The signature defines the inputs of the function. A JavaScript UDF signature has the following generic structure.

export const signature = {
  "inputs": [   
   {
      "alias": "Input1",
      "description": "Input1's description",
      "displayType": "<DataType>",
      "examples": [
        "COL1"
      ]
    },
    {
      "alias": "Input2",
      "description": "Input2's description",
      "displayType": "<DataType>",
      "examples": [
        "COL2"
      ]
    }
  ],
  "output": {
    "type" : "String"
  }
};

Notes:

export function trifactaUdf(<alias1>,<alias2>) {
   <your_JavaScript>
   }
   return <values_returned>;
}

This example computes net present value.

export const signature = {
  "inputs": [   
   {
      "alias": "R",
      "description": "Cash flow at time t",
      "displayType": "Integer",
      "examples": [
        "COL1"
      ]
    },
   {
      "alias": "i",
      "description": "Discount rate as a decimal value",
      "displayType": "Float",
      "examples": [
        "COL2"
      ]
    },
    {
      "alias": "t",
      "description": "Number of time units",
      "displayType": "Float",
      "examples": [
        "COL3"
      ]
    }
  ],
  "output": {
    "type" : "Float"
  }
};


export function trifactaUdf(R, i, t) {
   let discount = Math.pow(1 + i, t);  
   return (R / discount);
}

For additional examples, please see https://community.trifacta.com/s/article/JavaScript-UDFs-Examples.

When you have created your UDF in JavaScript, you can upload it to your project in the User Defined Functions page. Select Library > User definedfunctions.

See User Defined Functions Page.

JavaScripts UDFs cannot be separately exported and imported from the Trifacta Application. However, when you export a flow definition that contains references to a JavaScript UDF, the function definition is also exported.

When this flow is imported into a new project or workspace:

Javascript UDFs are executed as part of jobs on Dataflow and Trifacta Photon.

In the Transform Builder:

You cannot reference Wrangleobjects from within your UDFs.