Trerado Collaborator – Installation Guide

PostedAugust 20, 2025

This guide provides step-by-step instructions for installing Trerado Core and Trerado Collaborator.

1 System Architecture

Refer to the Trerado Collaborator Architecture diagram to understand the interaction between components such as Collaborator, Core services, databases, and designer repositories.

2 Prerequisites to install Trerado Collaborator

2.1 Application Server Specifications

These are the minimum recommended specifications for running Trerado Collaborator smoothly. Actual performance may vary based on load and deployment environment.

Resource	Minimum	Recommend (for >100 concurrent users)
Memory	8 GB	16 GB
CPU	2.4 GHz x 4 cores	2.4 GHz x 8 cores
Disk Space	20 GB	20 GB+

2.2 Database Server Specifications

The following are the minimum server specifications for the database server of Collaborator.

Resource	Minimum
Memory	8 GB
CPU	2.4 GHz x 4 cores
Disk Space	20 GB

2.3 Supported Operating Systems

Windows Server 2012 / 2012 R2

Windows Server 2016 / 2019 / 2022 / 2025

Windows 7 – SP1 Required

Windows 8

Windows 10

Windows 11

Note:

Administrator privileges are required.

Windows Server is recommended for enterprise deployments.

2.4 Supported Trerado Designer Databases

Collaborator allows you to add repositories from the following Designer database servers.

MySQL Server (8.0 and above)

MSSQL Server (2016 and above)

PostgreSQL Server (13 and above)

Oracle Server (12c Release 2 (12.2) and above)

SQLite

MariaDB Server (10.5.28 and above)

Note:

A user with appropriate permissions should be present for each Designer database. Note that Active Directory credentials cannot be used.

If you are using Postgres database, run the following query in all the repositories:
create extension hstore

The database of type Firebird is currently not supported.

2.5 Trerado Designer Database Drivers

You can use Open Server Connections – Native Connection or ODBC/OLE DB Connections to connect with the database. Please refer to the links below for more information.

Native Connections

SQL database (Read More)

MySQL databases (Read More)

PostgreSQL databases (Read More)

Oracle databases (Read More)

MariaDB (Read More)

ODBC/OLE DB Connections

SQL database (Read More)

MySQL databases (Read More)

PostgreSQL databases (Read More)

Oracle databases (Read More)

MariaDB (Read More)

2.6 Trerado Core Configuration Client

Ensure the Sparx Systems Trerado Core Configuration Client is installed and running.

2.7 Supported Trerado Collaborator Database Servers

Microsoft SQL Server 2016 and above

SQL Server Express 2016 and above

MySQL Server 8.0 and above

The following details of the Collaborator database should be readily available before the installation:

Server Name/IP Address

Database name

Username

Password

Note:

For the MySQL database server, please note the following.

The collation type of the database should be mandatorily set as “utf8mb4_general_ci” in MySQL server. Query to create MySQL database:
CREATE DATABASE treradocollaborator CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;

Check your max_allowed_packet size value in MySQL configuration. If it is less than 100, update it to 1024 or higher. Unit of max_allowed_packet is bytes.

Check your sql-mode or sql_mode value in MySQL configuration. If it contains ONLY_FULL_GROUP_BY, remove it. ONLY_FULL_GROUP_BY introduced in MySQL v8 which causes an issue in running custom query in Collaborator to retrieve data from Designer model database. Removing it will fix the issue that occurred while running the custom query and will not pose any issues for Designer repositories.

For the MSSQL database server, please note the following.

‘SQL Server Authentication’ mode is preferred.

Active Directory logins are not supported.

Refer to the Appendix on setting up the MSSQL or MySQL database for Trerado Collaborator.

2.8 Firewall / Port

The following ports should be opened in the firewall for uninterrupted action.

Designer database(s): Trerado Core should be able to access the Trerado Designer database(s).

