This method establishes connection information for the caller of the service to the back-end integrated system (such as Microsoft Dynamics CRM, NAV, or AX).
Since connection requirements vary for each integration, the ClientConnectInfo parameter passed in must be the appropriate type for the intended platform. The required properties are contained in the integration-specific types listed in the table below.
ClientConnectInfo
The ClientConnectInfo class represents the base type for parameters needed to connect to the server-side integration environment.
Properties
The following table outlines properties included in the base ClientConnectInfo class and all ClientConnectionInfo-derived classes used to connect to specific host systems.
Integration Platform
Expected Type
Microsoft Dynamics CRM
MSCrmClientConnectInfo
The MSCrmClientConnectInfo class derives from ClientConnectInfo and represents the parameters needed to connect to a Microsoft CRM environment.
Properties
Data Type
Property
Description
string
CrmOrganizationName
Sets the name of the CRM organization to connect to.
Guid
CrmUserId
Sets the CRM user to impersonate when interacting with CRM. This property is optional. If set, the account represented by AuthUserName and AuthPassword must have the permissions in CRM to act on behalf of another user. If not set, all activities in CRM will be performs as the Auth* user account.
string
OAuthToken
Sets the OAuthToken used to identify the user.
Inheritance
ClientConnectInfo
The ClientConnectInfo class represents the base type for parameters needed to connect to the integration environment.
Properties
The following table outlines properties included in the base ClientConnectInfo class and all ClientConnectionInfo-derived classed used to connect to specific host systems.
Data Type
Property
Description
string
AuthUserName
Returns or sets the user name to authenticate the caller to the service. The most common case will be that the user account specified here will be used as the service account for the backing service (such as the CRM web services); any existing server-side credentials will be ignored.
string
AuthPassword
Returns or sets the password to authenticate the caller to the service.
Microsoft Dynamics NAV
MSNavClientConnectInfo
The MSNavClientConnectInfo derives from ClientConnectInfo and represents the parameters needed to connect to a Microsoft NAV environment.
Properties
Data Type
Property
Description
string
NavCompanyName
Returns or sets the name of the NAV company to connect to.
string
OAuthHeader
Provides everything required to provide authorization for the API request. Includes the OAuth token.
Inheritance
ClientConnectInfo
The ClientConnectInfo class represents the base type for parameters needed to connect to the integration environment.
Properties
The following table outlines properties included in the base ClientConnectInfo class and all ClientConnectionInfo-derived classed used to connect to specific host systems.
Data Type
Property
Description
string
AuthUserName
Returns or sets the user name to authenticate the caller to the service. The most common case will be that the user account specified here will be used as the service account for the backing service (such as the CRM web services); any existing server-side credentials will be ignored.
string
AuthPassword
Returns or sets the password to authenticate the caller to the service.
Microsoft Dynamics AX
MSAxClientConnectInfo
The MSAxClientConnectInfo class derives from ClientConnectInfo and represents the parameters needed to connect to the Microsoft AX environment.
Properties
Data Type
Property
Description
string
AxCompanyName
Returns or sets the name of the AX company to connect to.
string
OAuthToken
Sets the OAuthToken used to identify the user.
Inheritance
ClientConnectInfo
The ClientConnectInfo class represents the base type for parameters needed to connect to the integration environment.
Properties
The following table outlines properties included in the base ClientConnectInfo class and all ClientConnectionInfo-derived classed used to connect to specific host systems.
Data Type
Property
Description
string
AuthUserName
Returns or sets the user name to authenticate the caller to the service. The most common case will be that the user account specified here will be used as the service account for the backing service (such as the CRM web services); any existing server-side credentials will be ignored.
string
AuthPassword
Returns or sets the password to authenticate the caller to the service.
Microsoft Dynamics 365 Commerce
D365CommerceClientConnectInfo
The D365CommerceClientConnectInfo class provides the necessary properties to connect to and configure a product within a Dynamics 365 Commerce environment.
Properties
Data Type
Properties
Description
string
AuthToken
Returns or sets the authorization token associated with the configurable context in D365 Commerce. This is required to perform integrator actions, and is a nonce issued to the record.
string
CartLineId
Returns or sets the Shopping Cart line ID, for accessing existing configurations that are associated with a Cart. Supersedes the ProductId property.
long
ProductId
Returns or sets the Product ID, for creating new configurations that are associated with a cart. Superseded by CartLineId.
Inheritance
ClientConnectInfo
The ClientConnectInfo class represents the base type for parameters needed to connect to the integration environment.
Properties
The following table outlines properties included in the base ClientConnectInfo class and all ClientConnectionInfo-derived classed used to connect to specific host systems.
Data Type
Property
Description
string
AuthUserName
Returns or sets the user name to authenticate the caller to the service. The most common case will be that the user account specified here will be used as the service account for the backing service (such as the CRM web services); any existing server-side credentials will be ignored.
string
AuthPassword
Returns or sets the password to authenticate the caller to the service.
NetSuite
NetSuiteClientConnectInfo
The NetSuiteClientConnectInfo class provides the parameters required to connect to a NetSuite environment. NetSuite does not require any additional properties beyond those provided by the base type ClientConnectInfo.
Inheritance
ClientConnectInfo
The ClientConnectInfo class represents the base type for parameters needed to connect to the integration environment.
Properties
The following table outlines properties included in the base ClientConnectInfo class and all ClientConnectionInfo-derived classed used to connect to specific host systems.
Data Type
Property
Description
string
AuthUserName
Returns or sets the user name to authenticate the caller to the service. The most common case will be that the user account specified here will be used as the service account for the backing service (such as the CRM web services); any existing server-side credentials will be ignored.
string
AuthPassword
Returns or sets the password to authenticate the caller to the service.
Salesforce
SalesforceClientConnectInfo
The SalesforceClientConnectInfo class contains the properties required to connect to a Salesforce system.
Properties
Data Type
Property
Description
string
SecurityToken
Returns or sets user-specific Salesforce security token.
bool
IsSandbox
Returns or sets the flag that indicates whether to authenticate against a sandbox or a normal org.
Inheritance
ClientConnectInfo
The ClientConnectInfo class represents the base type for parameters needed to connect to the integration environment.
Properties
The following table outlines properties included in the base ClientConnectInfo class and all ClientConnectionInfo-derived classed used to connect to specific host systems.
Data Type
Property
Description
string
AuthUserName
Returns or sets the user name to authenticate the caller to the service. The most common case will be that the user account specified here will be used as the service account for the backing service (such as the CRM web services); any existing server-side credentials will be ignored.
string
AuthPassword
Returns or sets the password to authenticate the caller to the service.
Custom/Generic
ClientConnectInfo
The ClientConnectInfo class represents the base type for parameters needed to connect to the integration environment.
Properties
The following table outlines properties included in the base ClientConnectInfo class and all ClientConnectionInfo-derived classed used to connect to specific host systems.
Data Type
Property
Description
string
AuthUserName
Returns or sets the user name to authenticate the caller to the service. The most common case will be that the user account specified here will be used as the service account for the backing service (such as the CRM web services); any existing server-side credentials will be ignored.
string
AuthPassword
Returns or sets the password to authenticate the caller to the service.
Unauthenticated
UnauthenticatedClientConnectInfo
The UnauthenticatedConnectInfo class derives from ClientConnectInfo and represents the parameters needed to establish an unauthenticated connection.
See the documentation for AuthenticateClient method for an explanation of this class and its purpose. The AuthUserName and AuthPassword properties of this object are insignificant and ignored by the service. Usage of this class indicates a specific intent to connect to the service in a fashion that allows general automation and retrieval of configuration data without the ability to connect to or persist information in the integration system.
Inheritance
ClientConnectInfo
The ClientConnectInfo class represents the base type for parameters needed to connect to the integration environment.
Properties
The following table outlines properties included in the base ClientConnectInfo class and all ClientConnectionInfo-derived classed used to connect to specific host systems.
Data Type
Property
Description
string
AuthUserName
Returns or sets the user name to authenticate the caller to the service. The most common case will be that the user account specified here will be used as the service account for the backing service (such as the CRM web services); any existing server-side credentials will be ignored.
string
AuthPassword
Returns or sets the password to authenticate the caller to the service.
The UnauthenticatedConnectInfo provides a special mechanism for connecting to and automating the service, while being prevented from interfacing with the host integration system. A client that connects this way can create, update, fix, and cancel their configuration but will be blocked in an attempt to load, delete, or save it. Because the integration is bypassed, no attempt is made to retrieve context/inbound property values. This will also result in some special, integration-specific functions not being available.
By default, unauthenticated connections are not allowed. You must set the Allows Unauthenticated Connections setting to True in the settings.config file in order for Experlogix to permit such a request to be accepted.
This method obsoletes the following methods (which are no longer available): SetMSCrmConnectionInfo, SetMSNavConnectionInfo, and SetMSAxConnectionInfo.
