Jump to main content

IPFusion Help Set

User Guide
Partner Portal
Support

Home
User Guide
Drawing Tools
Shapes can be used in Display Layouts and Maps to add shapes, labels and images. It is recommended to use Shapes for items that are expected to change, e.g., labels.

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.
- Legends
  A Legend is a visual key that explains icons and colors representing system statuses. It consists of a canvas displaying status icons. Each Integrated System has associated status icons in the Legend that represent its range of possible statuses. Legends are especially useful when displayed alongside alarms in Runtime, as they make it easier for users to understand the meaning of the colors and symbols. It is also possible to move the Legend across all Display Layout screens in Runtime.
- Drawing Tools
  Shapes can be used in Display Layouts and Maps to add shapes, labels and images. It is recommended to use Shapes for items that are expected to change, e.g., labels.
  - Common Shapes
    A user can add a Rectangle, Ellipse, Polygon, or Line to a Display Layout or Map.
  - Polyline
    If a user requires a shape that is not already provided, they can create a custom shape as a Polyline.
  - Add a Label
    A Label can be added to a Display layout, Legend, or Map. These can be used to accompany assets, controls, or areas of a Map or Legend.
  - Add an Image
    Images can be added to a Map or Display Layout. This can be used to represent a real-world element, display a corporate logo, or to be used as a design element.
  - Grid
    To aid in the positioning of objects on a Map, Display Layout or Workflow, IPFusion has a Grid overlay that can be turned on or off.
  - Lock the Position of Icons on a Map
    When a Map or Display Layout has crowded or stacked objects, locking the positions of icons on a map helps declutter the space. This assists in preventing the accidental selection of the wrong object.
  - Color Picker
    Panel Items and Shapes can be filled with a solid color, no color, or a linear or radial gradient. The color picking tool is found in the Properties panel of any highlighted graphical object under Appearance.
  - Shape Visibility
    You may want a shape to appear/disappear in Runtime. You can make the shape either visible or invisible as needed. For example, a Label indicating that a room is in use.
  - Shape Set Fill
    The Fill state determines whether the shape is visually filled and can be interactive or respond to a trigger. You can choose a color using the Fill Color picker or set it to transparent. Even with a transparent fill, the shape remains interactive if Enable Fill is checked. Shapes which can have this property modified include the Rectangle, Ellipse, Polyline, and Polygon.
  - Shape Fill Color
    The color used to fill a shape can be configured in Designer, then later changed during Runtime using Workflows. This can be used to convey information visually to a Runtime operator. Shapes which can have this property changed are the: Rectangle, Ellipse, Polyline, and Label.
  - Line Color
    The line color for shapes can be set in Designer and changed in Runtime using Workflows. This can be used to visually communicate information to the Runtime operator. The line color can be changed on these shapes: ellipse, line, polygon, polyline, and rectangle.
  - Line Style
    The appearance of lines and shapes outlines can be set in Designer. The line can be either solid, dashed, or dotted. This can be useful for differentiating the purpose of different shapes. The line style can be changed on these shapes: ellipse, line, polygon, polyline, and rectangle.
  - Line Thickness
    The thickness of the lines on shapes can be configured in Designer and changed in Runtime. This change of appearance can be used to indicate visual information to a Runtime operator. This can be changed for these shapes: ellipse, line, polygon, polyline, and rectangle.
  - Shape Image
    The image used in an image drawing object can be configured in Designer, then later changed during Runtime using Workflows. This can be used to convey information visually to a Runtime operator.
  - Label Text
    The text value for a label can be set in Designer and changed in Runtime using Workflows. This can be used to display messages to the Runtime operator.
  - Label Text Color
    The text color on a label can be configured in Designer, then changed later in Runtime using Workflows. This can be changed to provide visual information to a user. For example, it may change depending on the importance of the message currently displayed.
  - Using Shapes in Workflows
    Display Layout Shapes can also be used to either trigger an Action or Workflow.
- 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.
- Collections
  Collections give users the ability to group items in a project together. This feature simplifies the configuration required and makes it easier to do edits in the future. Many different types of groups can be created. Users can create custom Collections in the Collections menu located under the Home tab. When a Collection is created, it is accessible in the Asset Selection Browser, via Workflow Commands. This Collection can be defined once and used to perform actions in multiple places. Any updates or changes to that Collection only need to be made in one location, making the process more efficient and easier to manage. Additionally, Collections will dynamically update without the user needing to take additional action.
