Transtream Setup reference

This is a list of settings in Transtream Setup grouped and ordered by how they are encountered during a typical new install.

Channel Cloud Settings

Top

These settings are requested on first installs. Once saved for a machine, they are reused. To change saved settings, in Transtream Setup, use File > Settings.

Channel Cloud Connection

Transtream Setup gets software packages from a cloud service. Your software vendor will have supplied you with credentials for this service. If you don't have your cloud credentials, contact your vendor.

Channel Staging Cloud Connection

By default, staging is set to False. See Staging.

Proxy (optional)

If you need to install through a proxy, supply the details here. You will need to supply the URL, Port, User Name and Password.

Server Settings

Top

These settings control where versions, instances and carrier components are installed. Select the Servers entry at the root of the Transtream Setup tree. There settings affect all servers managed by this Transtream Setup configuration. You cannot control them per server (unless you create individual server configuration files). Typically, you will not need to change these locations.

Transtream

Version Install Directory is where the Transtream software is installed. You can have multiple versions installed. Each version will be in this folder (unless the location was changed between version installs).
Instance Install Directory is where Transtream instances will be created. You can have multiple instances all using the same or different Transtream versions. They will all be created in this folder. The logs for each instance will also be created under this folder (per instance and provided logging is to file).
Connector Version Directory is where carrier components are kept. Each carrier has its own component.
If you want to change a location, click the current setting to display a Browse button. Use this to find and select the folder you want.

HubCapp

HubCapp is the same behavior as Transtream, but the default folders are HubCapp.

Application Pool Settings

Top

An application pool is a group of URLs served by the same process. Every instance requires an application pool, so you must define at least one in Transtream Setup.

Name must be unique. When you add Transtream or HubCapp instances, you'll select the application pool used. If an application pool does not already exist in IIS, Transtream Setup will create it for you when you Install > Run Now.
If you create an application pool using Transtream Setup and subsequently delete it, you will need to assign a new application pool to any instances that used the deleted one. Validation will warn of those instances affected by the deletion. Also note that deleting an existing application pool in Transtream Setup does not delete it in IIS. As it could potentially be in use elsewhere, such housekeeping has to be performed in IIS Manager.

Process Model (optional)

In IIS, by default, application pool processes run under the Network Service user account. If required, this group of settings lets you run the application pool's processes under a custom account. Improved security can be one reason for this, or if operating with a Windows Authentication based install.
Account and Password are the credentials for the custom account to be used. The custom account must exist. Transtream Setup will not create it for you. Maximum Worker Processes is the maximum number of worker processes permitted to service requests to the application pool.
See your IIS documentation for full details on custom accounts, their use, and their settings.

Windows Authentication based installation

Transtream supports the option for Windows Authentication based installation. This allows IIS and SQL to use existing accounts. Before configuration, ensure that SQL is set up to use a Windows account and Windows Authentication.

Open Transtream Setup.
Navigate to your chosen Application Pool.
Configure a custom user for IIS.
Ensure that the Process Model is configured for Windows Authentication setup.
Locate the relevant instance under Transtream Instances.
In the Storage section, leave the following fields blank: SQL Server Admin User, SQL Server Admin Password, SQL User and SQL Password. The lack of credentials initiates the Windows Authentication based install, and will require the Application Pool credentials to be populated.

When correctly configured, the SQL Server Connection field displays: Data Source={Datasource Name};Initial Catalog={Database Name};Integrated Security=True.

Transtream Instance - Configuration Settings

Top

This table includes all possible Transtream instance settings in Transtream Setup. The Update? column is whether the setting can be updated by running the install again (if not, you need to create a new instance). Although many settings are mandatory, several of them have defaults, and validation won't let you Apply an invalid configuration.

General group	Mandatory	Default	Update?
Name. Uniquely identifies the Transtream instance. Name always defaults to "Instance". You should always change this.	Yes	Instance	No
Version. The version of Transtream used by this instance. You can have multiple instances, and they can use different versions. This defaults to the latest version that is available to you, but the list includes all versions available to you (which could just be one).	Yes	Latest	Yes
License Key. Each instance must be licensed. Your vendor will have supplied you with a license token. During the install you will be asked to submit this token to obtain a license.	Yes	-	Yes

Authentication Settings group	Mandatory	Default	Update?
Machine Keys. These settings identify the instance for load balancing purposes. If not load balancing, you can ignore these settings. Validation Key and Description Key are alphanumeric keys to be used. They are 128 and 48 character respectively. In load balanced environments, the values must match on all servers.	-	-	-
Timeout (minutes). This is the timeout for inactive Transtream sessions. 5 minutes is the minimum.	Yes	720 min	Yes

Authentication Settings group

Mandatory

Default

Update?

Machine Keys. These settings identify the instance for load balancing purposes. If not load balancing, you can ignore these settings.

Validation Key and Description Key are alphanumeric keys to be used. They are 128 and 48 character respectively. In load balanced environments, the values must match on all servers.

Timeout (minutes). This is the timeout for inactive Transtream sessions. 5 minutes is the minimum.

Yes

720 min

