Task reference overview
This section contains a library of Itential task references to help you design and manage your workflows. Each task performs a different activity within a workflow to support automation and orchestration on remote system services, servers, devices, and applications.
Although this library is designed to help you scale and work more productively, we recommend having a basic understanding of workflow best practices to use each task effectively.
Task references
The table below lists every task in the reference library along with a brief description. Click a task name to open the full reference page.
| Task | Description |
|---|---|
| addDuration | Use the addDuration task to add a duration to an existing timestamp and return the adjusted time. |
| arrayIncludes | Use the arrayIncludes task to determine whether an array contains a given element. |
| assign | Copies enumerable properties from a source object to a target object |
| indexOf (array) | Use the indexOf task to find the first index position of an element in an array. |
| arrayLastIndexOf | Use the arrayLastIndexOf task to find the last index position of an element in an array. |
| arrayToString | Use the arrayToString task to return a string representing the contents of an array. |
| calculateTimeDiff | Use the calculateTimeDiff task to calculate the difference between two timestamps and return the result as a duration. |
| charAt | Use the charAt task to return the character at a given index position in a string. |
| charCodeAt | Use the charCodeAt task to obtain the Unicode decimal (UTF-16) value for a character at a specific position in a string. |
| childjob | Use the childjob task to run a separate workflow as a child job, enabling workflow reuse and parallel or sequential looping. |
| codePointAt | Use the codePointAt task to retrieve the Unicode code point value of a character at a specific position in a string. |
| concat | Concatenates strings or arrays of strings. |
| concatArray | Use the concatArray task to combine the elements of two arrays into a new array. |
| convertEpochToObject | Use the convertEpochToObject task to convert an Epoch timestamp into a human-readable date string with a specified time and date format. |
| convertTimeFormat | Use the convertTimeFormat task to convert a time value into a new moment.js format string. |
| convertTimeToEpoch | Use the convertTimeToEpoch task to convert a date/timestamp to Epoch Time. |
| convertTimezone | Use the convertTimezone task to offset a timestamp by a specified number of whole hours. |
| copyWithin | Use the copyWithin task to copy a portion of an array to a new location within the same array without modifying its size. |
| csvStringToJSON | Use the csvStringToJSON task to convert a CSV string to JSON format. |
| deepmerge | Folds two or more objects together into a single object, merging at any depth. |
| delay | Use the delay task to pause a job for a specified number of seconds. |
| endsWith | Use the endsWith task to determine whether a string ends with a specified sequence of characters. |
| ErrorHandling | Use the ErrorHandling task to manage error severity levels and control workflow flow in response to fatal errors, warnings, or successful states. |
| evaluation | Controls execution paths by comparing values at runtime using configurable operators and evaluation groups. |
| eventListenerJob | Pauses a workflow and waits for an event matching a specified topic and schema. |
| exceltojson | Use the exceltojson task to convert a Base64-encoded Excel file to JSON format. |
| extractField | Use the extractField task to extract a specific time field such as day, month, or year from a timestamp. |
| fill | Fills the elements of an array with a static value from optional start and end positions. |
| FlattenJSONFormInput | Use the FlattenJSONFormInput task to convert single-value arrays into simple key-value pairs. |
| forEach | Use the forEach task to execute a loop inside a job, iterating over an array and running a series of tasks for each element. |
| getTime | Use the getTime task to obtain a current timestamp for use in a workflow, with an optional offset. |
| includes | Searches a string for a specified value and returns true or false. |
| indexOf | Use the indexOf task to find the position of a specific character or group of characters within a string. |
| isArray | Checks whether an input is an array and returns true or false. |
| join | Use the join task to join all elements of an array into a single string. |
| keys | Use the keys (object) task to return an array of key names from an object, preserving the original order. |
| lastIndexOf | Use the lastIndexOf task to identify the last occurrence of a character or group of characters within a string by searching backwards. |
| length (array) | Use the length task to return the number of elements in a given array. |
| length (string) | Use the length (string) task to count the number of characters in a string. |
| localeCompare | Use the localeCompare task to compare two strings in the current locale and return a numeric sort-order result. |
| makeData | Use the makeData task to convert an input string into a different data type. |
| map | Use the map task to map an input array to an array of values, producing key-value pairs. |
| match | Use the match task to find regex matches in a string and return results as an array. |
| merge | Combines data from job variables, static data, and task outgoing variables into a new variable using no-key or unique-key assignment modes. |
| modify | Creates a new variable from a modified copy of an existing variable by updating boolean, number, or string values. |
| normalize | Returns a string in a specified Unicode normalization form. |
| newVariable | Use the newVariable task to create a new job variable of type boolean, number, string, object, or array. |
| toString | Use the toString task to convert a number into its string representation. |
| objectHasOwnProperty | Use the objectHasOwnProperty task to check whether an object has a specified property as its own property, returning a boolean result. |
| objectToString | Use the objectToString task to convert a valid JSON value to a JSON string. |
| padEnd | Pads the end of a string with another string until the result reaches a specified length. |
| padStart | Use the padStart task to pad a string with a specified string at the start until it reaches a given length. |
| parseInt | Use the parseInt task to parse a string value and return an integer using the decimal number system as a base. |
| parse | Use the parse task to parse a JSON string and return a JavaScript object. |
| pop | Removes the last item from a job array variable and returns it. |
| popFromArray | Use the popFromArray task to remove the last element from a job array variable and return the removed item. |
| pushToArray | Use the pushToArray task to add an element to a job array variable during workflow execution. |
| push | Use the push (array) task to add an element to the end of an array. |
| query | Use the query task to extract and reshape data from object variables for use with existing tasks. |
| repeat | Use the repeat task to copy a string a specified number of times and concatenate the copies into a new string. |
| restCall | Use the restCall to make HTTP requests to external API data sources. |
| reverse | Use the restCall to make HTTP requests to external API data sources. |
| search | Use the search (string) task to find the index of the first regular expression match in a string. |
| setObjectKey | Use the setObjectKey task to set a property value on an object by specifying a path, creating the path if it does not exist. |
| shift | Removes the first element from an array and returns the shortened array. |
| slice | Use the slice (string) task to extract part of a string and return it as a new string. |
| slice-string | Extracts part of a string between specified start and end indexes. |
| sort | Sorts the elements of an array in ascending or descending order. |
| split | Use the split task to split a string into an array of substrings using a separator. |
| startsWith | Use the startsWith task to determine whether a string begins with a specified set of characters. |
| stringValueOf | Use the stringValueOf task to return the primitive value of a string object as a string data type. |
| stub | Use the stub task as a placeholder in a workflow to represent tasks that have not yet been implemented. |
| substring | Use the substring task to extract a sequence of characters from a string between a start and end index. |
| toLocaleLowerCase | Use the toLocaleLowerCase task to convert a string to lowercase according to locale-specific case mappings. |
| toLocaleString | Use the toLocaleString task to convert array elements to a locale-specific string. |
| toLocaleUpperCase | Use the toLocaleUpperCase task to convert a string to uppercase according to locale-specific case mappings. |
| toLowerCase | Use the toLowerCase task to convert all characters of a string to lowercase. |
| toString (array) | Returns a string representing the contents of an array with elements separated by commas. |
| toString (number) | Converts a number to its string representation. |
| toString (object) | converts a valid JSON value to a JSON string. |
| toUpperCase | Use the toUpperCase task to convert all characters in a string to uppercase. |
| transformation | Use the transformation task to run JSON Schema Transformations (JSTs) during workflow job execution. |
| trim | Use the trim task to remove whitespace from both ends of a string. |
| trimEnd | Use the trimEnd task to remove whitespace from the end of a string. |
| trimStart | Use the trimStart task to remove whitespace from the beginning of a string. |
| unshift | Use the unshift task to add an element to the beginning of an array. |
| updateJobDescription | Use the updateJobDescription task to update a job’s description while the job is running. |
| values | Use the values task to return an array of the enumerable property values of an object. |
| viewData | Use the viewData task to display a form to users containing job data and enable decision-making for the next workflow step. |
