Versions Compared

Key

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

Easy Heading Macro
headingIndent40
navigationTitleOn this page
selectorh2,h3
wrapNavigationTexttrue
navigationExpandOptiondisable-expand-collapse
This page presents information related to how to create and manage Projects.

Anchor
What is a Project?
What is a Project?
What is a Project?

This framework is a powerful platform used to develop and deliver applications that manage real-time information. Applications built with the platform are organized into Projects.

A Project holds the configuration for the various functional Modules, such as Tags definition, Alarms, Communication, Displays and others. We refer to the tool that assist to select Project and open for editing or execution as Project Manager.

This section explains how to create, edit and execute run your Projects, using the Project Project Manager User Interface.


Anchor
Project Manager
Project Manager
Project Manager

The Project Manager The Welcome page is the first interface you see when you start our platform.   This interface allows you to view the Projects create, open, edit and run projects located in your computer or remote computers —, create new ones, open projects for editing and run them.

Each item shown in the table view or card view main box is a complete Project project with the configuration for an application.

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

  • This Welcome interface is is product version agnostic. You can manage and open even projects created with different product versions without the need to upgrade upgrading the project in the field or to switch switching the engineering tool in your computer.
  • Each project is a single file. 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.
About your

Software License

There are flexible options for licensing according to each business' s needsneeds. The Your License box in Project Manager page presents information about the computer software license. Read more about the license options available and how to license your software in User Guide → Installation and Licensing  → Managing Licenses.

About the

Project Server

The Project Server Manager workspace tab on the Welcome page allows managing the Project Server Service settings.

You have There are two options for Project Server: Localhost or Remote. If you select Remote, you 'll will need to set it up. Read more about how to do this on User Guide → Managing Projects  → in Project Server.

License Workspace

The License Manager workspace tab on the Welcome page presents information about the computer software license.

You can activate your license code and manage your software license in this workspace. Read more about how to get a license code in User Guide → Installation and Licensing  → Managing Licenses.


Anchor
Project Selector
Project Selector
Project Selector

The Project Selector shows a list of

Listing Projects

At Projects workspace, you have a list of theprojects on your computer or on the a remote computer selected at the Server tabset previously.

Each image shown below is an independent Projectan independent project. On the top right corner, you can select to use the Card View or the List ViewList, Cards or Table view.

Info
titleProject Image

Click Refresh to update the projects list. The image used for the Project project preview is the contents of the Display display named MainPage in that project.

Refresh Icon (at the low right corner): updates the projects list

ListView Visualization

 

List View

Projects exhibited in listImage Modified

CardView Visualization

Card View

Projects exhibited as cardsImage Modified

TableView Visualization

Table View

Projects exhibited in a tableImage Modified


Anchor
Command Buttons

New Project

Command Buttons
Command Buttons

  • New...: opens
a dialog to enable the creation of a new projectEdit Project (read-only)
  • : opens the selected project in read-only mode.
  

Upgrade Version: if Project was created with a previous version the Upgrade button is enable

Test Project: Starts the project  execution using a Testing profile Project
  • :
Starts
  • starts selected project in startup production mode
. For


Info
See Running Projects for more information on
Testing Profiles and startup, go to section Running
testing profiles and startup.



Anchor
Creating New Projects
Creating New Projects
Creating New Projects

To create a project:

  1. On the Project Manager, click New....
  2. Select a platform where your project will be installed and click Next.

  3. Select a product family and a product model. Then, click Next.
  4. Enter desired information. See more information about each field below
  5. Click New Project. The New Project page will open.
  6. Enter or select any needed information.

  7. Select the desired Project Template.
  8. Click Create New Project to finish.

Depending on your license, this setting may give you options to build applications for a specific version of our platform. You can change this setting later, if needed.

info

Field

Description

Name

Enter a name for the project.

Description

(Optional) Enter a description of the project.

Location

Click the"..." button to select a folder or to create a new folder for the project.

Note

Remote access is configured by a project's folder. You can select where the project is created. Be sure to place local projects in their own folder. Do not add them to the same folder that has projects with remote access. 

Product Family

If you do not have a license, only the Express family will show. Even when you have a license, you may want to create Express projects to share demos and tutorials with users who do not have a license installed.


Product Model

Depending on your license, this setting may give you options to build applications for a specific product model. The product model is connected with the number of real-time communication points you are allowed on that project.

Canary Historian

 <<<< add description >>>>



Anchor
Project Templates
Project Templates
Project Templates

Pre-built Project Templates 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.In the following, you can check the basic content descriptions of each available template:

Blank project

  • Logon Dialog
  • Several Themes
  • Header page navigation using Industrial Icons
  • Empty Main page
  • Layout with Header and Main page

Default project

  • Server Information information page using the Dashboard page
  • System information template and Scripts
  • System Information Data Historian configuration

TrendChart project

  • UI data template
  • TrendChart page
  • TrendChart data templates

TrendChart and Alarm project
Contains all All content in the TrendChar project - plus:

  • Alarm Online and Alarm Historical page
  • Alarm data template

TrendChart and Alarm Footer project
Contains all All content in the TrendChar and Alarm project - plus:

  • Alarm Footer page

Redundancy project
Contains all All content in the TrendChar and Alarm project - plus:

  • Redundancy Information page


Using them is the best way to check if they make sense to your need. Just select one, and run it! Then, check the available displays on each oneSelect 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 or create one on your own. See further details about how to do this in the next.

Adding

new

New Templates

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

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

And to To add a new template, you have to create a project and save them it as a Template.


Anchor
Editing or Viewing Projects
Editing or Viewing Projects

Open Projects for

Editing or Viewing

Projects

The platform supports two ways to open projects. The View button opens a ready-only version of the Project project configuration. That is always the best way to go, , which is very useful if you just want to put the project in execution , or check its configuration. 

When opening using the Edit button, it will be possible to modify 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. If you already have a project open, select another project in the Project Selection list and open it. When a second instance of the same project is opened, the second instance will open as read-only.

In order to To enable concurrent users, your project server must be licensed for multiple engineers. In the License tab, the Engineering Group Box shows the maximum number of concurrent engineering users that are allowed to access the selected server or the local computer.See Managing Licenses for more information.



Anchor
Upgrading Projects
Upgrading Projects
Upgrading Projects

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

opening Opening a Project project with a previous version , the platform will try to find an installation of the previous version in the computer, and use it to edit the Project. without upgrading it will require a platform's equivalent version installed.

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

When Upgrading:

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

After upgrading a project, you should Open it and execute a Run → Build operation, it is recommended to open the new project and build it (Execute → Build and Publish → Build... operation), so the system verify checks all its scripts in the new project file. .



Anchor
RunningProjects
RunningProjects
Running Projects

You can run a project in any of the following waysby:

  • Use Using the Run Project command button, or the Test Projectbutton.
  • Setting Setup an Auto-Start option at the Server tab. <<<< ainda tem a tab Server? >>>>
  • Starting Start the execution manually after you open the Project for editing project for editing (Execute → Startup → Run Startup). 

Both Test Project and Run Project, will start the project execution. The difference is the Test Project will use any testing configuration created in the Project, such as alternate database connections, and other tools that simplify the development and validation cycle of the Project. <<<< ainda tem a tab Server? >>>>

For more information, see User Guide →  Running Projects.



In this section...

Page Tree
root@self
spacesV10