Aurion API Guide Version 10.4 MR23 ?· Aurion API Guide Version 10.4 MR23 ... Running the COM Interface…

Download Aurion API Guide Version 10.4 MR23 ?· Aurion API Guide Version 10.4 MR23 ... Running the COM Interface…

Post on 23-Mar-2019

212 views

Category:

Documents

0 download

Embed Size (px)

TRANSCRIPT

Aurion API Guide

Version 10.4 MR23

Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence

Version Control

Version Author Version Description Date

1.0 Aurion Corporation Initial version for 10.4 MR13 02/02/2016

1.1 Aurion Corporation Added EMP_COST_DEL for 10.4 MR23 19/09/2016

Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence

Contents

Introduction ............................................................................................................................................. 1

COM Configuration .................................................................................................................................. 1

Technical Overview ............................................................................................................................. 1

Installing aurion10.dll ......................................................................................................................... 2

Running the COM Interface Test Program .......................................................................................... 6

Login Test ........................................................................................................................................ 6

Security Test ................................................................................................................................... 7

Possible Errors when running AurionAPITest-COM........................................................................ 7

Web Service Configuration .................................................................................................................... 10

Technical Overview ........................................................................................................................... 10

Aurion Service EV397_AURION_WS ............................................................................................. 10

Changes to web.xml Configuration .............................................................................................. 11

SS Session Manager ...................................................................................................................... 13

Testing the Web Services .................................................................................................................. 14

Example .NET WebService Studio .............................................................................................. 14

Example Purpose-Built PHP Application .................................................................................... 19

Aurion API Classes Overview ................................................................................................................. 25

API Classes ......................................................................................................................................... 27

LOGON .......................................................................................................................................... 27

SETFUNCTION ............................................................................................................................... 27

SETVALUE ...................................................................................................................................... 28

CALLFUNCTION ............................................................................................................................. 29

LOGOUT ........................................................................................................................................ 29

CALLFUNCTION2 ........................................................................................................................... 29

CALLFUNCTION3 ........................................................................................................................... 30

API Functions ......................................................................................................................................... 31

Viewing API Field Details ....................................................................................................................... 38

Setting a Field to Null ............................................................................................................................ 38

API Notes ............................................................................................................................................... 40

Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence

Query to XML API .................................................................................................................................. 44

Example 1 of Parameterised Query + Output to XML ...................................................................... 44

Example 2 of Parameterised Query + Output to XML ...................................................................... 46

Returning the results in CSV format embedded in XML ................................................................... 52

Run the API to use the Query in Example 2 ...................................................................................... 53

Determine the parameter tags ..................................................................................................... 53

Summarise the API inputs............................................................................................................. 55

Run the API using SETFUNCTION, SETVALUE and CALLFUNCTION ............................................... 55

Run the API using CALLFUNCTION2 .............................................................................................. 61

Run the API using CALLFUNCTION3 .............................................................................................. 62

Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 1

Introduction

Aurion has created a number of Application Program Interfaces (API's) that expose functionality

within Aurion to developers and end-users of other software products.

Whilst the Aurion database may be accessed and modified directly via ODBC or other methods,

Aurion does not support these methods. Aurion API's are written specifically to allow access to

functionality and data within Aurion in a controlled manner. These APIs enforce the business

rules defined within Aurion and by doing this, safeguard referential integrity that might otherwise

be compromised by unsupported access.

Aurion APIs may be accessed via COM using other development tools such as Microsoft Visual

Basic, VBScript, Borlands Delphi etc.

The Aurion APIs are also available via an Aurion Web Service. This gives 3rd party applications

that are Web Service aware, the ability to access the Aurion API functions from external locations,

rather than relying on a local installation of the Aurion API components.

COM Configuration

Aurion has developed an interface to allow for API access from software products capable of

taking advantage of functionality exposed via Dynamic Link Libraries (.dll's). i.e. COM interface.

Technical Overview

Aurion API functionality is exposed via the aurion10.dll DLL. Once this DLL is registered, its classes

and functions are available via the Object Browser in Visual Basic and to all COM compliant

development environments.

Uniface generated DLLs use the concept of a configuration definition. This is a single name that

represents the combination of asn file, ini file, aps file, command line options, working directory

and Uniface bin directory.

The configuration definition for the aurion10.dll DLL is aurion10.

Configuration definitions are stored under the Compuware/UNIFACE area of the registry and can

be maintained by the Configuration Definition Management program (uComCfg.exe).

The API Classes and Functions exposed by the aurion10.dll DLL are detailed later in this document.

As the aurion10.dll can only have a single configuration definition, therefore, it can only be

configured to a single Aurion environment. An aurion10_test.dll and aurion10_tng.dll have also

been created. The configuration definition for the aurion10_test.dll is aurion10_test and the

configuration definition for the aurion10_tng.dll is aurion10_tng.

Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 2

If you have developed a program that calls Aurion APIs via an Aurion DLL that was issued in a

version previous to 10.4 MR2, then this program will need to be recompiled with the 10.4 MR2

version of the aurion10.dll.

Currently APIs can only be called by the COM interface if the program calling the APIs is a 32bit

application.

Installing aurion10.dll

For COM clients, such as Visual Basic and VbScript, to locate and load an object, you need to

register the objects class in the Microsoft Windows Registry for each PC accessing aurion10.dll.

1. Register the aurion10.dll. Run regsvr32 as follows:

32 bit operating system

Regsvr32 \aurion10.dll

64

Recommended

View more >