Data Step Glossary
  • 16 Jun 2022
  • 14 Minutes to read
  • Dark
    Light

Data Step Glossary

  • Dark
    Light

Overview 

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

LocationStep NameDescriptionInputs/Outputs
DataCreate Data

The Create Data step can be used to create or copy data objects (or lists of objects). Another useful application for the step is for error handling. A true/false flag can be set when an error occurs.

Inputs:
Data To Create (PlaceholderData[])
Outputs:
"Done"
Data > Advanced






























Compare Two Objects

The Compare Two Objects step allows users to analyze two different data Objects in a Flow. The step takes in the values and then evaluates if their values are null. It produces three separate outcome paths: a Done path, a path for when Item 1 is null, and a path for when Item 2 is null. 

Inputs:
Item 1, Item 2
Outputs:
Results
Get Property Names On Object

The Get Property Names on Object step Outputs a List of String values for the Name of each Property of a Target Object. Note that the Target Input must be mapped dynamically and cannot be Constant mapped on the step itself. 

Inputs:
Target

Outputs:
GetPropertyNamesOnObject1_Output


Get Property On Object

The Get Property On Objects step is used to Output the Value of the designated Property of an Object. The step contains the following Inputs: Property Path, a String value that determines which Property Value to output, and Target, an Object Input that designates the source of the Property value. The Target value must be sourced from outside of the step such with Select From Flow.

Inputs:
Property Path,  Target

Outputs:
GetPropertyOnObject1_Output

Get To String Value

The Get To String Value step is used to convert a Target Object into a String Value. As the Value Input obtains its context and definition from an Object, the Input must be dynamically mapped from outside of the step. This source may be a Create Data step or via any other step's Output

Inputs:
Value
Outputs:
GetToStringValue1_Output
Get Type Full Name

The Get Type Full Name step Outputs a String value for the Full Name value of a Target Object's DataType

For example. mapping an Account Object to the step, outputs "DecisionsFramework.ServiceLayer.Services.Accounts.Account". Note that the Target Input must be mapped dynamically outside of the step. 

Inputs:
Value
Outputs:
GetTypeFullName1_Output
Get Type Name

The Get Type Name step Outputs a String value of the Target Object's Type Name. For example, mapping an Account Object to the step would Output the String "Account". Note that the Target Input must be mapped dynamically from outside of the step. 

Inputs:
Value
Outputs:
GetTypeName1_Output
Data > Excel & CSV






Delete RowThe Delete Row step deletes the specified row from the specified Excel File input. Setting File Type to Constant allows selection of Excel file type of the inputted file. The Worksheet Number Input selects which worksheet in the Excel file the logic will apply. Finally, the Ignore First Row Input toggles counting the first row of the row numbers.Inputs:
File (FileData), File Type (CSV FileType), Worksheet Number (Int32), Row Number (Int32), Ignore First Row (Boolean)
Outputs:
None
Insert RowThe Insert Row step inserts a row at the specified row number into the specified Excel File input. Setting File Type to Constant allows selection of Excel file type of the inputted file. The Worksheet Number Input selects which worksheet in the Excel file the logic will apply. Finally, the Ignore First Row Input toggles counting the first row of the row numbers.
Inputs:
File (FileData), File Type (CSV FileType), Worksheet Number (Int32), Row Number (Int32), Ignore First Row (Boolean)
Outputs:
None
Data > Data Pair























Create Logical Data Pair

The Create Logical Data Pair step makes a Data Pair consisting of a Boolean value and a name. The step takes in the value Input as a Boolean and the name Input as a String value to combine and output them as a DataPair.

Inputs:
Name, Value
Outputs:
DataPair
Create Number Data Pair

The Create Number Data Pair step makes a Data Pair consisting of a numerical value and a name. The name is Input on the step via String value, and the value is Input in the form of a Decimal value to combine and output them as a DataPair.

Inputs:
Name, Value

Outputs:
DataPair

Create Object Data Pair

The Create Object Data Pair makes a Data Pair consisting of a specified data object and a name. The step takes in value Input of the same specified Data Type as well as the name Input as an Object value to combine and output them as a DataPair.

Inputs:
Name, Value
Outputs:
DataPair
Create String Data Pair

The Create String Data Pair step is used to make a Data Pair consisting of a String value and a name. Both the value and name Inputs are taken in via String value. These values are compiled into a DataPair Output.

Inputs:
Name, Value
Outputs:
DataPair
Data Pair To Object

The Data Pair To Object step is used to map a list of Data Pairs to a user-defined Object. To do so, the user maps in the Data Pair List via the Data Pair Input, and maps the target Object to the Target Input. 

