Best practices for designing workflows

These recommendations align with the standards and guidelines that our internal support team and service partners follow when building workflows with Rewst. Leverage the same principles that guide our experts, enhancing the efficiency, reliability, and maintainability of your automation. Any workflow built by the Rewst Agent will automatically follow these best practices.

Design principles

When designing workflows, keep these three guiding principles in mind.

1. Simplicity: Create workflows that are user-friendly and easy to understand.

2. Modularity: Break down workflows into smaller, reusable components.

3. Maintainability: Build workflows that are straightforward to update and maintain.

Automation build standards

A good workflow should meet all of these requirements.

• Consistency: Standardized practices lead to a consistent experience across different workflows.

• Quality assurance: Adhering to standards makes quality checks more efficient.

• Reusability: Modular design enables the reuse of components, speeding up development.

• Scalability: Design your workflows to handle increased complexity as your needs grow.

• Efficiency: Avoid redundancy by following a standardized approach.

• Knowledge Transfer: Standards foster collaboration and knowledge sharing within your team.

• Flexibility: Rewst's standards allow easy integration of new features without major rework.

Design, test, and document workflows

• Develop and test your workflows in a sandbox or development environment. Make necessary changes, test, and sync to your live environment. Always test a workflow before publishing.

  • Mock mode in Rewst executions is also a great, safe way to see what your workflow will do without the commitment.

• Document workflows manually or with the Rewst Agent to keep track of the intent of each action and called workflow.

• When publishing a workflow, document the changes made in that update to help with version control of your workflow.

Workflow naming and categorization

Properly naming and categorizing your workflows is essential for clarity and navigation, especially as the number of workflows you use in Rewst grows over time.

Adhering to a consistent naming convention helps in understanding the purpose and function of each automation.

Proper example: List Disabled User Accounts

Improper example: Steve's Workflow

You can also use tags within Rewst to organize your automations effectively.

Manage variables and tasks

Stay consistent with your styling when naming variables. Choose a naming convention, for example snake_case or camelCase, and apply it uniformly.

Organization variables

• Employ descriptive and straightforward wording using snake_case for clarity.

• Prefix integration-specific variables appropriately, like psa_ for PSA-related variables.

Work with transitions

For more on transitions, see our documentation here.

• Use conditions like {{ SUCCEEDED and CTX.list_of_things|d }} to control the flow based on a node's success or failure.

• Transitions are evaluated from left to right, so order them carefully.