In the cloud, you can import or export using data files but you need to manually drag and drop the files. You can automate the process with our web services, which allow you to exchange data directly between your application and X3.

In addition to running in real time, web services can also be executed by our batch server. This can be useful when you need to process data at specific times during the day, or on a recurring basis.

Available Web Services

Standard SOAP web services are supplied to manage these operations. They use the standard SOAP web service connection pools and can be called from any program that can:

The SOAP web services used are subprograms associated with web services. Their names are the following:

Service nameSubprogramDescription
AOWSIMPORTAOWSIMPORT.IMPORTImports data based on an import template
AOWSEXPORTAOWSEXPORT.EXPORTExports data associated with a template and parameters
AOWSBATGETAOWSGETBATCH.GETRetrieves information about a batch import/export request

These SOAP web services can be called from any program that can perform a SOAP web service in the correct format as described below. You can, for example, write in Java, PHP, JavaScript, .NET, C, etc.


Perform an Import

The import web service contains the following arguments:

GroupCodeDescriptionParameter typeArgument type
GRP1I_MODIMPTemplateCharSent
GRP1I_AOWSTAImport/export temporary storageCharSent
GRP1I_EXECExecution typeCharSent
GRP1I_RECORDSEPRecord separatorCharSent
GRP1I_FILEFileClbfileSent
GRP1O_REQNUMQueryIntegerReturned
GRP1O_STATUSStatusIntegerReturned
GRP1O_MESSAMessageCharReturned

The parameters sent are:

For example, if you import two lines with a string, a date, and a numeric value, and if the record separator is ā€œ|ā€, the correct clob contents would be: STRING1;20170203;1| STRING2;20160512;33|END

The SOAP parameters returned are:

The values returned are:

Import Examples


Perform an Export

The export web service contains the following arguments:

GroupCodeDescriptionParameter typeDimArgument type
GRP1I_MODEXPTemplateChar1Sent
GRP1I_CHRONOSequence no.Char1Sent
GRP2I_TCRITERECriteriaChar10Sent
GRP3I_EXECExecution typeChar1Sent
GRP3I_RECORDSEPRecord separatorChar1Sent
GRP3O_FILEData fileClbfile1Returned
GRP3O_REQNUMQueryInteger1Returned
GRP3O_STATUSStatusInteger1Returned
GRP3O_MESSAMessageChar1Returned

The parameters sent are:

The SOAP parameters returned are:

The values returned are:

Export examples


Get Information About a Batch Task

After performing an import or export with the BATCH option, the status of the batch server job can be querried with this web service.

More information about batch processing of imports and exports can be found in Batch Processing for Import/Export Templates, as well as our Online help center.

This web service contains the following arguments:

GroupCodeDescriptionParameter typeArgument type
GRP1I_TACHEBatch taskCharSent
GRP1I_REQNUMQueryIntegerSent
GRP1I_GETTRALogCharSent
GRP1O_STAREQStatusIntegerReturned
GRP1O_MESREQMessageCharReturned
GRP1O_FILEFileClbfileReturned
GRP1O_FILETRAFileClbfileReturned
GRP1O_STATUSStatusIntegerReturned
GRP1O_MESSAMessageCharReturned

The parameters sent are:

The SOAP parameters returned are:

The values returned are: