ER/Studio Team Server Configuration Manager

From TeamServer ER/Studio
Jump to: navigation, search

Go Up to Overview of the ER/Studio Team Server Tools

Stop ER/Studio Team Server | From Windows: Start > All Programs > ER/Studio Team Server 4.0 > ER/Studio Team Server Configuration Manager

You can use the ER/Studio Team Server Configuration Manager to change the settings that you can choose when you install ER/Studio Team Server. These settings include those related to ER/Studio Team Server, ER/Studio Repository, LDAP user authentication, email server, and Reporting Repository.

After you perform any change in this configuration application, click OK to apply the changes and close the dialog. You can click Cancel to exit the configuration application without saving any change.

Note: Remember to restart ER/Studio Team Server after you exit the ER/Studio Team Server Configuration Manager. Some changes might require you to perform additional administrative actions, such as synchronizing ER/Studio Team Server with ER/Studio Repository.

The ER/Studio Team Server Configuration Manager provides the following tabs:

After you change any setting in a tab, ER/Studio Team Server Configuration Manager disables all other tabs, and enables the Apply and Reset buttons:

Note: Click any of these buttons to enable the other tabs back.
Item Description

Apply

Applies your configuration changes.

Reset

Undoes your configuration changes, restoring the last saved configuration.

Application Server Tab

On the Application Server tab you can access the following items:

Item Description

Server Host

The address of the server where ER/Studio Team Server is installed. This address can be:

  • A host name. For example: DEWKBROW01.
  • A fully qualified network name. For example: DEWKBROW01.example.com.
  • An IP address. For example: 10.10.23.255.

Server Port

The network port where ER/Studio Team Server listens for connections. The default port number is 80.

If another application, such as another web server application, is already using this port on your system, enter an unused port number between 0 and 65535. The ports in use depend on the services running on your system. A commonly-used alternative is 8, although using a high number, such as 10000, reduces the chance of a conflict.

Shutdown Port

The network port where ER/Studio Team Server listens for the shutdown command. The default port number is 8006.

If another application is already using this port on your system, enter an unused port between 0 and 65535.

Windows User

The domain and username of the user account to run ER/Studio Team Server. For example: MyDomain\MyUser.

User Password

The password of the specified Windows user account.

Enable Security Communication (HTTPS)

Check this option to enable the Hyptertext Transfer Protocol Secure (HTTPS) network protocol for connections to ER/Studio Team Server.

HTTPS is a combination of the Hypertext Transfer Protocol with the Secure Socket Layer (SSL)/Transport Layer Security (TLS) to provide encryption and secure identification of the server. Select this option to provide a secure channel between web browsers and ER/Studio Team Server when transferring private information such as user credentials.

HTTP Secure Port
(only when using HTTPS)

The network port to use for connections using the HTTPS secure network protocol.

KeyStore Password
(only when using HTTPS)

The password of your KeyStore file.

The KeyStore file is a password-protected file that contains the private and public keys used for SSL encryption.

Path to KeyStore
(only when using HTTPS)

The path to your KeyStore file.

Click Browse to browse your file system, find your KeyStore file, select it and click OK.

Email Server Tab

On the Email Server tab you can enable email support for users to send search results and reports. This tab provides the following items:

Item Description

Enable Sending of Email

Check this option to give ER/Studio Team Server the ability to send emails.

Host/Port
(only after enabling sending email)

The Host field is the address of the email server. This address can be:

  • A host name. For example: MSMAILOW01.
  • A fully qualified network name. For example: MSMAILOW01.example.com.
  • An IP address. For example: 10.10.23.255.

The Port field is the network port where the email server listens for connections. The default port number is 25.

From Address
(only after enabling sending email)

The email address that you want to use as the author of emails sent from ER/Studio Team Server.

You may want to prepare a special email address on your email server for this purpose.

Use Authenticated SMTP
(only after enabling sending email)

Use the Authenticated SMTP (Simple Mail Transfer Protocol) network protocol to connect to the email server.

User Name
(only after enabling Authenticated SMTP)

The username to log in to the email server.

Password
(only after enabling Authenticated SMTP)

The user password.

LDAP Server Tab

On the LDAP Server Tab tab, check the "Enable LDAP Authentication" option to let users log in to ER/Studio Team Server using their LDAP accounts.

If you check this option, you can access the following items:

Item Description

URL

The URL of the server running LDAP. For example: ldap://10.40.40.94:389.

Manager DN

The domain name for the administrative user that is used to authenticate users. For example: CN=User1,OU=Users,OU=ER STUDIO,DC=Torlabdomain,DC=com.

This is the account that ER/Studio Team Server uses to connect to the LDAP server, to validate the user credentials.

Manager Password

Password of the administrative user.

Search Base DN

Name of the root node in LDAP from which to search for users. For example: OU=Users,OU=ER STUDIO,DC=Torlabdomain,DC=com.

Search Attribute

The attribute in LDAP holding the login name of a user. For example: sAMAccountName (for ActiveDirectory).

Test User

A sample username to attempt to authenticate against the LDAP server. ER/Studio Team Server uses this user to validate the specified LDAP information.

Password

The password for the test user.

ER/Studio Repository Tab

On the ER/Studio Repository tab you can access the following items:

