clsInstantiateFromFile Step

Use this step to instantiate process instance from a file

Last published at: January 2nd, 2024


This step instantiates from a file, instantiates a process instance for every single row of the data file.



  • filePath--Path to csv or xls file
  • passGlobals—Pass Globals to Instance
  • passVariables—Pass Variables to Instance
  • colMappings--Column mappings      
  • firstRowHeadings--First row has headings
  • definitionID--Select definition
  • executionPriority - Select execution priority



  • True – step executed successfully
  • False - step failed to execute






Let’s build and execute the clsInstantiateFromFileDef example.        

  • Create a new definition called “clsinstantiatefromfileDef”
  • Select the definition and click the “design” button
  • Drag a "clsInstantiateFromFile" step to the canvas
  • Connect the dots between the start and "clsInstantiateFromFile" step
  • Click on the "clsInstantiateFromFile" step to configure its "Settings" properties. Provide a name for the step. Provide the path to CSV or XLS file which contains few row items to instantiate the process by # of times. Click on the button to complete the column mappings. Select the process definition from the drop down list to instantiate. 
  • Click on the button to complete the column mappings. Provide the process variable/global reference and mention the column position in the CSV or XLS file to map. The column indexes are indentified from left to right by  
  • Click on the "clsInstantiateFromFile" step to configure its "Advanced" properties. Select YES to identify the first row of the file as headings. Select YES if the workflow is passing variables or globals to the instance. Select the execution priority in the drop down list. 
  • The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is acheived by configuring the step state and percent fields individually as shown in the images below. Configure the “Logging” using the following properties. 
  • Save the process definition, create a new process instance and execute. The process step should instantiate instance, for each row in the CSV or XLS file, using the selected process definition, as configured.