Tags:
create new tag
view all tags

Data Exchange Application

A new application (0DX) is included with 5.3. This application facilitates the exchange of data between Appx and external systems.This documentation is for the 5.3.1 version of the application. If you are using the 5.3.0 version, we recommend upgrading to release 5.3.1 or higher.


Overview:

The 0DX (zero DX) application included in 5.3.1 makes it easier to exchange data with external systems. The initial implementation only imports data in XML format, future plans include an export API, and more input formats.

The application allows the user to define 'maps' that map the external data to Appx files or fields. Once the map is defined, there are 2 steps required to import data:

  • The incoming file must be 'Processed' by the 0DX application. For XML files, this means extracting all tags and data elements and storing them in internal Appx files. More than one file can be processed at once, and the user will see a list of the processed files awaiting import.
  • The 'import' subroutine must be run. This is a subroutine (created by 0DX based on the mapping) that will read the internal files and move the data to the final files and fields based on the user defined mapping.
Alternatively, an external Appx process can read the extracted data & process it without defining a mapping or creating a subroutine.

An API allows a programmer to perform one or both of those steps under ILF control. Mapping the data is optional, the programmer can just use the API to process the file and then read the extracted data directly.

When defining the mapping, the user can enter the tags directly or they can choose to process an actual XML file first, and then refer to the tags found in that XML file in their mapping. This is often easier, as the user will be able to see the actual tags and the data associated with the tag.

Installation

The 0DX application should automatically be added to your Application file during the 5.3 installation. If not, you can manually add it. If you plan to use 0DX with a version other than '00', you will have to manually add those as well. It is not necessary to copy the 0DX design files from version '00' to other versions, the Appx engine will automatically use version 00 in all cases (similar to the Appx report writer SQL).

Next, add 0DX as a related application to any Databases that will use it, and run Create Files for that Database.

If you plan to expose the user interface, define an Optional Child somewhere in your application that invokes application 0DX, process type MENU, with no process name. If you only plan to use the API, you can skip this step.

Your client screen size should be set to 28 x 120 minimum to run 0DX interactively.

Usage

When you run 0DX, you should see the following menu:

odxmenunew.png

Tutorial

The easiest way to understand how to use 0DX is to work through an example. In the DMO application, run the Job called EXPORT PROSPECTS/CONTACTS. On the disposition screen, make sure you choose a form with a page length of zero, otherwise the resulting XML file will not import completely. This will export the Prospect and Contact Data from DMO in a simple XML format and upload it to your desktop as PROSPECT.XML. We will use this file for the tutorial.

The first step is to define our mapping using Mapping Files and Fields.

Once you have created a mapping, you can import the data using the Import Data option.

Reference

Use Define File/Field Map to modify existing mappings. You can use this to create new mappings as well, but you will probably find it easier to use Define File/Field map from Source File

The Transfer Maps option can be used to copy a mapping from one Database to another (ie, from a test to production database). You can also use this to copy an existing mapping to a new name.

The View Raw Data options give you various ways of examining the source file(s) that you have processed.

The Processing options give you various ways of loading data into Appx.

The API allows you to process and optionally import data under ILF control.

Comments:

Read what other users have said about this page or add your own comments.


-- JeanNeron - 2013-09-25

Edit | Attach | Watch | Print version | History: r11 < r10 < r9 < r8 < r7 | Backlinks | Raw View | Raw edit | More topic actions
Topic revision: r11 - 2020-05-12 - JeanNeron
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2021 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback