Page Tree
Software Knowledgebases
...
When you are finished developing and testing your project, you can deploy the runtime application for use by end-user clients. Projects can be deployed to run locally on a stand-alone computer or embedded device, as well as in a client-server distributed architecture or on the cloud. This chapter discusses the various methods for deploying these applications.
...
| On this page: | ||||||
|---|---|---|---|---|---|---|
|
Local and Distributed Systems
...
- Embedded devices with no local user interface.
- Stand-alone panels or computers with local user interface.
- Distributed systems with many client stations accessing a server.
- Redundant servers with multiple users connected.
The setup procedures for each scenario have many common steps. For all the systems, even the stand-alone installations, FactoryStudio makes use of a client-server architecture.
The server components are the project file and the modules that run the server side tasks, such as data-acquisition, alarms and data logging. The client components are the graphical user interfaces and related scripts.
When you have a local or stand-alone project the server and the client components run on the same machine.
The client technologies used by FactoryStudio simplify deployment, since you have to install the project only on the server computer. All the client stations will use the project from the server.
In order to setup the server components or stand-alone configurations refer to the following sections: "Product Installation on the Target Computer", "License and Project Settings Verification", and "Installing the Project File".
The client setup can be slightly different according to its type. FactoryStudio supports the following client technologies:
- Windows rich clients
- Windows smart clients
- Windows web-based clients
- iOS clients
...
- The Family defined in the license must be the same as the family in the project or a higher hierarchy family.
- Enterprise licenses can run all projects (Enterprise, HMI and OPCServer)
- HMI licenses can run HMI and OPC Server projects
- OPCServer licenses can run only OPC server projects
- Express licenses or projects are not authorized for production environments.
- The Model in the license must support a number of communication points equal to or greater than the requirements of the project that will run on the server computer.
- The License Type on the target computer must be Engineering or Runtime. Licenses of type DEV (Development) are only for the internal work of System Integrators and may not be used in production environments.
- If the project requires any additional interfaces, such as the OSIsoft(tm) PI System, or IEC protocols, the license on the target computer must be enabled for those interfaces.
- The number of remote clients enabled must meet the project requirements.
...
- If the folder structure on the production computer is not the same as on the computer you used for development, make sure that all the places you have file paths in your project are mapped correctly to the production computer. FactoryStudio has many features and macros to define paths relative to the project location, product installation or execution path; whenever possible avoid using fixed path locations in your projects.
- Any external WPF controls should also be copied to the target computer. For remote web access those files should be located in the folder WpfControl and the utility to update the web manifest must be executed.
- If the application references external DLL or .NET assemblies, ensure they are available and at the correct paths on the target computer.
- If the project uses Retentive values, you must decide if the target computer will create a new Retentive database or if you will copy one with some predefined values.
- Enable the firewall to allow remote clients. Ports 3101 for startup (optionally port 3201 to Test Mode). For web and iOS clients, data web services are enabled on port 80.
- If the application uses external DLLs, WpfControls, configuration files or embedded databases, make sure you copy those files to the target machine and double check if the PATHNAMES you used in the project configuration are compatible.
...
- Start manually. From the FactoryStudio main window and project list, right-click the project and select Run Project.
- Start manually. When configuring the project, go to Run > Startup and click Run Startup.
- Start the project automatically, which is the best option for production environments.
...
- In the Startup folder, right-click and select New > Shortcut.
- In the Create Shortcut window, paste into the field that displays.
- If you are not using redundancy, delete the redundancy part of the text.
In the examples below, be sure to change the installation path and version of FactoryStudio to the installation on your computer.
- Type or paste the full command line, for example: "C:\Program Files\Studio\fs-2018.1\TStartup.exe" /project:"C:\Studio Projects\Project1.tproj"
- Click Next.
- Enter a name for the shortcut.
- Click Finish.
...
Field | Description |
Primary Server IP and Target Port | Enter the IP address and port of the primary server. |
Secondary Server IP and Target Port | Enter the IP address and port of the secondary server, if any. |
On Primary Startup | Select the option you want. |
Historian Replication | Select how to handle historian replication. |
Connection Timeout | Connection timeout time, in seconds, to switch to secondary server. |
Server Command Line | Read-only field populated based on the fields above. Click Copy to Clipboard to copy the command for use. |
Rich Client command | The commands to start a Rich Client with the project selected parameters |
Smart Client url | The URL to access the Smart Client with the project's parameters |
Web Client url | The URL to access the Web Client with the project's parameters |
View-Only | If checked, apply View-Only parameter to Rich and Smart Client's url |
Windows Authentication | If checked, apply Windows Authentication logon parameter to Rich and Smart Client's url |
...
The whole command line should look something like this:
"C:\ProgramFiles(x86)\Tatsoft\FactoryStudio\fs-2018.1.1\ tStartup.exe" /project:C:\Factory Studio Projects\ <project_name>.tproj /username:<username>
- Leave the text file open for use in step 10.
- From the command line prompt, go to the <.NET Framework Install Path> and execute the following command:
installutil <InstallPath>\<fs-version>\TStartupAsService.exe
Example: C:\Windows\Microsoft.NET\Framework\v2.0.50727>installutil C:\Program files\Tatsoft\FactoryStudio\fs-2018.1\ TStartupAsService.exe
...
"HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\services\ TStartup\ImagePath"
Example: "C:\\tatsoft\fs-2018.1\TStartupAsService.exe" "/project:C:\FactoryStudio Projects\Project1.tproj"
- In the Windows Services (Administrative Tools), set "TStartup Service" to Automatic, so the selected project will start when the computer starts.
...
...
Installation
...
Install FactoryStudio on the client computer. See "Installing FactoryStudio" in the "Getting Started" guide.
...
How to start
...
Run the TRichClient.exe program. For an example of how to automatically start the client when a user logs in to Windows, see "Automatically Starting Windows Clients" in the previous section.
...
Execution
...
The project runs in its own window. It allows very strong user security, including the ability to disable Windows task-switch, according to the login on the running project.
When running the TRichClientt.exe on 64-bit machines, the application runs in 64-bit native code. If you need to run the 32-bit version, for instance to ensure compatibility with legacy COM and Active-X components, you can use the TRichClient32.exe program.
...
Communication
...
Communicates with the server using the Windows Communication Foundation (WCF) (port configurable, default 3101).
...
...
Installation
...
No installation required. You just need .NET Framework 4.0 and Internet Explorer 8.0 or later on the client computer.
The first time you start the application, it will automatically download the required components from the server. Every time the application starts, it verifies automatically if a new version is available on the server.
...
How to start
...
From Internet Explorer (or a shortcut) go to the URL:
http://<ServerIPAddressorName>/fs-2014.1/ TSmartClient.application
For an example of how to automatically start the client when a user logs in to Windows, see "Automatically Starting Windows Clients" in the previous section.
...
Execution
...
Runs exactly the same as the rich client. The functionality of the rich client and the smart client are the same; only the installation and activation methods are different.
...
Communication
...
Communicates with the server using WCF (port configurable, default 3101).
...
...
Installation
...
No installation required. You just need .NET Framework 4.0 and Internet Explorer 8.0 or later on the client computer.
The first time you start the application, will automatically download from the server the required components. Every time the application starts, it verifies automatically if a new version is available on the server.
...
How to start
...
From Internet Explorer (or a shortcut) go to the URL:
http://<ServerIPAddressorName>/fs-2014.1 /TWebClient.Xbap
For an example of how to automatically start the client when a user logs in to Windows, see "Automatically Starting Windows Clients" in the previous section.
...
Execution
...
Runs inside a web browser window using "Partial Trust" (Sandbox Security).
...
Communication
...
Communicates with the server using HTTP or HTTPS (port 80).
...
- In the Startup folder, right-click and select New > Shortcut.
- In the Create Shortcut window, paste into the field that displays.
- If you are not using redundancy, delete the redundancy part of the text.
- Do one of the following:
- For a rich client—At the beginning of the command line, enter or paste the full path to the FactoryStudio installation folder and put quotes around it. It should look something like this: "C:\Program Files (x86)\Tatsoft\FactoryStudio\fs-2014.1.3\ TRichClient.exe" /ip1:<IP_address>
- For a smart or web client—At the beginning of the command line, enter or paste the full path to the Internet Explorer installation folder and put quotes around it. It should look something like this: "C:\Program Files (x86)\Internet Explorer\iexplorer.exe" http:<IP_address>/fs-2014.1/TSmartClient.application "C:\Program Files (x86)\Internet Explorer\iexplorer.exe" http:<IP_address>/fs-2014.1/TWebClient.Xbap
- Click Next.
- Enter a name for the shortcut.
- Click Finish.
...
...
Installation
...
Install the SCADA HMI Client app from the Apple Store.
...
How to start
...
Start the SCADA HMI Client app and follow the initial setup options.
...
Execution
...
On iOS, it runs natively, thus providing higher performance, enhanced security, and access to native graphical components, compared to other applications using Terminal Client, Remote Desktop, or HTML web.
...
Communication
...
Communicates with the server by calling a web service using port 80. The server must be on the same VPN or local network as the iOS device, or it can be a public IP address, as long as HTTP access is enabled.
...
Field | Description |
Host Server | IP address or name of the project server. |
Port | Port 80. |
Polling | Defines the refresh rate between the client and the server, expressed in quarters of a second. The default value of 1, means the client gets new data from the server every 250 ms. When connecting to servers located on the Internet or low bandwidth networks, that value should be increased. For more information, refer to the help for the app. |
User | Project user name as configured in the project. The default is guest. |
Password | Project password associated with the user name. |
Project | Project name on the remote project server. |
...
FactoryStudio supports many deployment scenarios such as:
- Embedded devices with no local user interface.
- Stand-alone panels or computers with local user interface.
- Distributed systems with many client stations accessing a server.
- Redundant servers with multiple users connected.
The setup procedures for each scenario have many common steps. For all the systems, even the stand-alone installations, FactoryStudio makes use of a client-server architecture.
The server components are the project file and the modules that run the server side tasks, such as data-acquisition, alarms and data logging. The client components are the graphical user interfaces and related scripts.
When you have a local or stand-alone project the server and the client components run on the same machine.
The client technologies used by FactoryStudio simplify deployment, since you have to install the project only on the server computer. All the client stations will use the project from the server.
In order to setup the server components or stand-alone configurations refer to the following sections: "Product Installation on the Target Computer", "License and Project Settings Verification", and "Installing the Project File".
The client setup can be slightly different according to its type. FactoryStudio supports the following client technologies:
- Windows rich clients
- Windows smart clients
- Windows web-based clients
- HTML5 clients
- iOS clients
For more on these client types see "Remote Client Users Setup" below.
If you need to use Active-X, COM, and JavaScript, you can access the runtime application using the DataAccess API, which is a COM interface to provide integration with Active-X, JavaScript on web pages, or legacy programming languages such as VBScript. Contact support for assistance.
For redundant scenarios see "Deploying Redundant Systems" below.
Product Installation on the Target Computer
The server computer on distributed systems, or the standalone computer if used, must have FactoryStudio installed and licensed. The section "Installing FactoryStudio" in the "Getting Started" guide describes the standard way to install and license FactoryStudio. All servers and clients require the .NET framework, version 4.0 or higher.
When you are not using components that require the setup of the Windows Registry, such as the OPC components, you also just copy the product files without running any installation. This is especially useful for embedding the software on devices. If needed, you may remove project examples or engineering components and add custom protocols.
On distributed systems, the client computers don't require a license, they just need to be allowed to connect with the server based on number of runtime users enabled on the server. For more information on the client setup, see "Remote Client Users Setup", below.
If the system will have remote users, a web server, either TWebServer or IIS, must be installed and running on the server computer.
License and Project Settings Verification
A FactoryStudio project is created targeting one specific Product Family and Product Model, as defined on the Info > Project > Settings page.
It is necessary to ensure that the license on the server computer is greater than or equal to the requirements of the project, by reviewing the following checklist:
- The Family defined in the license must be the same as the family in the project or a higher hierarchy family.
- Enterprise licenses can run all projects (Enterprise, HMI and OPCServer)
- HMI licenses can run HMI and OPC Server projects
- OPCServer licenses can run only OPC server projects
- Express licenses or projects are not authorized for production environments.
- The Model in the license must support a number of communication points equal to or greater than the requirements of the project that will run on the server computer.
- The License Type on the target computer must be Engineering or Runtime. Licenses of type DEV (Development) are only for the internal work of System Integrators and may not be used in production environments.
- If the project requires any additional interfaces, such as the OSIsoft(tm) PI System, or IEC protocols, the license on the target computer must be enabled for those interfaces.
- The number of remote clients enabled must meet the project requirements.
For more Information about product and license models refer to Chapter "Versions and Licenses".
Installing the Project File
A project is installed as a single file, either the main configuration file (with extension "tproj") or a read-only file (with extension "trun") if you have created one.
The Project Management utility allows you to connect with remote servers and download the project file to remote computers.
Although that one file contains the entire project configuration, you should use the following checklist to ensure that any external dependencies are also taken care of.
- If the folder structure on the production computer is not the same as on the computer you used for development, make sure that all the places you have file paths in your project are mapped correctly to the production computer. FactoryStudio has many features and macros to define paths relative to the project location, product installation or execution path; whenever possible avoid using fixed path locations in your projects.
- Any external WPF controls should also be copied to the target computer. For remote web access those files should be located in the folder WpfControl and the utility to update the web manifest must be executed.
- If the application references external DLL or .NET assemblies, ensure they are available and at the correct paths on the target computer.
- If the project uses Retentive values, you must decide if the target computer will create a new Retentive database or if you will copy one with some predefined values.
- Enable the firewall to allow remote clients. Ports 3101 for startup (optionally port 3201 to Test Mode). For web and iOS clients, data web services are enabled on port 80.
- If the application uses external DLLs, WpfControls, configuration files or embedded databases, make sure you copy those files to the target machine and double check if the PATHNAMES you used in the project configuration are compatible.
Deploying Redundant Systems
You can configure application redundancy by configuring two computers as servers. One computer will be the primary, and the other will be the secondary or hot standby. If the primary computer or connection to the computer fails, the system automatically fails over to the secondary computer.
If you selected HMI as the Product Family, the redundancy configuration is not available.
To configure redundancy:
- Go
...
- to Info >Project > Redundancy.
- Enter or select the information, as needed.
Field | Description |
Enable Configuration | Select to enable the redundancy configuration. |
Primary Server IP and Port | Enter the IP address and port of the primary server. |
Secondary Server IP and Port | Enter the IP address and port of the secondary server. |
On Primary Startup | Select the option you want. |
Historian Replication | Select how to handle historian replication. |
Connection Timeout | Connection timeout time, in seconds, to switch to secondary server. |
Server Command Line | Read-only field populated based on the fields above. Click Copy to Clipboard to copy the command for use. |
Rich Client Command | Read-only field populated based on the fields above. Click Copy to copy the command for use. |
Smart Client URL | Read-only field populated based on the fields above. Click Copy to copy the command for use. |
Web Client URL | Read-only field populated based on the fields above. Click Copy to copy the command for use. |
To automatically start the application on a Windows client:
- Go
...
- to Info > Project > Redundancy.
- Enter or select the information, as needed.
Field | Description |
Enable Configuration | Select to enable the configuration. |
Primary Server IP and Port | Enter the IP address and port of the primary server. |
Secondary Server IP and Port | Enter the IP address and port of the secondary server, if any. |
On Primary Startup | Select the option you want. |
Historian Replication | Select how to handle historian replication. |
Connection Timeout | Connection timeout time, in seconds, to switch to secondary server. |
Rich Client Command | Read-only field populated based on the fields above. Click Copy to copy the command for use. |
Smart Client URL | Read-only field populated based on the fields above. Click Copy to copy the command for use. |
Web Client URL | Read-only field populated based on the fields above. Click Copy to copy the command for use. |
- Click
...
- the Copy
...
- button next to the type of client you want to start automatically.
Overview
Content Tools
Tasks