Trerado Core: Trerado Collaborator and Designer should be able to connect with Trerado Core. The default port for HTTP protocol is 2804, and HTTPS is 2805.

Trerado Collaborator Database: The Collaborator application should be able to connect to its database.

Trerado Collaborator Application: End users should be able to access the Collaborator application. You will be asked to open a port during installation.

Trerado Collaborator WebSocket: End-users should be able to receive real-time in-app notifications from the Collaborator application. You will be asked to open a port during the installation of Collaborator.

Note:

Ensure that all ports are open in the firewall. Refer to the Appendix for firewall configuration steps.

2.9 Support Browsers

Trerado Collaborator is compatible with the following browsers.

Chrome 44 and above

Firefox 38 and above

Safari 9 and above

Microsoft Edge 75 and above

Recommended Screen Resolution: Minimum 1280×720 for optimal experience.

Looking for cloud options to eliminate infrastructure woes? Learn more here.

3 Install and Configure Trerado Core Server

In this section, let us look at the steps involved in setting up Trerado Core in a new environment.

Ensure the prerequisites are met, and the Trerado Core installation file is downloaded.

3.1 Install Trerado Core Server

The Trerado Core installer is a standard Microsoft installer. Double-click on it to start the installation process and follow the steps on screen.

3.2 Create License Request

Follow the steps below to create a license request for Trerado Core Services

Open Trerado Core Configuration Client. The application shortcut can be found on the desktop.

Enter the following details and click Ok to open the service.
Server Address – localhost:2803
Password – Password of the Trerado Core Service

Click on Licensing.

Click on Create Request and fill in the required details. Click here to learn more.

Once the details are filled, click OK and save the license request file.

Send the ‘License Request’ file to our Sales Team at sales[at]sparxsystems[dot]com

3.3 Upload License

Once you send your license request, our sales team will sign your request and share a license certificate after validating the request.

To upload the license, kindly follow the steps below.

Open Trerado Core Configuration Client.

Navigate to the licensing window.

Click Add.

Select the license certificate and click Open. The license will be added.

Once the license is added successfully, ensure the license details and information are correct.

4 Install Trerado Collaborator

In this section, let us look at the steps involved in setting up Trerado Collaborator in a new environment.

4.1 Prerequisites

Ensure the prerequisites are met, and the Trerado Collaborator installation file is downloaded.

4.2 Run the Installer

Once the file is downloaded, extract its contents into a folder. Run Setup.exe as administrator.

Click on Next.

4.3 Accept EULA

Check the box to accept the terms and click Next.

4.4 Select Installation Path

Select a file path to install Trerado Collaborator.

4.5 Select Database Server

Choose the Database server (MySQL or MSSQL) in which the Trerado Collaborator database is hosted, and then choose Run Schema.

The skip this step option should not be used for fresh installations.

4.6 Provide Database Details

Fill in the Trerado Collaborator database details in the given fields.

4.7 Configure Trerado Collaborator

Enter the Trerado Collaborator server details in the given fields.

Field	Description
Host	Enter Domain Name or IP Address (E.g., localhost)
Port Number	Enter a Port Number that is not used. The port should be opened in the Firewall. Click here to know more.
Email ID of an Admin	Enter an Email ID. This user will be made the Super Admin of Collaborator.

enter collaborator host and admin details

4.8 Configure Push Notifications for Trerado Collaborator

Enter the required details in the given fields to configure push notifications for Trerado Collaborator.

Field	Description
Host	The Domain Name or IP Address entered in the previous step is displayed automatically.
Port Number	Enter a Port Number that is not used. The port should be opened in the Firewall. Click here to know more. The default port number is 8080.

enter port number for push notifications

4.9 Install Trerado Collaborator

Review the information in the previous steps and click Install to begin the installation process.

Note:

Write down the credentials or take a screenshot of this information for future reference.

A command prompt will appear once the setup is complete, like the one in the figure below. The command window will close automatically.

