Class DbiControl
Used for communicating with DBI agents to share data with external systems.
Syntax
Constructors
DbiControl()
Initializes a new instance of the DbiControl class.
Declaration
DbiControlMethods
getObject()
When fetching data from external system, this function is called repeatedly.
Declaration
Map getObject()Returns
| Type | Description |
|---|---|
| Map | Field-value pairs for the currently fetched object. |
getParameter(String)
Returns the value of the given parameter.
Declaration
String getParameter(String name)Parameters
| Type | Name | Description |
|---|---|---|
| String | name | Name of the parameter to get the value of. |
Returns
| Type | Description |
|---|---|
| String | The value of the named parameter. |
getParameters()
Retrieves parameters for a DBI setup.
Declaration
Map getParameters()Returns
| Type | Description |
|---|---|
| Map | Field-value pairs. |
Remarks
It can among else define parameters for limiting the data set, or whatever else you define under the "Settings/DBI" section of eJournal. You will also get saved parameters so that you can store values from one run to another.
saveParameter(String,String)
Saves a parameter to the object.
Declaration
Void saveParameter(String name, String val)Parameters
| Type | Name | Description |
|---|---|---|
| String | name | Name of parameter to save for later retrieval by other DBI integration runs. |
| String | val | The value to be saved for the given parameter. |
Returns
| Type | Description |
|---|---|
| Void |
sendObject(Map)
This function will send an object to the external system agent, during a DBI integration session.
Declaration
Void sendObject(Map values)Parameters
| Type | Name | Description |
|---|---|---|
| Map | values | Field-value pairs that define the object in a way that is meaningful to the external agent. |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
This may be a map of table.field_name and value, for instance, for an ODBC agent.
setParameter(String,String)
Allows you to set parameter values that are sent to the external DBI agent.
Declaration
Void setParameter(String name, String val)Parameters
| Type | Name | Description |
|---|---|---|
| String | name | The name of the parameter (for example, resultSet.size). |
| String | val | A string representation of the value (for example, 100). |
Returns
| Type | Description |
|---|---|
| Void |
Remarks
The parameters set using this function are not saved for later retrieval.