Managing Projects

Projects Management User Interface

The Projects Management interface is the main hub for managing and organizing your FactoryStudio projects. From this interface, you can create new projects, edit existing ones, and and run projects located in your computer or remote ones.

Some very unique and powerful features about project management tools include:

• This interface is product version agnostic. You can manage and open projects created with different product versions without upgrading the project in the field or switching the engineering tool in your computer.
• The platform creates a file for each project. All configuration, including tag definition, displays drawing, images and report templates is stored in a single file — an encrypted SQL database with extension .tproj — for easy management.
• You can open multiple projects at the same time or allow multiple engineers to work on each project.
• In order to enable multiple users to work concurrently on the same project, follow the procedure described at the section <<< Multi-User Collaboration >>>

<<< NOTA: Onde esta sendo salvas as figuras do Manual, o "Fonte" para editar as figuras? Tem que que estar em algum repositório de arquivo do próprio Confluence, ou no Egnyte

>>>>>. Apenas apague esta nota, quanto tiver um processo implementado para garantir que todos trabalhando em documento saibam e apliquem isso.

Project List

The middle box is called Project List and shows a list of projects on your computer or on a remote computer set previously. Click Refresh to update the projects list. 

Each item in the project selector is a complete project with the configuration for an application.

Each image below is an independent project. On the top right corner, you can select List, Cards or Table view.

List View

Card View

Table View

Your License

Your License presents information about the software license. There are flexible options for licensing according to each business' needs.

Clicking on the License Management shortcut will take you to the License Management page where you can manage your license and view your license details.

Project Server

The Projects Server section displays information about the computer and folders upon the list of presented list Projects is build.

Clicking Project Server allows managing the Project Server Service settings. There are two options for Project Server: Localhost or Remote. If you select Remote, you will need to set it up.

Help

Clicking the Help button (blue question mark icon) opens the Are you new here? dialog box which contains some suggestions to get started. It also contain links to our, documentation and forum pages.

Notifications

The bell icon located in the bottom right corner opens the Notifications box.

The Project Configuration file

The configuration for the entire project, is stored in single file with the extension TPROJ.

That file is an encrypted  embeded SQL database, with the configuration tables of the various modules, like Tags, Alarms, Scripts and Displays. 

You can move, rename, duplicate, backup and restore the project files, working directly on the computer folders, as you'd do with any other file.

The moving or adding TProj files directly on the computer folders, you need to press the Refresh button, so the list will update the content of the folders.

Other files extension for Projects are created, when using the Publish feature, as described in the chapter <<<< Build and Publish >>>>>

Creating New Projects

To create a  new project:

1. On the Project Management, click New....

2. Select a target platform where your project will be installed and click Next.

3. Select a product family and a product model. Then, click Next.
4. Put a name and a short description to the new project.
5. Select a project template.

6. Click Create New Project to finish.

Wizard Step 1: Target Platform selection 

When creating a new project, you will need to select a target platform. 

A Target Platform is where you intend to deploy your Project for execution in production. Here are the options, with guidance for selection:

.NET Framework 4.8:  If you are going to execute your application in a Windows server or desktop, that is the best point. It doesn't matter if is a Server or Workstation, neither the Windows version, as long it supports .NET 4.8. This option allows you access full capability of the Windows systems, including Active Directory Security and Authentication, and some other resources that are specific to Windows environments, not available in other platforms.

.NET 6.0: Formerly know as .NET core, this option sets the target to be the multi-platform,  allowing to create application that can execute in Windows, Linux or any other platform support .NET 6.

Cisco Routers: We are able to deploy projects to run inside Cisco routers using docker. Typically it will act as protocol gateway, and scripts calculation for data conversion, historian collator, or alerts and notification generation. 

Universal Robots: We can run the MQTT SparkPlug B publishing engine directly on Universal Robots. Its configuration is directly at the Robot, not in the Project Designer tool,  see << >> for more information

Docker container:  The Wizard doesn't present an option for Docker, as any .NET 6 project can be setup to run inside a docker. 

Wizard Step 2: Selecting the FrameworX Product 

Tatsoft's FrameworX technology powers 3 products option:

FactoryStudio: scalable models  based on the number the communication points, enabling SCADA, MES, AdvancedHMI and a wide range of industrial applications. 

EdgeHMI: scalable models  based on the number communication points, with the sub-set of FactoryStudio features typically require for HMI on machines and embedded devices.