Yes

Binding Settings group	Mandatory	Default	Update?
Application Pool. The application pool that the instance will use. The list includes all the application pools added in Transtream Setup.	Yes	-	Yes
Host Name. The URL that will be used to access the instance in a browser. It is created in IIS and must be unique. For testing or training installations you can modify your hosts file so that the URL resolves to your local machine, for example, add a 127.0.0.1 testsite row if you have specified testsite as your instance's Host Name. Typically, the hosts file is at C:\Windows\System32\drivers\etc. It is a text file that you can edit in any text editor. However, note that the Host Name setting cannot be updated once the instance has been created. You may need to register the Host Name in Domain Name System (DNS) if it is not accessible to all uesrs on the network. Note that an understanding of network configuration, or working with a professional, is beneficial to ensure correct configuration of Host Names.	Yes	-	No
Binding Protocol. This is HTTP or HTTPS. If you select HTTPS, you must supply the detail under SSL Certificate.	Yes	HTTP	No
SSL Certificate. If Binding Protocol is set to HTTPS, supply details here. You can find the detail in IIS Manager under Server Certificates. See your Microsoft documentation if you need help with IIS Manager, or Configure HTTPS.	Depends	-	Yes
Require Server Name Identification. If Binding Protocol is set to HTTPS, the setting activates and defaults to False. If set to True, multiple HTTPS Certificates can be configured under one IP address. Note that this applies to 2012 IIS 8.0 and above website bindings.	Depends	False	Yes

Compliance Engine group	Mandatory	Default	Update?
Compliance Engine Type. Whether to create a new Logistics Server, or use an existing Logistics Server. Default means a new Logistics Server will be created.	Yes	Default	Yes
Compliance Engine EndPoint. The URL of the existing Logistics Server.	Depends	-	Yes

