DataSource Class

This object represents a database DataSource which contains the connection details to connect to a database. The Provider and Connection can be used with native ADO.NET calls to connect to external databases.

This object is derived from the ContentObject class. All properties and methods from the ContentObject are supported for this object, plus the properties below.

Properties

PROPERTY NAME

DATA TYPE

DESCRIPTION

Provider

String

The Provider string of this connection.

Connection

String

The connection string for this SQL connection.

DBType

String

The optional type of database.

Methods

Link

This API will return the number of items in the Datasource cache.

Parameters

DSID: The string ID of the DataSource.

Returns

Integer: The Number of items in the cache.

Example

int count = DataSource.CacheCount("DSID");

Link

This API will remove all items from the Datasource cache.

Parameters

DSID: The string ID of the DataSource.

Returns

Boolean: Returns "true" if the operation succeeds.

Example

bool cleared = DataSource.ClearCache("DSID");

Link

This API will get a DataSource object from the specified ID.

Parameters

BP: The Process Director BP Object

DSID: The ID of the DataSource to retrieve.

Returns

DataSource: Will return null if Datasource isn't found.

Example

// Normally not used directly
var oDS = DataSource.GetDataSourceByDSID(bp, "DSID");

Link

This API will get a DataSource object from the specified ID.

Parameters

BP: The Process Director BP Object

Name: The name of the DataSource to retrieve.

Returns

DataSource: Will return null if Datasource isn't found.

Example

// Get the Datasource to my ERP system
var oDS = DataSource.GetDataSourceByName(bp, "ERP System");