Create an External Connection to ODBC

An External Connection connects CSM to an External Database. The steps below are specifically for an External Connection between CSM and an ODBC.

ODBC Requirements:

  • The ODBC provider must show as available on the current machine.
  • The Desktop Client must be installed.
  • For Oracle: Client must have Oracle 11 or 12 on the Application Server and it must be configured.

To create an External Connection to an ODBC Server Database:

  1. Open or Create a Blueprint.
  2. Select Managers > External Connections to open the External Connections Manager.
  3. Click Create New.

    The External Connection Wizard opens.

  4. On the Login options page:
    • Select the Use Trusted Agents check box if you use the Trusted Agents feature and you want to control how the system logs in to the external data source.
    • Select one of these options:
      • Any Trusted Agent Group: Select to allow any group to handle requests for this External Connection.
      • Trusted Agent Group: Select a specific group to handle requests for this External Connection.
    • Click Next.

    For more information, refer to Import External Data Using Trusted Agent.

  5. On the Data Source page:
    1. Select ODBC.
    2. Select Next.

  6. On the ODBC Provider page:
    1. Select an ODBC Provider.

      The ODBC Providers list might vary depending on the drivers installed. If using Oracle as the provider, there are some differences in the Wizard. For more information, see Create an External Connection to Oracle.

    2. Select Next.

  7. On the Database Location page:
    1. Select the Database Location of the connecting database:
      • Located on this Machine: Select this option if running a local database. Typically, this is only for evaluation systems.
      • Specific Server: Select this option to select a database installed on a named server, and then select the named server.
      • IP Address: Select this option to select a database installed on a server referenced by an IP address, and then provide the IP address.
    2. Select Next.

  8. On the Select a Database page:
    • Provide the Name of the database/file to which to connect, or click Browse to see a list of available databases/files.
    • Click Browse.

      The Login to server window opens.

    1. Select a login radio button to use either:
      • Windows authentication
      • User ID and Password: Provide the server User ID and Password.
    2. Select OK.

      The system runs for a few minutes and the Choose a Value window opens.

    3. Click a database.
    4. Select OK.

  9. Select Next.

  10. On the Login Options page:
    1. If the database requires login information, select the Login Required check box and either:
      • Windows Authentication: Uses the stored Windows credentials (user name and password) for authentication.

        When Cherwell Services use this connection, the account under which the Cherwell Application Service is running is the account whose credentials are used to connect to the database.

      • User ID and Password: Provide a User ID and Password.

        The account must have select rights for each table that is imported or linked to CSM. If CSM is allowed to update data in the database, this account must also have insert and update rights..

    2. Select Next.

  11. On the Database Owner or Schema page:
    1. Click an option from the drop-down or provide a Database owner or schema. This field should be pre-populated.

      Not all databases have this concept. If implemented, and CSM is able to read the available owners, they are listed in the drop down. If not, provide the owner name. If unsure, provide the dbo default.

    2. Select Next.

  12. On the Connection Name page:
    1. Provide a Name for the database connection.
    2. (Optional) Provide a Description for the database connection.
    3. Select Next.

    The Connection String page opens, showing the connection string that is used to connect to the database. Modify the connection string, if needed. Many examples of connection strings can be found at www.connectionstrings.com.

  13. Click Test Connection to verify that the connection to the server/database.

    Text appears next to the button confirming the connection is successful.

    If the test connection is not successful, contact a DBA for help.

  14. Select Finish.

    There is now a connection to the External ODBC Database.

  15. Publish the Blueprint (File>Publish Blueprint) to commit the changes, or save the Blueprint (File>Save Blueprint) to continue making other changes.