Database tab

Specifies the configuration of the databases AgilePoint Server uses to store data.

Prerequisites

How to Start

  1. On the AgilePoint Server machine, in Windows Explorer, right-click the file (AgilePoint Server installation folder) C:\Program Files\AgilePoint\AgilePoint Server\WCFConfigurationUtility.exe, and click Run as Administrator.

    Configuration Utility Run As Administrator Screen
  2. On the AgilePoint Server Manager screen, in the left pane, select your AgilePoint Server instance.

    Select AgilePoint Server Intance
  3. Click Open Server Configuration Open Server Configuration icon.

    Click Open Server Configuration
  4. On the AgilePoint Server Configuration screen, click the Database tab.

    Click Database tab

Main Database

Specifies the connection to the AgilePoint workflow database to store the data for processes. The main database is workflow database.

Figure: AgilePoint Configuration > Database > Main Database tab

Main Database tab

Fields

Field NameDefinition

Database Type
Description:
Specifies the database technology to store your data.
Allowed Values:
  • Microsoft SQL Server
  • MySQL
  • Oracle
Default Value:
Microsoft SQL Server

Encrypt Database Setting
Description:
Specifies whether to encrypt your stored database settings.
Allowed Values:
  • Selected - Saves the database settings in encrypted format.
  • Deselected - Saves the database settings in plain text.
Default Value:
Deselected

User Name
Description:
The user name for the account AgilePoint Server uses to connect to the database.
Allowed Values:
An alphanumeric string that contains a user name for the database.
Default Value:
sa

Password
Description:
The password for the authentication account.
Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None

Integrated Security
Description:
Specifies whether the Windows account credentials for the runtime app user are used for authentication.
To Open this Field:
  1. In the Database Type list, select Microsoft SQL Server.
Allowed Values:
  • Selected - The Windows account credentials for the runtime app user are used to access the database.
  • Deselected - The user name and password fields are enabled for database authentication, and you must enter the database credentials.
Default Value:
Selected

Database Server
Description:
Specifies the server name and domain for your database.
To Open this Field:
  1. In the Database Type list, select Microsoft SQL Server.
Allowed Values:
A valid database server name.
Default Value:
None

Database
Description:
Specifies the name of your database.
To Open this Field:
  1. In the Database Type list, select Microsoft SQL Server.
Allowed Values:
A database name.

Click Ellipses to populate the database names from the database server.

Default Value:
None

Connection Pool Size
Description:
Specifies the maximum number of simultaneous database connections for the workflow database.
Allowed Values:
An integer.

It is recommended to use a connection pool size that is >= 100, or 2 * the thread pool size.

Default Value:
100

Archive Database

Specifies the connection to the Archive database to store backup of your application data.

Figure: AgilePoint Configuration > Database > Archive Database tab

Archive Database tab

Fields

Field NameDefinition

Database Type
Description:
Specifies the database technology to store your data.
Allowed Values:
  • Microsoft SQL Server
  • MySQL
  • Oracle
Default Value:
Microsoft SQL Server

Encrypt Database Setting
Description:
Specifies whether to encrypt your stored database settings.
Allowed Values:
  • Selected - Saves the database settings in encrypted format.
  • Deselected - Saves the database settings in plain text.
Default Value:
Deselected

User Name
Description:
The user name for the account AgilePoint Server uses to connect to the database.
Allowed Values:
An alphanumeric string that contains a user name for the database.
Default Value:
sa

Password
Description:
The password for the authentication account.
Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None

Integrated Security
Description:
Specifies whether the Windows account credentials for the runtime app user are used for authentication.
To Open this Field:
  1. In the Database Type list, select Microsoft SQL Server.
Allowed Values:
  • Selected - The Windows account credentials for the runtime app user are used to access the database.
  • Deselected - The user name and password fields are enabled for database authentication, and you must enter the database credentials.
Default Value:
Selected

Database Server
Description:
Specifies the server name and domain for your database.
To Open this Field:
  1. In the Database Type list, select Microsoft SQL Server.
Allowed Values:
A valid database server name.
Default Value:
None

Database
Description:
Specifies the name of your database.
To Open this Field:
  1. In the Database Type list, select Microsoft SQL Server.
Allowed Values:
A database name.

Click Ellipses to populate the database names from the database server.

Default Value:
None

Archive Completed Process In
Description:
Specifies the minimum number of days to save Completed or Cancelled processes before archiving.
Allowed Values:
An integer.

Represents

  • A number of days

Rules:

  • If you set this value to 0, archiving does not occur.
Default Value:
180

Data Entities Database

Specifies the connection to the Data Entities database to store the data.

Figure: AgilePoint Configuration > Database > Data Entity Database tab

Data Entity Database tab

Fields

Field NameDefinition

Database Type
Description:
Specifies the database technology to store your data.
Allowed Values:
  • Microsoft SQL Server
  • MySQL
  • Oracle
Default Value:
Microsoft SQL Server

Encrypt Database Setting
Description:
Specifies whether to encrypt your stored database settings.
Allowed Values:
  • Selected - Saves the database settings in encrypted format.
  • Deselected - Saves the database settings in plain text.
Default Value:
Deselected

User Name
Description:
The user name for the account AgilePoint Server uses to connect to the database.
Allowed Values:
An alphanumeric string that contains a user name for the database.
Default Value:
sa

Password
Description:
The password for the authentication account.
Allowed Values:
An alphanumeric string that represents a password.
Default Value:
None

Integrated Security
Description:
Specifies whether the Windows account credentials for the runtime app user are used for authentication.
To Open this Field:
  1. In the Database Type list, select Microsoft SQL Server.
Allowed Values:
  • Selected - The Windows account credentials for the runtime app user are used to access the database.
  • Deselected - The user name and password fields are enabled for database authentication, and you must enter the database credentials.
Default Value:
Selected

Database Server
Description:
Specifies the server name and domain for your database.
To Open this Field:
  1. In the Database Type list, select Microsoft SQL Server.
Allowed Values:
A valid database server name.
Default Value:
None

Database
Description:
Specifies the name of your database.
To Open this Field:
  1. In the Database Type list, select Microsoft SQL Server.
Allowed Values:
A database name.

Click Ellipses to populate the database names from the database server.

Default Value:
None

Connection Pool Size
Description:
Specifies the maximum number of simultaneous database connections for the workflow database.
Allowed Values:
An integer.

It is recommended to use a connection pool size that is >= 100, or 2 * the thread pool size.

Default Value:
100