Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.


HTML
<style>
.text-span-6 {
    background-image: linear-gradient(99deg, rgba(170, 163, 239, .5), rgba(125, 203, 207, .5));
    border-radius: 50px;
    padding-left: 15px;
    padding-right: 15px;
}

#title-text {
display: none;
}

.panelgradient {
    background-image: linear-gradient(180deg, #d5def0, whitesmoke);
    border-radius: 8px;
    flex-direction: column;
    justify-content: center;
    align-items: center;
    padding: 4rem;
    display: flex;
    position: relative;
}

</style>


<div class ="panelgradient">

<h1 style="text-align: center;">User Guide</h1>

</div>



From configuring and testing to deploying a solution, learn about everything our platform has to offer.

Each chapter of the user guide can be found in the left navigation and is also linked below, along with a summary of what you'll find in those chapters.

*If you haven't already, we highly recommend that you first visit "Getting Started", then come back here to the User Guide as needed.



Panel

Solutions Manager

Create, edit, run, and license all of your solutions.



Panel

Designer (IDE Overview)

Your IDE for building Industrial Applications.



Panel

Solution Settings and Tools

General Settings and Import/Export Tools.



Panel

Runtime (Solution Execution)

Execution and startup settings for the solution.



Panel

UNS (Tags and DataTemplates)

Build Asset DataModels and link external systems.



Panel

Devices (Field Communication)

70+ protocols for industrial field devices.



Panel

Alarms (Audit and Alerts)

Setup alarms, events, notifications and AuditTrail.



Panel

Historian (Time-Series Data)

Store and retrieve time-series process data.



Panel

Datasets (SQL Queries)

Data interaction with SQL databases and files.



Panel

Reports (Forms and WebData)

Create, configure, and manage reports.



Panel

Scripts (Tasks and Classes)

High-performance custom code extensions.



Panel

Displays (Desktop and Web)

Distributed client displays and custom layouts.



Panel

Draw (Displays and Symbols)

Advanced drawing tools, for displays and symbols.



Panel

Security (Users, Roles, and AD)

Users access management and permissions.



Panel

Data Explorer Tools

Data mining from various data sources.



Panel

Track Changes

Log Solution Configuration changes.



Panel

Solution Deployment

Deploy runtime applications post-development.



Panel

Best Practices

Best Practices and troubleshooting scenarios.



This section contains the reference guide on all aspects related to Creating, Testing and Deploying a Project Solution, using the FrameworX technologies.

Some of there sections in this site, can be used in conjunction with this section:

  • For new users, the  Getting Started and Platform Overview sections are recommend. 
  • For Application Engineers and Developers, the Integrations, Project Examples. Guidelines and Best Practices provide a deeper understanding of the platform.

The organization of this Project Development section follows.

Installation and Licensing

Detailed information on installing in multiple platforms. 

To Do: WIndows, .NET 6 multiplaform, Docker, Web Server, etc..

Managing Projects

This chapter expelling the Project Management, which allows you to create new project, open the configuration tools and interact to execute application. That is the first User Interface you have access when starting the FactoryStudio Software.

Designer Configuration tool

Introduces the Project Designer, an integrated tool, which allows easy access to configure and test all the platform Modules. This chapter also presents the overview of the Configuration Workflow when creating new Projects. 

Executing and deploying the Application

Core Modules Configuration

Auxiliary Tools and Guides

The chapter  Execute, Runtime environments introduces the concept of executing your Project Configuration, and the benefits or having development and runtime isolated processes.

The Chapter Deploying the Application cover detailed practical scenarios and procedure to install a Project Solution in a Production environment. 

The Core Modules chapters present in-depth description of FrameworX main modules, including:

  • Project Settings and Wizards.
  • Tags, Unified Namespace, and Historian.
  • Security and Users Roles Management.
  • Device drivers  for Field Communication.
  • Alarms and Notifications.
  • Datasets and SQL databases access.
  • Scripts, Reports and Web Services,
  • Client Displays and Drawing Screens.

The chapter Tools presents client browsing utilities for OPC and MQTT, and simulation and server built-in tools. 

Track and Version Control introduce features to maintain a cross-reference of your variables and manage configuration changes. 

The Advanced Features and Troubleshooting empower new and experience users for optimal usage of the platform. 

In this section...

Page Treeroot@selfspacesV10