Integration Step Glossary
- 27 Jul 2022
- 13 Minutes to read
- Print
- DarkLight
This documentation version is deprecated, please click here for the latest version.
Integration Step Glossary
- Updated on 27 Jul 2022
- 13 Minutes to read
- Print
- DarkLight
Article summary
Did you find this summary helpful?
Thank you for your feedback
Overview
The following article details all steps found in the Integration category in the Step Toolbox.
| Location | Step Name | Description | Inputs/Ouputs |
|---|---|---|---|
| Integration > Accounts | Add Group To User | The Add Group to User step adds a user to a group based on the entered email and group name defined in the input variables. | Inputs: Email Address (String), Group Name (String) Outputs: Output (String) |
| Create Account | The Create Account step creates a new Decisions account from the defined email and password passed in. It outputs the account id for the new account once it has been created. | Inputs: Email Address (String), Password (String) Outputs: Output (String) | |
| Add Group To User By Account Id | The Add Group to User By Account Id step adds a user to a group based on the entered account Id and group name defined in the input variables. | Inputs: Account Id, Group Name Outputs: None | |
| Get Current Account | The Get Current Account step examines and returns the current Account either debugging or running the Flow. It outputs the Account datatype without taking in any inputs. | Inputs: None Outputs: GetCurrentAccount1_Output | |
| Get Assignment Role For Folder By Name Or Id | The Get My Assignment Count step is used to return the number of assignments in an user's inbox cache. This value is returned in the Form of a Int32 numerical value. | Inputs: Folder Id (String), Role Name Or Id (String) Outputs: Output (AssignmentRole) | |
| Integration > Excel And CSV | Convert CSV To Excel | The Convert CSV to Excel step converts CSV tabular data to the Excel format. | Inputs: Ignore First Line (Boolean), Input (FileData), Skip Blank Lines (Boolean), Try To Format Numbers (Boolean), Type (CSVFileType) Outputs: Output (FileData) |
| Delete Row | The 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 Row | The 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 | |
| Import Excel or CSV | The Import Excel or CSV step converts imported CSV values from an Excel or CSV File into a user-determined DataType. | Inputs: File Data (FileData) Outputs: Imported Data (List of [SelectedDataType]), | |
| CSV To Object Mapping | The CSV To Object Mapping step is used as a means to alter the value of a piece of stored data. The step takes Input from whatever preceding steps are attached to it. By using a Build Data mapping on an Input data type, users are able to adjust individual parameters of the data rather than the entire data object. This includes mapping values from a different data type onto another's Inputs. See attached screenshots and documentation for further detail. | Inputs: File Input (FileData) Outputs: None | |
| Get Row As Array | The Get Row As Array step can be found under Integrations > Excel & CSV. This step reads the Excel document inputted and returns a list of strings from each column in the row. A user must provide an Excel document, choose a file type, and list the number of the row that will be read. The user should also specify whether to include the first row and empty columns or not. | Inputs: File (FileData), File Type (CSVFileType), Worksheet Number (Int32), Row Number (Int32), Ignore First Row (Boolean), Include Empty Columns (Boolean) Outputs:Output (List of String) | |
| Integration > File | Create File | The Create File step allows a user to input a file and give it a name. | Inputs: Data, File Name Outputs: None |
| Delete File | The Delete File step allows a user to delete the inputted file. | Inputs: File Outputs: None | |
| Create Text File | The Create Text File step takes a string value and saves a plain text file to the local file system. View documentation for more information. | Inputs: Data, File Name Outputs: None | |
| Directory Exists | The Directory Exists step is a pre-configured rule step that accepts a file path and branches to True or False if the given directory exists and is accessible to Decisions. Note: this step will not detect NAS file paths. | Inputs: Directory Name Outputs: None | |
| List File In Directory | The List File In Directory step will output a string list of all Windows files on the Decisions Server, given a windows directory. For example, given C:\ as an input, it will list out all files that are on that directory. | Inputs: Directory Name Outputs: Output | |
| Load All Files | The Load All Files step takes in the name of a file directory (C:\\...) and loads all of the files in both that directory as well as the files stored in the folders living in that directory. The output is a list of FileData. There is no indication on the list of loaded FileData whether the files are direct children of the supplied directory or nested deeper in the folder tree. | Inputs: Directory Outputs: Output | |
| Load File | The Load File step loads a file into Decisions as a File Data object from a specified file path. By default this will load files from the application server, but a network path can be used to load files remotely as long as the service account running Decisions has access to the network drive. | Inputs: File Name Outputs: Output | |
| Load From File Data | The Load From File Data step can be used to convert FileData into the FileReference type within a workflow. It takes in a single FileData and outputs a single FileReference. | Inputs: File Outputs: Output | |
| Load From Path | The Load From Path step is used to upload a file from a file path. It takes in a file location and outputs that file as a single FileReference. | Inputs: File Path Outputs: Output | |
| Move File | The Move File step is used to move a file from anywhere to anywhere. You will need to use the absolute file path to the file you want to move. For example, C:\Program Files\Decisions\Decisions Services Manager\filename or C:\users\username\filename. In the "Move To" field paste the absolute file path to the destination you want to save your file. To move a file to a shared drive the IP of the server sharing that drive needs to be used and NOT the DNS name. The flow step is not able to resolve the DNS name. The format for the move to input needs to be as follows: \\IPADDRESS\folder\subfolder\ Another factor to consider is make sure that the service account running service host manager has permissions to access that share drive. | Inputs: File Name, Move To Outputs: None | |
| Read Text File | The Read Text File step reads and outputs the contents of a file as plain text. | Inputs: File Name Outputs: Output | |
| Rename File | The Rename File step is used to rename files in a Flow. Users must specify the name of the file and the name they wish to change it to under INPUTS. | Inputs: File Name, New Name Outputs: None | |
| Rename Directory | The Rename Directory step is used to rename a directory within a Flow. A user must specify the directory name and the new name they want to give the directory under INPUTS. | Inputs: Directory Name, New Name Outputs: Output | |
| Create Directory | The Create Directory step creates a directory on the storage file back-end. | Inputs: Directory Name Outputs: None | |
| Rename Directory | The Rename Directory step renames the specified directory with the New Name input. | Inputs: Directory Name (String), New Name (String) Outputs: None | |
| Move Directory | The Move Directory step relocates the specified directory to the desired location via file path. This functions similarly to the Move File step. The Directory Name specifies the directory to move, the Move To input takes in the desired file path, and finally the Overwrite If Exists boolean toggles overwriting the pre-existing directory with the new one if duplicates of the same name exist. | Inputs: Directory Name (String), Move To (String), Overwrite If Exists (Boolean) Outputs: None | |
| Delete Directory | The Delete Directory step deletes the specified directory by taking in the Directory Name input. The Error If Not Empty boolean toggles appearance of an error if the deleted directory populated with data when attempting to delete it to prevent accidental data loss. | Inputs: Directory Name (String), Error If Not Empty (Boolean) Outputs: None | |
| List Sub Directories | The List Sub Directories step lists all sub directories. | Inputs: Directory Name Outputs: Output | |
| Get Last Write Time | The Get Last Write Time takes in the complete file name and uses it to get the last file write time. | Inputs: File Name Outputs: Output | |
| Load and Delete File | The Load and Delete File step loads and deletes a specified file. | Inputs: File Name Outputs: Output | |
| Open Fast File Writer | The Open Fast File Writer step has two additional steps which are Write Line and Close. The main purpose of this step is is to have a quick, asynchronous step that lets a user create and name an open fast file. After that, a user must have a step called Write Line. After using Write Line, a user must use the Close step. Users must always have these three steps in combination. They cannot be used independently. This doesn't bring the full file into memory, and it writes on a different thread. | Inputs: Delete If Exists, File Name Outputs: Output | |
Integration > File > Zip | Add File to Zip | The Add File to Zip step takes in a single file and includes it into the designated zip file. It then outputs the zip file with the new file inside. | Inputs: File To Add (FileData), Zip File (FileData) Outputs: Output (FileData) |
| Create Zip File | The Create Zip File step takes in a single file and a file name and outputs a zipped version of the file under the defined name. | Inputs: File To Add (FileData), Zip File Name (String) Outputs: Output (FileData) | |
| Unzip Files | The Unzip Files step takes in a single zipped folder and outputs an array of files found within that folder. If these outputs need to be converted to FileReference a 'Load From File Data' step can be used to create a FileReference type from FileData | Inputs: Zip File (FileData) Outputs: Output (FileData) | |
| Unzip (Advanced) | The Unzip (Advanced) step take in a single zipped folder as well as its password to output an array of now unzipped files within the folder. If these outputs need to be converted to FileReference, a 'Load From File Data' step can be used to create a FileReference type from FileData | Inputs: Zip File (FileData), Password(String) Outputs: Output | |
| Unzip to Directory | The Unzip to Directory step takes in a single zipped folder as well a directory path. Once it runs, it unzips the folder and places its contents within the designated directory path. | Inputs: Directory Path (String), File Data(FileData) Outputs: None | |
| Zip Array | The Zip Array step takes in list of bytes, zips them, and outputs the new zipped byte folder. | Inputs: Data (Byte[]) Outputs: Output (FileData) | |
| Zip Files | The Zip Files step takes in an array of FileData and outputs a single FileData value. It's important to note that ".zip" will need to be included on the end of the file name in order for a computer to recognize the output as a zipped folder. | Inputs: Files To Include, Name Outputs: Output | |
| Integration > Page Context | Get Page Variable | The Get Page Variable step is used to pass Page parameters into a Flow based on the context of the Page, which is defined in the step properties. | Inputs: None Outputs: None |
| Integration > Portal | Navigate To Folder | The Navigate to Folder step will navigate the current user running a Flow to the defined Folder. It is typically used to navigate users to different Dashboards/Pages. | Inputs: Folder Id, Page Name Outputs: None |
| Open Designer | The Open Designer step opens a specific Designer from within a Flow. The step accomplishes this task via a user designated element Id, which determines which element will be edited, as well as the element type drop down. The step then evaluates the object and defined type and designates the respective Designer that needs to be opened for that specific element. | Inputs: Element Id, Element Type Outputs: None | |
| Open Page Designer | The Open Page Designer step is used to open the Page Designer within a Flow in Decisions. The step accomplishes that by utilizing a user designated page id Input to determine which Page to open up in the Designer. | Inputs: Page Id Outputs: None | |
| Open Text Merge Designer | The Open Text Merge Designer step is used to open the Text Merge Designer within a Flow in Decisions. The step accomplishes that by utilizing a Text Merge Id Input to determine which Text Merge to open. | Inputs: Text Merge Id Outputs: None | |
| Integration > Reporting | Run Report | The Run Report step runs a user-defined Report and outputs the results in the form of a Complex, Data Rows, CSV File, Report Data, Excel, or PDF. This Output type is defined via the Return Data Option dropdown in the Properties tab. | Inputs: None Outputs: Report (FileData) |
| Integration > Scheduling | Check Schedule | The Check Schedule step is a Rule step used to evaluate a date to see if it exists within the confines of a set schedule. The step uses a folder Id Input (String) to source the schedule and the date Time in Question (DateTime) Input to evaluate against the Folder's schedule. The step outputs the results in the form of a True or False response. | Inputs: Date Time In Question (DateTime), Folder Id (String) Outputs: Depends on the Flow |
| Compute Schedule | The Compute Schedule step is used as a means to establish a schedule for an object in Decisions. The object is defined via the folder Id (String) Input, and a from Date and to Date Input (Both DateTime) to establish the schedule. The schedule is then Output in a CalculationResult List format. | Inputs: Folder Id (String), From Date (DateTime), To Date (DateTime) Outputs: Output (List of CalculationResult) | |
| Find Next Start Time | The Find Next Start Time is a scheduling step used to determine the next Start Time in a preconfigured schedule. The step utilizes the folder Id in addition to the user Context Input to determine which object's schedule is evaluated. Using a Build Data mapping on the user Context reveals a number of configurable properties such as the BrowserUserAgent, the ClientEventSessionId, the Session Id, a Boolean to denote whether or not the session is in the Studio Portal, and the DisplayType (such as Silverlight, html, etc...). Then, the step evaluates the folder's schedule against the user defined from Date, and the max Days Input to establish how far in the future to evaluate the schedule. The step outputs Start Time as a DateTime value. | Inputs: Exclude Current Time Slot, Folder Id, From Date, Max Days, User Context Outputs: Output | |
| Find Next Start Time By Timespan | The Find Next Start Time by Time Span is a scheduling step used to determine the next Start Time in a preconfigured schedule within a defined Time Span. The step utilizes the folder Id in addition to the user Context Input to determine which object's schedule is evaluated. Using a Build Data mapping on the user Context reveals a number of configurable properties such as the BrowserUserAgent, the ClientEventSessionId, the Session Id, a Boolean to denote whether or not the session is in the Studio Portal, and the DisplayType (such as Silverlight, html, etc...). Then, the step evaluates the folder's schedule against the user defined from Date, the max Days Input, and time Span Input to check how far in the future to evaluate the schedule, and when it occurs within the time Span (set via Seconds, Minutes, Hours and Days). The step outputs the scheduled time as a DateTime value. | Inputs: Folder Id, From Date, Max Days, Time Span, User Context Outputs: Output | |
| Find Prior Day In Schedule | The Find Prior Day in Schedule step is a scheduling tool used to evaluate a user input folder Id and a date value to evaluate the most recent date in the Schedule that occurred prior to the user Input date. The Prior Day is Output as a DateTime value. | Inputs: Date, Folder Id Outputs: Output | |
| Get Next Time By Schedule | The Get Next Time By Schedule is a scheduling step used to evaluate the next schedule time by checking the date Time in Question Input against a Schedule. The step sources which Schedule to test the date against, from a user input folder Id. The GetNextTimeBySchedule value is Output in a DateTime value.The Get Next Time By Schedule is a scheduling step used to evaluate the next schedule time by checking the date Time in Question Input against a Schedule. The step sources which Schedule to test the date against, from a user input folder Id. The GetNextTimeBySchedule value is Output in a DateTime value. | Inputs: Date Time In Question, Folder Id Outputs: Output | |
| Is In Schedule | This Is In Schedule step is a Rule used to evaluate whether a user Input date value lies within a Scheduled Job's schedule. The step does by utilizing a folder Id Input to determine which Schedule to evaluate, and a date Input to define the date being compared against the schedule. This step returns either a True or False path based on the evaluation. | Inputs: Date, Folder Id Outputs: None |
Was this article helpful?
