Database Step Glossary

Overview

The following article details all steps found in the Database category in the Step Toolbox.

Location	Step Name	Description	Inputs / Outputs
Connection Strings	Get Value From Connection String	The Get Value From Connection String step gains access to the connection string thanks to its key, grabs it, and then exports the connection string value. When wishing to checking a parameter, such as Integrated Security, this step may locate its occurrence or lack thereof within the connection string.	Inputs: Connection String (String), Key (String)
Connection Strings	Get Value From Connection String		Outputs: Output (String)
Leasing	Delete Leased Entity	The Delete Leased Entity step deletes the leased Entity. The user may choose to hard delete the leased Entity. Hard deleting typically occurs upon completing processing for the leased Entity and no other process intends to work on it.	Inputs: Entity (Object), Hard Delete (Boolean)
	Delete Leased Entity		Outputs: None
	Lease Entity Step	The Lease Entity step fetches an Entity and acquires a leases on it preventing other process threads from working on the Entity. The Lease Setup settings specify the amount of leases and for how long they are applied. By default, it contains two outcome paths: No Entry To Lease and Leased Entity.	Inputs: Parent Folder Id (String)
	Lease Entity Step		Outputs: None
	Release Lease	The Release Lease step frees up the specified leased Entity according to the lease's ID thus allowing the entity to be used in another process thread. This release may be permanent or for a specified time according to the For How Long input. Furthermore, the Release Behavior Input configures release to either delete, logically delete, or unlease the Entity.	Inputs: Entity (Object), For How Long (TimeSpan), Lease Id (String), ReleaseBehavior (ReleaseBehavior)
	Release Lease		Outputs: None
	Renew Lease Entity	The Renew Lease Entity rule step continues the lease the specified Entity beyond its original expiration date/time if the Rule passes as True. The length of this extension is specified by the For How Long Input.	Inputs: Entity (Object), For How Long (TimeSpan), Lease Id (String)
	Renew Lease Entity		Outputs: None
	Try Lease Entity	The Try Lease Entity step applies a lease on the specified Entity for the specified length of time. Unlike the Lease Entity step, this step only applies one lease per initialization and then outputs the now leased Entity.	Inputs: Entity (Object), For How Long (TimeSpan)
	Try Lease Entity		Output: Output (String)
Root	Attach Extension to Entity	The Attach Extension to Entity step combines a premade Entity, such as a Folder, with the specified Extension such as a Flow Execution Extension. This is less intensive thus faster than Create steps when batch inserting multiple entities.	Inputs: Entity, Extension, Save (Boolean)
	Attach Extension to Entity		Outputs: None
	Batch Insert Entities	The Batch Insert step takes a list of Decisions objects and then saves that list in the Decisions database.	Inputs: None
	Batch Insert Entities		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
	Batch Insert Entities (auto-queue)		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)
	Batch Insert Entities (save pending)		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
	Delete All of Type		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)
	Delete All of Type in Folder		Outputs: None
	Delete and Clear Entity	The Delete and Clear Entity step takes in a Flow Data Structure ID, deletes the Entity, and clears any associated tables using its data.	Inputs: Entity Id (String)
	Delete and Clear Entity		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 similarly to how a Fetch Entities step collect data through use of a set Type Name, an applicable Extension Type Name, Parent Folder Id, and Fetch Criteria. Successful completion of the Flow results in deletion of the configured data.	Inputs: Parent Folder Id(String)
	Delete Entities		Outputs: None
	Delete Entity	The Delete Entity step deletes an entity.	Inputs: Entity Id(String)
	Delete Entity	The Delete Entity step deletes an entity.	Outputs: None
	Export Entities to CSV	The Export Entities to CSV step takes an Entity according to its Type Name and its Field Names and then outputs them into a CSV file. When selecting the Build Array mapping type for the Field Names, it will export the Field Names in the order specified. If wishing to export an Entity without knowing all the required names, the List to CSV step may help instead.	Inputs: Field Names (String[]), Type Name (String)
	Export Entities to CSV		Output: SampleFile (FileData)
	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)
	Fetch Entities		Outputs: None
	Get Changed Fields	The Get Changed Fields step searches the specified Entity for changes and, if any are found, returns an array of field names where the current value differs from its value stored in the database. This is related to the Is Changed step, but this instead gathers the exact details of the change.	Inputs: Entity Id (String)
	Get Changed Fields		Outputs: Output (String[])
	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)
	Get Count		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)
	Get Field Names		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)
	Get Sample File		Outputs: Sample File(FileData)
	Hide Entity	The Hide Entity step hides the specified Entity in its parent Folder from the initiating user once ran. The user cannot view the Entity in the Folder View, but it is still searchable.	Inputs: Entity Id (String)
	Hide Entity		Outputs: None
	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)
	Import From CSV		Outputs: None
	Is Change Tracking Entity	The Is Change Tracking Entity rule step checks if the specified Entity's type is one that tracks field changes for audit purposes.	Inputs: Entity Id (String)
	Is Change Tracking Entity		Outputs: None
	Is Changed	The Is Changed rule step validates if the specified Entity has changed. This is related to the Get Changed Field step, but this step checks for changes as true/false while the former gathers which field names have changed.	Inputs: Entity Id(String)
	Is Changed		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)
	Is Field Changed		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)
	Is Valid		Outputs: None
	Move Entity	The Move Entity step relocates the specified Entity to the specified Folder.	Inputs: Entity Id(String), Folder Id(String)
	Move Entity		Outputs: None
	Rename Entity	The Rename Entity step renames the specified Entity with the New Name.	Inputs: Entity Id(String), New Name(String)
	Rename Entity		Outputs: None
	Run Rules on Object	The Run Rules on Object step checks the specified Object for validation errors. This is useful when verifying if a Flow has any problems without manually opening it in the Flow Designer.	Inputs: Object (Object)
	Run Rules on Object		Outputs: Output (ValidationIssue[])
	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[])
	Save Entities		Output: None
	Set Entity Description	The Set Entity Description step sets the 'Description' field of the specified Entity.	Inputs: Description(String), Entity Id(String)
	Set Entity Description		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)
	Set Entity State		Outputs: None
	Unhide Entity	The Unhide Entity step reveals the specified Entity that was previously hidden from the initiating account.	Inputs: Entity Id (String)
	Unhide Entity		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)
	Update Entities		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)
	Update Entity		Outputs: None
	Validate Fields To Include	The Validate Fields To Include step intakes a specified type name and field name array and then validates whether a data upload including only those field names will encounter any potential issues and/or errors. For example, if the primary key field is not present in the list and thus the upload, then any Entity created will not update any existing Entity: it will create a new one. Other test may include checking for a missing parent folder ID for folder Entities, missing Entity name, missing extension data if an extension, or missing folder behavior type if a folder.	Inputs: Field Names (String[]), Type Name (String)
	Validate Fields To Include		Outputs: Warnings (String)