ol config module

Configure module connection properties profile

The ol config module command creates or updates module connection profiles. 

A connection profile groups the module's connection properties under a single name. You can create several profiles for the same module to satisfy particular use cases. For example, you can define one connection profile under the name "dev" that includes the connection properties for the development environment and another under the name "prod" that works with the production environment.

Connection profiles are stored in module.json:

{
  "id" : "50943f0f-6af4-4276-89b8-aba745f63a3b",
  "moduleName" : "sybase2",
  "connectorName" : "sybase-db",
  "connectorVersion" : "1.35.0",
  "profiles" : {
    "ol_profile" : {
      "url" : "http://url",
      "driverClassName" : "net.sourceforge.jtds.jdbc.Driver",
      "password" : "'{cipher}32aae59a6050eb6995fa2ef4c5ec27a49b0ef0222dceb059ba$
    },
    "dev" : {
      "host" : "http://url/dev",
    }
  },
  "type" : "as400Rpc",
  "dtVersion" : "1.35.0"
}

Rules

  • Login to the OL Hub.
  • Execute the ol config module command from the module root folder.

Syntax

ol config module [PROFILE_NAME] [OPTIONS]

Arguments

PROFILE_NAME

The name of the profile you create or update (will use default if empty).

Options

Dynamic connection properties

The connection parameters to the module's remote data source. The module connection properties are determined by the module connector and remote data source. For example, an SAP data source has different connection properties than a REST data source. 

Reviewing the default profile

A module is created with a default empty connection profile (ol_profile in module.json ) that gets automatically updated with connection properties when ol test connection or ol add are executed. (See ol test connection --profile option)

Display the default profile

[module-name]> ol config module
[module-name]$ ol config module

The CLI displays the default profile:

Profile '$default':
- url                              : http://url
- driverClassName                  : net.sourceforge.jtds.jdbc.Driver
- connectionTestQuery              : Select 1
- backendSolution                  : SYBASE

Creating a new profile

If you want to create a new profile with connection properties different from the default profile, specify only existing properties with different values or new properties. The new profile spans the overridden properties and the new properties. 

Creating a profile under the dev designation

[module-name]> ol config module dev --url http://new_url
[module-name]$ ol config module dev --url http://new_url

The CLI displays the dev profile:

Profile 'dev':
- url                              : http://new_url
- driverClassName                  : net.sourceforge.jtds.jdbc.Driver
- connectionTestQuery              : Select 1
- backendSolution                  : SYBASE