Skip to main content
Version: v0.15.0

Sequence® Steps

StepConnectorSummary
AndCoreReturns true if all terms are true
ArrayConcatCoreConcatenates arrays or streams of entities
ArrayDistinctCoreRemoves duplicate elements in an array or entities in an entity stream. By default, all entity properties are used to determine duplicates. This behaviour can be changed by using the KeySelector parameter.
ArrayElementAtIndexCoreGets the array element at a particular index. The first element has an index of 0.
ArrayFilterCoreFilter an array or entity stream using a conditional statement
ArrayFindCoreGets the first index of an element in an array. The index starts at 0. Returns -1 if the element is not present.
ArrayFirstCoreGets the first element of an array or entity stream
ArrayGroupByCoreGroup elements in an array or entities in a stream using a function. Entities in the resulting array will have two properties Key and Values. The Key will be set according to the result of the function.
ArrayIsEmptyCoreChecks if an array is empty.
ArrayLastCoreGets the last element of an array or entity stream
ArrayLengthCoreCounts the elements in an array or entities in an entity stream.
ArrayMapCoreMap each element of an array or entity stream to a new value. This Step can be used to update elements of an array, or to update entity property values. The new value must have the same type as the original value.
ArrayNewCoreRepresents an ordered collection of objects.
ArraySkipCoreSkip the first n elements of an array or entity stream
ArraySortCoreReorder an array or entity stream
ArrayTakeCoreTake the first n elements of an array or entity stream
AssertEqualCoreAsserts that two objects are equal. Both objects must have the same type.
AssertErrorCoreReturns success if the ValueIf step returns an error and a failure otherwise.
AssertTrueCoreReturns an error if the nested step does not return true.
AutopsyAddDataSourceTSKAdd a Data Source to an Autopsy Case
AutopsyCreateNewCaseTSKCreates a new Autopsy Case
AutopsyGenerateReportsTSKGenerate Reports
AutopsyListDataSourcesTSKList all Data Sources in an Autopsy Case. The result is written to the 'Command Output' folder in the case
CharAtIndexCoreGets the letter that appears at a specific index
ConvertSizeUnitsCoreConvert a string representing a data size to a string representing the same size but with different units.
CreateMsSQLConnectionStringSqlCreates an MSSQL connection string
CreateMySQLConnectionStringSqlCreate a database connection string for a MySQL database.
CreatePostgresConnectionStringSqlCreates a PostgreSQL connection string
DateToStringCoreConverts a date to the specified format, yyyy/MM/dd HH:mm:ss by default. If no date is specified, uses the current date and time.
DelayCoreDelay for a specified amount of time
DeleteItemFileSystemDeletes a file or folder from the file system.
DirectoryCopyFileSystemCopy a directory
DirectoryCreateFileSystemCreates a new directory in the file system. Will create all directories and subdirectories in the specified path unless they already exist.
DirectoryExistsFileSystemReturns whether a directory on the file system exists.
DirectoryGetItemsFileSystemGets all items in a directory
DirectoryMoveFileSystemMove a directory
DivideCoreDivide an integer by a list of integers
DocumentationCreateCoreGenerates documentation for all available steps.
DoNothingCoreDoes nothing.
DoubleDivideCoreDivide a double by a list of doubles
DoublePowerCoreRaises a double to the power of a list of integers sequentially
DoubleProductCoreCalculate the product of a list of doubles
DoubleSubtractCoreSubtract a list of numbers from a number
DoubleSumCoreCalculate the sum of a list of doubles
DoXTimesCoreRepeat a step a set number of times.
EntityCombineCoreCombine two entities. Property values of the second entity will be prioritized.
EntityFormatCoreFormats an entity as a string
EntityGetPropertiesCoreGets the names of all properties of an entity
EntityGetValueCoreGets the value of a property from an entity
EntityHasPropertyCoreChecks if an entity has a particular property.
EntityMapPropertiesCoreRename entity properties
EntityRemovePropertyCoreReturns a copy of the entity with the specified property removed
EntitySetValueCoreReturns a copy of the entity with this property set. Will add a new property if the property is not already present.
EqualsCoreReturns true is all terms are equal
FileCopyFileSystemCopy a file
FileExistsFileSystemReturns whether a file on the file system exists.
FileExtractFileSystemExtract a file in the file system.
FileMoveFileSystemMove a file
FileReadFileSystemReads text from a file.
FileWriteFileSystemWrites a file to the local file system.
ForCoreDo an action for each value of <i> in a range.
ForEachCoreDo an action for each element in an array
FromConcordanceStructuredDataExtracts entities from a Concordance stream. The same as FromCSV but with different default values.
FromCSVStructuredDataExtracts entities from a CSV stream. The same as FromConcordance but with different default values.
FromIDXStructuredDataCreate an entity from an IDX Stream
FromJsonStructuredDataExtracts the entity from a Json stream containing a single entity.
FromJsonArrayStructuredDataExtracts entities from a Json stream containing an array of entities.
FromSingerSingerExtracts the data from a Singer Tap and converts it to entities
FromXmlStructuredDataExtracts the entity from a Xml stream containing a single entity.
FromXmlArrayStructuredDataExtracts entities from a Xml stream containing an array of entities.
FromYamlStructuredDataExtracts the entity from a Yaml stream containing a single entity.
GetApplicationVersionCoreGets the current version of the application
GetAutomaticVariableCoreGets the value of the automatic variable
GetConnectorInformationCoreGets information about connectors
GetImageFormatTesseractGets the image format implied by the file extension of the file name. Note that this does not actually look at the file.
GetSettingsCoreGet an entity containing SCL settings
GetVariableCoreGets the value of a named variable.
GreaterThanCoreReturns true if each term is less than the next term
GreaterThanOrEqualCoreReturns true if each term is greater than or equals to the next term
HashCoreProduce a hash for some data using the specified hash algorithm
HttpRequestCoreMakes a Http Request to download data from the web. Returns a StringStream containing binary encoded data.
IfCoreExecutes a statement if a condition is true.
IncrementVariableCoreIncrement an integer variable by a particular amount
IsNullCoreChecks if a step returns null
LessThanCoreReturns true if each term is less than the next term
LessThanOrEqualCoreReturns true if each term is less than or equals to the next term
LogCoreWrite a value to the logs
ModuloCoreModulo a number by a list of integers sequentially
NotCoreNegation of a boolean value.
NotEqualsCoreReturns true if each term is not equal to the next term
NuixAddConcordanceNuixAdds data from a Concordance file to a NUIX case.
NuixAddItemNuixAdds a file or directory to a Nuix Case.
NuixAddToItemSetNuixRun a search query in Nuix and add all items found to an item set. Will create a new item set if one doesn't already exist.
NuixAddToProductionSetNuixRun a search query in Nuix and add all items found to a production set. Will create a new production set if one with the given name does not already exist.
NuixAnnotateDocumentIdListNuixAnnotates a document ID list to add production set names to it.
NuixAssertPrintPreviewStateNuixChecks the print preview state of the production set.
NuixAssignCustodianNuixRun a search query on a nuix case and assign found items to a custodian.
NuixCloseConnectionNuixClose the connection to nuix. Also closes all cases
NuixCountItemsNuixReturns the number of items matching a particular search term
NuixCreateCaseNuixCreates a new case and opens it.
NuixCreateIrregularItemsReportNuixCreates a list of all irregular items in a case. The report is in CSV format. The headers are 'Reason', 'Path' and 'Guid' Reasons include 'NonSearchablePDF','BadExtension','Unrecognised','Unsupported','TextNotIndexed','ImagesNotProcessed','Poisoned','Record','UnrecognisedDeleted','NeedManualExamination', and 'CodeTextFiles' Use this inside a WriteFile step to write it to a file.
NuixCreateNRTReportNuixCreate a case report using an NRT file.
NuixCreateReportNuixCreates a report for a Nuix case. The report is in csv format. The headers are 'Custodian', 'Type', 'Value', and 'Count'. The different types are: 'Kind', 'Type', 'Tag', and 'Address'. Use this inside a WriteFile step to write it to a file.
NuixCreateTermListNuixCreates a list of all terms appearing in the case and their frequencies. The report is in CSV format. The headers are 'Term' and 'Count' Use this inside a WriteFile step to write it to a file.
NuixDoesCaseExistNuixReturns whether or not a case exists.
NuixExcludeDecryptedItemsNuixExcludes password protected items once they have been decrypted. This only excludes encrypted original items that have a decrypted child with the same name.
NuixExportConcordanceNuixExports a production set in Concorfance format
NuixExtractEntitiesNuixExtract Entities from a Nuix Case.
NuixGeneratePrintPreviewsNuixGenerates print previews for items in a production set.
NuixGetAuditedSizeNuixCalculate the total audited size for a case. For this to work, the case material needs to have been ingested with the calculateAuditedSize=true processing setting. Nuix uses 1000 base for kb/mb/gb, not 1024.
NuixGetCaseDetailsNuixReturns an Entity with information about the current case. Includes Name, Description, GUID, Investigator, InvestigationTimeZone, Users, Custodians, Tags, Languages, Location (path), and if available the earliest and latest dates.
NuixGetItemPropertiesNuixA step that the searches a case for items and outputs the values of item properties. The report is in CSV format. The headers are 'Key', 'Value', 'Path' and 'Guid' Use this inside a WriteFile step to write it to a file.
NuixGetLicenseDetailsNuixReturns an Entity with information about the Nuix license currently in use. Includes license type, description, exprity, number of available workers, and the available features. The features list can be used when configuring the Nuix Connector.
NuixGetVersionNuixReturns the Nuix version
NuixImportDocumentIdsNuixImports the given document IDs into this production set. Only works if this production set has imported numbering.
NuixMigrateCaseNuixMigrates a case to the latest version if necessary.
NuixOpenCaseNuixMigrates a case to the latest version if necessary.
NuixOpenConnectionNuixOpen the connection to nuix. Does not open the case.
NuixPerformOCRNuixPerforms optical character recognition on items in a NUIX case.
NuixRemoveFromItemSetNuixRemoves particular items from a Nuix item set.
NuixRemoveFromProductionSetNuixRemoves particular items from a Nuix production set.
NuixReorderProductionSetNuixReorders and renumbers the items in a production set.
NuixRunScriptNuixRun an arbitrary ruby script in nuix. It should return a string.
NuixSearchAndExcludeNuixRun a search query in Nuix and exclude all items found.
NuixSearchAndTagNuixSearches a NUIX case with a particular search string and tags all files it finds.
OpenConnectionSqlOpen a new connection to a database.
OrCoreReturns true if any terms are true
PathCombineFileSystemCombine Paths. If the resulting path is not fully qualified it will be prefixed with the current working directory.
PowerCoreRaises an integer to the power of a list of integers sequentially
PrintCorePrints a value to the console.
ProductCoreCalculate the product of a list of integers
PwshRunScriptPwshExecutes a powershell script.
PwshRunScriptAsyncPwshExecutes a powershell script and returns any results written to the pipeline as an entity stream. Running a script asynchronously allows for input streaming. Note that the script only runs when the output of this Step is read.
RelativityCreateDynamicObjectsRelativityCreate a relativity dynamic objects from entities. Returns an array of the new artifact ids
RelativityCreateFieldRelativityCreates a new Fixed Length Field and returns the ArtifactId of that field
RelativityCreateFolderRelativityCreate a folder in a relativity workspace
RelativityCreateKeywordSearchRelativityCreates a keyword search. Returns the artifact id of the created search.
RelativityCreateMatterRelativity
RelativityCreateWorkspaceRelativityCreates a new Relativity Workspace
RelativityDeleteDocumentRelativity
RelativityDeleteKeywordSearchRelativity
RelativityDeleteMatterRelativityDelete a matter
RelativityDeleteUnusedFoldersRelativityDeletes unused folders in a relativity workspace
RelativityDeleteWorkspaceRelativityDeletes a relativity workspace
RelativityExportRelativity
RelativityGetClientsRelativityRetrieve a list of the available clients that you can associate with a matter.
RelativityGetMatterStatusesRelativity
RelativityGetSubfoldersRelativityGets all children of a folder
RelativityImportRelativityImports a load file into Relativity using the desktop client
RelativityImportEntitiesRelativityImport Entities into Relativity
RelativityMoveFolderRelativityMove a folder and its children, including subfolders and documents.
RelativityReadKeywordSearchRelativityReads a search
RelativityRetrieveMatterRelativity
RelativityRetrieveRootFolderRelativityRetrieve the root folder of a Workspace
RelativityRetrieveWorkspaceRelativity
RelativityRetrieveWorkspaceStatisticsRelativity
RelativitySendQueryRelativityQuery for Workspaces, Documents, RDOs and System Types
RelativityUpdateFolderRelativityUpdate a Relativity folder
RelativityUpdateMatterRelativity
RelativityUpdateObjectRelativityUpdate a Relativity Object
RepeatCoreCreates an array by repeating an element.
RESTDeleteRestDelete a REST resource
RESTGetJSONRestGet JSON from a REST service
RESTGetStreamRestGet data from a REST service
RESTPatchRestExecutes a REST Patch request
RESTPostRestCreate a REST resource and return the id of the created resource
RESTPutRestExecutes a REST Put request
RoundCoreRound an SCL double to a fixed number of decimal places
RunExternalProcessCoreRuns an external executable program.
RunSCLCoreRuns SCL defined in a StringStream
RunStepCoreRuns another step, reads the output to the end, and ignores it.
SchemaCreateCoreCreate a new schema by analysing the entity properties and values in an array or an entity stream. This Step is best used with data sources where the property values already have a data type (string, date, int...) such as JSON or databases. For generating schemas from flat data sources such as Concordance or CSV, use the SchemaCreateCoerced step, which will attempt to infer the property types.
SchemaCreateCoercedCoreCreate a new schema by analysing the entity properties and values in an array or an entity stream. This Step is best used with flat data sources such as Concordance or CSV as it does additional processing to infer the data types of strings.
SequenceCoreA chain of steps to be run one after the other.
SetVariableCoreSets the value of a named variable.
SqlCommandSqlExecutes a Sql command
SqlCreateSchemaFromTableSqlCreates a Schema entity from a SQL table
SqlCreateTableSqlCreate a SQL table from a given schema
SqlInsertSqlInserts data into a SQL table
SqlQuerySqlExecutes a SQL query and returns the result as an entity stream.
StandardErrorWriteCoreWrites to the console standard error
StandardInReadCoreReads the Console standard input
StandardOutWriteCoreWrites to the console standard output
StringAppendCoreAppends a string to an existing string variable.
StringContainsCoreReturns true if the String contains the substring.
StringFindCoreGets the index of the first instance of a substring in a string. The index starts at 0. Returns -1 if the substring is not present.
StringFindLastCoreGets the last instance of substring in a string. The index starts at 0. Returns -1 if the substring is not present
StringInterpolateCoreJoins strings. Supports string interpolation. To use string interpolation, the string must be enclosed in double quotes and prefixed with a dollar-sign ($). Then, anything in curly brackets { and } will be evaluated as SCL.
StringIsEmptyCoreReturns whether a string is empty.
StringJoinCoreJoin strings with a delimiter.
StringLengthCoreCalculates the length of the string.
StringMatchCoreReturns true if a string is matched by a particular regular expression
StringReplaceCoreReplace every regex match in the string with the result of a particular function
StringSplitCoreSplits a string.
StringSubstringCoreGets a substring from a string.
StringToBoolCoreConverts a string to a boolean
StringToCaseCoreConverts a string to a particular case.
StringToDateCoreConverts a date to the specified format, yyyyMMddHHmm by default. If no date is specified, returns the current time.
StringToDoubleCoreConverts a string to a double
StringToIntCoreConverts a string to an integer
StringTrimCoreTrims a string, removing whitespace from the TrimSide.
SubtractCoreSubtract a list of numbers from a number
SumCoreCalculate the sum of a list of integers
TesseractOCRTesseractReturns true if the file in the specified path exists, false otherwise
ToConcordanceStructuredDataWrite entities to a stream in concordance format. The same as ToCSV but with different default values.
ToCSVStructuredDataWrite entities to a stream in CSV format. The same as ToConcordance but with different default values.
ToIDXStructuredDataWrite an entity to a stream in IDX format.
ToJsonStructuredDataWrites an entity to a stream in JSON format
ToJsonArrayStructuredDataWrite entities to a stream in Json format.
ToXmlStructuredDataWrites an entity to a stream in XML format
ToXmlArrayStructuredDataWrite entities to a stream in Xml format.
ToYamlStructuredDataWrites an entity to a stream in YAML format
TransformCoreAttempts to transform entities in the stream so that they match the schema. Will transform strings into ints, datetimes, booleans, array, or nulls where appropriate. The properties of the transformed entities will be in the same order as in the schema For more information on schemas please see the documentation.
TryCoreTries to execute a step and recovers if that step results in failure.
ValidateCoreValidate that the schema is valid for all entities. Does not evaluate the entity stream. For more information on schemas please see the documentation.
WhileCoreRepeat an action while the condition is met.