Overview
The following article details all steps found in the Database category in the Step Toolbox.
Location | Step Name | Description | Inputs / Outputs |
---|---|---|---|
Root | Batch Insert Entities | The Batch Insert step takes a list of Decisions objects and then saves that list in the Decisions database. | Inputs: None |
Outputs: None | |||
Batch Insert Entities (auto-queue) | The Batch Insert Entities (auto-queue) step takes in data one piece at a time and then stores it in Decisions memory for a specified amount of time via the Batch Save Time configuration. After the time has passed, the data that is stored in memory is then saved in the database | Inputs: None | |
Outputs: None | |||
Batch Insert Entities (save pending) | The Batch Insert Entities (save pending) step allows the data being stored in memory to empty before the specified time by the Batch Insert Entities (auto-queue). The step executes the process when all data has been filtered through. | Inputs: Entity Id(String), New State(String) | |
Outputs: None | |||
Delete All of Type | The Delete All of Type step deletes all data objects of a user-specified type. The step utilizes the Type Name input to determine which data objects to delete. | Inputs: None | |
Outputs: None | |||
Delete All of Type in Folder | The Delete All of Type in Folder step deletes all data objects of a user-specified type in the specified folder via their Folder ID. The step utilizes the Type Name input to determine which data objects to delete. | Inputs: Folder Id(String) | |
Outputs: None | |||
Delete Entities | The Delete Entities step is used to delete pieces of data from a user-defined type. The step determines which data to delete, similar to how a Fetch Entities step collects data through a set Type Name, an applicable Extension Type Name, Parent Folder Id, and Fetch Criteria. Successful completion of the Flow results in the deletion of the configured data. | Inputs: Parent Folder Id(String) | |
Outputs: None | |||
Delete Entity | The Delete Entity step deletes an entity. | Inputs: Entity Id(String) | |
Outputs: None | |||
Fetch Entities | The Fetch Entities step pulls data for a user defined type in a workflow. Users may define specific fields and matching criteria via the Fetch Criteria input. The step outputs two separate output paths; one for when the step returns Results and the other to express when No Results are found. | Inputs: Parent Folder Id(String) | |
Outputs: None | |||
Get Count | The Get Count step returns a count of all objects pertaining to a user defined type. Similar to the Fetch Entities Step, this step asks for a Parent Folder, Type Name, Fetch Criteria, and, if applicable, an Extension Type Name. The step returns this value as a numerical value. | Inputs: Parent Folder Id(String) | |
Outputs: Count(Int64) | |||
Get Field Names | The Get Field Names step retrieves the field names associated under the specified Type Name. These retrieved field names are outputted as a String list. | Inputs: Type Name(String) | |
Outputs: Field Names(String[]) | |||
Get Sample File | The Get Sample File step collects a list of Field Names belonging to the same Type Name and exports them into a sample CSV file. | Inputs: Field Names(String), Type Name(String) | |
Outputs: Sample File(FileData) | |||
Import From CSV | The Import From CSV step loads tabular data from CSV or Excel-formatted files. This step imports an Excel or CSV file into a data type. The assumption is that the imported data type has properties that correspond to the columns of the excel file. | Inputs: Import File(String), Type Name(String) | |
Outputs: None | |||
Is Changed | The Is Changed rule step validates if the specified Entity has changed. | Inputs: Entity Id(String) | |
Outputs: None | |||
Is Field Changed | The Is Field Changed rule step validates if the specified Field Name within the specified Entity has changed. | Inputs: Entity Id(String), Field Name(String) | |
Outputs: None | |||
Is Valid | The Is Valid rule step evaluates a Decisions object to determine if it passed all validation rules applied for that particular entity. | Inputs: Object(Object) | |
Outputs: None | |||
Move Entity | The Move Entity step relocates the specified Entity to the specified Folder. | Inputs: Entity Id(String), Folder Id(String) | |
Outputs: None | |||
Rename Entity | The Rename Entity step renames the specified Entity with the New Name. | Inputs: Entity Id(String), New Name(String) | |
Outputs: None | |||
Save Entities | The Save Entities step selects a Type Name and saves the specified Entity. Multiple Entities may be saved once enabling the Save Multiple Entities checkbox. If this is enabled, the Entity input takes a list instead. It does not contain Fetch functionalities like the Update Entities step because this step does not require prior data to function: it saves the entity in its entirety to the database. | Inputs: Entity(UserDefinedEntity OR UserDefinedEntity[]) | |
Output: None | |||
Set Entity Description | The Set Entity Description step sets the 'Description' field of the specified Entity. | Inputs: Description(String), Entity Id(String) | |
Outputs: None | |||
Set Entity State | The Set Entity State step updates the state of the Entity once given the Folder ID of the Entity and a string of the desired State. Typically, but not exclusively, it is used with Case Entity Data Structures. When used with a Case Entity or a Flow Execution Extension, a Trigger Flow can be defined for particular states that will execute as soon as that state initiates. | Inputs: Entity Id(String), New State(String) | |
Outputs: None | |||
Update Entities | The Update Entities step updates pre-existing values of multiples Entities under the same specified Type Name with new values. Similar to the Fetch Entities Step, this step asks for a Parent Folder, Type Name, Fetch Criteria, and, if applicable, an Extension Type Name. Unlike the Save Entities step, this step require pre-existing data to perform. | Inputs: Custom Long Description(String), Custom Short Description(String), ID(String), Parent Folder Id(String) | |
Outputs: None | |||
Update Entity | The Update Entity step updates pre-existing values of a specified Entity under a specified Type Name with new values. | Inputs: Custom Long Description(String), Custom Short Description(String), ID(String) | |
Outputs: None |