click finish to complete the installation

Click Finish once the installation is completed successfully.

4.10 Update Protocol and Domain

By default, the application will use the default protocol (HTTP) and domain (localhost) given during the installation.

To run your application using the HTTPS protocol and secure domain, the admin must manually configure the WebApp and Push Notifications settings in Collaborator Management.

Update WebApp

Open the Collaborator Management from the installation folder (C:\Program Files\Sparx Systems\Trerado Collaborator\ Collaborator Management) and run the CollaborateManagement.exe as an administrator.

Click on Manage Configuration and open the WebApp section.

Do the following to enable the HTTPS protocol.

Field	Description
Host	Enter Domain Name or IP Address.
Port Number	Enter a Port Number that is not used. The port should be opened in the Firewall. Click here to know more.
Certificate	Upload a valid .pfx certificate file for your domain.
Password	Enter the password for the uploaded certificate.

After making the changes, enable the Use HTTPS option and then click on Save to save the changes.

Restart all the Collaborator Services once the save action is successful.

Update Push Notification

Click on Manage Configuration and open the Push Notification section.

Do the following to enable the HTTPS protocol.

Field	Description
Host	Enter Domain Name or IP Address.
Port Number	Enter a Port Number that is not used. The port should be opened in the Firewall. Click here to know more.
Certificate	Upload a valid .pfx certificate file for your domain.
Password	Enter the password for the uploaded certificate.

After making the changes, enable the Use HTTPS option and then click on Save to save the changes.

update domain and protocol for push notification

Restart all the Collaborator Services once the save action is successful.

4.11 Access Trerado Collaborator

Launch your preferred web browser (e.g., Google Chrome, Mozilla Firefox, Microsoft Edge).

In your browser’s address bar, enter the following

Protocol

Domain or IP Address

Port Number

Example: https://treradocollaborator.com/443

After entering the correct URL, press Enter. The web browser will load the Trerado Collaborator application interface. You will be prompted to log in. Use the administrator credentials to log in.

5 Get Started with Trerado Collaborator

Activate License – Ensure the appropriate licenses are installed to grant users full access to all application features.

Add Repositories – Repositories are the first elements users interact with after logging in.

Users can only manage repositories to which they have been granted access.

Only Administrators have the permission to create new repositories.
Refer to the Appendix to learn how to add a model in Trerado Core and connect it in Trerado Designer.

Add Users and User Groups – Users are team members collaborating within a repository. Each user’s ability to view or modify content is based on the access rights assigned by the administrator to the individual user or to the user group that he is a part of.

Configure Sections – Define which Trerado Designer model packages should be accessible through Collaborator. This helps tailor the user experience by focusing only on relevant models.

Set up Access Permissions – Administrators can assign controlled access to individual users or user groups, ensuring that the right people have the appropriate level of interaction within the platform.

Configure Mailer – Collaborator uses your SMTP or MS Graph server to send emails for account activations, notifications, reviews, and more. To ensure reliable email delivery, configure your Mailer settings correctly.

Setup Active Directory – Enable Active Directory integration to allow users from your organization to log in to Collaborator using their existing domain credentials, streamlining authentication and user management.

6 Generate Data Cache to View Diagrams

Enabling and generating a Data Cache is a one-time activity. Collaborator relies on this data cache to show its users live diagrams and linked documents.

To create a data cache in Trerado Designer, follow the steps below:

Open the model in Trerado Designer.

Click on the Settings menu in the ribbon and choose Options.

Navigate to the Cloud section and enable the two checkboxes under Data Cache.

Click Create to generate a data cache.

To generate cache periodically,

Open Trerado Core Config Client.

Double-click on a Database Manager to edit.

Enable Periodically Generate Diagram Images for WebEA & Prolaborate option.
Click on Configure and enter the following information.

