The DBConnection task defines the OpenEdge database connection, which can be referred to by a compile task.

Properties

Property Required? Description Example Default value
dbName Yes, if parameterFile is not set The physical database name (-db parameter). This can also be a full path. dbName = 'sports2020' None
parameterFile Yes, if dbName is not set The parameter file parameterFile='pathToFile' None
connectionParameters Yes, if dbName and parameterFile are not set

The connection parameters as string. A temporary pf file is created and used as the parameterFile property.

This property will be ignored if connection-name.parameterFile is provided

 connectionParameters='-S 8000' None
port No The database port (-S parameter) port = '8000' None
host No The database host (-H parameter) host = 'localhost' None
username No The database user name (-U parameter) username = 'admin' None
password No The database user password (-P parameter) password = 'admin' None
aliases No The database aliases aliases = ['alias1', 'alias2', 'aalias3'] None
id Yes, if using as a task The identifier for this task, which can be referred to from a compile task. id = 'id1' None

Sample code snippet

The following code snippet is an example using DBConnection:
task con1(type: DBConnection){
    id = "idCon1"
    dbName = 'sports2020'
    parameterFile='pathToFile'
    aliases = ['a1', 'a2']
}
Note:

These properties are passed in the following order:

-db <dbName> -pf parameterFile> <other - attributes like -S 8655>
The properties that are defined later take priority, if the same parameter is repeated inside the parameterFile:
  • If -db is defined inside the pf file and dbName is also set, then the property defined in the pf file takes priority.
  • If any other parameter, such as -S 8655, is defined in the pf file and the corresponding attribute, such as port='8665', is also set, then the attribute, port, takes priority.

Progress reccommends that you do not define multiple database connection details, because this can lead to unexpected behavior.