Installing Optima on a Windows server

1. Download and install the .NET framework.

For information on the supported versions: → System requirements.

1. Extract the folder
   C:\optima_zip\ptv-optima-vv.n.xxxxx\TRE-vv.n.xxxxx\
   to
   C:\optima\

2. Rename the extracted folder to TRE (no version number).

   So the folder now is: C:\optima\TRE\

3. If your PTV project manager has given you a TRE configuration file CommandLineTDE.csv, copy this file to: C:\optima\TRE\

   If you have not been given this configuration file:

   1. Copy the configuration file template
      C:\optima\TRE\config-template\TRE online.csv
      to
      C:\optima\TRE\CommandlineTDE.csv

   2. Open the file with a text editor.

   3. Configure at least the following parameters:

      (For a detailed description of TRE configuration: → Traffic Real-time Equilibrium (TRE)).

      • DS_MAIN

        Configure the main datasource to be connected to the Optima database: postgresql:Server=localhost;Port=5432;Uid=postgres;
        Pwd=postgres;Database=optima;CommandTimeout=3600

      • WebServiceAddress

        Set this parameter to the URL value you want to use.

        Example: http://SERVER_IP:1800/tre/

        Replace SERVER_IP with the IP address of the server.

        Important:  Make sure that the port is actually free to be used on your machine. You will need the port number later to set up the corresponding web service.

      • AppNameForIO

        Set this parameter to: TRE_tattico

4. Edit the application server configuration file to allow the Optima application server to connect to TRE services:

   1. With a text editor, open the file:
      C:\optima\ptv-optima-as\standalone\configuration\optima\optima-configuration.xml
      
   2. Search for the node <TRE_tattico>.

   3. Set the URL parameter to the hostname of the TRE service.

      Example: http://SERVER_IP:1800/tre/

      Replace SERVER_IP with the IP address of the server.

5. Open a Windows command prompt window as a system administrator.

6. Run the configuration script TRE-service-installation.bat at the path:

   C:\optima\TRE\installation_script

1. Extract the folder in the file
   C:\optima_zip\ptv-optima-vv.n.xxxxx\VMS-vv.n.xxxxx.zip
   to
   C:\optima\

2. Rename the extracted folder to VMS (no version number).

   So the folder now is: C:\optima\VMS\

3. Copy
   C:\optima\VMS\config-templates\CommandlineTDE.csv
   to
   C:\optima\VMS\CommandlineTDE.csv

4. For a detailed description of the VMS configuration: → Smart Display.

5. Edit the application server configuration file to allow the Optima application server to connect to VMS services:

   1. With a text editor, open the file:
      C:\optima\ptv-optima-as\standalone\configuration\optima\optima-configuration.xml
      
   2. Search for the node <vms> and, within this node, search for the subnode <serverHost>.
   3. Set the URL parameter to the hostname of the VMS server.
      Typically: http://127.0.0.1:1800/vms
6. Open a Windows command prompt window as a system administrator.

7. Run the configuration script VMS-service-installation.bat at the path:

   C:\optima\VMS\installation_script

You can install Vehicle Tracker both as a Windows service or as an application. Installing Vehicle Tracker as a service improves the level of service because you can configure the Windows service to restart automatically when the server machine restarts.

Important:  If you are going to have both FCD and portals in your system, you need to set up two different Vehicle Tracker components.

Optional: Installing Vehicle Tracker as a service

1. Extract
   C:\optima_zip\ptv-optima-vv.n.xxxxx\VehicleTracker-vv.n.xxxxx.zip
   into the folder
   C:\optima\

2. Rename the extracted folder to Vehicle Tracker (no version number).

   So the folder now is: C:\optima\Vehicle Tracker\

3. With a text editor, open the application server configuration file:
   C:\optima\ptv-optima-as\standalone\configuration\optima\optima-configuration.xml
   

4. Find the node <VehicleTracker> and, inside this node, find the subnode <serverHost>.

5. Set the URL parameter to the hostname of the Vehicle Tracker server (web service URL).

   Typically: http://<SERVER_IP_ADDRESS>:1800

6. Open a Windows command prompt window as a system administrator.

7. Check the presence, in the folder C:\optima\Vehicle Tracker, of the Vehicle Tracker configuration file named CommandLineTDE.csv.

8. Edit the CommandLineTDE.csv accordingly with project parameters, like license path, installation type, and methods to receive real-time traffic data (CSV or XML.).

9. Run the script: C:\optima\VehicleTracker\installation_script/ VT-service-installation.bat

Optional: Installing Vehicle Tracker as an application

Instead of installing Vehicle Tracker as a Service as described above, you can install Vehicle Tracer also as an application.

1. Go to the Vehicle Tracker installation folder.
2. Run the executable: VehicleTracker.exe

A console window opens, showing log messages.

On the server, set the correct time and the correct time zone.

Caution:  During installation, do not use the Stack Builder tool provided with PostgreSQL. Use only the standalone executable of PostGIS.

1. Download PostgreSQL from here.

   For information on the supported versions: → System requirements.

2. Install PostgreSQL.

   • Set both username and password to postgres.
   • Set default port to 5432.
   • Set language to English United Kingdom.

3. Download PostGIS from here.

   For information on the supported versions: → System requirements.

4. Install PostGIS.
5. During the installation of the PostGIS software, confirm all questions with Yes.

You need to set up the network connection to the database.

1. With a text editor, open the PostgreSQL client authentication configuration file:
   pg_hba.conf

   The standard path is: C:\Program Files\PostgreSQL\X.X\data\

2. Enable the network class that is going to be connected to the DB.

3. Check the configuration.
   

   It is usually not necessary to modify the file.
   

4. Test the connection from this network.
5. Open Windows PowerShell as the Administrator.

6. Execute:

   set-executionpolicy unrestricted with the option A.

   

7. Execute:

   cd c:\optima_zip\optima_install\Windows\Postgresql\

8. Execute:

   postgresql-configure.ps1

1. Open the Windows Control Panel.
2. Open Administrative tools > Services.
3. Find the service: postgresql-x64-10 - PostgreSQL Server 14

4. Click Start.
   

   On Windows, the PostgreSQL service is started automatically at the end of a correct installation. For this reason, the service is already started at this point of the procedure.

5. Check the status of the service and, if the service has not yet started, try to start it.

PostgreSQL is now running on your machine.

1. Extract the archive: C:\optima_zip\PTV-Optima-vv.n.xxxxx\TDE_vv.n.xxxxx.zip
2. Copy the extracted folder to: C:\optima\

3. Rename the folder to TDE (no version number). TDE is the data model of Optima.

   Therefore, the path and name of the folder now is: C:\optima\TDE\

4. To prepare for creating an empty database, open the following script with a text editor:
   C:\optima_zip\ptv-optima-vv.n.xxxxx\optima-db\creation_scripts\create-empty-db.bat

5. Make sure that the configuration parameters in the script are as follows:

   

6. Double-click the script to execute it.

   The script merges all .sql files in the folder into one single file 000_ALL_SCRIPTS.sql. Then, the script halts.

   

7. Press the Enter key to confirm that you wish to create a single file.

   The script halts again.

8. Press the Enter key to confirm that you wish to create the database.

   At the end of the process, this message might be displayed: Not enough memory

9. Skip the message.

   The database will be created nevertheless.

   

10. To verify that the empty DB has been successfully created:

    1. Open pgAdmin 4.
    2. Select the DB. Use the default username and passwordpostgres.
    3. Make sure that there are more than 200 tables under Server Groups > Servers > PostgreSQL 17 > Databases > optima > schema > public > tables.

    The DB has been created.

To load the model in the empty DB, use the Transportation Data Exchange component (TDE).

1. Copy all network model files (.net, .dmd, .xml, and tprb.sql for both the simulation model and for the current model) from the source folder
   C:\optima_zip\05 Models and elaborations\Visum_Model
   or
   C:\optima_zip\09 Models and elaborations\Visum_Model
   to the folder
   C:\optima\TDE\model_update\

2. If your PTV project manager has given you a TDE configuration file
   CommandLineTDE.csv,
   copy this file to
   C:\optima\TDE\
   from the source folder
   C:\optima_zip\05 Models and elaborations\Config\TDE or
   C:\optima_zip\09 Models and elaborations\Config\TDE

   If you have not been given this configuration file:

   1. Copy the file C:\optima\TDE\config-templates\CommandLineTDE.csv

      to: C:\optima\TDE\

   2. Open the copy of CommandLineTDE.csv with a text editor.

      For a detailed description of TDE configuration: → Transportation Data Exchange (TDE).

      Important:  Each variable value is given directly below the variable name. All subsequent rows up to the next variable name are ignored. A value of −1 forces TDE to get the value from the DS_MAIN datasource. A value of −2 forces TDE to ignore a specific variable in the configuration file. This makes it possible to skip the import of specific parts of the model.

   3. Configure the main datasource DS_MAIN to connect to the simulation model. For Visum export files named <simmod_filename>.net, .xml, .dmd, insert visum:/.../model_update/<simmod_filename> with no extension.

   4. Configure the output datasource DS_OPUT to connect to the database where the result will be stored:
      postgresql:Server=DB_SERVER_IP;Port=5432;Uid=postgres;
      Pwd=postgres;Database=optima;CommandTimeout=3600

      Replace DB_SERVER_IP with the IP address of the DB server hosting PostgreSQL ver. 17.4.

3. Create a DB backup.

   Caution:  Do not skip this step! A DB backup is necessary to restore the DB in case of unexpected fails.

   1. Open pgAdmin 4.
   2. Click Server Groups > Servers > PostgreSQL 17 > Databases > optima to connect to the DB that you have created in the previous steps.
   3. Right-click and choose Backup.
   4. Choose the backup folder, for example: C:/Optima_DB.xxx.

4. Double-click the executable file: C:\optima\TDE\TDE_GUI.exe

   A dialog box opens. It shows the configuration review panel through which you can run the TDE software.

5. Click Execute.

   The operation can take some time, depending on the size of the model.

6. If the folder model contains additional scripts, such as .sql or .backup, restore them with pgAdmin 4.

   For .sql files:

   1. Open pgAdmin 4.
   2. Press Ctrl+E to open the Query Manager.
   3. On the File menu, click Open to execute the .sql.

   For .backup files:

   1. Open pgAdmin 4.
   2. Browse to the Optima DB.
   3. Right-click the DB or a specific table.
   4. Right-click and choose Restore.
   5. On the Restore Options#1 tab, set the parameter Type of object to only data.

The DB hosts now the network model.

1. Open the TDE log file:

   C:\optima\TDE\LogFile_TDE_GUI.log

   Important:  It is MANDATORY to check for the absence of ERROR messages in the log file.

2. Open pgAdmin 4.

3. Click Ctrl+E to open the Query Manager.

4. Execute the following queries to verify basic database integrity (click F5 to execute a query):

   • SELECT COUNT(*) from link must return the number of assignment links of the model (greater than zero).
   • SELECT COUNT(*) from strt must match the number of links in the Navteq network (greater than zero).
   • SELECT COUNT(*) from lkst must be greater than zero.

If all the checks listed have been successful, you get a valid DB.

1. Copy the folder C:\optima_zip\ptv-optima-vv.n.xxxxx\ptv-optima-as\
   to
   C:\optima\

   So the folder now is: C:\optima\ptv-optima-as\

2. In a text editor, open the configuration file:
   C:\optima\ptv-optima-as\bin\standalone.conf.bat