Field	Description
Port	Select the Port that you are using to connect to this EA repository.
Model User	Enter a valid repository user. Ignore if model security is not enabled.
Model Password	Enter the password for the repository user. Ignore if model security is not enabled.
Interval (seconds)	Set the interval. The default value is 30 seconds.

Click OK and restart the Sparx Systems Trerado Core Services from the task manager.

7 Appendix

7.1 How to Open a Port

Make sure the firewall is enabled by confirming that ‘Firewall state’ is set to ‘On’ and not to ‘Off’.

Step 1: Open Windows Defender Firewall with Advanced Security.

Step 2: In the left-hand side of the navigation bar, click Inbound Rules.

Step 3: From the right side of the Inbound Rules tab, click on ‘New Rule’. The new rule wizard launches.

Step 4: Select ‘PORT’ and click ‘Next’.

Step 5: Select ‘TCP’ and in the Specific local ports section, enter the Port number that needs to be opened and click on ‘Next’.

Step 6: Select ‘Allow the connection’ and click ‘Next’.

Step 7: Make sure all Domains, Private and Public, are checked and click ‘Next’.

Step 8: Specify the Name and Description for the port and click ‘Finish’.

7.2 Setup SQL Server

7.2.1 How to Create a Database for Trerado Collaborator in SQL Server

‘SQL Server authentication’ must be enabled, and an admin account must be created. The following settings must be accomplished:

Step 1: Create a new Database called with the required name (e.g. TreradoCollaborator).

Step 2: Create a new user by using the ‘New Login’ option under Security -> Login section.

Step 3: Uncheck ‘Enforce password policy’.

Step 4: Set the default database to ‘ TreradoCollaborator’.

Step 5: Configure ‘Server Roles’, grant access to all admin privileges.

Step 6: ‘User Mapping’, maps the database to the new user.

Step 7: Configure ‘Status’ as shown below:

Step 8: Click OK to save the changes.

7.2.2 How to Create a Database for Trerado Designer in SQL Server

Follow the steps below to create a database for Trerado Designer.

Create a database for the Designer model and execute the following scripts in the Designer database: first, execute ‘EASchema_1558_SQLServer.sql’ (Click here to download), and then execute ‘EABase_1558_SQLSvr.sql’ (Click here to download).

7.3 Setup MySQL Server

7.3.1 Update MySQL Configuration

Post installing MySQL server, check and update the max_allowed_packet size and sql-mode or sql_mode values in MySQL configuration file by following the steps below,

Press the Win + R key

Enter %programdata% and click Ok.

Open the my.ini file located at “C:\ProgramData\MySQL\ MySQL Server [your server version]”. (E.g., “C:\ProgramData\MySQL\MySQL Server 8.0”) in Notepad.

Check your max_allowed_packet size value in MySQL configuration. If it is less than 100, update it to 1024 or higher. Unit of max_allowed_packet is bytes.

Check your sql-mode or sql_mode value in MySQL configuration. If it contains ONLY_FULL_GROUP_BY, remove it. ONLY_FULL_GROUP_BY was introduced in MySQL v8 which causes an issue in running a custom query in Collaborator to retrieve data from the Designer Model DB. Removing it will fix the issue that occurred in running the custom query and will not pose any issues for Designer repositories.

Once the changes are done, save the file.

7.3.2 How to Create a Database for Trerado Collaborator in SQL Server

To create a new Trerado Collaborator database, follow the steps below,

Step 1: Open MySQL Workbench and create a new connection.

Step 2: Open the new connection.

Step 3: Create a new database called ‘TreradoCollaborator’ with charset ‘utf8mb4’ and collation ‘utf8mb4_general_ci’.

You can also execute a query to create a new database.

CREATE DATABASE treradocollaborator CHARACTER SET utf8mb4 COLLATE utf8mb4_general_ci;

Click on Apply to the database.

Step 4: Click on Finish.

7.3.3 How to Create a Database for Trerado Designer in MySQL Server