Questions?
Call us:

1.888.684.2256

Contact UsBIG arrow

Online Documentation: Configuration

Flow Definition Form / Dialog

All information for a Flow Definition can be configured on the Flow Definition Dialog. The figure below shows a screen shot for this Dialog. Below this screen shot the different entries and sections will be discussed:

Dialog for the Flow Definition

The form consists of a number of sections:

The Header section show general information and the 'Main' action button (Prev - Next). When the Flow Definition is just created the window title will not be updated, this will happen the next time you open the form.

  • Status and creation information

    Peding state for the Flow Definition Active state for the Flow Definition Closed state for the Flow Definition
    This section in the upper left corner, shows when and by whom the Flow Definition was created. The state and the icon show the current State of the Flow Definition.

  • Next - Previous

    Press this button to move the Flow Definition to the Next State (Pending -> Active -> Closed) Press this button to move the Flow Definition to the Next State (Closed -> Active -> Pending)
    The state of the Step Definition can be changed by pressing the 'Next' button in the upper right corner. At the moment the Step Definition can move back, a Previous button will be shown as well. The sequence of states for a Step Definition: Pending -> Active -> Closed.

Left Control Buttons

Buttons to perform actions on the current Flow Definition

  • Refresh:

    Press this button to update the information in the Flow Definition Form
    Will query the data for this Flow Definition from the server. Press this button if you think the information shown in the form is not up to date.

  • Clone:

    Press this button to Clone, by using the Current Flow Definition information to create a new Flow Definition
    Will create a new Flow Definition using the information of this Step Definition. Note: Do not use 'Clone' if you would like to make a new revision for this Flow Definition. Use the Revs tab instead. (see below)

  • Recalc:

    Press this button to recalculate the Flow Definition to determine the valid Input-Output Combinations
    Will recalculate the Flow Definition input - output combination based on the information configured on the Inputs / Outputs tab of the Step Definitions that are used to make up this total Flow.

  • Delete:

    Press this button to delete the Flow Definition Press this button to undelete the Flow Definition
    Will move the Flow Definition to the Deleted State. Only the System Admin has the rights to undelete the Flow Definition. A Flow Definition can only be deleted when the Flow Definition is Pending.

Flow Definition Form - General Tab

The General (Home) Tab is the default tab and the form opens with this tab on top.

The Name, Flow Number, Revision, 'Flow Definition Type', 'Part / Equipment State when Active', and 'Part / Equipment State when Done' are Required Fields. These fields have to be filled out before the Flow Definition can move to the Active State.

The combination of the Flow Number and the Revision should be unique, if another Flow Definition exists with the same Flow Number and Revision, the Flow Definition cannot move to the Active State.

Fields on the General Tab:

  • Name:

    A descriptive name for the Flow, this name will show up in other listboxes and in some cases the Name is combined with the Flow Number and the Revision into a single string.

  • Flow Number: (Required Data)

    A number for the flow. In case you don't have a numbering system for the flow just start with e.g. FD01. It is no problem to change these later on, it will not affect the design of the flows.

  • Revision: (Required Data)

    In case you are not using Revision Control, you still need to fill out a value and the combination of the Flow Number with the revision has to be unique.

  • Flow Definition Type (Required Data)

    The Flow Definition Type is used to determine the main purpose of the flow.

    • Consume Part: This flow Type will create a new Part Record and consume the input Part Record. This type of flow is rarely used.
    • Make Equipment: Use this type to create new Equipment Records
    • Make Part: This flow does not require an existing input Part Record. The Part Records are created during the first step of the flow.
    • Use Equipment: This flow type is used for running equipment or to perform Preventive Maintenance on Equipment.
    • Use Part: This flow will have to pick an existing input Part Record.
  • Part / Equipment State when Active: (Required Data)

    This determines the State of the Parts on the Travelers (that are based on this Flow Definition) that are still active.

  • Part / Equipment State when Done:

    This determines the State of the Parts on the Travelers when the Traveler finished its last Step (The state of the Traveler will be 'Closed').

  • Calc DateTime

    This is the last time this Flow Definition was Calculated for the valid Input - Output combinations. Pressing the Recalc button will do the Calculation now.

  • Calc Messages:

    Any Warnings or Error messages that came up during the calculation of the Flow Definition will show up in this text area. The calculation happens when the Recalc button is pressed, or when the Flow Definition moves to the Active state.

  • Input -> Outputs:

    All possible Input - Output combinations for this Flow Definition. ANY -> ANY means that this Flow Definition will accept any Part Defintion and will move the Part Record based on this Part Definition through this flow without changing the Part Definition.

Flow Definition Form - Advanced Tab

The advanced tab will give you access to Flow Definition Attributes that are not required. The default setting for these parameters are in most cases the correct values.

  • Part Qty Limit:

    Will allow a maximum limit for the number of Part Records that can be added to a Flow Record.

  • Category:

    Different categories can be used. The categories can be configured on the Settings Desktop.

  • Close Form?:

    This setting will determine if the Traveler Forms that are based on this Flow Definition will close after any of the steps is signed off.

  • Flow Creates Parts: (Required Data)

    This setting will determine if the Travelers, that are based on this Flow Definition, create or grab parts on the first step for this flow. If the checkmark is checked, new Part Records are created when the Traveler based on the Flow Definition starts.

  • Flow Consumes Input:

    When this check mark is checked, the input Part Record will be consumed by a newly created Part Record. Both Part Records will have the same Part Defintion. To change the Part Definition of the newly created part, use an Input - Output Conversion.

Other Tabs

The Flow Definition form has the following tabs besides the General Tab and the Advanced Tab: