And Step | Core SDK Documentation
Returns true if all terms are true. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns true if all terms are true. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Concatenates arrays or streams of entities. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Removes duplicate elements in an array or entities in an entity stream. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets the array element at a particular index. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Filter an array or entity stream using a conditional statement. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets the first index of an element in an array. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets the first element of an array or entity stream. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Group elements in an array or entities in a stream using a function. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Checks if an array is empty.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets the last element of an array or entity stream. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Counts the elements in an array or entities in an entity stream.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Map each element of an array or entity stream to a new value. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Represents an ordered collection of objects.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Reverse the order of elements in an array. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Skip the first n elements of an array or entity stream. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Reorder an array or entity stream. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Take the first n elements of an array or entity stream. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Asserts that two objects are equal. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns success if the ValueIf step returns an error and a failure otherwise.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns an error if the nested step does not return true.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Add a Data Source to an Autopsy Case. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Creates a new Autopsy Case. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Generate Reports. Use this step to easily automate forensic and e-discovery workflows using Sequence.
List all Data Sources in an Autopsy Case. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets the letter that appears at a specific index. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Creates an array by cloning an element.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Convert a string representing a data size to a string representing the same size but with different units.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Creates an MSSQL connection string. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Create a database connection string for a MySQL database.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Creates a PostgreSQL connection string. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Converts a date to the specified format, yyyy/MM/dd HH:mm:ss by default. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Delay for a specified amount of time. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Deletes a file or folder from the file system.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Copy a directory. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Creates a new directory in the file system. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns whether a directory on the file system exists.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets all items in a directory. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Move a directory. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Divide an integer by a list of integers. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Generates documentation for all available steps.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Does nothing.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Divide a double by a list of doubles. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Raises a double to the power of a list of integers sequentially. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Calculate the product of a list of doubles. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Subtract a list of numbers from a number. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Calculate the sum of a list of doubles. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Combine two entities. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Recursively flatten an entity, turning all nested entities into separate fields. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Formats an entity or an array of entities as a string. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets the names of all properties of an entity. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets the value of a property from an entity. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Checks if an entity has a particular property.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Rename entity properties.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns a copy of the entity with the specified property removed. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns a copy of the entity with this property set. Use this step to easily automate forensic and e-discovery workflows using Sequence.
For each entity in the stream, check that the value of the `ParentIdProperty` is the value of the `IdProperty` for at least one entity in the stream.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns true is all terms are equal. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Copy a file. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns whether a file on the file system exists.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Extract a file in the file system.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Move a file. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Reads text from a file.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Writes a file to the local file system.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Do an action for each value of <i> in a range.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Do an action for each element in an array. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Extracts entities from a Concordance stream. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Extracts entities from a CSV stream. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Create an entity from an IDX Stream. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Extracts the entity from a Json stream containing a single entity.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Extracts entities from a Json stream containing an array of entities.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Extracts the data from a Singer Tap and converts it to entities. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Extracts the entity from a Xml stream containing a single entity.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Extracts entities from a Xml stream containing an array of entities.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Extracts the entity from a Yaml stream containing a single entity.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets the current version of the application. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets the value of the automatic variable. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets information about connectors. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets the image format implied by the file extension of the file name. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Get an entity containing SCL settings. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets the value of a named variable.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns true if each term is less than the next term. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns true if each term is greater than or equals to the next term. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Produce a hash for some data using the specified hash algorithm. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Makes a Http Request to download data from the web. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Executes a statement if a condition is true.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Increment an integer variable by a particular amount. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Checks if a step returns null. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns true if each term is less than the next term. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns true if each term is less than or equals to the next term. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Write a value to the logs. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Reads M365 Channels. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Reads M365 Channels. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Read User mail from Microsoft 365. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets the M365 Token that was used to login.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Login to M365. You do not need to do this.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Read User mail from Microsoft 365. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Read a list of users from Microsoft 365. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Read a list of users from Microsoft 365. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Modulo a number by a list of integers sequentially. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Negation of a boolean value.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns true if each term is not equal to the next term. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Adds data from a Concordance file to a NUIX case.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Adds a file or directory to a Nuix Case.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Run a search query in Nuix and add all items found to an item set. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Run a search query in Nuix and add all items found to a production set. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Annotates a document ID list to add production set names to it.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Checks the print preview state of the production set.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Run a search query on a nuix case and assign found items to a custodian.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Close the connection to nuix. Also closes all cases. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns the number of items matching a particular search term. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Creates a new case and opens it.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Creates a list of all irregular items in a case. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Create a case report using an NRT file.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Creates a report for a Nuix case. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Creates a list of all terms appearing in the case and their frequencies. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns whether or not a case exists.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Excludes password protected items once they have been decrypted. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Exports a production set in Concorfance format. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Extract Entities from a Nuix Case.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Generates print previews for items in a production set.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Calculate the total audited size for a case. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns an Entity with information about the current case. Use this step to easily automate forensic and e-discovery workflows using Sequence.
A step that the searches a case for items and outputs the values of item properties. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns an Entity with information about the Nuix license currently in use. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns the Nuix version. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Imports the given document IDs into this production set. Only works if this production set has imported numbering.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Migrates a case to the latest version if necessary.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Migrates a case to the latest version if necessary.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Open the connection to nuix. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Performs optical character recognition on items in a NUIX case.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Removes particular items from a Nuix item set.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Removes particular items from a Nuix production set.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Reorders and renumbers the items in a production set.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Run an arbitrary ruby script in nuix. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Run a search query in Nuix and exclude all items found.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Searches a NUIX case with a particular search string and tags all files it finds.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Open a new connection to a database.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns true if any terms are true. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Combine Paths. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Raises an integer to the power of a list of integers sequentially. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Prints a value to the console.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Calculate the product of a list of integers. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Executes a powershell script.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Executes a powershell script and returns any results written to the pipeline. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Create a relativity dynamic objects from entities. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Creates a new Fixed Length Field and returns the ArtifactId of that field. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Create a folder in a relativity workspace. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Creates a keyword search. Returns the artifact id of the created search.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Creates a new Relativity Workspace. Use this step to easily automate forensic and e-discovery workflows using Sequence.
. Use this step to easily automate forensic and e-discovery workflows using Sequence.
. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Delete a matter. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Deletes unused folders in a relativity workspace. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Deletes a relativity workspace. Use this step to easily automate forensic and e-discovery workflows using Sequence.
. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Retrieve a list of the available clients that you can associate with a matter.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets all children of a folder. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Imports a load file into Relativity using the desktop client. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Import Entities into Relativity. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Move a folder and its children, including subfolders and documents. . Use this step to easily automate forensic and e-discovery workflows using Sequence.
Reads a search. Use this step to easily automate forensic and e-discovery workflows using Sequence.
. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Retrieve the root folder of a Workspace. Use this step to easily automate forensic and e-discovery workflows using Sequence.
. Use this step to easily automate forensic and e-discovery workflows using Sequence.
. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Query for Workspaces, Documents, RDOs and System Types. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Update a Relativity folder. Use this step to easily automate forensic and e-discovery workflows using Sequence.
. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Update a Relativity Object. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Repeat a step a set number of times.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Delete a REST resource. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Get JSON from a REST service. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Get data from a REST service. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Executes a REST Patch request. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Create a REST resource and return the id of the created resource. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Executes a REST Put request. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Round an SCL double to a fixed number of decimal places. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Runs an external executable program.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Runs SCL defined in a StringStream. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Runs another step, reads the output to the end, and ignores it.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Create a new schema by analysing the entity properties and values in. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Create a new schema by analysing the entity properties and values in. Use this step to easily automate forensic and e-discovery workflows using Sequence.
A chain of steps to be run one after the other.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Sets the value of a named variable.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Executes a Sql command. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Creates a Schema entity from a SQL table. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Create a SQL table from a given schema. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Inserts data into a SQL table. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Executes a SQL query and returns the result as an entity stream.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Writes to the console standard error. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Reads the Console standard input. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Writes to the console standard output. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Appends a string to an existing string variable.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns true if the String contains the substring.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets the index of the first instance of a substring in a string. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets the last instance of substring in a string. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Joins strings. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns whether a string is empty.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Join strings with a delimiter.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Calculates the length of the string.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns true if a string is matched by a particular regular expression. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Replace every regex match in the string with the result of a particular function. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Splits a string.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Gets a substring from a string.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Converts a string to a boolean. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Converts a string to a particular case.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Converts a date to the specified format, yyyyMMddHHmm by default. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Converts a string to a double. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Converts a string to an integer. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Trims a string, removing whitespace from the `TrimSide`.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Subtract a list of numbers from a number. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Calculate the sum of a list of integers. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Returns true if the file in the specified path exists, false otherwise. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Write entities to a stream in concordance format. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Write entities to a stream in CSV format. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Write an entity to a stream in IDX format.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Writes an entity to a stream in JSON format. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Write entities to a stream in Json format.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Writes an entity to a stream in XML format. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Write entities to a stream in Xml format.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Writes an entity to a stream in YAML format. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Attempts to transform entities in the stream so that they match the schema. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Tries to execute a step and recovers if that step results in failure.. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Validate that the schema is valid for all entities. Use this step to easily automate forensic and e-discovery workflows using Sequence.
Repeat an action while the condition is met.. Use this step to easily automate forensic and e-discovery workflows using Sequence.