Microsoft SQL Repository


These instructions are specific to Microsoft SQL Server 2017 Evaluation Edition, running on Windows Server 2019, and may require adjustments for other environments.

Install Microsoft SQL Server and Associated Tools
  1. Install Microsoft SQL Server:

    1. On the Installation has completed successfully! page of the installer, click Customize to launch the SQL Server Setup application.

    2. Select the server instance you just created, and continue through setup. On the Feature Selection step, select at least the following options:

      • SQL Server Replication

      • Full-Text and Semantic Extractions for Search

    3. Continue through the setup and verify that the required options were successfully installed, as displayed on the Complete page.

      SQL Server Feature Selection Screenshot

  2. Download and install SQL Server Management Studio (SSMS).

  3. Restart the server.

  4. Launch SSMS, and connect to the SQL server instance.

  5. From the Object Explorer, right-click the SQL server instance, and then click Properties.

  6. On the Security page, in the Server authentication area, select SQL Server and Windows Authentication Mode, and then click OK.

  7. From the Object Explorer, right-click the SQL server instance, and then click Restart.

  8. Configure TCP/IP:

    1. Launch SQL Server Configuration Manager.

    2. From the left pane, expand the SQL Server Network Configuration node, and click Protocols for serverName.

    3. Double-click TCP/IP.

    4. In the TCP/IP Properties window, from the Protocol tab, click the Enable drop-down menu, and select Yes.

    5. Click the IP Addresses tab, and make the following changes under IPAll, and then click OK:

      • In the TCP Dynamic Ports field, enter 0.

      • In the TCP Port field, enter 1433.

    6. From the left pane, click SQL Server Services, right-click SQL Server (serverName), and then click Restart.

    7. Configure the firewall to allow IDM to access the SQL Server.

Install and Configure IDM to Use the SQL Repository
  1. Install IDM.


    Do not start IDM.

  2. Import the IDM data definition language script into Microsoft SQL:

    1. Launch SSMS.

    2. In the Connect to Server window, select Windows Authentication and click Connect.

    3. From the main menu, select File > Open > File, navigate to the data definition language script (C:\path\to\openidm\db\mssql\scripts\openidm.sql), and click Open.

    4. Click Execute.

      SSMS displays a message in the Messages tab:

      Commands completed successfully.
      Completion time: 2020-11-02709:26:39.1548666-08:00

      Executing the openidm.sql script creates an openidm database for use as the internal repository, and an openidm user with password openidm who has all the required privileges to update the database. You may need to refresh the view in SSMS to see the openidm database in the Object Explorer.

      If you expand Databases > openidm > Tables, you should see the IDM tables in the openidm database:

      Default tables in the openidm Microsoft SQL database
  3. Execute the script that creates the tables required by the workflow engine; for example:

    sqlcmd -S localhost -d openidm ^
    -i C:\path\to\openidm\db\mssql\scripts\flowable.mssql.all.create.sql
    (1 rows affected)
    (1 rows affected)
    (0 rows affected)


    When you run the flowable.mssql.all.create.sql script, you may see the following warning in the log:

    Warning! The maximum key length is 900 bytes. The index 'ACT_UNIQ_PROCDEF' has maximum
    length of 1024 bytes. For some combination of large values, the insert/update operation will fail.

    It is very unlikely that the key length will be an issue in your deployment, and you can safely ignore this warning.

  4. If you are going to direct audit logs to this repository, run the script that sets up the audit tables:

    sqlcmd -S localhost -d openidm ^
    -i C:\path\to\openidm\db\mssql\scripts\audit.sql
  5. Download the Microsoft JDBC Drivers for SQL Server:

    1. Download the JDBC Drivers from Microsoft's download site. IDM requires at least version 7.2 of the driver, which supports OSGi by default.

    2. Extract the driver JAR files.

    3. Copy the JAR file that corresponds to your Java environment to the C:\path\to\openidm\bundle directory. For example:

      copy mssql-jdbc-7.4.1.jre11.jar C:\path\to\openidm\bundle
  6. Download the JDBC OSGi Service Package JAR and place it in the C:\path\to\openidm\bundle directory.


    IDM was tested with version 1.0.0 of the service package.

  7. Remove the default DS repository configuration file (repo.ds.json) from your project's conf/ directory. For example:

    cd C:\path\to\openidm\my-project\conf\
    del repo.ds.json
  8. Copy the database connection configuration file for Microsoft SQL (datasource.jdbc-default.json) and the database table configuration file (repo.jdbc.json) to your project's configuration directory. For example:

    cd C:\path\to\openidm
    copy db\mssql\conf\datasource.jdbc-default.json my-project\conf\
    copy db\mssql\conf\repo.jdbc.json my-project\conf\
  9. Update the connection configuration to reflect your Microsoft SQL deployment. The default connection configuration in the datasource.jdbc-default.json file is as follows:

        "driverClass" : "",
        "jdbcUrl" : "jdbc:sqlserver://&{}:&{openidm.repo.port};instanceName=default;databaseName=openidm;applicationName=OpenIDM",
        "databaseName" : "openidm",
        "username" : "openidm",
        "password" : "openidm",
        "connectionTimeout" : 30000,
        "connectionPool" : {
            "type" : "hikari",
            "minimumIdle" : 20,
            "maximumPoolSize" : 50

    Specify the values for and openidm.repo.port in one of the following ways:

    Set the values in resolver/ or your project's conf/ file, for example:

    Set the properties in the OPENIDM_OPTS environment variable before startup. You must include the JVM memory options when you set this variable. For example:

    set:OPENIDM_OPTS="-Xmx1024m -Xms1024m -Dopenidm.repo.port=1433"
  10. Start IDM.

Read a different version of :