Jump to main content

IPFusion Help Set

IPFusion User Guide
Learning and Training
Partner Portal
Support

Home
IPFusion User Guide
Workflows
A Workflow is used to execute a process. This can be a standard operating procedure, automating system actions, and more. There are two types of Workflows: Interactive and Background.
Workflow Blocks
Workflow blocks representations of different actions to take within a process or procedure. This includes actions such as: executing commands, making decisions, displaying items and more.
Start Block
The Start block is where the Workflow begins executing. There can only be one Start block in a Workflow.

IPFusion User Guide
- Getting Started
- Workstations
  Workstations are physical or virtual computers that run an instance of Runtime. Each instance of Runtime must be associated with a single, unique Workstation. They are where the operator monitors and interacts with Runtime.
- Display Layouts
  A Display Layout is the layout that will be shown on a Runtime Workstation monitor. This can contain items such as Maps, controls, Video Viewers, and more. A Workstation can have multiple Display Layouts assigned, and a layout can be used on multiple Workstations.
- Maps
  A Map is a graphical representation of real-world elements. This is commonly a floor plan or a grid containing asset icons. Maps are where you display your Integrated System assets. A project will typically have many Maps. Navigation controls are used to allow the operator to swap between Maps. To add a Map to a Display Layout, you must add a Map Container.
- Drawing Tools
  The Drawing tools can be used in Display Layouts and Maps to add shapes, labels and images. It is recommended to use Drawing tools for items that are expected to change, e.g., labels. The Drawing tools are found in the Drawing pane.
- Integrated Systems
  An integrated system is a plug-in component that allows a third-party subsystem to communicate with Runtime. Items from the systems can be added as assets. When these assets are added via Designer, their states can be monitored and have commands issued to them.
- Alarm Management
  Alarms are used to alert the operator to a potential issue within a facility. For example, a camera that has lost its connection to Runtime. While Designer projects do come with preset Alarm Types, you can add new ones, or change the existing Alarm Types. Creating different alarm types will assist in providing context surrounding an alarm event which is displayed in the Alarm Grid. Alarm postings may then be used to allow only alarms for certain assets to be displayed based on the Workstation.
