Interface IErpConnector

Interface to be implemented by Connectors in the ERP Integration System; implementations also need to be marked with the ErpConnectorAttribute to be recognized by the loader.

Namespace: SuperOffice.CRM
Assembly: SuperOffice.Plugins.dll
Syntax
public interface IErpConnector

Methods

CreateActor(Guid, ErpActor)

Creates a new actor

Declaration
ActorPluginResponse CreateActor(Guid connectionID, ErpActor act)
Parameters
Type Name Description
Guid connectionID
ErpActor act
Returns
Type Description
ActorPluginResponse

DeleteConnection(Guid)

Tells the Connector that a connection has been deleted from EIS, in case the Connector needs to know and take some action.

Declaration
PluginResponseInfo DeleteConnection(Guid connectionID)
Parameters
Type Name Description
Guid connectionID
Returns
Type Description
PluginResponseInfo

GetActors(Guid, string, string[], string[])

Retrieves actors based on primary key and actor type

Declaration
ActorArrayPluginResponse GetActors(Guid connectionID, string actorType, string[] erpKeys, string[] fieldKeys)
Parameters
Type Name Description
Guid connectionID
string actorType
string[] erpKeys
string[] fieldKeys
Returns
Type Description
ActorArrayPluginResponse

GetActorsByTimestamp(Guid, string, string, string[])

Retrieves all actors of a specified actor type updated on or after a given date and time.

Declaration
ActorArrayPluginResponse GetActorsByTimestamp(Guid connectionID, string updatedOnOrAfter, string actorType, string[] fieldKeys)
Parameters
Type Name Description
Guid connectionID
string updatedOnOrAfter
string actorType
string[] fieldKeys
Returns
Type Description
ActorArrayPluginResponse

GetConfigData()

Asks the connector what fields are needed to set up a new connection (e.g. database, username and password)

Declaration
FieldMetadataInfoArrayPluginResponse GetConfigData()
Returns
Type Description
FieldMetadataInfoArrayPluginResponse

GetList(Guid, string)

Retrieves a list from the connector, using the name specified by the connector itself

Declaration
ListItemArrayPluginResponse GetList(Guid connectionID, string listName)
Parameters
Type Name Description
Guid connectionID
string listName
Returns
Type Description
ListItemArrayPluginResponse

GetListItems(Guid, string, string[])

Retrieves one or more specific list items from the connector, using the list name specified by the connector itself

Declaration
ListItemArrayPluginResponse GetListItems(Guid connectionID, string listName, string[] listItemKeys)
Parameters
Type Name Description
Guid connectionID
string listName
string[] listItemKeys
Returns
Type Description
ListItemArrayPluginResponse

GetSearchableFields(Guid, string)

Gets a list of searchable fields for a given actor type

Declaration
StringArrayPluginResponse GetSearchableFields(Guid connectionId, string actorType)
Parameters
Type Name Description
Guid connectionId
string actorType
Returns
Type Description
StringArrayPluginResponse

GetSupportedActorTypeFields(Guid, string)

Gets a list of fields that are available for a given connection and a given actor type

Declaration
FieldMetadataInfoArrayPluginResponse GetSupportedActorTypeFields(Guid connectionID, string actorType)
Parameters
Type Name Description
Guid connectionID
string actorType
Returns
Type Description
FieldMetadataInfoArrayPluginResponse

GetSupportedActorTypes(Guid)

Gets the supported actor types for a given connection

Declaration
StringArrayPluginResponse GetSupportedActorTypes(Guid connectionID)
Parameters
Type Name Description
Guid connectionID
Returns
Type Description
StringArrayPluginResponse

SaveActors(Guid, ErpActor[])

Saves (updates) existing actors

Declaration
ActorArrayPluginResponse SaveActors(Guid connectionID, ErpActor[] actors)
Parameters
Type Name Description
Guid connectionID
ErpActor[] actors
Returns
Type Description
ActorArrayPluginResponse

SaveConnection(Guid, Dictionary<string, string>)

Creates a new connection, or updates an existing one

Declaration
PluginResponseInfo SaveConnection(Guid connectionID, Dictionary<string, string> connectionInfo)
Parameters
Type Name Description
Guid connectionID
Dictionary<string, string> connectionInfo
Returns
Type Description
PluginResponseInfo

SearchActorByParent(Guid, string, string, string, string, string[])

Searches for one or more actors given a search string

Declaration
ActorArrayPluginResponse SearchActorByParent(Guid connectionID, string actorType, string searchText, string parentActorType, string parentActorErpKey, string[] fieldKeys)
Parameters
Type Name Description
Guid connectionID
string actorType
string searchText
string parentActorType
string parentActorErpKey
string[] fieldKeys
Returns
Type Description
ActorArrayPluginResponse

SearchActors(Guid, string, string, string[])

Searches for one or more actors given a search string

Declaration
ActorArrayPluginResponse SearchActors(Guid connectionID, string actorType, string searchText, string[] fieldKeys)
Parameters
Type Name Description
Guid connectionID
string actorType
string searchText
string[] fieldKeys
Returns
Type Description
ActorArrayPluginResponse

SearchActorsAdvanced(Guid, string, SearchRestrictionInfo[], string[])

Searches for one or more actors given a search string

Declaration
ActorArrayPluginResponse SearchActorsAdvanced(Guid connectionID, string actorType, SearchRestrictionInfo[] restrictions, string[] returnFields)
Parameters
Type Name Description
Guid connectionID
string actorType
SearchRestrictionInfo[] restrictions
string[] returnFields
Returns
Type Description
ActorArrayPluginResponse

TestConfigData(Dictionary<string, string>)

Creates a new connection, or updates an existing one

Declaration
PluginResponseInfo TestConfigData(Dictionary<string, string> connectionInfo)
Parameters
Type Name Description
Dictionary<string, string> connectionInfo
Returns
Type Description
PluginResponseInfo

TestConnection(Guid)

Checks if the given connection ID is valid (is the connection up, is the configuration data correct, etc)

Declaration
PluginResponseInfo TestConnection(Guid connectionID)
Parameters
Type Name Description
Guid connectionID
Returns
Type Description
PluginResponseInfo

Extension Methods