Inputs:
Data Pairs, Destination Names, Source Names, Target.
Outputs:
None
Object Properties To Data Pairs

The Object Properties to Data Pairs step makes a List of Data Pairs based on the properties of a user-defined Object. The user Inputs the Object via the o Input; the step then converts the properties of that chosen object, into a List of Data Pairs. 

Inputs:
Object
Outputs:
List of DataPair
Data > Dates









Add DaysThe Add Days step allows users to configure the DateTime value. Adds set number of days to the configured start date.Inputs:
SourceDate (DateTime), Days (Int32)
Outputs:
Output (DateTime)
Add Mins From NowThe Add Mins From Now step takes in an Integer and Outputs a DateTime value. It adds minutes to the current time, determined at Flow execution time.Inputs:
Mins (Int32).
Outputs:
Output (DateTime)
Get Current DateThe Get Current Date step fetches the current Date Time value and Outputs it as a result.Inputs:
None
Outputs:
Output (DateTime)
Data > Documents
Convert Document
The Convert Document step accepts a PDF, DOCX, or XLSX files as a FileData Input. The Input file can be converted to another file type. Note that a file cannot be converted to its present type, and that PDF and DOCX files may lose some of their formatting when converted to XLSX.
Inputs:
Document (FileData).
Outputs:
ConvertedDocument (FileData)
Data > Generator
Generate Guid
The Generate Guid step creates an alpha-numeric, globally unique identifier (GUID) that can be used as the primary 'id' for any structure. Generated GUIDs will be delimited with dashes of segment lengths 8-4-4-4-12, for a total of 32 characters.
Inputs:
None
Outputs:
Guid (String)
Data > MS Word














Add Image to Word Doc

The Add Image to Word Doc step takes in both an image file and Word document and inserts the image in accordance with the user defined parameters.

Inputs:
Word Document, Image (FileData), Image Size Preference (ImageSizePreference), Choose Values at Runtime (ChooseValuesAtRuntime), Add Image at Bookmark (AddImageAtBookmark).
Outputs:
Word Document Result (FileData)
Add Image to Word DocThe Add Image To Word Doc step inserts the image Input into the Word Doc input to output the new Word Doc file with the image now included.

