Jump to main content

IPFusion Help Set

IPFusion User Guide
Learning and Training
Partner Portal
Support

Home
IPFusion User Guide
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.
Heartbeat
Runtime uses regular check-in intervals with Workstations, Data Servers, and to check their status. These messages can be viewed within the Debug Tools client.

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.
- 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.
  - Manage Debug Tools Connections
    To view the logging and debug messages from IPFusion or a driver, you must first connect to the Workstation it is running on.
  - Data Columns
    The columns listed below are available to view information from in the Debug Tools live data area.
  - Filter Live Data
    In Debug Tools, you can filter out data which you do not want to see. This can be done by adding filters, formatting rules, and searching for specific text strings.
  - Customizing Live Data Layout
    In Debug Tools, the live data area can be customized to include row lines, additional data columns, log count summaries, and group similar data together.
  - Export Debug Tools Logs
    The logs in Debug Tools can be exported as a file. This creates a record of the logs being viewed.
  - Heartbeat
    Runtime uses regular check-in intervals with Workstations, Data Servers, and to check their status. These messages can be viewed within the Debug Tools client.
    - Data Server Heartbeat
      The heartbeat for a Data Server is used to confirm its status to Runtime.
    - Workstation Heartbeat
      The heartbeat for a Workstation is used to confirm its status with Runtime.
- 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

Heartbeat

Runtime uses regular check-in intervals with Workstations, Data Servers, and to check their status. These messages can be viewed within the Debug Tools client.

Data Server Heartbeat
The heartbeat for a Data Server is used to confirm its status to Runtime.
Workstation Heartbeat
The heartbeat for a Workstation is used to confirm its status with Runtime.

IPFusion User Guide