Item Description

ER/Studio Repository <n>.<n>

Host

The name of the machine where ER/Studio Repository is installed.

Super User

The username of a user with the Super User role in ER/Studio Repository.

Password

The user password.

Repository DBMS - <DBMS>

Enable Encrypted Connection
(only Microsoft SQL Server)

Check this option to enable the Secure Sockets Layer (SSL) communication protocol, which encrypts messages between ER/Studio Team Server and ER/Studio Repository.

Host/Port

The host name and port number of the machine that contains the ER/Studio Repository database.

For Microsoft SQL Server only, if ER/Studio Repository runs on a Microsoft SQL Server database that is a named instance, specify the host name in the format HostName\NamedInstanceName. For example: DEWKBOW01.embarcadero.com\RepositoryServer.

Database Name

The name of the ER/Studio Repository database.

User Name

The username of the user account to access the ER/Studio Repository database.

Password

The user password.

Report Repository Tab

On the Report Repository tab you can access the following items:

Item Description

Enable Encrypted Connection
(only Microsoft SQL Server)

Check this option to enable the Secure Sockets Layer (SSL) communication protocol, which encrypts messages between ER/Studio Team Server and the Reporting Repository.

Host/Port

The host name and port number of the machine that contains the Reporting Repository database.

For Microsoft SQL Server only, if the Reporting Repository runs on a Microsoft SQL Server database that is a named instance, specify the host name in the format HostName\NamedInstanceName. For example: DEWKBOW01.embarcadero.com\ReportingRepositoryServer.

Database Name
(only Microsoft SQL Server)

The name of the database.

SID
(only Oracle)

The identifier of the database.

DBName
(only DB2)

The name of the database.

Tablespace
(only Oracle and DB2)

The Tablespace information.

Admin User

An super user, a user with the privilege to create database tables, etc.

Admin Password

The super user password.

Same as Admin
(only Microsoft SQL Server)

Use the Admin User and Admin Password values for the User Name and Password fields.

User Name
(only Microsoft SQL Server)

The name of a user to read and write on the target database.

Password
(only Microsoft SQL Server)

The user password.

Connection Options

You can choose one of the following connection options:

  • Initialize an existing, empty database. Select this option to create a new Reporting Repository database. This option assumes that a Reporting Repository exists and is empty, and that the specified super user has the privileges required to create the Reporting Repository schema.
  • Connect to an existing Repository database. Select this option so that ER/Studio Team Server connects to an existing Reporting Repository. This assumes that the Reporting Repository exists and that ER/Studio Team Server can access all the Reporting Repository tables.
    Note: If you are upgrading ER/Studio Team Server, select this option to retain your connection to ER/Studio Repository. Permissions are preserved, but some of the solution repository information such as logs, become obsolete. If you choose this option, after the installation you must update the solution repository from the Admin page. If you used inherited roles, you must synchronize the repository.
  • Reinitialize current Repository database. Select this option to reinitialize the current Reporting Repository database. This option drops all solution tables and creates a new Reporting Repository schema. The super user must have the privilege to drop the tables and create the Reporting Repository schema.

Solution Repository Tab

On the Solution Repository tab you can access the following items:

Item Description

Enable Encrypted Connection
(only Microsoft SQL Server)

Check this option to enable the Secure Sockets Layer (SSL) communication protocol, which encrypts messages between ER/Studio Team Server and the Solution Repository.

Host/Port

The host name and port number of the machine that contains the Solution Repository database.

For Microsoft SQL Server only, if the Solution Repository runs on a Microsoft SQL Server database that is a named instance, specify the host name in the format HostName\NamedInstanceName. For example: DEWKBOW01.embarcadero.com\SolutionRepositoryServer.

Database Name
(only Microsoft SQL Server)

The name of the database.

SID
(only Oracle)

The identifier of the database.

DBName
(only DB2)

The name of the database.

Tablespace
(only Oracle and DB2)

The Tablespace information.

Admin User

An super user, a user with the privilege to create database tables, etc.

Admin Password

The super user password.

Same as Admin
(only Microsoft SQL Server)

Use the Admin User and Admin Password values for the User Name and Password fields.

User Name
(only Microsoft SQL Server)

The name of a user to read and write on the target database.

Password
(only Microsoft SQL Server)

The user password.

Connection Options

You can choose one of the following connection options:

  • Initialize an existing, empty database. Select this option to create a new Solution Repository database. This option assumes that a Solution Repository exists and is empty, and that the specified super user has the privileges required to create the Solution Repository schema.
  • Connect to an existing Repository database. Select this option so that ER/Studio Team Server connects to an existing Solution Repository. This assumes that the Solution Repository exists and that ER/Studio Team Server can access all the Solution Repository tables.
    Note: If you are upgrading ER/Studio Team Server, select this option to retain your connection to ER/Studio Repository. Permissions are preserved, but some of the solution repository information such as logs, become obsolete. If you choose this option, after the installation you must update the solution repository from the Admin page. If you used inherited roles, you must synchronize the repository.
  • Reinitialize current Repository database. Select this option to reinitialize the current Solution Repository database. This option drops all solution tables and creates a new Solution Repository schema. The super user must have the privilege to drop the tables and create the Solution Repository schema.

See Also