Basis Ii BIX Guide: Coca-Cola Computer Service G.m.b.H. Vienna, Austria

You might also like

Download as pdf or txt
Download as pdf or txt
You are on page 1of 16

BASIS II

BIX Guide

PTF 53.5

Coca-Cola Computer Service G.m.b.H.


Vienna, Austria

Legal Notices and Disclaimer


This publication could include technical inaccuracies or typographical errors. Information in
this document is subject to change without notice and does not represent a commitment on
the part of Coca-Cola Computer Services G.m.b.H. No part of this manual may be reproduced
or transmitted in any form or by any means, electronic, mechanical, or otherwise, including
photocopying and recording, for any purpose other than the users personal use, without the
prior written permission of Coca-Cola Computer Services G.m.b.H.
These materials are furnished upon the condition that the user assumes all risks and liabilities
arising out of the use of, or the reliance upon this documentation.
Neither The Coca-Cola Company nor Coca-Cola Computer Services G.m.b.H. warrants
suitability or favorable results, NOR SHALL THEY BE LIABLE OR RESPONSIBLE FOR ANY
LOSS, CLAIM, OR DAMAGE, DIRECT OR CONSEQUENTIAL, ARISING OUT OF THE USE
OF, THE POSSESSION OF, OR THE RELIANCE UPON THE INFORMATION CONTAINED
IN THIS PUBLICATION.
This document may contain examples of data used in daily business correspondence and
operations. In these examples, we use names of hypothetical businesses and persons. These
names are fictitious, and any similarity to names of actual businesses or persons is purely
coincidental.
THIS SOFTWARE AND ACCOMPANYING DOCUMENTATION ARE PROPRIETARY TO
THE COCA-COLA COMPANY. THEY ARE VALUABLE TRADE SECRETS AND ARE TO BE
KEPT CONFIDENTIAL AND NOT TO BE USED WITHOUT THE PRIOR WRITTEN
CONSENT OF THE OWNER.
COPYRIGHT 2001, 2002, 2005, 2007. AN UNPUBLISHED WORK BY THE COCA-COLA
COMPANY. ALL RIGHTS RESERVED.
BIX Guide
PTF 53.5

Contents
Chapter 1

BIX: Formatted Business Data for Exchange


with Third-Party Software
Interface Architecture ........................................................................... 1-2
Dynamics of Data Exchange ............................................................... 1-5

Chapter 2

Mapping of BIX Business Objects


Converting between BASIS Data Formats and Foreign System
Data Formats ..................................................................................... 2-2
BIX Mapping Definitions User Interface ............................................... 2-4

BIX Guide

PTF 53.5

iv

PTF 53.5

BIX Guide

CHAPTER

BIX: Formatted Business Data for


Exchange with Third-Party Software

Introduction

This chapter describes BIX (BASIS Information Exchange) format, a


business-oriented, release-independent data format used for exchange
of business information between BASIS and other software.

In this chapter

This chapter contains the following topics.


Topic

See Page

Interface Architecture............................................................................ 1-2


Dynamics of Data Exchange ................................................................ 1-5

BIX Guide

PTF 53.5

1-2

BIX: Formatted Business Data for Exchange with Third-Party Software

Interface Architecture

Purpose of the
architecture

Third-party software (here called "foreign systems") with attractive special


features is available to bottlers who use BASIS as the foundation
software for running their business. Therefore, BASIS provides a
standard interface for data exchange between BASIS and these
programs. This interface maximizes the release independence of data
exchange and standardizes the approach from the BASIS side.

BIX

BIX (BASIS Information Exchange format) is the release-independent


intermediate data format developed to support BASIS interface
architecture. During data exchange, BIX is used in the mapping of BASIS
data to the format required by a foreign system and in the mapping of
foreign system data to BASIS format.

Business
objects

BIX is "business oriented" rather than database record oriented. That is,
a BIX entity is a "business object" data related to a specific business
operation that is shared between BASIS and the foreign system, such as
delivery route creation and dispatching of loads.
When bottlers request an interface between BASIS and a foreign system,
the BASIS BIX development group analyzes the requirements for data
exchange. If a suitable BIX business object does not already exist, a new
one is created. BASIS also provides the system functions for mapping
the contents of business objects between the formats required by BASIS
and the foreign system for data import/export. These system functions
are called "adapters", and they operate on both sides of data exchange
a foreign system adapter and a BASIS adapter.
The advantages of business objects are:
A business object contains only information relevant to data
exchange between BASIS and a foreign system, rather than the
contents of entire BASIS database records. That is, a business object
is a form of data presentation that is customized to the interface
between BASIS and a foreign system.
When one system changes (a new release), relevant business
objects or their contents can be changed (added, deleted,
rearranged).
Because a business object is not represented as database file with a
predefined layout, when business objects change, BASIS does not
have to be recompiled.

PTF 53.5

BIX Guide

BIX: Formatted Business Data for Exchange with Third-Party Software

1-3

Interface Architecture, Continued

Tags

The data in a business object is stored as "tags" data items that may be
directly exported to or imported from a foreign system or first be altered
by a specific mapping program.

Mapping and
mapping sets

It is highly unlikely that all of the data exchanged between BASIS and a
foreign system can be mapped directly between one system and the
other. The BASIS interface architecture provides specific mapping
programs to accomplish this data modification, which is done at tag level.
A mapping set consists of one or more related business objects that are
to be transmitted between systems as part of the same operation.
For example, for data exchange with some foreign systems the BASIS
interface architecture can use the functiongroup feature of the BASIS XQ
Task Scheduler to drive the data exchange, via a shared folder on the
BASIS iSeries. The architecture may include a polling program, called the
import controller, to detect when the third-party system has put data to
send to BASIS into the shared folder.
For other foreign systems, a different approach may be required in
developing the adapters, depending on the mechanism of foreign system
data exchange. The important point is that with BIX the interface
architecture is flexible.

Tag mapping

Tags are arranged by sequence number in a business object. Each has

a BASIS name and a third-party software name


a type, either numeric or alphanumeric
a start position from which it is taken or put into a BASIS field
position and length indicators for where it is put into or taken from
third-party software data
indicators specifying whether it is put to or taken directly from BASIS
or third-party software, or modified by a specified mapping program
These tag attributes (and some others) are usually exposed in the BASIS
user interface for maintaining the relationship between BASIS and foreign
system data. Usually, to some extent, it is possible for you to make
specified changes to tag attributes.

BIX Guide

PTF 53.5

1-4

BIX: Formatted Business Data for Exchange with Third-Party Software

Interface Architecture, Continued

Structure

The diagram below is an overview of how the interface architecture


operates:

BASIS user interface


for BIX mapping and
selection

Transport tool

Foreign system
adapter

Foreign
system
Vendor X
Release X.X

Selection
Mapping
Conversion
Formatting
Validation
Sorting

BIX
BASIS
Information
Exchange
format
System/vendor
independent
Release independent

BASIS adapter
Selection
Mapping
Conversion
Formatting
Validation

BASIS database
files

BASIS Release XX.X

The BASIS interface architecture provides all the features shown in the
diagram that have a light gray background.

PTF 53.5

BIX Guide

BIX: Formatted Business Data for Exchange with Third-Party Software

1-5

Dynamics of Data Exchange

Data exchange
process

The following diagram summarizes the data exchange process for the
interface between BASIS and a foreign system when data exchange is
via a shared folder on the iSeries:
iSeries

Start import functiongroups

Import
controller

Start export functiongroups


BASIS functiongroup task
scheduler

poll

Map import data

Text file in
iSeries
shared folder

BIX

Put data to BASIS

Map export data from BASIS

BX10
Map import data to BASIS
database files

Foreign
system

BX11
Mapping
definitions

BASIS database
files

Map data to export file

Text file in
iSeries
shared folder

Get data from BASIS

BX03
BX04
Business
objects / tags

Other approaches to data exchange are possible, depending on the


requirements of the foreign system server.

Export and
import
functiongroups

In the example shown above, export of data from BASIS can be


scheduled or started manually from the Functiongroup Overview
XQP425/S01 screen of the BASIS task scheduler. The import controller
starts import of data to BASIS automatically when it detects data in the
import text file of the iSeries shared folder.
The BIX development group defines the functiongroups for data
exchange with the foreign system.

BIX Guide

PTF 53.5

1-6

BIX: Formatted Business Data for Exchange with Third-Party Software

PTF 53.5

BIX Guide

CHAPTER

Mapping of BIX Business Objects

Introduction

This chapter describes how BIX data is stored in BASIS and how data
mapping between BASIS and a foreign system is achieved.

In this chapter

This chapter contains the following topics.


Topic

See Page

Converting between BASIS Data Formats and Foreign System


Data Formats...................................................................................... 2-2
BIX Mapping Definitions User Interface................................................ 2-4

BIX Guide

PTF 53.5

2-2

Mapping of BIX Business Objects

Converting between BASIS Data Formats and Foreign


System Data Formats
Introduction

