You can modify the Orchestrator database connection when you run a workflow from the Configuration plug-in. You can also configure the database connection by using the REST API.

About this task

The Configuration plug-in contains workflows for configuring the database types supported by Orchestrator. To change the settings of the Orchestrator database connection, you can run a workflow named after the database type you want to configure. You can find these workflows by navigating to Configuration > Database in the Workflows view of the Orchestrator client. In addition, you can also run these workflows by using the Orchestrator REST API.

For more information about configuring the Orchestrator database connection by using the Orchestrator configuration interface, see Configure the Database Connection.

Procedure

  1. Make a GET request at the URL of the Workflow service, for the database connection you want to configure.

    Option

    Description

    Oracle

    Configures Orchestrator to work with an Oracle database instance

    Microsoft SQL Server

    Configures Orchestrator to work with a Microsoft SQL Server or Microsoft SQL Server Express database instance

    PostgreSQL

    Configures Orchestrator to work with a PostgreSQL database instance

    Embedded

    Configures Orchestrator to work with the embedded database

    For example, to search for a workflow named Microsoft SQL Server, make the following GET request:

    GET https://{orchestrator_host}:{port}/vco/api/workflows?conditions=name=Microsoft SQL Server
  2. Retrieve the definition of the workflow by making a GET request at the URL of the definition.

    To retrieve the definition of the Microsoft SQL Server workflow, make the following GET request:

    GET https://{orchestrator_host}:{port}/vco/api/workflows/9643be91-35fc-49a9-819b-56e3bffc7705
  3. Make a POST request at the URL that holds the execution objects of the workflow.

    For the Microsoft SQL Server workflow, make the following POST request:

    POST https://{orchestrator_host}:{port}/vco/api/workflows/9643be91-35fc-49a9-819b-56e3bffc7705/executions
  4. Provide values for the input parameters of the workflow in an execution-context element in the request body.

    Option

    Description

    host

    The database server IP address or DNS name.

    This parameter is applicable for all databases.

    port

    The database server port that allows communication to your database.

    This parameter is applicable for all databases.

    databaseName

    The full unique name of your database. The database name is specified by the SERVICE_NAMES parameter in the initialization parameter file.

    This parameter is valid only for SQL Server, and PostgreSQL workflows.

    db

    The name of the database instance that can be identified by the INSTANCE_NAME parameter in the database initialization parameter file.

    This parameter is valid only for SQL Server and Oracle databases.

    domain

    To use Windows authentication, type the domain name of the SQL Server machine, for example company.org.

    To use SQL authentication, provide an empty value for this parameter.

    This parameter is valid only for SQL server and specifies whether you want to use Windows or SQL Server authentication.

    ntlm2

    Select to send NTLMv2 responses when using Windows authentication.

    This parameter is valid only for SQL Server.

    user

    The user name that Orchestrator uses to connect and operate the selected database. The name you type must be a valid user on the target database with db_owner rights.

    This parameter is applicable for all databases.

    password

    The password for the user name.

    This parameter is applicable for all databases.

    ssl

    Specifies whether you want to use SSL connection to the database. To use this parameter, you must import the database SSL certificate into Orchestrator.

    This parameter is applicable for all databases.