The image's placement and size can be configured with the Vertical and Horizontal Placement settings and the Choose Image Size in Points setting respectively. By default, sizing is determined based on a percentage of the image to the page. The Add To All Pages (In Header) setting determines whether this image occurs in all pages' headers or only in specified pages.
Inputs:
Image (FileData), Word Document (FileData)
Outputs:
Word Document Result (FileData
HTML to Word Document

The Html to Word Document Flow step takes in a string of HTML and a file name as Input data and Outputs either a Word Document formatted form of the HTML or results in an error message. If an error occurs while the step is converting, the step will route down the error path.

Inputs:
FileName, Name (String), Get HTML From File (Boolean).
Outputs:
Doc File (FileData)

Data > Numbers









































AddThe Add step sums two supplied number values and outputs a decimal result.
Inputs:
Value1 (Decimal), Value2 (Decimal)
Outputs:
Add1_Output
Divide

The Divide step finds the quotient of two supplied number values. The "value" input is the dividend and the "by Value" input is the divisor. The output of this step is of the decimal type.

Inputs:
By Value (Decimal), Value (Decimal)
Outputs:
Divide1_Output
AverageThe Average step takes in a list of decimals and outputs a single decimal representing the average of the values passed in.Inputs:
Values (List of Decimal)
Outputs:
Average1_Output
Equals (Number)The Equals (Number) step compares two number values to determine whether or not they're equivalent. This can compare numbers of different types (i.e. Integers & decimals). A boolean value of true or false is the result.Inputs:
Value1 (Decimal), Value2 (Decimal)
Outputs:
None
Greater Than (Number)The Greater Than (Number) step compares two number values and determines whether or not the first value is higher than the second value.Inputs:
Value1 (Decimal), Value2 (Decimal)
Outputs:
None
Get Random IntThe Get Random Int step generates a random integer smaller than the defined max.
Inputs:
Max (Int32)
Outputs:
GetRandomInt1_Output
Greater Than Or Equal To

The Greater Than Or Equal To step takes in two decimals and checks if the first is greater than or equal to the second. It results in the appropriate answer of true or false.

Inputs:
Value1 (Decimal), Value2 (Decimal)
Outputs:
None
Less Than (Number)The Less Than (Number) step compares two number values and outputs a true boolean if the first value is lower than the second value.
Inputs:
Value1 (Decimal), Value2 (Decimal)
Outputs:
None
Number Ranges

The Number Ranges step allows the user to define ranges with parameters that each have a unique outcome path. A single number is passed into the step and it will navigate down the first range path that the number applies to.

Inputs:
Number To Evaluate (Double)
Outputs:
Number Ranges
Subtract

The Subtract step takes in two numbers: "from Value" and "subtract Value". The "subtract Value" is subtracted from the "from Value" and the step returns a single number which is the of this result of this calculation.

Inputs:
From Value (Decimal), Subtract Value (Decimal)
Outputs:
Subtract1_Output
Data > Object
Cast Object To Type
The Cast Object to Type step acts as a method that allows users to convert an object in Decisions to a Defined Data Structure.

The step takes in the object via the Source Object Input, and chooses which type(s) to convert to via the Type to Try drop down. The step provides at least two paths: one for where the object returns a resulting match and subsequent conversion, and one where the path does not return results and fails. This step will only map an object to its generic Data Type and not a type containing the same fields.
Inputs:
Source Object (Object)Outputs:
String Result (String)
Outputs:
String Result (String)



Data > PDF






























































































Add Image To PDFThe Add Image To PDF step inserts the image Input into the PDF file input to output the new PDF file with the image now included.

The image's placement and size can be configured with the Vertical and Horizontal Placement settings and the Choose Image Size in Points setting respectively. By default, sizing is determined based on percentage of the image to the page. The Add To All PDF Pages setting determines whether this image occurs in all pages or only in specified ones.
Inputs:
Image (FileData), Pdf Document (FileData)
Outputs:
Pdf Document Result (FileData)
Add PDF Header and FooterThe Add PDF Header and Footer step inserts a header and/or a footer into the list of PDF file Inputs.

When set to Constant, the Footer Alignment designates where the footer is located while the Page Footer Input specifies the data within the footer. The Page Header Input specifies the data within the header. Finally, you may rename the PDF output according to the PDF File Name Input. If the step errors out, it instead outputs a string error message.
Inputs:
Footer Alignment (HorizontalPlacement), Page Footer (String), Page Header (String), PDF File (FileData[]), PDF File Name (String)
Outputs:
PDF File (FileData), Error Message (String)
Convert Image to PDF
The Convert Image to PDF step takes the Image Input and outputs it into a PDF file. This step accepts PNG, JPEG, and TIFF image file extensions: it does not accept SVG files.
Inputs:
Image (FileData)
Outputs:
Output (FileData)
Convert PDF to PCLThe Convert PDF to PCL step takes the PDF file Input and outputs it as the new PCL file. The PCL File Name Input will automatically rename the PCL file to the given name. If the step errors out, it instead outputs a string error message.Inputs:
PCL File Name (String), PDF Document (FileData)
Outputs:
Output File (FileData), Error Message (String)
Convert PDF To PNG Images
The Convert PDF To PNG Images step takes the PDF file Input and changes each of its pages into a PNG file. Since PDFs likely contain more than one page, this outputs as a list.
Inputs:
Pdf Document (FileData)
Outputs:
Output (FileData[])
Convert PDF to TIFF ImagesThe Convert PDF To TIFF Images step takes the PDF file Input and changes each of its pages into a TIFF file. Since PDFs likely contain more than one page, this outputs as a list.
Inputs:
Pdf Document (FileData)
Outputs:
Output (FileData[])
Delete Pages from PDFThe Delete Pages From PDF step takes the PDF file Input and removes the designates pages in the Pages to Remove Input. It then outputs the new PDF file.Inputs:
Pages to Remove (PageRange[]), Pdf Document (FileData)
Outputs:
Output (FileData)
Get PDF Form Field NamesThe Get PDF Form Field Names step pulls the Field Names for a specified PDF file and sorts the items into a string list.

The Field names can be sorted either alphabetically, by tab order, or by position on in the PDFfile
Inputs:
PDF File (FileData). Sorting Method
Outputs: Fields (List of String)
Get PDF Form Fields

The Get PDF Forms Fields step is used to pull the specified PDF Field Definition(s) into a Flow.

The step does so by taking in the user Input PDF File and evaluating the PDF Fields Definitions Input. Within the Edit PDF Fields Definitions panel, users Input one of the PDF file's For Field's Names in the Name Input and select the Type of data being pulled from the Field via the drop down selector. The step Outputs the select Field(s) value. The PDF Field Definition MUST match the definitions present in the PDF file, to progress in the Flow and Output data.

Inputs:
PDF File
Outputs:
None
Get Text From PDFThe Get Text From PDF step uses Decisions OCR to read the PDF File Input and outputs text within the PDF as a string. The Preserve Whitespace checkbox toggles empty spacing in the PDF while the Read All Pages checkbox toggles if the step runs for all pages or only specified pages.Inputs:
PDF Document (FileData)
Outputs:
PDF Text (String)
HTML To PDFThe HTML To PDF step takes a string HTML Input, renames it with the PDF File Name Input, and outputs the new PDF file.

The Include Page Number checkbox toggles visibility of page numbers while the Page Number Alignment Input configures the location of page numbers on a page. If the step errors out, it instead outputs a string error message. 
Inputs:
HTML (String), Include Page Numbers (Boolean), Page Number Alignment (HorizontalPlacement), PDF File Name (String)
Outputs:
PDF File (FileData), Error Message (String)
Make PDFDocument Read OnlyThe Make PDFDocument Read Only step converts the inputted list of PDF bytes and outputs those list of bytes as a Read Only document thus preventing content modification, form field completion, or comment creation on the PDF.Inputs:
Document (Byte[])
Outputs:
Output (Byte[])
Merge PDFDocumentsThe Merge PDFDocuments step combines two list of PDF byte Inputs into one new PDF byte list output. Inputs:
Document1 (Byte[]), Document2 (Byte[])
Outputs:
Output (Byte[])
Recognize Text From PDFThe Recognize Text From PDF step scans the PDF file Input for string text and outputs all recognized text. Unlike the Get Text From PDF step, this step does not support options for page selection nor whitespace preservation: it only reads the text.

Text outputs from this step may deviate slightly from the original content, so flow logic steps like Replace Text in String step may correct these errors assuming the text is all in a similar style. Note that this step may take fifteen to thirty seconds to execute.
Inputs:
Pdf Document (FileData)
Outputs:
Output (String)
Remove Password From PDFThe Remove Password From PDF step takes the Document byte list Input, unlocks it with the provided Password string Input, and then outputs a new Document byte list without password protection.Inputs:
Document (Byte[]), Password (String)
Outputs:
Output (Byte[])
Set PDF Form FieldsThe Set PDF Form Fields step passes data from a Flow into a PDF including Form Fields. Mapping in a PDF Files via the respective Input will populate the PDF Fields Definitions box with each available PDF Form Field. The user can then map in an Input for each individual Field. The step Outputs the revised PDF to the pre-configured Download Folder.
Inputs:
PDF File Example (FileData), PDF File (FileData), PDF Fields Definitions (PlaceholderData[])
Outputs:
PDF File (FileData)
Set PDF Form Fields Dynamic

The Set PDF Form Fields Dynamic step passes in a list of DataPairs where the name is the field name, and the value is an object, and get a PDF FileData object to download/store.

Inputs:
PDF File, Field Data
Outputs:
PDF File
Set PDF PasswordThe Set PDF Password step assigns the User Password Input as the password for the PDF Document file input. It then outputs the new, password-protected PDF file.

The optional Current Password and Owner Password settings need be configured if the PDF contains a pre-existing password else the step fails without proper the proper credentials. Otherwise, these settings can be left to Ignore.
Inputs:
PDF Document (FileData), User Password (String), Current Password If Any (String), Owner Password Optional (String)
Outputs:
Output (FileData)
Split PDFThe Split PDF step takes in a PDF file Input and outputs the specified pages/page ranges as a new list of PDF files.

Setting the Output Page as Constant allows selection of pages according to range, single page, or to end which selects pages from the specific page to the last page.
Inputs:
Pdf Document (FileData), Output Page as Constant (PageRange[])
Outputs:
Output (FileData[])
Data > Text
Strip Characters
The Strip Characters step Outputs a String value that removes the specified character(s) listed in the Chars To Strip Input which takes the Chars data type. The Case Insensitive Boolean toggles case sensitivity of the Chars To Strip Input while the Input is the original String Value.
Inputs:
Case Insensitive (Boolean), Chars To Strip (Chars[]), Input (String)
Outputs:
StripCharacters1_Output (String)
Merge String Lists by LineThe Merge String Lists by Line step merges two String lists together to create a new String list. The list items are combined together at their position, separated by a specified separator character.Inputs:
List One (List of String), List Two (List of String), Separator (String)
Outputs:
Output (List of String)
System > Caching
Put In CacheThe Put In Cache step places value in memory for a defined time.
"Cache Instant Name" can be any desired name to associate with the cache.
"Cache Type Name" can be default Decisions cache or a custom cache found under System >Administration > Cache.

"Key" will be the key by which the Cache will be accessible.

"Value" is the data that will be stored.
Inputs:
Key, Cache Type Name, Cache Instance Name, Value (String)
Outputs:
"Done"

Was this article helpful?