Tags: 
API, Dynamics AX

Overview

These public interfaces are used in Dynamics AX components. They are provided for implementing advanced functionality in your scripts. In order for you to use these interfaces in your project, you have to reference CozyRoc.SSISPlus.dll and Microsoft.Dynamics.BusinessConnectorNet.dll libraries.


IAxConnection

When you call Dynamics AX Connection Manager AcquireConnection method, it returns object implementing IAxConnection interface. This is the interface used for interaction with Dynamics AX server.

Methods

Connects to Dynamics AX server. The method result is Axapta object.

Closes the connection to Dynamics AX server. Use always after you finish working with the server.

Returns true if connected to the server.

Get list of Dynamics AX tables. These are the method parameters:

  • accessType (int) - table access type. It can be one of the options listed in the following table.
    Value Description
    0 Returns all tables, including tables without access.
    1 Returns tables, which can viewed
    2 Returns tables, which can be updated.
    3 Returns tables, which permit add.
    4 Returns tables, which permit delete.

Gets table fields. The method returns array of IAxTableField objects. These are the method parameters:

  • table (string) - Dynamics AX table.

Properties

Specify user name to access Dynamics AX server.

Specify the domain associated with the Windows user.

Specify if all clients should use the same connection. This property has the options listed in the following table.

Value Description
True All clients use same connection (default).
False Every client uses different connection.

Specify Business Connector Proxy user.

Specify Business Connector Proxy password.

Specify Business Connector Proxy domain.

Specify company you want to select for the session.

Specify language to use for Microsoft Dynamics AX labels. For example, "en-us".

Specify Microsoft Dynamics AX Application Object Server (AOS) to connect to. For example, Company1@AosInstance:PortNumber.

Specify name of the Microsoft Dynamics AX configuration to use while logging on.


IAxTableField

This interface is used to retrieve table field information.

Properties

Returns field identifier.

Returns field name.

Returns field type. The type can be one of the types listed here.

Returns field length. Note: This property applies only to fields of type string.

Returns field access rights. It can be one of the options listed in the following table.

Value Description
0 Field cannot be accessed.
1 Field can be viewed.
2 Field can be updated.

Related documentation