Fieldcode Manual

Tip: You can use filters for better results

Inside the Workflow menu you can view all workflows for your account in detail. 
We call the lifecycle of the ticket the workflow. The workflow reflects all possible steps available for a ticket and determines which actions are available. Initially, we provide you with a basic workflow that covers all standard Field Service Management use cases and helps you understand what is going on in every phase of the ticket.

With upcoming Fieldcode Releases, you will be able to fully define workflows on your own.
This will be a huge milestone.

Inside the Admin panel go to Automations → Workflows.

What is a Workflow?

The lifecycle of a ticket is called workflow.

Learn more about workflows here
Worfklows only move horizontally, not vertically

Knowing that workflows only move horizontally back and forth is essential for understanding how workflows work at all. The Workflow path view section lists all the paths in a alphabetical order (think of the file structure of folders on your desktop for a better picture) with all their nested items. It is important to know however that a workflow doesn't follow a path in alphabetical order, it rather starts from a path point from right to left or left to right (horizontally).

Workflow objectIcon nameDescription
ResourceUser related workflow object, is intended for user form types.
InterventionIntervention related workflow object, is intended for intervention form types.
TicketTicket related workflow object, is intended for the ticket form type.
ItemParts related workflow object, is intended for the part form type.
PUDO AppointmentPUDO related workflow object, is intended for PUDO appointment form type.
What is the difference between a node and a path?
  • The node is a point on the whole workflow path -> Basic/InterventionWait/CancelAppointment
  • The workflow path describes all the nodes that were required to reach a particular node -> Basic/InterventionWait/CancelAppointment
  • Basic is a node, InterventionWait is a node, and CancelAppointment is a node of the workflow path: Basic/InterventionWait/CancelAppointment

A workflow nodeis a point on the workflow path (eg. a ticket status) which can be customized in various ways (Coming with later updates).

The InterventionWait node which has the Basic Workflow node as a start point and connects also to the CancelAppointment node.

As mentioned above the workflow always moves horizontally back and forth (never vertically) between workflow nodes.
Understanding this is crucial when it comes to defining oww workflows, which will be feature that is planned to be released in later versions of the Workflow Designer.

Tree view with a horizontally moving workflow.

The workflows menu contains all configured workflows in the first list view and all the particular nodes of a workflow when you click on a particular workflow.

The first thing you see when you open the Workflow menu is all the workflows configured for your account. When you click on a workflow, you open the workflow path and workflow node overview, which shows all the paths your workflow takes and allows you to understand a workflow in detail.
  • Workflow Parameters tab: The parameters tab allows you to set basic options, such as how the currently selected workflows is named, which version of the workflow you are currently watching, the object type of the workflow and eventually a detailed description of the workflow.

  • Validations tab: The validations tab allows you to identify issues with your workflow and helps you to troubleshoot your workflows.

  • Workflow node search: Gives you to the option to search for a specific workflow node by entering a search keyword.

  • View changer: Gives you the option to change between a workflow node tree view and workflow node list view. The Workflow path tree view gives you a better understanding of how a selected workflow can move around by displaying children, siblings etc.

  • Workflow node view: You can check all the workflow paths of a selected workflow, configured settings for each workflow node, workflow node creation dates, workflow node creators, workflow node last edit date and times, and which user last edited a certain workflow node in this section.

  • Validations Checker: This notification gives you a hint of whether your selected workflow is performing flawlessly.

  • Settings tab: The setting tab displays the path of the selected item, allows you to initiate a jump to another node/step, can display the button label, can display the form, and can display the alert. Furthermore, you can check Appearances, Buttons, Automations, Guides, and Actions of a workflow node.

  • Translations tab: The translation tab gives you the option to edit workflow path localizations for different languages. What you can do with it for example, is to add translations for the history tab as when a workflow changes in some way it is always displayed inside the History tab.

  • Audit info tab: The audit info tab summarizes by whom a workflow path was created initially and who last edited it.

  • Workflow name: The name of the selected workflow

  • Version field:The version number of the selected workflow. Workflows can have the same name, but different versioning.

  • Object field: Describes the object type of the selected workflow.

  • Description field: The description of the selected workflow

  • Notification Summary: You can check how many errors and warnings you have in the header.

  • Refresh button: The Refresh button gives you the possibility to refresh the current error list and therefore to re-check your validations.

  • Error/Warning message and description: You can check the error type and the path which may help you to resolve the error/warning. Please check the below error/warning list to find workflow error solutions.

  • Open this node button: Gives you the option to directly jump to the affected node.

Error/WarningExplanationTroubleshooting
AUTODESTINATION_LOOPThe configuration of autodestinations can lead to an endless loop.
CONDITION_LOOPThe configuration of conditional destinations can lead to an endless loop.
INVALID_PATH
ACTUATOR_CONDITIONThe condition to show or not show a button is invalid.Please correct the condition.
JUMP_NODE_CONFIGURATIONDepending on the message several reasons can apply:

- a jump node is not allowed to have any buttons, auto destinations or conditions
- a jump node is not allowed to have child nodes
- a jump node needs to be placed in a jump node context .../jumpNodes/
- a jump node is not allowed to be used beside of buttons (no conditions, no autoDestinations)
  • Search field: Gives you the option to search for specific nodes of the currently selected workflow. When you enter a search term and the result matches, the matching node will be highlighted.

  • View changer: This allows you to switch between a node tree view and a node list view. Inside the node tree view you have the option to zoom in and out or even display the tree view in fullscreen.

  • Node list/Node tree view: Displays all nodes of the selected workflow.

  • Path field: Describes the path the workflow needs to go through to reach this selected node.

  • Jump toggle: You have the option to turn the selected node into a so-called jump node. Jump nodes can skip nodes to reach a destination directly.

  • Button label field: Indicates the button label of the selected node, if there is any.

  • Form field: Indicates the used form for this selected node, if there is any.

  • Alert field: Indicates if the selected node creates an alert.

  • Appearances menu:  You can check all the appearances of a certain node.

  • Buttons menu: You can check all the buttons of a certain node.

  • Open this node button: This button allows you to directly jump to the affected node.

  • Automations menu: You can check all the automations of a certain node.

  • Actions menu: You can check all the actions of a certain node.

  • In the Translations tab, you will soon be able to create and customize translations (currently only view). Soon you will be able to translate individual workflow buttons for different languages or, for example, translate history events.

  • Plus button (currently view only): Gives you the option to add new translations.

  • Trash button (currently view only): Gives you the option to delete individual translations.

  • Inline Edit option: The inline edit option gives you the possibility to edit translations directly, just click inside a translation to edit it.

  • First info: Here you can check when and by whom this node was initially created.

  • Second info: Here you can check who last edited this node.

Was this topic helpful?
5 out of 5 stars

1 rating

5 Stars 100%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
5
How can we further improve this topic?
Please provide the reason for your vote. This will help us improve this topic.
Navigation