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, Borland’s 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 object’s 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 <path to aurion10.dll>\aurion10.dll
64 bit operating system
%WINDIR%\SysWOW64\Regsvr32 <path to aurion10.dll>\aurion10.dll
The aurion10.dll file is typically located under the Aurion environment’s API\COM directory on the
application server. If you are registering the aurion10.dll on a PC/server where Aurion is not
installed, copy the contents of the COM directory to this PC/server. The mfc80.dll is also required
for the Aurion 10 COM interface to work.
E.g. If you would like the aurion10.dll to be located in the C:\AurionAPI directory then copy it from
the Aurion environment’s API\COM directory along with the mfc80.dll. Then run the following to
register it.
32 bit operating system
Regsvr32 C:\AurionAPI\aurion10.dll
64 bit operating system
%WINDIR%\SysWOW64\Regsvr32 C:\AurionAPI\aurion10.dll
2. Use the uComCfg.exe (32 bit application) tool to edit the Aurion Configuration Definition
entries in the Registry. This tool is distributed with UNIFACE and can be found in the Aurion
environment’s Uniface\Common\bin directory.
3. This step must also be completed for every PC accessing Aurion functionality via the DLL,
however once the first Configuration Definition entry is entered on a PC, a .reg file may be
created to expedite distribution to other PCs using the registry editor.
NB. For ease of deployment it is recommended to run the uComCfg program as a local
administrator so that it updates the HKEY_LOCAL_MACHINE section of the registry. Storing the
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 3
configuration settings in HKEY_LOCAL_MACHINE means that the uComcCfg program will not have
to be run for every user that wishes to call APIs via the DLL on that PC / server.
The following screen shows the Configuration Definition Management dialog with explanations.
Field Description
Configuration Definitions This should be aurion10, aurion10_test or
aurion10_train
UNIFACE Initialization File
This needs to point to the usys.ini. This can be a
UNC path if the usys.ini contains settings with
UNC paths rather than local or mapped drives.
UNIFACE Assignment File
This needs to point to the aurion.asn file. This
can be a UNC path if the aurion.asn contains
settings with UNC paths rather than local or
mapped drives. If the aurion.asn file is
configured as connecting directly to the database
(i.e. not using the URouter) then you will need to
create an asn file that specifies the physical path
to the license.xml rather than the license
manager (e.g. 7188@server). This is due to the
API interface using server license features rather
than client ones. Server license features are
always read directly from the license.xml.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 4
Field Description
Uniface Installation Directory This needs to point to the Uniface bin directory
(Uniface\Common\Bin).
UNIFACE Working Directory This needs to point to the Uniface bin directory
(Uniface\Common\Bin).
Keep COM component in
memory
Check this box if a process repeatedly calls
Uniface COM objects. This speeds up COM
operation and prevents memory leakage, which
is particularly useful when Uniface services are
being called from ASPs.
NB. If your Aurion.asn is configured to directly connect to the database (i.e. the $AURION line in
the paths section does not use the TCP driver but rather a Uniface database driver such as MSS,
ORA, DB2 or SOL), then you will need to configure the $LICENSE_OPTIONS line in the Aurion.asn to
point to the physical license file, rather than connect to the Uniface license manager. Below is an
example of an asn file that includes the Aurion.asn and then sets the $LICENSE_OPTION setting to
the physical path to the license file.
#file <path to aurion.asn file>
[SETTINGS]
$LICENSE_OPTIONS LM_LICENSE_FILE=<path to license.xml>
E.g.:
#file D:\Aurion\Aurion10\Aurprod\ADM\aurion.asn [SETTINGS] $LICENSE_OPTIONS LM_LICENSE_FILE=D:\Aurion\Aurion10\Common\DLM\License\license.xml
The settings entered in the UComCfg program results in the following registry entries.
32 bit operating system
64 bit operating system
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 5
You can export the aurion10 branch of this registry key for deployment to other PCs of the same
operating system (i.e. either 32 or 64 bit).
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 6
Running the COM Interface Test Program
Test the aurion10.dll has been registered and configured correctly by launching the
AurionAPITest-COM.vbs program on the computer. This VBScript can be copied from the Aurion
environment’s API\COM directory on the application server.
If the computer is running a 64 bit windows operating system, then you will need to open a 32 bit
DOS window (i.e. %WINDIR%\SysWOW64\cmd) and then navigate to the directory that contains
the AurionAPITest-COM.vbs and run either AurionAPITest-COM.vbs or wscript AurionAPITest-
COM.vbs.
When the AurionAPITest-COM.vbs is run the following screen will appear.
Login Test
To test the API Class LOGON, select the Function LOGON, enter a User ID into Input 1 and a
password into Input 2, and click the Action button. (Please refer to the Logon topic in the API
classes section of this document.)
If you enter a valid User Id and Password combination, the Status returned will be 0. If you enter
an invalid User Id and Password combination, Aurion responds appropriately.
You must login before further functionality is available.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 7
Security Test
Perform the following steps to perform a Security Check for another Userid:
1. Select Function SETFUNCTION, and enter CORE_IDSEC_CHECK into Input 1, and click the
Action button.
2. Select Function SETVALUE, and enter TASK into Input 1 and ES018_ORG_LIST into Input 2, and
click the Action button.
3. Select Function SETVALUE, and enter USER into Input 1 and aurion into Input 2, and click the
Action button.
4. Select Function CALLFUNCTION and click the Action button.
Aurion will return a 0 status if no errors were encountered and a T or F in the field Output
indicating whether userid aurion has access to Security Task ES018_ORG_LIST.
Possible Errors when running AurionAPITest-COM
5. ActiveX component can’t create object: ‘aurion10’.
This error occurs when the aurion10.dll has not been registered using regsvr32. Remember, if you
are on a 64 bit computer the DLL has to be registered as a 32bit DLL.
6. The registration information for this server is inconsistent or incomplete.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 8
This error occurs when you:
do not have an Aurion Configuration Definition entry defined.
See Installing the Aurion10.dll DLL, Step 2. You must define an Aurion Configuration Definition on
each PC that will run the demo.
have misconfigured the Aurion Configuration Definition. Pay particular attention to the
Uniface Installation Directory. It must point to the Uniface bin directory of your Uniface
Install.
7. Initialising COM interface. Please wait message does not disappear when the test program
starts.
This may be due to:
you have not correctly defined the Aurion Configuration Definition entries using uComCfg.exe.
Check the location of UNIFACE Assignment File.
The Uniface license setting in the asn file is incorrect. i.e. you have not configured the
$LICENSE_OPTIONS setting in the asn file (that the COM interface is using) to point to the
physical license file if the asn file is configured to directly connect to the database via a
Uniface database driver.
8. No Aurion Control Record Found.
This error may appear if:
you have not correctly defined the Aurion Configuration Definition entries using uComCfg.exe.
Check the location of UNIFACE Working Directory.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 9
Your database may be unavailable.
A network error may be preventing you from accessing Urouter/Userver.
Refer to the log file defined by the $putmess_logfile setting in the asn file to further debug the
issue.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 10
Web Service Configuration
Aurion has developed a Web Service interface to the Aurion APIs to address the following issues.
Aurion APIs do not cater for users who wish to access the functions when they are not on the
same physical system network. This is because APIs use DLLs – third party applications wishing to
use Aurion APIs and reside on the same physical network.
Requirements exist that:
Aurion be “opened up” to remote 3rd party apps residing on other external networks or
unconnected systems.
The ability to access the Aurion API functions from an external location (intranet, extranet,
internet).
Web Services allow an interface into the Aurion API components for users that are from external
locations.
A WSDL file will be generated based on the new Aurion Web Service. This allows the new service
to be publicly accessible or exposed.
Technical Overview
Aurion Service EV397_AURION_WS
The Aurion Service EV397_AURION_WS provides access to any Aurion API. This service is only
accessible by the WSDL file ev397_aurion_ws.wsdl that is generated by the service. This file will
reside in the environment’s “/WEB-INF/wsdl” folder on the web server. This file is delivered with
Aurion.
Aurion has built a WSDL for Remote Procedure Call (RPC) binding style and document binding
style. By default the RPC binding style WSDL is installed to the WEB-INF/wsdl directory. If you
wish to use the document binding style WSDL, then copy the ev397_aurion_ws.wsdl.document
file to the “<env_name>/WEB-INF/wsdl/ev397_aurion_ws.wsdl on your web server.
The process for accessing Aurion APIs via this web service is as follows:
1. A user logs into the Web Service (EV397_AURION_WS) that is published from a site’s web
server using the LOGON operation.
2. The logon credentials will contain the user name and password:
P_USER – Aurion user name
P_PASSWORD – Password for Aurion user
3. When a successful logon occurs, the web service will return a session token.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 11
4. This token will be used by all subsequent interactions with the web service in this session.
5. The user will then set the desired API Function using the SETFUNCTION operation.
6. This operation requires the following:
P_TOKEN – Token returned from the LOGON operation.
P_FUNCTION – API function described in the Aurion API guide.
7. An out parameter for this operation is P_FIELDLIST. This contains a list of all parameters along
with each parameters constraint, rules, and attributes.
8. Using the P_FIELDLIST return parameter as a starting basis, the user will then set the
appropriate parameters necessary to execute the API function using the SETVALUE operation.
9. This operation will be called for each parameter to set for the API function.
10. This operation requires the following:
P_TOKEN – Token returned from the LOGON operation.
P_ITEM – Name of parameter item in the API function.
P_VALUE – Value of parameter item in the API function.
11. Once all appropriate parameters are set, the CALLFUNCTION operation is invoked.
The P_TOKEN will be set to the Token obtained from the logon process.
The P_OUTPUT parameter will contain results from the API function.
12. As an alternative to calling the SETFUNCTION, SETVALUE and CALLFUNCTION you can use
CALLFUNCTION2 or CALLFUNCTION3 which combines the three classes/functions into one.
CALLFUNCTION2 and CALLFUNCTION3 requires the following:
P_TOKEN – Token returned from the LOGON operation.
P_FUNCTION – Name of API function.
P_DELIMITER – parameter delimiter. The default is a comma. This value does not need to
be set if you wish to use the default.
P_WRAPPER – parameter wrapper. The default is null. This value does not need to be set
if you wish to use the default.
P_PARAMETERS – API parameters values for CALLFUNCTION2. API parameter name and
alues for CALLFUNCTION3.
13. To perform another function or the same function again in the same web service session, the
FLUSHVALUES operation must be executed to flush out the values that are currently set for
the session.
14. The LOGOFF function will clear out the web service session data from the database.
Changes to web.xml Configuration
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 12
Parameters are required to enable the Uniface Web Request Dispatcher (WRD) engine to provide
web service access to the application. The web.xml file contains the configuration for this. These
configuration settings should be present in your web.xml.
Before configuring the web.xml file for web service, the web.xml will contain a block looking
similar to this:
<servlet-mapping>
<servlet-name>testwrd</servlet-name>
<url-pattern>/servlet/testwrd/*</url-pattern>
</servlet-mapping>
<servlet-mapping>
<servlet-name>ard</servlet-name>
<url-pattern>/servlet/ard/*</url-pattern>
</servlet-mapping>
<servlet-mapping>
<servlet-name>repos</servlet-name>
<url-pattern>/servlet/repos/*</url-pattern>
</servlet-mapping>
The parameters required for the web service are highlighted in green below.
NB. The UV8 line is just an example and should be identical to the UV8 line under the ard servlet.
<!-- UNIFACE S(oap) R(equest) D(ispatcher) Servlet -->
<servlet>
<servlet-name>srd</servlet-name>
<servlet-class>
com.compuware.uniface.urd.SRDServlet
</servlet-class>
<init-param>
<param-name>MIDDLEWARE</param-name>
<param-value>UV8:server+13100|userver|xxxxx|AURPROD_WEB</param-value>
</init-param>
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 13
<param-name>ASVTIMEOUT</param-name>
<param-value>300</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>testwrd</servlet-name>
<url-pattern>/servlet/testwrd/*</url-pattern>
</servlet-mapping>
<servlet-mapping>
<servlet-name>ard</servlet-name>
<url-pattern>/servlet/ard/*</url-pattern>
<servlet-mapping>
<servlet-name>repos</servlet-name>
<url-pattern>/servlet/repos/*</url-pattern>
</servlet-mapping>
<servlet-mapping>
<servlet-name>srd</servlet-name>
<url-pattern>/servlet/services/*</url-pattern>
</servlet-mapping>
SS Session Manager
The standard Aurion session state is used to maintain state between interactions for web services.
The Session state mechanism is shared by the Self Service state container.
A column has been added to the SS Session manager (ES053_ESS_STATE) to identify between a
Self Service session and a Web Service session.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 14
This new type of “Web Service” is created by a successful connection to the Aurion Web Service.
Testing the Web Services
There are several web service testing tools available on the Internet. You may build your own web
services application using a programming language that has the means to access a web service via
the SOAP protocol.
The first example demonstrates how to access the Aurion Web Service using the “.NET
WebService Studio” available at http://www.codeplex.com/WebserviceStudio. You might also
consider using soapUI - www.soapui.org.
A second example is provided using as a purpose-built “php” based application.
Example – .NET WebService Studio
Type in the location of the WSDL file in relation to your Web Server, and then click ‘Get’…
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 15
You will be provided with the published operations…
Click the LOGON operation, and you will be provided with the input parameters available. Enter
your Aurion username and password…
Once all the credentials are set, click the “Invoke” button. Upon a successful logon, the return
parameter will contain the session token for the users’ session. Once available as the value string,
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 16
copy the value from the P_TOKEN string value.
Once a token has been returned upon a successful logon, click on the APIS operation. Enter the
token value returned from the LOGON operation. This operation will return a list of APIs
available. The list is a string separated by the “_RESP_” separator token. This list may be
interrogated by third party applications for purposes of establishing the name and description of
available API Functions published by Aurion. The P_STATUS output parameter indicates the
number of APIs available.
Once a Token has been returned upon a successful logon, and you have decided what API to use,
click on the SETFUNCTION operation. Enter the Token value returned from the LOGON operation
and the API Function you want. In this case, we are going to execute the “QUERY_TO_XML”
function.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 17
This will set the application to expect parameters relating to the QUERY_TO_XML function. The
P_FIELDLIST output parameter contains a list of function parameters with their attributes (Size,
Allowed Values, Data Type, etc)
In this example, the QUERY_TO_XML function will require one mandatory parameter, being the
QUERY_ID. When you click on the SETVALUE operation, you are presented with inputs required
for the P_TOKEN, the P_ITEM, and the P_VALUE for the item. In this example, the Query ID is
RK_99. You will need to select a valid query already defined within Aurion at your site. For each
SETVALUE instruction you must click the Invoke button.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 18
Use SETVALUE to set the RETURN_XML parameter to indicate to the API that XML is to be
returned by the Query.
Once you have set all of the required parameters, you can then execute the function by accessing
the CALLFUNCTION operation. This operation only requires the value for P_TOKEN.
Once executed/invoked, the return result set XML stream is contained within the P_OUTPUT
value, and, in the case of this API function (QUERY_TO_XML), the P_STATUS value is set to the
number of query records returned…
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 19
To ensure that the Web Service sessions are cleaned up, issue a LOGOFF call by passing the
P_TOKEN for the session…
Example – Purpose-Built PHP Application
An example set of PHP scripts are provided with Aurion for further testing. These scripts have
been purpose-built to access the Aurion Web Service and are shipped with Aurion 10 in the
API\SOAP folder.
These PHP scripts provided should be placed on a PHP enabled web server.
These scripts are supplied as examples only, and are not supported by Aurion.
Two script files are supplied; ssoap.php and aurionws.php
Access the “ssoap.php” script from a web browser.
Accessing the Example Script
The ssoap.php script contains the URL, user and password for accessing the Aurion APIs. This
information can now be updated by two methods:
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 20
Method 1: Modify the ssoap.php script, entering values valid at your site (shown below).
Method 2: Access the ssoap.php script from the web server in which it was placed, and enter
the login and URL credentials on the home page (this will not update the default parameters)
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 21
A list of available API functions will be built into the displayed dropdown list on the page, also a
full download in .csv file format is available here
API Update from form method
When an API function is selected, the details of the function will be presented to the user. In this
example, you will use the QUERY_TO_XML function. …
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 22
Each parameter may or may not have rules or constraints. If they do, they are defined in the table
listed for the function. …
Once these have been identified, the user may now execute the API via the web service by placing
the appropriate values in the parameter list for the API.
In the case of the function QUERY_TO_XML, the result is a XML stream. In some cases, the result
would be plain text or blank. For our web browser to accommodate anything other than the
browser default (which is HTML) you must set the result output header for the browser to know
what to do with the returned data. This is done by setting the “Header / Output Type” to XML.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 23
This is already done for the QUERY_TO_XML function.
When the function is submitted, the results are as follows. (Your results will differ depending on
the test query selected)
API Update From CSV File Method
From Aurion 10.2 MR5, there is new functionality for uploading the updated details of the
selected function in the form of a csv file to either update a single or multiple records
simultaneously via API.
Various templates of API functions can be downloaded from the ssoap.php web form.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 24
This downloaded template can either be updated, or serve as a guide for how the relevant
information is expected for a successful API import to occur. In this example, the downloaded csv
is shown as:
This csv file can then be updated with the relevant information, and subsequently imported on
the ssoap.php form to complete the API import process.
Browse to your updated csv file, and select "UPLOAD"
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 25
Aurion API Classes Overview
The Aurion API has 7 main Classes:
1. LOGON – used to validate a logon an API Session to Aurion and enable further functionality.
You must successfully log on before further processing can occur.
2. LOGOFF – used to logoff an API session.
3. SETFUNCTION – used to nominate what function Aurion should perform.
To view available functions, use the Security Task List in Aurion, nominating the type as API as
follows.
4. SETVALUE – used to set Item/Value pairs for the selected function.
Each Function requires one or more pairs of input values. The SETVALUE function is called
repetitively until all input values are registered. For a list of available Item/Value pairs for each
function, pulldown process, API Items on an API in the Aurion security Task List as follows.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 26
5. CALLFUNCTION – used to actually run the requested function after it has been identified using
SETFUNCTION, and the Item/Value pairs set by SETVALUE calls.
Any output returned by the function is returned as a string in the Output parameter.
6. CALLFUNCTION2 – combines the SETFUNCTION, SETVALUE and CALLFUNCTION classes into a
single class. You must provide all values for the API function that you are calling even if they
are null.
7. Any output returned by the function is returned as a string in the Output parameter.
8. CALLFUNCTION3 – combines the SETFUNCTION, SETVALUE and CALLFUNCTION classes into a
single class. You must provide the mandatory values and any other values that are required
to achieve your desired outcome. Both parameter names and values must be provided in the
format PARAM1=value,PARAM2=value.
9. Any output returned by the function is returned as a string in the Output parameter
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 27
API Classes
LOGON
API Class: LOGON
Description: This API Class enables you to logon to Aurion. After successful logon, your Aurion session will continue until you logoff.
Parameters Type
USER INPUT 1
PASSWORD INPUT 2
MESSAGE OUTPUT
STATUS OUTPUT
Successful LOGON returned parameter values:
STATUS MESSAGE
0 Any message returned identifies conditions that may impact the successful completion of subsequent processes.
LOGON error conditions:
STATUS MESSAGE
< 0 Description of error condition.
SETFUNCTION
API Class: SETFUNCTION
Description: This API Class defines the function to be executed by Aurion, e.g. PAYROLL_TS_ADDW (Add Timesheet Work).
Parameters Type
FUNCTION INPUT 1
MESSAGE OUTPUT
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 28
Parameters Type
STATUS OUTPUT
Successful SETFUNCTION returned parameter values:
STATUS MESSAGE
0 Any message returned identifies conditions that may impact the successful completion of subsequent processes.
SETFUNCTION error conditions:
STATUS MESSAGE
< 0 Description of error condition.
SETVALUE
API Class: SETVALUE
Description: This API Class defines the parameter name and values that are to be used by the function, e.g. EMPLOYEE_NO and TIME_CODE.
Parameters Type
ITEM INPUT 1
VALUE INPUT 2
MESSAGE OUTPUT
STATUS OUTPUT
Successful SETVALUE returned parameter values:
STATUS MESSAGE
0 Any message returned identifies conditions that may impact the successful completion of subsequent processes.
SETVALUE error conditions:
STATUS MESSAGE
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 29
< 0 Description of error condition.
CALLFUNCTION
API Class: CALLFUNCTION
Description: This API Class initiates the execution of the function that has been previously defined, by Aurion.
Parameters Type
FUNCTION INPUT 1
OUTPUT OUTPUT
MESSAGE OUTPUT
STATUS OUTPUT
The CALLFUNCTION returned parameter values are dependent upon the API Function being executed by Aurion. Refer to the documentation for the specific API Function for the parameter values returned.
LOGOUT
API Class: LOGOUT
Description: This API Class terminates the Aurion session.
There are no parameters for LOGOUT.
There are no return codes for LOGOUT.
CALLFUNCTION2
API Class: CALLFUNCTION
Description:
This API Class executes a function directly without previously having to call SETFUNCTION or SETVALUE. Function parameters are defined in a single input variable in a comma separated variable length format. The first value is mapped to the first parameter name in the API parameter list, and so on. The Delimiter defaults to a comma "," value. The Wrapper defaults to a null value.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 30
Parameters Type
FUNCTION INPUT 1
DELIMITER INPUT 2
WRAPPER INPUT 3
PARAMETERS INPUT 4
OUTPUT OUTPUT
MESSAGE OUTPUT
STATUS OUTPUT
The CALLFUNCTION returned parameter values are dependent upon the API Function being executed by Aurion. Refer to the documentation for the specific API Function for the parameter values returned.
CALLFUNCTION3
API Class: CALLFUNCTION
Description:
This API Class executes a function directly without previously having to call SETFUNCTION or SETVALUE. Function parameters are defined in a single input variable in a labelled list format. For example, PARAM1=value1,PARAM2=value2,... With this format, function parameters can be specified in any order and function parameters that are not set do not need to be included. The Delimiter defaults to a comma "," value. The Wrapper defaults to a null value.
Parameters Type
FUNCTION INPUT 1
DELIMITER INPUT 2
WRAPPER INPUT 3
PARAMETERS INPUT 4
OUTPUT OUTPUT
MESSAGE OUTPUT
STATUS OUTPUT
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 31
The CALLFUNCTION returned parameter values are dependent upon the API Function being executed by Aurion. Refer to the documentation for the specific API Function for the parameter values returned.
API Functions
NOTE: Click on hyperlinked text to view any notes available for APIs.
API Function Description
CCODE_UPDATE Update Cost Code Details
CHANGEHRS Schedule an Hours Change
CHANGEHRS_SCHED Set Hours Change to Scheduled
CHANGEHRS_WPWEEK Schedule an Hours Change - WP
CHANGESTATUS Schedule Change Status
CHANGESTATUS_SCH Set Status Change to Schedule
CHANGESTATUS_WP Schedule Change Status - WP Week
CLASS_ALLOW_ADD Add Classification Allowance
CLASS_ALLOW_DEL Delete Classification Allowance
CODE_UPDATE Add/Update General Code
CORE_IDSEC_CHECK Security Check for User
CORE_SEC_CHECK Security Check
CORE_SEC_UPDUSER Update Security User
CRIMTRAC_ADD Add CrimTrac Checks
DOCUMENT_COPY Copy/Move Document
DOCUMENT_DELETE Delete Document
DOCUMENT_UPDATE Update Document
EEO_ADD_MODIFY Add or Modify EEO Details
EEO_DELETE Delete EEO Details
EMP_CHANGESTATUS Change Employee Status
EMP_COST_DEL Delete Employee Costing
EMP_SCHEDNEWHIRE Schedule Start New Hire
EMP_SCHEDPRO Employee Schedule Process
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 32
API Function Description
EMP_SCHEDREHIRE Schedule Employee Rehire
EMP_SCHEDSTATUS Set New Hire/Rehire to Schedule
EMP_SCHED_ALLOW Update Schedule Start Employee – Allowance
EMP_SCHED_DEDN Update Schedule Start Employee – Deduction
EMP_SCHED_DELETE Delete incomplete schedules
EMP_SCHED_EMP Update Schedule Start Employee – Employee Details
EMP_SCHED_JOB Update Schedule Start Employee – Job Details
EMP_SCHED_SUPER Update Schedule Start Employee – Super Details
EMP_SCHED_TAX Update Schedule Start Employee – Tax Details
EMP_SCHED_WPWEEK Update Schedule Start Employee – Work Pattern
EMP_START_NONPAY Start Employee Not on Leave/Payroll
EMP_TERMINATE Employee Termination
EMP_UPDATE_PERS Update Personal Details
EMP_UPDATE_ROST Update Employee Roster/Cycle
EMRGCONT_MAINT Maintain Emergency Contacts
EXPOSURE_ADD Add Exposure Incidents
EXPOSURE_MODIFY Modify Exposure Incidents
EXPOSURE_DELETE Delete Exposure Incidents
EXTRA_DET_MAINT Maintain Employee Extra Details
GET_SUPER_DETS Get Supervisor Mail Details
GET_USER_DETS Get User Mail Details
HR_PROF_MAINT Maintain Personal HR Profile Comments
IEVENT_BOOKING Maintain Immunisation Event Booking
INDUCT_ADD Add Induction Details
INDUCT_DELETE Delete Induction Details
INDUCT_EVENT_ADD Add Induction Event Details
INDUCT_EVENT_DEL Delete Induction Event Details
INDUCT_EVENT_MOD Modify Induction Event Details
INDUCT_MAINT Maintain Induction (deprecated)
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 33
API Function Description
INDUCT_MODIFY Modify Induction Details
INVOICE_HEAD_ADD Add Invoice Header
INVOICE_LINE_ADD Add Invoice Line
INV_UPDATE_CUST Invoice - Update Customer
INV_UPDATE_SITE Invoice - Update Site
IREGO_ADD Add Immunisation Rego Details
IREGO_DELETE Delete Immunisation Rego Details
IREGO_MODIFY Modify Immunisation Rego Details
ISSUES_ADD Add Issue Details
ISSUES_DELETE Delete Issue Details
ISSUES_MAINT Maintain Issue (deprecated)
ISSUES_MODIFY Modify Issue Details
ISTATUS_ADD Add Immunity Status Details
ISTATUS_DELETE Delete Immunity Status Details
ISTATUS_MODIFY Modify Immunity Status Details
LEAVE_ADD_ADJUST Add Leave Balance Adjustment
LEAVE_ADD_PAYOUT Add Leave Payout
LEAVE_PREAUR_ADD Add Pre Aurion Leave
LEAVE_PREAUR_DEL Delete Pre Aurion Leave
LICENCE_ADD Add Licence Details
LICENCE_DELETE Delete Licence Details
LICENCE_MAINT Maintain Licence (deprecated)
LICENCE_MODIFY Modify Licence Details
MAIL_SEND Send Mail Message
MENU_OPTION_ADD Add Menu Option
NOTATION_ADD Add Notation Details
NOTATION_DELETE Delete Notation Details
NOTATION_MAINT Maintain Notation (deprecated)
NOTATION_MODIFY Modify Notation Details
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 34
API Function Description
OHS_INCIDENT_ADD Add OHS Incident
OHS_INCIDENT_MOD Modify OHS Incident
OHS_NOEMP_INCADD Add Non-Employee OHS Incident
OHS_NOEMP_INCMOD Modify Non-Employee OHS Incident
PASSPORT_ADD Add Passport Details
PASSPORT_DELETE Delete Passport Details
PASSPORT_MODIFY Modify Passport Details
PAYCODE_COSTING Load Pay Codes Costing
PAYROLL_ADDALLOW Add Allowance Transaction
PAYROLL_ADDBONUS Add Net Bonus
PAYROLL_ADDDEDN Add Deduction Transaction
PAYROLL_ADDSTD Add Standing Allowance/Deduction
PAYROLL_ADDWORK Add Work Transaction
PAYROLL_ATO_ADJ Add ATO Adjustment
PAYROLL_ATO_KLM Add Kilometre Allowance
PAYROLL_AUS_TAX Tax Details
PAYROLL_NET_BANK Net Pay Details
PAYROLL_RANGEADJ Adjust Standing Allowance/Deduction
PAYROLL_ROST_ADD Add Roster Code
PAYROLL_STOPALLW Stop Standing Allowance
PAYROLL_SUPERADJ Capture Superannuation Adjust
PAYROLL_SUP_LTD Payroll Super Update
PAYROLL_TKR_ADD Add Roster Timekeeper Line Times In Row
PAYROLL_TKR_ADD2 Add Roster Timekeeper Line Hours In Row
PAYROLL_TKR_DALL Delete All Roster Timekeeper Lines
PAYROLL_TK_ADD Add Timekeeper Line Times In Row
PAYROLL_TK_ADD2 Add Timekeeper Line Hours In Row
PAYROLL_TK_D_ALL Delete All Timekeeper Lines
PAYROLL_TK_D_DAY Delete Timekeeper Lines 4 Day
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 35
API Function Description
PAYROLL_TK_PRO Process Timekeeper Form
PAYROLL_TS_ADDA Add Timesheet Allowance
PAYROLL_TS_ADDD Add Timesheet Deduction
PAYROLL_TS_ADDW Add Timesheet Work
PAYROLL_TS_DEL Delete Employee Timesheet
PAYROLL_TS_PRO Process an Employee Timesheet
PERSON_ADD Add Person (non-Employee)
PLACEMENT_ADD Add Employee Placement
PLACEMENT_ERASE Delete All Employee Placements
PLACE_COST_ADD Add Placement Cost Profile
PLACE_COST_DEL Delete Placement Cost Profile
POSITION_ADD Add a Position
POSITION_MODIFY Modify a Position
POSN_ALLOW_ADD Load Position Allowance Codes
POSN_AUTHTYPE Maintain Position Authorisation
POSN_AUTH_REPORT Position Update Authority/Report Lines
POSN_COST_ADD Add Position Cost Profile
POSN_COST_DEL Delete Position Cost Profile
POSN_INACTIVATE Position Abolish / Inactivate
POSTCODE_UPDATE Add/Update Postcode
PROBATION_ADD Add Probation Details
PROBATION_DELETE Delete Probation Details
PROBATION_MAINT Maintain Probation (deprecated)
PROBATION_MODIFY Modify Probation Details
PSH_SALARY_CHANGE Import Pay Scale History Data
PUB_HOLIDAY_ADD Load Public Holidays
QUERY_TO_XML Output Query to XML
RELCOST_MAINT Add & Maintain Related Cost Data
RELCOST_DELETE Delete Related Cost Data
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 36
API Function Description
SEC_CLR_ADD Add Security Clearance Details
SEC_CLR_DELETE Delete Security Clearance Details
SEC_CLR_MODIFY Modify Security Clearance Details
SEC_EVENT_ADD Add Security Event Details
SEC_EVENT_DEL Delete Security Event Details
SEC_EVENT_MOD Modify Security Event Details
SEC_OACCES_MAINT Maintain Organisation Unit/Position Security Access
SEC_OLEVEL_MAINT Maintain Organisation Unit/Position Security Levels
SEC_OPROF_MAINT Maintain Organisation Unit/Position Security Profile
SEC_PROFTSKMAINT Maintain Security Profile Task
SEC_TASK_ADD Add Security Task
SEC_UACCES_MAINT Maintain Security User Access
SEC_ULEVEL_MAINT Maintain Security User Levels
SEC_UPROF_MAINT Maintain Security User Profile
SEC_USER_ADD Add Security User
SEC_USER_UPDATE Update Security User
SERVHIST_ERASE Delete All Service History
SERVHIST_UPDATE Add/Update Service History
SKILLS_GEN_ADD Add General Skill Details
SKILLS_GEN_DEL Delete General Skill Details
SKILLS_GEN_MOD Modify General Skill Details
SKILLS_MAINT Maintain Skill Bank
SPIN_UPDATE Update SPIN Code Details
SVYAN_BLK_UPDATE Update Form Answers in Bulk
SVYAN_ROW_UPDATE Update Form Answer Table Row
SVYAN_UPDATE Update Form Answer
SVYSM_UPDATE Update Form Summary
SVYSM_WORKFLOW Process Form Workflow
TIMECODE_ADD Add Time Code – Full Details.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 37
API Function Description
TIMECODE_MOD Modify Existing Time Code – Full Details.
TIMECODE_MODIFY Modify Existing Time Code – Primary Details
TK_TEAM_ACCESS Maintain Team Approval Access
TNG_ATT_COST_UPD Training Course Attendee Cost Update
TNG_ATT_UPD Training Attendance Update
TNG_CRS_ADD Add Training Course
TNG_CRS_COST_ADD Add Training Course Cost
UNAPPROV_TK_DEL Delete Unapproved Timekeeper Forms
VISA_ADD Add Visa Details
VISA_DELETE Delete Visa Details
VISA_MODIFY Modify Visa Details
WEB_LICENCE_ADD Add Candidate Licence Details
Output File
The output file produced by all API’s is a comma delimited file with a wrapper of double quotes
(“). Fields in the output file are the same as the fields in the input file plus the following fields:
OUTPUT String
STATUS Number
MESSAGE String
Input Variables
Aurion APIs accept input in a variety of formats including Booleans, strings, dates, times and
numbers with the following provisions.
String A string of alphanumeric characters with (optionally) a maximum length as specified in the Max. Len column.
Boolean A True/False field, where True may be input as T,1 or Y. False may be F, 0 or N.
Date A string that represents a date in the format YYYYMMDD.
Time A string that represents a time in the format HH:MM.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 38
Number A string of numeric characters. Decimal point is optional, but required when expressing fractions. Negative numbers are indicated by a preceding “-“.
Viewing API Field Details
The API Import task (ER250_API_IMPORT) is used to import details from a comma delimited (CSV)
file and process the details using Aurion API’s.
You can select Process > File Descriptions from the API Import Parameters form
(EP250_API_IMPORT) to view the field details of all available APIs. An example is shown below:
You can also, if required, output the contents of this form to another application such as MS
Notepad or MS Excel if you wish to produce a printed copy of the API details.
Setting a Field to Null
When importing data into Aurion from an API you can define optional fields as blank, or remove
any existing data from the field, by defining the field as being NULL.
When a variable has no value, it is considered to be null. Having a null value is
different than having a value of 0, because 0 is an actual value.
To do this you enter the following for the required field/s:
<NULL>
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 39
Note that the brackets shown above are intentional and must be used.
The data type of the field does not matter when being set to null.
You could use this, for example, when using the PAYROLL_AUS_TAX API, if you wanted to blank
out, or remove any existing data from, the AWE field.
As another example, to remove all of the address details for an employee's emergency contact,
you could call the API function EMRGCONT_MAINT to update the record and set all of the address
fields to null, as shown below:
EMRGCONT_MAINT,10123456,,F,W,1,JOHN
CITIZEN,<NULL>,<NULL>,<NULL>,<NULL>,<NULL>,<NULL>,<NULL>,100,T,,,,,,
Aurion will return an error message if a mandatory field is entered as <NULL>.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 40
API Notes
API Description Notes
EMP_SCHED_EMP Update Schedule Start Employee – Employee Details
If a Work Pattern Template is specified, then the other Hours per Week items are ignored.
EMP_SCHEDNEWHIRE Schedule Start New Hire
Will generate an Employee Number if not provided and return the generated Employee Number back in the OUTPUT variable.
EMP_START_NONPAY Start Employee Not On Leave/Payroll
Will generate an Employee Number if not provided and return the generated Employee Number back in the OUTPUT variable.
HR_PROF_MAINT Maintain Personal HR Profile Comments
Only alpha-numeric characters allowed.
ISTATUS_ADD
ISTATUS_DELETE
ISTATUS_MODIFY
Add, modify and delete Immunity Status data
Whilst there are fields in this API that
are always mandatory, there are other
fields that become mandatory
depending on the value of other fields:
If IMMUNITY_TYPE is E (for Expiring)
then DATE_OF_EXPIRY is mandatory
otherwise the DATE_OF_EXPIRY is
forced to be blank.
If OBTAINED_METHOD is O (for Other)
then OTHER_METHOD_TEXT is
mandatory and the REGO_TRANS_NO
value is forced to be blank.
If OBTAINED_METHOD is I (for
Immunisation Program) then
REGO_TRANS_NO is mandatory and the
OTHER_METHOD_TEXT is forced to be
blank. The REGO_TRANS_NO must be a
valid program registration transaction
number for the person and the disease
of the program must match the
DISEASE_CODE of the API record.
If OBTAINED_METHOD is P (Previous Employment) or D (Data Capture) then
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 41
API Description Notes
both the OTHER_METHOD_TEXT and REGO_TRANS_NO fields are forced to be blank.
OHS_NOEMP_INCADD Add Non-Employee related incidents
These incidents get attached to an External Organisation-based Wami number. This WAMI number is derived from Business rule 02906 ( Define External Organisation Aurion Number to be used for Non-Person Related OHS Incident Recording.)
PAYROLL_ADDDEDN Add Deduction Transaction
The deduction code MUST be of Type CREDITOR paid by CREDITOR CHEQUE or CREDITOR BANK or of Type OTHER paid by INTERFACE, and cannot be a ‘Percentage’ or ‘Per Hour’ type of deduction code.
PAYROLL_ADDSTD Add Standing Allowance/Deduction
Adds recurring allowances, non-superannuation employEE deductions, or employER benefits. These arrangements can have a reducing range capital balance.
PAYROLL_STOPALLW Stop Standing Allowance
Does not support range standing
arrangements
If the date ceased:
is the same as the last pay
period end date, then removes
the allowance from the current
pay.
is in a future pay period, does
not remove from the current
pay, but updates the ongoing
allowance with a date to and
reason/indicator etc. The
standard Aurion payrun process
remove the allowance from the
appropriate pay when it rolls
around.
is for a previous pay period,
removes from the current pay
and adds a warning in the report
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 42
API Description Notes
output that an adjustment may
need to be made.
does not match a period end
date, adds a warning in the
report output that an
adjustment may need to be
made.
PAYROLL_RANGEADJ Adjust Standing Allowance/Deduction
Resets the reducing range capital balance outstanding.
PLACEMENT_ADD Add Employee Placement
This API will allow acting placements to be processed when there is already future-dated acting after this period of acting, on the proviso there are no overlapping acting placements.
Business Rule 01010 can be used to automatically derive the salary from the previous placement when:
adding a new placement (not acting
placement)
both previous classification and new
classification are banded, or set the
salary to the bottom of the range of
the new placements banded
classification (current functionality,
no change)
salary is within the band range of
the classification specified for the
new placement - if not a warning is
issued.
POSITION_ADD Add a Position HOURS_PER_WEEK must be entered in decimal format, e.g. 36:45:00 must be entered as 36.75.00.
POSITION_MODIFY Modify a Position HOURS_PER_WEEK must be entered in decimal format, e.g. 36:45:00 must be entered as 36.75.00.
POSN_ALLOW_ADD Load Position Allowance Codes
Positions & allowance codes must exist & be active. Allowance code must be position-based. Combination of Position
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 43
API Description Notes
and allowance code must not already exist as a position allowance
PSH_SALARY_CHANGE Import Pay Scale History
Changes to salary data only are supported.
Date effective cannot be more than 3 months into the future.
RELCOST_MAINT/RELCOST_DELETE
Add & Maintain Related Cost Data
Delete Related Cost Data
These APIs add, modify and delete Cost Code dependency data. I.e. codes listed in the ‘Uses these Codes’ section of the Cost Code Detail form (ES344_CCODE_DET).
SEC_CLR*/SEC_EVENT* Security Clearance & Security Clearance Event APIs
Document fields are shortcuts and are not validated by Aurion.
SVYAN_BLK_UPDATE Update Form Answers in Bulk
Enables the SVYAN_UPDATE (Update Form Answer) API and the SVYAN_ROW_UPDATE (Update Form Answer Table Row) API to be invoked multiple times with a list of inputs, and so reduce processing overheads when a survey with many questions is defaulted, or copied, by a BPA Ruleset.
The formula syntax for this API is very complex so the Edit Answer List for Bulk Update form has been provided to simplify the process of populating the API’s list item. This form can be accessed by clicking the Zoom button on the Formula fields of the Event Ruleset Editor form when the ANSWER_LIST field is selected in the API Fields list.
TNG_CRS_ADD Add Training Course This function does not support Template courses, only actual courses.
UNAPPROV_TK_DEL Delete Unapproved Timekeeper Forms
Deletes ALL Timekeeper forms except those that are Approved, Validated or Submitted. This includes forms with a status of Empty, Incomplete or Error.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 44
Query to XML API
Aurion’s API functionality has been extended to enable the Aurion Query Tool to be activated
from an API.
Record selection (or Filter) values are passed into the API and the results are returned as an XML
stream.
Following is information on the configuration and use of the API, including examples.
Note that this API does not transform the XML into HTML.
Ensure that you have access to the QUERY_TO_XML API security task as well as any data that you
wish to query. Ensure that your Aurion licence gives you access to the Query Tool.
Example 1 of Parameterised Query + Output to XML
Illustrated below is a query that accepts Ask in Batch input parameters from the API, and then
outputs the results to XML.
Select fields, in this case from the Employee data source. In this example we know that Employee
Number will be input parameter into the API, so we ensure that we select this field.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 45
Specify that this field is “Ask in Batch”. This means it is able to accept input from the API. It is
recommended that the Mandatory checkbox be selected also, to ensure that a value is provided.
Use the Preview tab to verify that the “default” Employee Number is retrieving the information
needed for the XML.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 46
Specify the location of the XML file to be output. This can be overridden by input into the API.
Example 2 of Parameterised Query + Output to XML
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 47
Illustrated below is a query that accepts Ask in Batch input parameters from the API, and then
outputs the results to XML.
Select fields, in this case from the Employee Issues data source. In this case the parameters are
going to be for the Item Code and Date Issued fields.
Specify that the Item Code field is “Ask in Batch” and it this case provide default selection values
for it:
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 48
Specify that the Date Issued field is “Ask in Batch” and it this case provide default selection values
for it:
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 49
Or alternatively, don’t provide default values for it, as shown below. This method ensures that the
input values will come through the API, as the Mandatory checkbox is also selected:
Specify the org unit location as required. In this example Org Unit 1 will be derived by the query
runtime.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 50
Use the Preview tab to verify that the “default” settings are retrieving the information needed for
the XML. Note the number of hits as 7 in this case.
Specify the location of the XML file to be output. This can be overridden by input into the API.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 51
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 52
Alternatively you can specify values for the Path fields, all of which can be overridden via input
into the API.
Returning the results in CSV format embedded in XML
Due to that nature of XML being descriptive, an AQT query returning the results in an XML format
will always result in a significantly larger file / data stream than the same results returned in a csv
format.
The QUERY_TO_XML API now allows a query’s results to be returned in csv format embedded in
an xml file / data stream. To enable this functionality, update your query so that the File Type to
Delimited on the File tab (of the Output tab).
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 53
If you are seeking to reduce the time it takes for data to be returned from the QUERY_TO_XML
API, then you should consider using this option.
Run the API to use the Query in Example 2
Determine the parameter tags
We have specified in Example 2 that the filters are on Item Code and Date Issued.
We need to ascertain the tags to be used to pass the input parameters through the API. These are
the same as the fields’ respective internal field names, visible on the AQT tab pages, as illustrated
below.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 54
So from the above we know that:
the tag for Item Code is T010F020_ITEM_CODE.T010_ISSUES
the tag for Date Issued is T010F025_DATE_ISSUED.T010_ISSUES.
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 55
We will assume we want to use the following criteria:
Item Code (i.e. T010F020_ITEM_CODE.T010_ISSUES) of 100
Not forgetting we need to insert a separator here of “<br>”
Date Issued (i.e. T010F025_DATE_ISSUED.T010_ISSUES) of between 01-JAN-2001 and 01-FEB-
2001.
Summarise the API inputs
We then summarise the inputs as follows:
QUERY_ID QUERY_2
FILTER T010F020_ITEM_CODE.T010_ISSUES=100<br> T010F025_DATE_ISSUED.T010_ISSUES=01-JAN-2001
FILTER_HI T010F025_DATE_ISSUED.T010_ISSUES=01-FEB-2001
ORG_UNIT 1
ORG_VIEW BELOW
RETURN_XML T (as we want the XML to be returned in the OUTPUT field in the API)
XML_FILE_PATH svc_remote_test_1
Since 10.2 MR5 there are three methods of calling APIs using the different classes:
SETFUNCTION, SETVALUE and CALLFUNCTION
CALLFUNCTION2
CALLFUNCTION3.
Following are examples of how you would call the same query using the different classes.
Run the API using SETFUNCTION, SETVALUE and CALLFUNCTION
Now we have determined the parameters to pass the API, we can run the Aurion API test facility.
This resides in <aurion_install_folder>\<environment>\API\COM\ AurionAPITest-COM.vbs and
looks like this:
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 56
The sequence of “Action” steps to be followed, based on the API inputs that we summarised in
the previous section, is as follows:
Class/Function Input1 Input2
LOGON your userid your password
SETFUNCTION QUERY_TO_XML
SETVALUE QUERY_ID QUERY_2
SETVALUE FILTER T010F020_ITEM_CODE.T010_ISSUES=100<br> T010F025_DATE_ISSUED.T010_ISSUES=01-JAN-2001
SETVALUE FILTER_HI T010F025_DATE_ISSUED.T010_ISSUES=01-FEB-2001
SETVALUE ORG_UNIT 1
SETVALUE ORG_VIEW BELOW
SETVALUE RETURN_XML T
SETVALUE XML_FILE_PATH svc_remote_test_1
CALLFUNCTION
LOGOFF
1 2
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 57
3 4
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 58
5 6
7 8
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 59
9 10
11
After the Action button has been clicked there is a delay while the query is executed and the XML
generated.
This XML is returned from the query to the API, and appears in the OUTPUT field, as illustrated
above.
To view the complete XML output, click on the field and select its entire contents, then copy and
paste into a text editor such as Notepad.
In the example above, the XML returned looked like this:
<?xml version="1.0" encoding="ISO-8859-1"?>
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 60
<!DOCTYPE DocumentRoot [
<!ELEMENT DocumentRoot (AQT_Output*)>
<!ELEMENT AQT_Output (Employee_Number, Full_Name, Salutation, Gender, Item_Code,
Date_Issued, Short_Description)>
<!ELEMENT Employee_Number (#PCDATA)>
<!ELEMENT Full_Name (#PCDATA)>
<!ELEMENT Salutation (#PCDATA)>
<!ELEMENT Gender (#PCDATA)>
<!ELEMENT Item_Code (#PCDATA)>
<!ELEMENT Date_Issued (#PCDATA)>
<!ELEMENT Short_Description (#PCDATA)>
]>
<DocumentRoot>
<AQT_Output>
<Employee_Number>10001</Employee_Number>
<Full_Name>Davenport, Lindsay</Full_Name>
<Salutation>Ms</Salutation>
<Gender>FEMALE</Gender>
<Item_Code>100</Item_Code>
<Date_Issued>14-JAN-2001</Date_Issued>
<Short_Description>Key No. 100</Short_Description>
</AQT_Output>
</DocumentRoot>
If the Query was configured to use a File Type of Delimited rather than XML then the following
would be returned.
<?xml version="1.0" encoding="ISO-8859-1"?>
<![CDATA["Employee_Number","Full_Name","Salutation","Gender","Item_Code","Date_Issued","
Short_Description"
"10001","Davenport, Lindsay","Ms","FEMALE","100","14-JAN-2001","Key No. 100"]]>
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 61
Run the API using CALLFUNCTION2
CALLFUNCTION2 combines the SETFUNCTION, SETVALUE and CALLFUNCTION class into one class.
CALLFUNCTION2 requires that you provide values, even if they are null, for all API parameters.
The table below summarises the API test program’s sequence steps.
Class/Function Input1 Input2 Input3 Input4
LOGON your userid your password
CALLFUNCTION2 QUERY_TO_XML QUERY_2
QUERY_2, T010F020_ITEM_CODE.T010_ISSUES=100<br>T010F025_DATE_ISSUED.T010_ISSUES=01-JAN-2001, T010F025_DATE_ISSUED.T010_ISSUES=01-FEB-2001,,1,BELOW,T,,,,, svc_remote_test_1,
LOGOFF
NB. Given that Input 2 and 3 were not provided for the CALLFUNCTION2, the default values for the
parameter delimiter (,) and wrapper (null) will be used.
1 2
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 62
3
Run the API using CALLFUNCTION3
CALLFUNCTION3 combines the SETFUNCTION, SETVALUE and CALLFUNCTION class into one class.
CALLFUNCTION3 requires that you only provide the API’s mandatory parameter values as well as
other parameter values that you require to achieve the desired outcome.
The table below summarises the API test program’s sequence steps.
Class/Function Input1 Input2 Input3 Input4
LOGON your userid your password
CALLFUNCTION3 QUERY_TO_XML
QUERY_ID=QUERY_2, FILTER=T010F020_ITEM_CODE.T010_ISSUES=100<br>T010F025_DATE_ISSUED.T010_ISSUES=01-JAN-2001, FILTER_HI=T010F025_DATE_ISSUED.T010_ISSUES=01-FEB-2001,ORG_UNIT=1,ORG_VIEW=BELOW,RETURN_XML=T, XML_FILE_PATH=svc_remote_test_1
LOGOFF
© Aurion Corporation Pty Ltd 2016 V 1.1 Last Updated: 19/09/2016 Commercial in Confidence 63
NB. Given that Input 2 and 3 were not provided for the CALLFUNCTION3, the default values for the
parameter delimiter (,) and wrapper (null) will be used.
1 2
3