BIX is designed to handle the alterations to data required for data


exchange, including calculation of data values that are required by one
system but not already calculated in the other. BIX can also provide literal
data values and other special values.

BIX files

The following diagram shows how the BIX files are organized and some
of the important fields in their records :
To / from foreign system

Adapter to foreign system

BX10 Mapping
Definition file

Application

Mapping
set name

Business
object
sequence
number

Business
object
identifier

Mapping
direction
indicator

BX11 Mapping
Definition Detail file

Application

Mapping
set name

Business
object
sequence
number

Tag
sequence

Tag name

Mapping
program

BX04 Data file

BASIS
company
code

Interface
batch

Interface
batch
sequence
number

Tag name

Tag value

BX03 Header file

BASIS
company
code

Interface
batch

Interface
batch
sequence
number

Business
object
identifier

BX02 Control file

BASIS
company
code

Interface
batch

Source /
target
system

Processing
status

To / from BASIS company application


database files

PTF 53.5

BIX Guide

Mapping of BIX Business Objects

2-3

Converting between BASIS Data Formats and Foreign


System Data Formats, Continued
The BIX files are all stored in the BASIS company database library. The
BX02 Control file, BX03 Header file, and BX04 Data file contain BIX
business object and tag data, and the BX10 Mapping Definition file and
BX11 Mapping Definition Detail file contain information required to
transmit data between a BASIS application and a foreign system.
In the interface architecture, BX10 and BX11 are considered part of the
foreign system adapter that is, the part of the architecture having to do
with data transformation. It is assumed that such adapters will be
provided by the BIX development group for each foreign system having
an interface with BASIS.

Mapping sets
and mapping
definitions

Each BIX business object belongs to a mapping set, and a mapping set
consists of one or more business objects. More than one instance of a
business object may be specified for a particular mapping set.
Mapping sets are defined in the BX10 Mapping Definition file.

Mapping
programs

Data mapping is accomplished by a specially written mapping program


specified for a BIX tag or group of tags. Included within the list of tags that
make up a business object may be "calculated" tags that is, tags whose
value is calculated by a mapping program.

Business object
sequence

The order in which business objects in a mapping set are processed is


usually important in data exchange. The processing sequence number of
each business object in a mapping set is specified in the BX10 Mapping
Definition file.

Tag sequence

The processing order of tags within a business object is also important.


The tag sequence is specified in the BX11 Mapping Definition Detail file.

BIX Guide

PTF 53.5

2-4

Mapping of BIX Business Objects

BIX Mapping Definitions User Interface

Introduction

Although a large part of data exchange processing is automatic, for most


foreign systems with which a BASIS application interfaces it is assumed
that there will be some degree of flexibility in determining which data is
passed between systems and how it is formatted.
Therefore, for such a BASIS application you will find a mapping
definitions user interface among the BASIS application screens.
This section describes a brief example of a mapping definitions user
interface that for the interface between the BASIS Dispatching
application and the Roadshow application, a dispatching tool that designs
delivery routes based on geocoding.
There are likely to be other aspects of the interface between a BASIS
application and a particular foreign system that require a BASIS user
interface. These are beyond the scope of this document. They will be
described in the application documentation.

Mapping sets

This screen from the Dispatching application lists the mapping sets and
the business objects that compose them. It represents the contents of the
BX10 Mapping Definitions file. You can work with the details of each
business object using View Details action code to open the mapping
definition details screen. Additionally you can copy each business object
using the Copy action code.

MC
BASIS Mapping Def. Overview
Standard Layout
1=Maintain
2=View
5=Exit
6=Help
Select action bar or object with action code, press ENTER
1=View Details
2=Update
3=Copy
5=Display
App.
Set
Bus.
Set name
ver. obj.
..............................
...BI CBIMPORT
00001 00070
...BR RSHCALRTEIMP 00001 00010
...BR RSHCALRTEIMP 00001 00020
...BR RSHDAYORDEXP 00001 00010
...BR RSHDAYORDEXP 00001 00020
...BR RSHDAYORDEXP 00001 00030
...BR RSHDAYORDIMP 00001 00020
...BR RSHDAYORDIMP 00001 00030
...BR RSHDAYORDIMP 00001 00040
...BR RSHDAYORDIMP 00001 00050
...BR RSHDAYORDIMP 00001 00060
F1=Help
ROLL

PTF 53.5

F3=Exit

Bus. object
identifer
BI9007
CUSSGIUPL
CALSGIUPL
ORDHDR
ORDARTDTL
ORDMSG
LODHDR
LODASGVEH
LODASGVEH
LODASGVEH
LODASGPRN

