You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 42 Next »

About Projects

Framework is a powerful platform for developing and delivering applications that handle real-time data. Applications created using this platform are structured into projects.

A Project encompasses the configuration for different functional Modules, which can include Tag definitions, Alarms, Communication, Displays, and more. Each Project can be understood as as Application, or Solution, that will be installed in a production environment. 

The tool utilized for selecting and opening a project is known as Projects Management.

By using the Projects Management interface, you can easily organize your various FactoryStudio projects, from local your local computer or remote devices, to streamline your workflow and increase productivity.

On this page:



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.

<<< 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 Management

Field

Type

Description

Your license

Dynamic text box

Displays the license information.

License Management

Shortcut

Click to go to the License Management page.

Find Projects

Dynamic text box

Displays the Project Server information.

Project Server

Shortcut

Click to go to the Project Server settings page.

Language

Combo box

Selects the user interface language.

Project List

View Selector

The Project List allow the selection of a project to perform actions on it.
The View ComboBox has options to visualize on the Projects in different ways:
List, Cards, or Table view.

Refresh

Icon

Refreshes the project list.

Notifications

Icon

Opens the notifications box.

Help

Text box

Shows useful tips.

Search project

Search box

Searches project in the Project List.

New

Command button

Opens the New Project wizard. See Managing Projects.

Edit

Command button

Opens selected project for edition. See Managing Projects

View

Command button

Opens selected project in read-only mode. See Managing Projects.

Run

Command button

Starts selected project in startup production mode. See Running Projects.

See Runtime Environment for detailed information on executing project, including the ability to define testing and production profiles.

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.

The image used for the project preview is the contents of the display named MainPage in that project. 

List View

Projects exhibited in list

Card View

Projects exhibited as cards

Table View

Projects exhibited in a table

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.

See Managing Licenses for more information.

Project Server

Find Projects

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.

See Project Server page more information.

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.


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

Language and Project Selector
The Language and Project Selector sections allow you to choose the user interface language and select a project to work on.

View Selector
The View Selector section allows you to choose between List, Cards, and Table view options for your project list.

Refresh and Notifications
The Refresh icon allows you to refresh your project list, while the Notifications icon and text box display any notifications or alerts.

Help and Search Project
The Help text box provides useful tips, while the Search Project box allows you to search for projects in the project selector.

New, Edit, View, and Run Buttons
The New button opens the New Project wizard for creating a new project, while the Edit button opens an existing project for editing. The View button opens an existing project in read-only mode. Finally, the Run button starts the selected project in startup production mode.

By using the Project Management interface, you can easily manage and organize your FactoryStudio projects to streamline your workflow and increase productivity.




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.


New Project Wizard

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.

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 Model info

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 combo box

Sets how many tags will be stored on Canary Historian

Template selector

Selects a project template. See Managing Projects.



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

Target Platform:
When creating a new project, you will need to select a target platform. The options available are typically specific to the development environment you are working with, and may include options such as a desktop application, a web application, or a mobile app. The choice you make will depend on the type of application you are building and the platform you want to deploy it to. It is important to carefully consider which option is best for your needs, as it can impact the development process and the end user experience.

Product Family and Product Model:
After selecting a target platform, you will need to choose a product family and product model. The product family is a group of related products, and the product model refers to a specific version of a product within that family. These options are important because they determine the functionality that will be available in your application, and what features and modules can be used. Examples of different product families and models include controllers, gateways, and sensors. When selecting these options, consider the specific requirements of your application and the functionality you need to build.

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.

Folder Structure:
Organizing your projects into folders is an important part of project management. It is important to keep local and remote projects separate, as this can help to prevent issues with access and security. When creating a new project, be sure to select the appropriate folder location to ensure that it is stored in the correct location. This will make it easier to manage and access your projects over time.

License Information:
The license you have for your development environment will affect the product model options available to you. Depending on the license level, there may be limitations on the number of real-time communication points you are allowed on a project. Be sure to check the license information to ensure that you are selecting the appropriate product model for your needs.

Canary Historian:
Canary Historian is a module that is used to store historical data for your application. When configuring Canary Historian, you will need to select the number of tags that will be stored. This will depend on the size of your application and the amount of data that needs to be stored. Be sure to carefully consider your data storage needs when configuring Canary Historian.


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.

Opening in View mode

If the Project file is locked, or there is another local instance of the Project open, the Project will open in Read-Only View mode. In that mode is still possible to Run or Export configuration, but no to edit.


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). 
For more information, see Runtime Environment.

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

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

(tick)

(tick)(tick)(tick)(tick)(tick)

Several themes

(tick)

(tick)(tick)(tick)(tick)(tick)

Header page navigation using Industrial Icons

(tick)

(tick)(tick)(tick)(tick)(tick)

Empty main page

(tick)

(tick)(tick)(tick)(tick)(tick)

Layout with Header and Main page

(tick)

(tick)(tick)(tick)(tick)(tick)

Server Information page using the Dashboard display


(tick)

(tick)

(tick)(tick)(tick)

System information template and Scripts


(tick)

(tick)

(tick)(tick)(tick)

System Information Data Historian configuration


(tick)

(tick)

(tick)(tick)(tick)

UI data template



(tick)

(tick)

(tick)

(tick)

TrendChart display



(tick)

(tick)

(tick)

(tick)

TrendChart data templates



(tick)

(tick)

(tick)

(tick)

Alarm Online display




(tick)

(tick)

(tick)

Alarm Historical display




(tick)

(tick)

(tick)

Alarm data template




(tick)

(tick)

(tick)

Alarm Footer display





(tick)

(tick)

Redundancy Information display






(tick)


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...


  • No labels