Identity Provider group	Mandatory	Default	Update?
Url. The Url of the Pierbridge identity provider. Note the field only accepts valid test or live Pierbridge IdP Urls (e.g. https://login.tscloudidp.com).	Yes	-	Yes
Enable Self Sign-Up. Indicates if users can self-register from a Transtream login screen.	Yes	False	Yes

Logging group	Mandatory	Default	Update?
Logging Level. The default logging level is Error. The levels are Fatal, Error, Warn, Info and Debug. Levels are cumulative, with Debug giving the fullest possible logging. In Product Admin, you can view logs on the Diagnostics page.	Yes	Error	Yes
Logging Output. By default (File), activity is logged to time stamped files in a Logs folder under the instance’s installation folder (in the Transtream Setup tree, click Servers to see these folders). Console directs the logging to the DebugView application. This is available at: https://technet.microsoft.com/en-us/sysinternals/debugview.aspx. PaperTrail is a cloud-based log management service. See https://papertrailapp.com/ for details on PaperTrail.	Yes	File	Yes
PaperTrail Settings. When Logging Output is set to PaperTrail, set Destination Url and Destination Port to the host URL and port number for your PaperTrail account.	Depends	-	Yes

Logging group

Mandatory

Default

Update?

Logging Level. The default logging level is Error. The levels are Fatal, Error, Warn, Info and Debug. Levels are cumulative, with Debug giving the fullest possible logging.

In Product Admin, you can view logs on the Diagnostics page.

Yes

Error

Yes

Logging Output. By default (File), activity is logged to time stamped files in a Logs folder under the instance’s installation folder (in the Transtream Setup tree, click Servers to see these folders).

Console directs the logging to the DebugView application. This is available at: https://technet.microsoft.com/en-us/sysinternals/debugview.aspx.

PaperTrail is a cloud-based log management service. See https://papertrailapp.com/ for details on PaperTrail.

Yes

File

Yes

PaperTrail Settings. When Logging Output is set to PaperTrail, set Destination Url and Destination Port to the host URL and port number for your PaperTrail account.

Depends

Yes

Storage group	Mandatory	Default	Update?
Transtream stores its Apps and settings in a Microsoft SQL Server® database. You must provide sysadmin credentials to an existing SQL Server instance. Enter these in the SQL Server Admin User and SQL Server Admin Password settings. Provided it has valid credentials, Transtream Setup will create the required database using the details provided under SQL Server Connection.	Yes	-	Yes
SQL Server Connection. Transtream Setup uses these component settings to construct the connection string to the database. Note that if operating with a Windows Authentication based install, you are required to leave some fields blank. See Windows Authentication based install for detail. If you cannot enter details in any of the fields, it means that you have not supplied valid credentials in the SQL Server Admin User and SQL Server Admin Password fields. As you add detail, you'll see the connection string being constructed alongside this setting. See your SQL Server documentation for details on connection strings. The component settings are: Failover Partner. Not mandatory, but here you can give the URL of another server to use should the connection to the main server fail. Database Name. The name of the SQL Server database that Transtream Setup will create. SQL Server. The name of the SQL Server instance that the database will be created within. This instance must exist and the credentials given in the SQL Server Admin User and Password settings above must be valid for it. SQL User and SQL Password. The user and password that will be created and subsequently used to access this database. SQL Options. Not mandatory, but here you can add any additional connection string options required. See your SQL Server documentation for details on other parameters supported in connection strings. If adding multiple pairings, separate them with semi-colons.	Yes	-	Yes

Storage group

Mandatory

Default

Update?

Transtream stores its Apps and settings in a Microsoft SQL Server® database. You must provide sysadmin credentials to an existing SQL Server instance. Enter these in the SQL Server Admin User and SQL Server Admin Password settings.

Provided it has valid credentials, Transtream Setup will create the required database using the details provided under SQL Server Connection.

Yes

SQL Server Connection. Transtream Setup uses these component settings to construct the connection string to the database. Note that if operating with a Windows Authentication based install, you are required to leave some fields blank. See Windows Authentication based install for detail.

If you cannot enter details in any of the fields, it means that you have not supplied valid credentials in the SQL Server Admin User and SQL Server Admin Password fields.

As you add detail, you'll see the connection string being constructed alongside this setting. See your SQL Server documentation for details on connection strings.

The component settings are:

Failover Partner. Not mandatory, but here you can give the URL of another server to use should the connection to the main server fail.
Database Name. The name of the SQL Server database that Transtream Setup will create.
SQL Server. The name of the SQL Server instance that the database will be created within. This instance must exist and the credentials given in the SQL Server Admin User and Password settings above must be valid for it.
SQL User and SQL Password. The user and password that will be created and subsequently used to access this database.
SQL Options. Not mandatory, but here you can add any additional connection string options required. See your SQL Server documentation for details on other parameters supported in connection strings. If adding multiple pairings, separate them with semi-colons.

Yes

Transtream Credentials	Mandatory	Default	Update?
Once the instance is created, these credentials give access to its Admin screens in a browser. A user with these credentials is created in the Administration App. This user has Admin role meaning they can access all Apps.	Yes	-	No

HubCapp Instance - Configuration Settings

Top

This table includes all possible HubCapp instance settings in Transtream Setup. The Update? column is whether the setting can be updated by running the install again (if not, you need to create a new instance). Although many settings are mandatory, several of them have defaults, and validation won't let you Apply an invalid configuration.

General group	Mandatory	Default	Update?
Name. Uniquely identifies the HubCapp instance. Name always defaults to "Instance". You should always change this.	Yes	Instance	No
Version. The version of HubCapp used by this instance. You can have multiple instances, and they can use different versions of HubCapp. This defaults to the latest version that is available to you, but the list includes all versions available to you (which could just be one).	Yes	Latest	Yes
License Key. Each instance must be licensed. Your vendor will have supplied you with a license token. During the install you will be asked to submit this token to obtain a key that will then populate this field. This key is what you need to supply to your users along with the HubCapp URL in order for them to connect.	Yes	-	Yes

Binding Settings group	Mandatory	Default	Update?
Application Pool. The application pool that the instance will use. The list includes all the application pool instances added in Transtream Setup.	Yes	-	Yes
Host Name. The URL that will be used to access the instance. In a browser, this will take users to this instance of HubCapp. It is used by IIS; and must be unique.	Yes	-	No
Binding Protocol. This is HTTP or HTTPS. If you select HTTPS, you must supply the detail under SSL Certificate.	Yes	HTTP	No
SSL Certificate. If Binding Protocol is set to HTTPS, supply details here. You can find the detail in IIS Manager under Server Certificates. See your Microsoft documentation if you need help with IIS Manager.	Depends	-	Yes

Logging group	Mandatory	Default	Update?
Logging Level. The default logging level is Error. The levels are Fatal, Error, Warn, Info and Debug. Levels are cumulative, with Debug giving the fullest possible logging.	Yes	Error	Yes
Logging Output. By default (File), activity is logged to time stamped files in a Logs folder under the instance’s installation folder (in the Transtream Setup tree, click Servers to see these folders). Console directs the logging to the DebugView application. This is available at: https://technet.microsoft.com/en-us/sysinternals/debugview.aspx. The DebugView Application is only supported on Microsoft operating systems Vista and below. PaperTrail is a cloud-based log management service. See https://papertrailapp.com/ for details on PaperTrail.	Yes	File	Yes
PaperTrail Settings. When Logging Output is set to PaperTrail, set Destination Url and Destination Port to the host Url and port number for your PaperTrail acount.	Depends	-	Yes

Logging group

Mandatory

Default

Update?

Logging Level. The default logging level is Error. The levels are Fatal, Error, Warn, Info and Debug. Levels are cumulative, with Debug giving the fullest possible logging.

Yes

Error

Yes

Console directs the logging to the DebugView application. This is available at: https://technet.microsoft.com/en-us/sysinternals/debugview.aspx.

The DebugView Application is only supported on Microsoft operating systems Vista and below.

PaperTrail is a cloud-based log management service. See https://papertrailapp.com/ for details on PaperTrail.

Yes

File

Yes

PaperTrail Settings. When Logging Output is set to PaperTrail, set Destination Url and Destination Port to the host Url and port number for your PaperTrail acount.

Depends

Yes

Article last edited 6 April 2020