3. Search for the parameter -Xmx and set the maximum amount of RAM available for the Optima application server.

   Example: -Xmx4G allows the Optima AS to use up to 4 GB of RAM.

   Typical configurations depend on the amount of RAM available on the machine and on your specific Optima installation. Assuming that the server is only used for Optima:

   • If only the Optima AS is running on the machine, set the value to 80% of the RAM available. This is typically not the case for the scenario where Optima is installed on a single server. You must at least have the PostgreSQL DB server running on the same machine.
   • If both the optima AS and the DB server are running on the machine, set the value to 60% of the RAM available.
   • If the installation includes one or more .NET components, such as TRE, VMS, etc., set the value to 50% of the RAM available.

The Optima AS needs to be registered and started as a service.

1. Open a Windows command prompt window as a system administrator.

2. Execute the command service.bat install.

   The script installs and registers the service ptv-optima-as.

3. To move to the correct folder, execute the command:
   cd C:\optima\ptv-optima-as\bin\service
4. Open the Windows Control Panel.
5. Open Administrative tools > Services.
6. Right-click the service.
7. Click Properties.
8. Change Startup Type to Automatic (Delayed start).

Important:  You need to perform this task ONLY if you need to run TS (→ Traffic Operator’s Guide TS).

1. With a text editor, open the file:
   C:\optima\ptv-optima-as\standalone\configuration/standalone.xml
   

2. Search for the node <datasources> and find the row <datasource> that contains enable=TRUE.

   Verify that the database parameters were added to the subnode <connection-url>. If you have followed the previous instructions, this is:

   <connection-url>
   jdbc:postgresql_postGIS://localhost:5432/optima
   </connection-url>

   (Should you have set a different IP address or port for the database when you installed PostgreSQL, change the IP address or the port number 5432 according to the IP address and the port number that you have used.)

3. Search for the node <security>.

4. Make sure that both <username> and <password> have been set to postgres:

   <security>
   
   <user-name>postgres</user-name>
   
   <password>postgres</password>
   
   </security>

5. Save the file standalone.xml.
6. With a text editor, open the file:
   C:\optima\ptv-optima-as\standalone\configuration\optima\optima-configuration.xml
7. Search for the node <appSettings>.

8. If the Traffic Supervisor module is deployed, you need to configure the correct time zone.

   In the file /opt/ptv-optima-as/standalone/configuration/optima/optima-configuration.xml, find the node <TSTimezone> (→ <TSTimezone> tag) where you can set the time zone of the network and model.

   For information on time zones, see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones.

   Example:
   

   <TSTimezone>Europe/Rome</TSTimezone>

9. Save the file /opt/ptv-optima-as/standalone/configuration/optima/optima-configuration.xml.

The AS can be configured to send log errors via e-mail.

The feature can be useful for different goals.

For examples, TomTom and INRIX interfaces can notify map version changes.

Setting the SMTP alerts

In a Windows environment, update the file:

C:\optima\ptv-optima-as\standalone\configuration\standalone.xml

In a Linux environment, update the file:

/opt/ptv-optima-as/standalone/configuration/standalone.xml

The information to be updated is:

• Handler (<custom-handler name="emailHandler"/>).
• E-mail address of the sender ("From").
• E-mail address of the receiver ("To").
• Host name of the SMTP server to send the e-mail ("SMTPHost").
• Port number of the SMTP server to send the e-mail ("SMTPPort").

Example:

<custom-handler name="emailHandler" class="org.apache.log4j.net.SMTPAppender" module="org.apache.log4j">
    <level name="ERROR"/>
    <formatter>
        <pattern-formatter pattern="%d{HH:mm:ss,SSS} %-5p [%c] (%t) %s%E%n"/>
    </formatter>
    <properties>
        <property name="BufferSize" value="1"/>
        <property name="From" value="name.surname@ptvgroup.com"/>
        <property name="To" value="name.surname@ptvgroup.com"/>
        <property name="Subject" value="Optima Warning"/>
        <property name="SMTPHost" value="${env.MAIL_SMTP_SOCKET_HOST:localhost}"/>
        <property name="SMTPPort" value="${env.MAIL_SMTP_SOCKET_PORT:25}"/>
     </properties>
</custom-handler>