Nintex Workflow for SharePoint On Premise Best Practices

Topic

Many issues with workflows can be resolved by apply and adhering to best practices for workflow design.

 

Instructions

These are some best practices to utilize when building workflows and investigating issues.

Action Count
If the workflow has over 150 actions, the workflow may need to be split into several workflows to improve stability at run time.

https://community.nintex.com/community/build-your-own/blog/2014/12/02/defensive-workflow-design-part...


Workflow Size
If workflow size is over the recommended size of 500KB it is recommended to split up the workflow. Workflows above 500KB will often take extensive periods of time to process, and will often lead to stability issues with the workflow at run time.
https://community.nintex.com/community/build-your-own/blog/2014/12/02/defensive-workflow-design-part...


Batching Check
It is recommended when using actions such as "Update Item", "Create Item", "Set Item Permissions" and "Set Field Value" that a "Commit Pending Changes" action be added directly after the action to ensure that the workflow batches as expected.
https://community.nintex.com/t5/Best-Practices/Commit-Pending-Changes-In-Workflow-Design/ta-p/90426


Progress Data Logged in Loop
When using loops, it is recommended to avoid using a "Log to history" action inside the loop, as this can result in a massive number of entries being added to the workflow history list, which can negatively impact overall workflow performance.
https://community.nintex.com/community/build-your-own/blog/2014/10/13/defensive-workflow-design-part...


Parallel Action
Heavy use of parallel branches (10+ parallel actions) can cause issues depending on the complexity of branch logic. Consider using a serial process to execute the actions instead of doing them in parallel.


Recursive Workflow
If the workflow has a recursive condition meaning that it will run, and actually set the triggers to run the workflow again, trying to create an infinite loop. Review your conditions for workflow and make sure there are none that will try to trigger the workflow.


State Machine
Ensure that all branches of a State Machine have a "Switch State" action, even if the workflow needs to end.

Instead of using an "End Workflow" inside the State Machine, have the State Machine set a variable 'EndWorkflow' to true, then switch states to "End State Machine".  And then use "Run If" action that checks if 'EndWorkflow' is true then "End Workflow" action will be executed.
https://community.nintex.com/t5/Nintex-for-SharePoint-Forum/Using-State-Machine-Workflows/td-p/85143

 

Stored Credentials
Check to see if workflow contains hard-coded credentials that are in plain text, to secure these credentials please see how to use Workflow Constants.

 

Timing Check
If the workflow is triggered on the event receiver, it is recommended the first action be a "Pause For..." action. This will help avoid race condition errors.
https://community.nintex.com/community/build-your-own/blog/2015/03/02/defensive-workflow-design-part...

 

Nintex Version Check
If you are currently running an older version of Nintex. We recommend upgrading to the latest version when possible to address bugs and implement new features.
https://help.nintex.com/en-US/platform/ReleaseNotes.htm

 

Workflow Access to Lists/Libraries
Ensure that the workflow initiator has access to all lists/libraries that the workflow will interact with. This interaction may occur through actions such as "Query List", "Create Item", "Update Item" and "Delete Item".
Check Workflow History List and Task list that is used by the workflow. If they are large lists and/or contain a lot of columns it may result in issues where data is not pulled correctly.

 

 

Additional Information

 

 

Related Links

 

 

Version history
Revision #:
1 of 1
Last update:
‎04-14-2021 07:32 AM
Updated by:
 
Contributors