EdgeGateway: scalable models based on the number of communication points, with the features to perform data collections on field, including various protocols, data logging and scripting. 

You can keep the selection of product as FrameworX, when creating projects for Unlimited communication points, and Unlimited users.

According the selecting or the product, the various options of communications are presented. 

Wizard Step 3: Customizing Project Name and other options 

About the Folder Structure for Projects

FrameworX projects are created in a way that is possible to have multiple projects in one folder. 

Each project file, TPROJ, has all the configuration of the project, and some files that are dynamically created, such as retentive tag databases, or user UI settings, they carry the name of the Project. 

Therefore when create multiple simple projects, typically for tests and demos,  it is easier to keep in the same folder. But, when created larger applications, or Project for formal field deployment it's a good procedure to do in a new folder.r 

Canary Historian:

FrameworX applications bring the benefit to allow, at no extra cost, the usage up to 500 historian points, using the Canary Historian tools. You can upgrade to a higher tag counting.

When using that feature, even for the built-in 500 points, it's necessary to add the Canary license. See << Canary Integration >> for more information. 

Editing and Viewing Projects

The View button opens a ready-only version of the project configuration, which is very useful if you just want to put the project in execution or check its configuration. 

The Edit button enables modifications in the project. You may need to use the Logon button in the toolbar before editing if the Security projections were enabled to that project. 

Many projects can be opened at the same time. When a second instance of the same project is opened, the second instance will open as read-only.

To enable concurrent users, your project server must be licensed for multiple engineers. See Managing Licenses for more information.

Steps to open am existing project.

Start Project.exe: Run the Projects application, using the Project.exe command line, or desktop icon. 

Select Local or Remote computers: By default, the system will show the projects from the last location, or from your local computer on the first. You can modify the list of project, going the Project Server page.

For remote computers, you can use the Web UI: If the remote computer has Web Server enabled, and you are in Windows computer, you can start see the projects of remote computer with the URL: <<<<<<<<<<I

Select the desired Project at the List: you can use the search box or modify the options for visualization. When using Tables, you can sort by columns clicking in the tiles, or right click to switch column visibility.

Running Projects

You can run a project by:

• Using the Run button in Project Management.
• Starting the execution manually after you open the project for editing (Execute → Startup → Run Startup). 

Upgrading Projects

Projects retain information about the platform's version used to create the Project.

Opening a project with a previous version without upgrading it will require a platform's equivalent version installed.

Also, you can upgrade the project to the latest version using the Upgrade Version command button. 

When Upgrading:

• A copy of the project is executed, creating a new file named: <project-name>-<preivous-vesion>.tproj.
• A new empty project is created named <project-name>.tproj.
• The Previous project is imported to the new project.

After upgrading, it is recommended to open the new project and build it (Execute → Build and Publish → Build... operation), so the system checks all its scripts.

Project Templates

Project templates can be a great way to speed up the development process by providing pre-configured settings and modules. Templates can be customized to fit your specific needs, and can be a useful starting point for building your application. When selecting a template, consider the functionality you need and the type of application you are building. Examples of different templates available include web applications, mobile apps, and desktop applications.

Pre-built project templates get you started faster by building the solutions you need. Some project templates are available when you install the software, such as Blank, Default, TrendChart, TrendChart with Alarm Pages and Alarm Footer, Redundancy projects, and Asset Viewer.

Template	Blank	Default	TrendChart	TrendChart and Alarm	TrendChart and Alarm Footer	Redundancy
Log on dialog
Several themes
Header page navigation using Industrial Icons
Empty main page
Layout with Header and Main page
Server Information page using the Dashboard display
System information template and Scripts
System Information Data Historian configuration
UI data template
TrendChart display
TrendChart data templates
Alarm Online display
Alarm Historical display
Alarm data template
Alarm Footer display
Redundancy Information display

Select and run a template to check the displays available on each template, and explore its settings. By that, you can check if one of the templates meet your needs and speed up your project development.

In addition, you can add or create more templates on your own.

Adding New Templates

The templates presented when creating a new project are standard project files located in the product installation folder in Templates. 

If you receive a new template from your vendor or integrators, copy it to that project.

To add a new template, create a project and save it in the Template folder on the installation directory, such as the following sample path: "C:\Program Files\...\Product\Version\Templates"

=================================

F

In this section...