F5=Refresh

Description

52 00 BXP001/S01
01.07.05
4=Delete

Dir

CB TAX SUMMARY RECORD


B
CALL ROUTE IMPORT: CUSTOMER
B
CALL ROUTE IMPORT: CALL INFO
B
ORDER EXPORT:ONLY ORDER HEADER F
ORDER EXPORT:ARTICLE DETAILS
F
ORDER IMPORT: MESSAGES
F
ORDER IMPORT: LOAD HEADER
B
ORDER IMPORT: ASS. VEHICLE #1 B
ORDER IMPORT: ASS. VEHICLE #2 B
ORDER IMPORT: ASS. VEHICLE #3 B
ORDER IMPORT: ASS. PERSONNEL
B
More...
F6=Create
F10=Action
F12=Cancel

BIX Guide

Mapping of BIX Business Objects

2-5

BIX Mapping Definitions User Interface, Continued

Mapping
definition
details

This screen lists mapping definitions details (BX11 Mapping Definitions


Detail record) for the CUSGEN business object in the RSHOUTEXP
mapping set. You can work with the mapping details for a tag in the
business object using the Update action code to open the mapping
definition data screen. Additionally you can copy each tag using the Copy
action code.

MC
BASIS Mapping Def. Detail
1=Maintain
2=View
5=Exit

Standard View 1
6=Help

52 00 BXP001/S02

Select action bar or object with action code, press ENTER


2=Update
3=Copy
4=Delete
5=Display
Application .......: BR
Set name ..........: RSHOUTEXP
Set version number.: 00001
Tag seq
number
..........
...0000001
...0000010
...0000020
...0000030
...0000040
...0000050
...0000070
...0000080

Bus. obj. seq. num.: 00010


Bus. object ident. : CUSGEN

<------Tag-------> <------Foreign system------> MapLit Mapping


Name
Pos I Name
Pos Len I T F D Tvalue function
&&DECSGN
PRCFUN
OUTNUM
CAC
TRDCHN
SUBTRDCHN
**RSHCOD
ADRLIN1

F1=Help
F14=View 2

Implications of
changing
mapping
definition
details

BIX Guide

01.07.05

F3=Exit
ROLL

000
000
000
000
000
000
001
000

L
T
T
T
T
T
M
T

&&DECSGN
PRCFUN
ACCOUNT
**CAC
**TRDCHN
**SUBTRDCHN
RSHCOD
NAME

F5=Refresh

000
001
002
001
002
005
015
016

000
001
013
001
003
003
001
024

F6=Create

E
R
R
M
M
M
R
R

A
A
A
A
A
A
A

0 A.
0
0
0
0
0
0
0

F10=Action

GET RSHCOD
More...
F12=Cancel

When you use the BASIS user interface to make changes to mapping
definition details, it is your responsibility to see that these changes do not
disrupt the integrity of the data exchange process between BASIS and
the foreign system. You will almost certainly have to make matching
changes on both sides of the interface that is, to BIX on the BASIS side
and to foreign system data files.

PTF 53.5

2-6

Mapping of BIX Business Objects

BIX Mapping Definitions User Interface, Continued

Modifying tags

WB
1=View

This screen shows the mapping definition details for the ADRLIN1 tag in
the CUSGEN business object. Using this screen, you can change tag
values.

BASIS
Mapping Definition Data
5=Exit
6=Help

App
BR
SetN. RSHOUTEXP
SetV. 00001
Req
Key
Key
Key
Key
Key
Req

Fld#
005
010
015
020
030
035
045
Req 055
060
065
070
075
080

Type
Text
Text
Number
Number
Number
Text
Number
Text
Text
Text
Text
Number
Number

F1=Help
F12=Cancel

PTF 53.5

Standard layout

04/12/01

BusSq 00010
TagSq 0000080
Lgth
2
12
5
5
7
12
4
1
1
5
12
4
4

F3=Exit
ROLL

Field
APP
SETNAM
SETVRS
BUSOBJSEQ
TAGSEQ
TAG
TAGPOS
TAGVALIND
MAPLTRTYP
MAPLTR
FOSFLDNAM
FOSPOS
FOSLEN

Value
BR
RSHOUTEXP
00001
00010
0000080
ADRLIN1

Code Int.

> T
>

Tag

NAME
0010
0030

F4=Prompt(>) F5=Refresh

02 BXMFM/S04

F7=CheckAll

More...
F10=Action

BIX Guide

You might also like