- 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. Rules may then be used to allow only alarms for certain assets to be displayed based on the Workstation.
- Rules
  Rules provide a framework for controlling asset and Map visibility, selection, and alarm behavior across Workstations. Users can create custom Rules in the Rules menu located under the Home tab, and Rules can also be modified through Workflows. These Rules can then be applied to either All, None, or a Custom selection of Maps or assets. However, if an asset or Map is included in one or more Rules with contradicting scopes, Allow takes precedence for all Rule types.
- 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.
- Variables
  A Variable is used to save information to be used later. There are three types of variables: Global, Workstation, and Workflow Variables.
- 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
  Security enables you to create login requirements for access to Runtime and 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.
- Best Practices
  Below are topics which include information for best practices when creating projects.
- Glossary

Shapes

Shapes can be used in Display Layouts and Maps to add shapes, labels and images. It is recommended to use Shapes for items that are expected to change, e.g., labels.

Location of drawing tools area in Designer

Common Shapes
A user can add a Rectangle, Ellipse, Polygon, or Line to a Display Layout or Map.
Polyline
If a user requires a shape that is not already provided, they can create a custom shape as a Polyline.
Add a Label
A Label can be added to a Display layout, Legend, or Map. These can be used to accompany assets, controls, or areas of a Map or Legend.
Add an Image
Images can be added to a Map or Display Layout. This can be used to represent a real-world element, display a corporate logo, or to be used as a design element.
Grid
To aid in the positioning of objects on a Map, Display Layout or Workflow, IPFusion has a Grid overlay that can be turned on or off.
Lock the Position of Icons on a Map
When a Map or Display Layout has crowded or stacked objects, locking the positions of icons on a map helps declutter the space. This assists in preventing the accidental selection of the wrong object.
Color Picker
Panel Items and Shapes can be filled with a solid color, no color, or a linear or radial gradient. The color picking tool is found in the Properties panel of any highlighted graphical object under Appearance.
Shape Visibility
You may want a shape to appear/disappear in Runtime. You can make the shape either visible or invisible as needed. For example, a Label indicating that a room is in use.
Shape Set Fill
The Fill state determines whether the shape is visually filled and can be interactive or respond to a trigger. You can choose a color using the Fill Color picker or set it to transparent. Even with a transparent fill, the shape remains interactive if Enable Fill is checked. Shapes which can have this property modified include the Rectangle, Ellipse, Polyline, and Polygon.
Shape Fill Color
The color used to fill a shape can be configured in Designer, then later changed during Runtime using Workflows. This can be used to convey information visually to a Runtime operator. Shapes which can have this property changed are the: Rectangle, Ellipse, Polyline, and Label.
Line Color
The line color for shapes can be set in Designer and changed in Runtime using Workflows. This can be used to visually communicate information to the Runtime operator. The line color can be changed on these shapes: ellipse, line, polygon, polyline, and rectangle.
Line Style
The appearance of lines and shapes outlines can be set in Designer. The line can be either solid, dashed, or dotted. This can be useful for differentiating the purpose of different shapes. The line style can be changed on these shapes: ellipse, line, polygon, polyline, and rectangle.
Line Thickness
The thickness of the lines on shapes can be configured in Designer and changed in Runtime. This change of appearance can be used to indicate visual information to a Runtime operator. This can be changed for these shapes: ellipse, line, polygon, polyline, and rectangle.
Shape Image
The image used in an image drawing object can be configured in Designer, then later changed during Runtime using Workflows. This can be used to convey information visually to a Runtime operator.
Label Text
The text value for a label can be set in Designer and changed in Runtime using Workflows. This can be used to display messages to the Runtime operator.
Label Text Color
The text color on a label can be configured in Designer, then changed later in Runtime using Workflows. This can be changed to provide visual information to a user. For example, it may change depending on the importance of the message currently displayed.
Using Shapes in Workflows
Display Layout Shapes can also be used to either trigger an Action or Workflow.

IPFusion User Guide