Set Up a Database for AgilePoint Data Entities

AgilePoint Data Entities is a new component in AgilePoint NX v7.0. The Upgrade Installer installs this component, but it can not create the associated database on your database server. Therefore, you must create the database, and connect it to AgilePoint Server after you run the Upgrade Installer.

To set up a database for AgilePoint Data Entities, do the procedure in this topic.

Prerequisites

  • You are upgrading from AgilePoint NX v6.0 or v6.0 SP1 to v7.0 or higher.
  • Run the Upgrade Installer for AgilePoint NX v7.0.
    Note: You must run the Upgrade Installer before you create Data Entities database.

Good to Know

  • This component is required for all AgilePoint NX OnPremesis environments.
  • It is only necessary to create the database. You do not need to create database tables.

Create a Database for Data Entities

To create a database for Data Entities, do the procedure in this topic.

How to Start

  1. Make sure your SQL Server is up and running.
  2. Open the SQL Server Management Studio:
    1. On the AgilePoint Server machine, click Start, and enter SSMS.
    2. On the search results, click SQL Server Management Studio.

Procedure

  1. In SQL Server Management Studio, right-click Databases > New Database.
  2. On the New Database screen, enter a database name.

AgilePoint Database

ComponentDatabase Name (Suggested but Optional)Database Optional for Component?Function

Data Entities

AP_Data_Entities_DB

No

Stores the data for the Data Entities component.

Configure the Database for Data Entities in AgilePoint Server

To configure a database for Data Entities in AgilePoint Server, do the procedure in this topic.

Figure: AgilePoint Configuration > Database > Data Entity Database tab

AgilePoint Configuration Database Data Entity Database tab

Prerequisites

  • Create a database for Data Entities on your database server.

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
  5. On the Database tab, click the Data Entities tab.

Procedure

  1. On the Data Entities tab, in the Database Type list, select Microsoft SQL Server.
  2. Complete these fields.
    Field NameDefinition

    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.
    To Open this Field:
    1. Turn off Windows Authentication.
    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
  3. In the Database Server field, enter the server name and domain for your database.
  4. In the Database Name list, select the name of the database that you created for Data Entities.

    Click the Ellipses to get the database names in the Database Name list from the database server.

  5. Complete this field.
    Field NameDefinition

    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