> ## Documentation Index
> Fetch the complete documentation index at: https://docs.superoffice.com/llms.txt
> Use this file to discover all available pages before exploring further.

# DbiControl

> Used for communicating with DBI agents to share data with external systems.

Used for communicating with DBI agents to share data with external systems.

## Constructors

### DbiControl()

```crmscript theme={null}
DbiControl
```

Initializes a new instance of the DbiControl class.

## Methods

## getObject()

When fetching data from external system, this function is called repeatedly.

```crmscript theme={null}
Map getObject()
```

**Returns:** [CRMScript.Native.Map](CRMScript.Native.Map) - Field-value pairs for the currently fetched object.

## getParameter(String)

Returns the value of the given parameter.

```crmscript theme={null}
String getParameter(String name)
```

**Returns:** [CRMScript.Global.String](CRMScript.Global.String) - The value of the named parameter.

## getParameters()

Retrieves parameters for a DBI setup.

```crmscript theme={null}
Map getParameters()
```

**Returns:** [CRMScript.Native.Map](CRMScript.Native.Map) - Field-value pairs.

<Note>
  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.
</Note>

## saveParameter(String,String)

Saves a parameter to the object.

```crmscript theme={null}
Void saveParameter(String name, String val)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

## sendObject(Map)

This function will send an object to the external system agent, during a DBI integration session.

```crmscript theme={null}
Void sendObject(Map values)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  This may be a map of table.field\_name and value, for instance, for an ODBC agent.
</Note>

## setParameter(String,String)

Allows you to set parameter values that are sent to the external DBI agent.

```crmscript theme={null}
Void setParameter(String name, String val)
```

**Returns:** [CRMScript.Global.Void](CRMScript.Global.Void)

<Note>
  The parameters set using this function are not saved for later retrieval.
</Note>


## Related topics

- [Void](/en/automation/crmscript/reference/CRMScript.Global.Void.md)
- [Namespace CRMScript.Native](/en/automation/crmscript/reference/CRMScript.Native.md)
- [CRMScript Reference](/en/automation/crmscript/reference/index.md)
- [dbi](/en/onsite/automated-tasks/dbi.md)
- [dbi_agent table](/en/database/tables/dbi-agent.md)
- [dbi_agent_field table](/en/database/tables/dbi-agent-field.md)