Setup Process Folder And Run Flow
  • 30 Jan 2023
  • 3 Minutes to read
  • Dark
    Light

Setup Process Folder And Run Flow

  • Dark
    Light

Article Summary

Step Details

Introduced in Version4.0.0
Last Modified in Version5.12.0
LocationProcess

The Setup Process Folder And Run Flow step will create a Process Folder and allow the user to pick or define the logic of a Flow that will run when the Process Folder is created.  


Properties

Settings

PropertyDescriptionData Type
PICK OR CREATE FLOWIDAllows a user to pick or create a Process Folder Data Aware Flow---
ThreadJobNameAllows user to define the Thread Job name---
ThreadsAllows a user to define the number of Threads---

Parent Folder

PropertyDescriptionData Type
SourceThis drop-down list offers different places where the parent Folder can be sourced.---
Parent FolderThis section is defined when the Specify Source option is selected. Click Pick to select the appropriate folder to store all the other Process Folders created. It is best practice to create a separate folder so that Process Folders do not crowd up any managed Designer Elements.---

Process Folder

PropertyDescriptionData Type
Make UniqueAdds a unique identification scheme to the Process Folder. There are options to use numeric, appended numeric, and date/time-based identifiers.
---
Flow Prefix LengthDetermines the length of the numeric ID that is generated after the prefix.
Int32
Include Flow Run Id in NameThis checkbox can be selected for the Name of the Process Folder and the Flow Output, but the function is the same. When the box is checked, the Prefix/ID that was defined will appear next to the Folder Name in the Parent Folder/Flow Output Data. It is recommended that this remains enabled to avoid confusion when reviewing Processes.
Boolean
Include Flow Run Id in Flow OutputBoolean
Use Extension DataEnable this checkbox if a Flow Execution Data Structure needs to be used to record and define various pieces of data. Learn more about the Flow Execution Extension Data Type.
Boolean

Extension Data TypeChoose the Extension Data Type.---
Auto Complete if State Not SetThis checkbox is enabled so that if the process reaches a State that is not yet defined, that State will auto-complete.
Boolean

Inputs

PropertyDescriptionData Type
Anticipated Flow TimeSets the anticipated end DateTime in the flow_tracking_folder_data table
TImeSpan
Expected States of FlowExpected states that the Process Folder will go throughList of String
Extension DataChange the Extension Data input to Build Data. New child inputs appear, including all data fields created for the Flow Execution Extension
---
Flow PrefixInserts a prefix before the numeric ID is generated. The Flow Prefix must be unique; a duplicate Flow Prefix in a Flow will result in a validation error.String
Folder DescriptionThe Folder Description will appear in the Process Folder's Properties when the Process Folder is selected as a line item within the Parent Folder.
String
Folder NameThe Folder Name will appear after the prefix/Id.
String
Folder Type NameThe Folder Type Name displays in the Parent Folder in the Type Column.String

Outputs

PropertyDescriptionData Type
Process Folder IdOutputs the Process Folder IdString

Example Inputs and Outputs

Flow PrefixFolder DescriptionFolder NameOutput
WFSampleExample08daf7fe-88fc-7b6d-1f24-2216a00b93a6
XFNullData For Sales08da6f2e-eafc-755c-1f24-2223a4075e85
NullEmptyNullEXCEPTION MESSAGE
NullFolder for EventEmptyEXCEPTION MESSAGE


Common Errors

Value cannot be null

If the Flow is null or empty, an error may occur.

To correct this, ensure that the Flow is configured.

Exception Message:

Exception Stack Trace: DecisionsFramework.Design.Flow.ErrorRunningFlowStep: Error running step Setup Process Folder And Run Flow 1[SetupProcessFolderAndRunFlow] in flow [Flow 1]: Value cannot be null. (Parameter 'key')
 ---> System.ArgumentNullException: Value cannot be null. (Parameter 'key'
 at System.ThrowHelper.ThrowArgumentNullException(String name
 at System.Collections.Concurrent.ConcurrentDictionary`2.TryGetValue(TKey key, TValue& value
 at DecisionsFramework.Data.Caching.Implementations.MemoryCacheImpl`1.DoGet(String id
 at DecisionsFramework.Data.Caching.Interface.BaseCacheImpl`1.Get(Type type, String id
 at DecisionsFramework.Data.Caching.Interface.BaseCacheImpl`1.Get(String id
 at DecisionsFramework.Design.Flow.FlowEngine.GetFlowFromCache(String flowId
 at DecisionsFramework.Design.Flow.FlowEngine.GetFlow(String flowID
 at DecisionsFramework.Design.Flow.PrimaryFlowTrackingData..ctor(String flowId, String flowTrackingRunId
 at DecisionsFramework.Design.Flow.CoreSteps.StandardSteps.SetupProcessFolderAndRunFlow.Run(StepStartData data
 at DecisionsFramework.Design.Flow.FlowStep.RunStepInternal(String flowTrackingID, String stepTrackingID, KeyValuePairDataStructure[] stepRunDataValues, AbstractFlowTrackingData trackingData
 at DecisionsFramework.Design.Flow.FlowStep.Start(String flowTrackingID, String stepTrackingID, FlowStateData data, AbstractFlowTrackingData trackingData, RunningStepData currentStepData)
   --- End of inner exception stack trace ---

Folder name cannot be empty

If the Folder name is null or empty, an error may occur.

To correct this, ensure that a value is entered for the Folder Name input. 

Exception Message:

Exception Stack Trace: DecisionsFramework.Design.Flow.ErrorRunningFlowStep: Error running step Setup Process Folder And Run Flow 1[SetupProcessFolderAndRunFlow] in flow [Flow 1]: folder name cannot be empty
 ---> DecisionsFramework.LoggedException: folder name cannot be empty 
at DecisionsFramework.Design.Flow.CoreSteps.StandardSteps.SetupProcessFolder.GetNewFolderName(StepStartData data, String flowRunName
 at DecisionsFramework.Design.Flow.CoreSteps.StandardSteps.SetupProcessFolder.DoSetupProcessFolder(StepStartData data, AbstractFlowTrackingData trackingData, SystemUserContext context
 at DecisionsFramework.Design.Flow.CoreSteps.StandardSteps.SetupProcessFolderAndRunFlow.Run(StepStartData data
 at DecisionsFramework.Design.Flow.FlowStep.RunStepInternal(String flowTrackingID, String stepTrackingID, KeyValuePairDataStructure[] stepRunDataValues, AbstractFlowTrackingData trackingData
 at DecisionsFramework.Design.Flow.FlowStep.Start(String flowTrackingID, String stepTrackingID, FlowStateData data, AbstractFlowTrackingData trackingData, RunningStepData currentStepData)
   --- End of inner exception stack trace ---

Was this article helpful?