- Workflows
  A Workflow is used to execute a process. This can be a standard operating procedure, automating system actions, and more. There are two types of Workflows: Interactive and Background.
  - Add New Workflow
    In Designer, you can create Workflows to complete procedures in Runtime. There are two types of Workflows: Interactive and Background.
  - Background Workflows
    When triggered, the processes will not be visual to the operator. These will run in the Background and cannot display elements the same way an Interactive Workflow can. These are best for processes which do not require end-user intervention.
  - Interactive Workflows
    A step-by-step process that, when triggered, is displayed to the operator. This can be used to walk an operator through a scenario, provide them visual information, and to receive their input to determine what to do.
  - Triggering Item
    The Triggering Item is used in Workflows to determine what will Trigger its start. It is configured within the Start block.
  - Workflow Commands
    Commands are actions that can be performed on an Object. They can be executed in a Workflow by using an Action block.
  - Enable/Disable a Workflow
    You may have a Workflow created which is not ready to be executed on your Runtime Workstations. You can disable the Workflow, then Enable it later.
  - Assign a Workflow
    Workflows can be selectively assigned to Workstations. A Workflow can only be run on Workstations it is assigned to. Therefore, if it has no assigned Workstations, it will not run.
  - Single Execution Workflows
    Workflows by default run on all active Workstations. A Background Workflow allows it to be run on a single Workstation when triggered — however, it can be triggered by any Workstation it is assigned to. The active Workstations communicate to determine which one will run the Workflow.
  - Edit a Workflow
    You can edit a Workflow after its initial creation. This can be to fix an issue, or update its functionality.
  - Import/Export Workflows
    Workflows can be exported and later imported to other projects. This assists in quickly configuring similar Workflows between multiple projects. Below are the properties which are included in the export.
  - Set Workflow Display Style
    Interactive Workflows can present steps for operators in different ways. For example, you may want to display some information to an operator prior to having them make a decision. You can have the Workflow display both the current and next step. This way they know they will need to make a decision based on the information displayed.
  - Workflow Execution Priority
    Certain Interactive Workflows may execute more critical procedures than others. To ensure those are brought to the Runtime operators attention sooner, the execution priority of the Workflow may be configured.
  - Preview an Interactive Workflow
    An Interactive Workflow can be previewed in Designer. This allows you to see how your Workflow will appear when executed in Runtime.
  - Workflow Blocks
    Workflow blocks representations of different actions to take within a process or procedure. This includes actions such as: executing commands, making decisions, displaying items and more.
    - Start Block
      The Start block is where the Workflow begins executing. There can only be one Start block in a Workflow.
    - Action Block
      The Action block is used to issue a Command. This can be on an Object within the Action Browser, or an integrated system.
    - Execute Workflow Block
      The Execute Workflow block allows you to trigger an Interactive Workflow before exiting another Interactive Workflow.
    - Decision Block
      The Decision block prompts an operator in Runtime to make a choice. An unlimited number of decision paths can be created, however there must be at least one choice available.
    - Display Block
      The Display block is used to show the operator text or an image in Runtime. This is used to prompt the operator with information — e.g., a warning before a command is executed.
    - File Block
      The File block is used to display a PDF file to an operator in Runtime. For example, a workplace policy or procedure.
    - Email Block
      The Email block sends an e-mail to a specified address. This is used to send e-mail notifications to a recipient. For example, you may want to notify maintenance staff when a camera is unable to connect to Runtime.
    - Get Block
      The Get block sends an HTTP GET request to a server. A GET request sends data within the URL for where the information is being sent to.
    - Logic Block
      The Logic block available in Workflows allows for two potential continuation paths. The paths are each dependent on what the expression entered into the Logic block evaluates to: true or false. The Workflow will then continue running, following the appropriate path.
    - Loop Block
      The Loop Workflow block is used to repeat a section of a Workflow a predefined number of times. This can be useful when the same operation needs to be completed multiple times. You can use a Loop, rather than having to recreate the same section of your Workflow over and over.
    - Post Block
      The Post block is used to send an HTTP POST request in a Workflow. A POST request is a method of sending information to a web server. The data is enclosed within the request.
    - Save and Load State Blocks
      The Save and Load State blocks are used to keep track of Runtime States.
    - Set Variable Block
      Variables are used to store data within a Workflow, and can be accessed within other Workflow blocks. The Set Variable block is used to change the value of a variable. This allows the value to change from the initial one.
    - Shell Command Block
      The Shell Command block is used to execute a Windows command. This is used to complete batch processes in Windows. For example, launching an external application.
    - Switch and Case Blocks
      The Switch and Case blocks are used together to make a decision on what path to take in a Workflow. They execute a sequence of blocks if a logical expression matches one of the specified cases. If no case matches, a default path is used.
    - Timer Block
      The Timer block is used to delay the continuation of a Workflow by a user-defined number of seconds.
    - Stop Block
      The Stop block is the end of the Workflow execution path. There can be multiple within a single Workflow. This block can not, however, be directly connected to a Start block. There is no extra configuration to be completed for the Stop block.
  - Logic Editor
    The Logic Editor allows for the configuration of logical expressions within Workflows.
  - Workflow Cancel Button
    Interactive Workflows have a Cancel Button. They determine how the Workflow handles being Cancelled.
  - Set Action on Preempt
    Interactive Workflows are assigned an Action on Preempt. This determines how and when it is executed in the queue.
  - Workflow Statuses
    A Workflow can be in any of the below statuses when running. These will be shown in the Active Workflow Banner.
- Version Control
  Version Control allows you to create a repository to track changes to your projects. This is useful for if you need to roll back to a previous version, or to keep track of changes when multiple people are working on the project.
- Runtime
  Runtime is where projects created in Designer are run. It connects with integrated systems, runs Workflows, manages alarms, etc. A graphical Runtime can be interacted with by an operator on a Workstation. It can also be run as a service instead.
- Language Manager
  The Language Manager allows the addition and editing of the text displayed in Runtime. This allows a user to set multiple languages on a project for multilingual operators and localize international projects.
- Security Manager
  Access to IPFusion can be restricted for users and groups. IPFusion can either use the existing users and groups from Active Directory, or you can create your own in Designer.
- Logging and Reporting
  The Logging and Reporting application allows the logging and generation of data about activities in the software. Using this application, system events and user actions can be monitored and archived.
- Simulation Client
  Simulation mode is a way to test your design before going live on Runtime. With the Simulation Client you can change the status of assets, trigger Workflows, create command associations for statuses, and view how it behaves. Simulation allows you to test your configuration without having to connect to real devices.
- OPC Tag Database Manager
  The OPC Tag Database creates a connection to OPC devices using tags — the representation of the OPC variable or datapoint. It provides OPC client functionality for Runtime. This includes the querying of states and execution of commands either locally or remotely.
- API
  Enable external programs and users to connect to the IPFusion event stream and send commands to IPFusion Objects.
- Debug Tools
  The Debug Tools are used to assist in troubleshooting issues with your project. It can connect to Designer, Runtime, and running drivers. The Debug Tools display all logging and debugging messages as you work in the project.
- VideoFusion
  The VideoFusion application is used either with Runtime or on its own to display video. VideoFusion can only display video from one of its video providers. This includes Avigilon, Genetec, and Milestone video sources.
- Best Practices
  Below are topics which include information for best practices when creating projects.
- Glossary

Start Block

The Start block is where the Workflow begins executing. There can only be one Start block in a Workflow.

The Start block can be configured by setting your Workflow triggers.

IPFusion User Guide