Nav

Microsoft Dynamics GP Connector Reference

Default Configuration

Parameters

Name Type Description Default Value Required

Name

String

The name for this configuration. Connectors reference the configuration with this name.

x

Connection

The connection types to provide for this configuration.

x

Expiration Policy

Configures the minimum amount of time that a dynamic configuration instance can remain idle before the runtime considers the instance eligible for expiration. This does not mean that the platform expires the instance at the exact moment it becomes eligible. The runtime actually purges the instances as it sees fit.

Kerberos Authentication Connection Type

Parameters

Name Type Description Default Value Required

Username

String

x

Password

String

x

Endpoint URL

String

Base URL where the SOAP services are exposed.

x

SPN

String

The Service Principal Name that identifies the service instance.

x

Login Conf. Location

String

Path to a customized Login Properties File.

x

Krb5 Conf. Location

String

Path to a customized Kerberos Properties File.

x

Reconnection

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Create Entity

<dynamicsgp:create-entity>

Creates a new entity in Dynamics GP.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Entity

String

The type of the entity to create.

x

Input

Binary

The web service input, containing the entity to create, the context and policy.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • DYNAMICSGP:CONNECTIVITY

  • DYNAMICSGP:DYNAMICSGP_INTERNAL

  • DYNAMICSGP:RETRY_EXHAUSTED

  • DYNAMICSGP:UNKNOWN

  • DYNAMICSGP:WS_SECURITY

  • DYNAMICSGP:XML_PARSING

Delete Entity

<dynamicsgp:delete-entity>

Deletes an existing entity in Dynamics GP.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Entity

String

The type of the entity to delete.

x

Input

Binary

The web service input, containing the key object, the context and policy.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • DYNAMICSGP:CONNECTIVITY

  • DYNAMICSGP:DYNAMICSGP_INTERNAL

  • DYNAMICSGP:RETRY_EXHAUSTED

  • DYNAMICSGP:UNKNOWN

  • DYNAMICSGP:WS_SECURITY

  • DYNAMICSGP:XML_PARSING

Get Entity By Key

<dynamicsgp:get-entity-by-key>

Retrieves an entity from Dynamics GP, based on the key values supplied.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Entity

String

The type of the entity to retrieve.

x

Input

Binary

The web service input, containing the key object and the context.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the output of the operation and to store the outcome of the expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • DYNAMICSGP:CONNECTIVITY

  • DYNAMICSGP:DYNAMICSGP_INTERNAL

  • DYNAMICSGP:RETRY_EXHAUSTED

  • DYNAMICSGP:UNKNOWN

  • DYNAMICSGP:WS_SECURITY

  • DYNAMICSGP:XML_PARSING

Get Entity List

<dynamicsgp:get-entity-list>

Retrieves a list of entities from Dynamics GP that match the specified criteria.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Entity

String

The type of the entity to fetch.

x

Input

Binary

The web service input, containing the search criteria and the context.

#[payload]

Streaming Strategy

Configure to use repeatable streams.

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the output of the operation and to store the outcome of the expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Binary

For Configurations

Throws

  • DYNAMICSGP:CONNECTIVITY

  • DYNAMICSGP:DYNAMICSGP_INTERNAL

  • DYNAMICSGP:RETRY_EXHAUSTED

  • DYNAMICSGP:UNKNOWN

  • DYNAMICSGP:WS_SECURITY

  • DYNAMICSGP:XML_PARSING

Multitenant Enabled

<dynamicsgp:multitenant-enabled>

Indicates whether the Dynamics GP service is installed in a multitenant configuration.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Target Variable

String

The name of a variable that stores the output of the operation.

Target Value

String

An expression to evaluate against the output of the operation and to store the outcome of the expression in the target variable.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

Output

Type

Boolean

For Configurations

Throws

  • DYNAMICSGP:CONNECTIVITY

  • DYNAMICSGP:DYNAMICSGP_INTERNAL

  • DYNAMICSGP:RETRY_EXHAUSTED

  • DYNAMICSGP:UNKNOWN

  • DYNAMICSGP:WS_SECURITY

  • DYNAMICSGP:XML_PARSING

Update Entity

<dynamicsgp:update-entity>

Updates an existing entity in Dynamics GP.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Entity

String

The type of the entity to update.

x

Input

Binary

The web service input, containing the entity to update, the context and policy.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • DYNAMICSGP:CONNECTIVITY

  • DYNAMICSGP:DYNAMICSGP_INTERNAL

  • DYNAMICSGP:RETRY_EXHAUSTED

  • DYNAMICSGP:UNKNOWN

  • DYNAMICSGP:WS_SECURITY

  • DYNAMICSGP:XML_PARSING

Void Entity

<dynamicsgp:void-entity>

Voids an existing entity in Dynamics GP.

Parameters

Name Type Description Default Value Required

Configuration

String

The name of the configuration to use.

x

Entity

String

The type of the entity to void.

x

Input

Binary

The web service input, containing the key object, the context and policy.

#[payload]

Reconnection Strategy

A retry strategy in case of connectivity errors.

For Configurations

Throws

  • DYNAMICSGP:CONNECTIVITY

  • DYNAMICSGP:DYNAMICSGP_INTERNAL

  • DYNAMICSGP:RETRY_EXHAUSTED

  • DYNAMICSGP:UNKNOWN

  • DYNAMICSGP:WS_SECURITY

  • DYNAMICSGP:XML_PARSING

Types

Reconnection

Field Type Description Default Value Required

Fails Deployment

Boolean

When the application is deployed, a connectivity test is performed on all connectors. If set to true, deployment fails if the test doesn’t pass after exhausting the associated reconnection strategy.

Reconnection Strategy

The reconnection strategy to use.

Reconnect

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Count

Number

How many reconnection attempts to make.

Reconnect Forever

Field Type Description Default Value Required

Frequency

Number

How often in milliseconds to reconnect.

Expiration Policy

Field Type Description Default Value Required

Max Idle Time

Number

A scalar time value for the maximum amount of time a dynamic configuration instance should be allowed to be idle before it’s considered eligible for expiration.

Time Unit

Enumeration, one of:

  • NANOSECONDS

  • MICROSECONDS

  • MILLISECONDS

  • SECONDS

  • MINUTES

  • HOURS

  • DAYS

A time unit that qualifies the maxIdleTime attribute.

Repeatable In Memory Stream

Field Type Description Default Value Required

Initial Buffer Size

Number

The amount of memory to allocate to consume the stream and provide random access to it. If the stream contains more data than can fit into this buffer, the buffer expands according to the bufferSizeIncrement attribute, with an upper limit of maxInMemorySize.

Buffer Size Increment

Number

By how much the buffer size expands if it exceeds its initial size. Setting a value of zero or lower means that the buffer should not expand, meaning that a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised when the buffer gets full.

Max Buffer Size

Number

This is the maximum amount of memory to use. If more than that is used, then a STREAM_MAXIMUM_SIZE_EXCEEDED error is raised. A value lower or equal to zero means no limit.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which all these attributes are expressed.

Repeatable File Store Stream

Field Type Description Default Value Required

Max In Memory Size

Number

Defines the maximum memory that the stream should use to keep data in memory. If more than that is consumed then it starts to buffer the content on disk.

Buffer Unit

Enumeration, one of:

  • BYTE

  • KB

  • MB

  • GB

The unit in which maxInMemorySize is expressed.

We use cookies to make interactions with our websites and services easy and meaningful, to better understand how they are used and to tailor advertising. You can read more and make your cookie choices here. By continuing to use this site you are giving us your consent to do this.

+