ISO/IEC 13238-3:1998

Information technology - Data Management - Part 3: IRDS export/import facility

This part of ISO/IEC 13238 enables the bulk transfer of all or part of the data contained in an Information Resource Dictionary (IRD) or in an Information Resource Dictionary Definition conforming to ISO/IEC 10728:1993 IRDS Services Interface. This part of ISO/IEC 13238 defines a format for such a transfer and also services to generate the export file and services to import the file. These services are additional to the existing services defined in the IRDS Services Interface. This version of this part of ISO/IEC 13238 defines a limited set of Export and Import services. It is expected that implementations will also provide more sophisticated services based on the use of the Transfer File structure defined in this part of ISO/IEC 13238. The physical way in which the transfer takes place is outside the scope of this part of ISO/IEC 13238. Each transfer may be effected in one of several ways including the physical transfer of the data using a transportable storage device.

Technologies de l'information — Gestion de données — Partie 3: Aide export/import IRDS

General Information

• Status: Published
• Publication Date: 19-Dec-1998
• ICS: 35.240.01 - Application of information technology in general
• Technical Committee: ISO/IEC JTC 1/SC 32 - Data management and interchange
• Drafting Committee: ISO/IEC JTC 1/SC 32 - Data management and interchange
• Current Stage: 9093 - International Standard confirmed
• Start Date: 30-Apr-2021
• Completion Date: 30-Oct-2025

Overview

ISO/IEC 13238-3:1998 - "Information technology - Data Management - Part 3: IRDS export/import facility" defines a standard method for bulk transfer of metadata and dictionary content between Information Resource Dictionary Systems (IRDS). It specifies the IRDS Transfer File format and a set of export/import services (additional to the IRDS Services Interface) that generate, read and apply Transfer Files. The standard mandates character set and coding (ISO/IEC 10646 Basic Multilingual Plane and UCS‑2), describes the Transfer File header, optional IRD Definition and IRD Content components, and defines import control tables and working‑set semantics. The physical transport medium (network, removable media, etc.) is explicitly out of scope.

Key topics and technical requirements

• Transfer File structure
  • Three components: Transfer File Header (mandatory), Transfer File IRD Definition (optional), Transfer File IRD Content (optional, but at least one of the latter two must be present).
  • One component per IRD working set; supports multiple components per file.
• Character set and coding
  • Characters must come from the Basic Multilingual Plane (BMP) of ISO/IEC 10646.
  • Encoding required: UCS‑2 (no file-level translation permitted).
• Export/import services
  • Services include: open export file, select rows for export, clear selection, export working set, close export file; and open import file, retrieve working set details, import working set, import complete file, close import file.
• Working sets and selections
  • Export operations act on IRD or IRD Definition working sets and can include full context or referenced working sets.
  • Exported rows include required IRD Object and IRD Object Version rows plus IRD_REFERENCE_PATH rows for foreign key paths.
• Import control tables
  • Tables defined to assist matching imported objects with existing IRD entries.
• Conformance
  • The standard specifies file format conformance and combined file+services conformance.

Applications and who uses it

• Helps organizations perform metadata migration, dictionary exchange, repository synchronization, and system integration where IRDS is used.
• Primary users:
  • IRDS implementers and vendors building export/import facilities.
  • Database and data architects, metadata managers, and system integrators performing bulk metadata transfer or repository consolidation.
  • Tool developers that need a standard Transfer File format and services for IRD export/import.
• Typical use cases: cross‑system deployment of IRD Definitions, moving IRD content between environments, baseline distribution of metadata schemas.

Related standards

• ISO/IEC 10728 - IRDS Services Interface (service model referenced)
• ISO/IEC 10027 - IRDS Framework
• ISO/IEC 10646-1 - Universal Multiple-Octet Coded Character Set (BMP)
• ISO/IEC 9075 - SQL (BNF and syntax references)
• ISO/IEC 6429 - Control functions for coded character sets
• ISO/IEC 13238 Parts 1 and 2 - Export/import framework and SQL import/export

Keywords: ISO/IEC 13238-3, IRDS export/import facility, IRDS Transfer File, IRD Definition, UCS-2, BMP, metadata transfer, data dictionary exchange.

Standards Content (Sample)

INTERNATIONAL ISO/IEC
STANDARD 13238-3
First edition
1998-12-15
Information technology — Data
Management —
Part 3:
IRDS export/import facility
Technologies de l'information — Gestion de données —
Partie 3: Aide export/import IRDS
Reference number
B C
Contents
Page
FOREWORD V
INTRODUCTION VI
1. SCOPE 1
2. NORMATIVE REFERENCES 1
3. DEFINITIONS 2
3.1 Terms from ISO/IEC 10027 IRDS Framework 2
3.2 Terms from ISO/IEC 10646-1 Universal Multiple-Octet Coded Character Set (UCS) 2
3.3 Terms from ISO/IEC 10728 IRDS Services Interface 2
3.4 Additional definitions 2
4. ABBREVIATIONS 3
5. CONVENTIONS 4
5.1 Definition of Data in the Transfer File 4
5.2 Definition of Services 4
6. CONCEPTS AND FACILITIES 4
6.1 Overview 4
6.2 Transfer File 4
6.3 Export/import services 6
6.4 Working Sets 6
6.5 Import Control Tables 7
6.6 Content Modules 7
©  ISO/IEC 1998
All rights reserved. Unless otherwise specified, no part of this publication may be reproduced or
utilized in any form or by any means, electronic or mechanical, including photocopying and micro-
film, without permission in writing from the publisher.
ISO/IEC Copyright Office • Case postale 56 • CH-1211 Genève 20 • Switzerland
Printed in Switzerland
ii
© ISO/IEC ISO/IEC 13238-3:1998(E)
7. SPECIFICATION OF THE TRANSFER FILE 7
7.1 Character Set 7
7.2 Character Coding 7
7.3 Tokens 7
7.4 White Space 9
7.5 IRDS Transfer File Structure 10
7.6 Transfer File Header 11
7.7 Transfer File IRD definition 13
7.8 Transfer File IRD content 16
7.9 Transfer File Table Transfer Syntax 17
8. SPECIFICATION OF THE IMPORT CONTROL TABLES 20
8.1 Table IRDS Dictionary Import Control 20
8.2 Table IRD Object Import Control 20
8.3 Table IRD Working Set Import Control 21
9. SPECIFICATION OF THE EXPORT/IMPORT SERVICES 23
9.1 Relationship to the IRDS Services Interface 23
9.2 Services provided 23
9.3 Selection of data to be exported 23
9.4 Service Data Types and Data Structures 24
9.5 Open IRDS Export File 25
9.6 Select For Export Service 27
9.7 Clear Export Selection Service 29
9.8 Export Working Set 30
9.9 Close IRDS Export File 33
9.10 Open IRDS Import File 34
9.11 Retrieve Import File Working Set Details 36
9.12 Import Working Set 37
9.13 Import Complete File 41
iii
9.14 Close IRDS Import File 43
10. CONFORMANCE 44
10.1 File Format Conformance 44
10.2 File Format and Services Conformance 44
Annexes
A. State Classes and Subclasses 45
B. Business Requirement 50
C. Example Use Of the BNF syntax for transferring columns 51
D. Sample Transfer File Format 53
E. Informative illustrations of the file structure 143
iv
© ISO/IEC ISO/IEC 13238-3:1998(E)
Foreword
ISO (the International Organization for Standardization) and IEC (the International
Electrotechnical Commission) form the specialized system for worldwide standardization.
National bodies that are members of ISO or IEC participate in the development of
International Standards through technical committees established by the respective
organization to deal with particular fields of technical activity. ISO and IEC technical
committees collaborate in fields of mutual interest. Other international organizations,
governmental and non-governmental, in liaison with ISO and IEC, also take part in the work.
In the field of information technology, ISO and IEC have established a joint technical
committee, ISO/IEC JTC 1. Draft International Standards adopted by the joint technical
committee are circulated to national bodies for voting. Publication as an International
Standard requires approval by at least 75 % of the national bodies casting a vote.
International Standard ISO/IEC 13238-3 was prepared by Joint Technical Committee
ISO/IEC JTC 1, Information technology, Subcommittee SC 32, Data management services.
ISO/IEC 13238 consists of the following parts, under the general title Information
technology — Data Management :
— Part 1: Export/import framework
— Part 2: SQL import/export
— Part 3: IRDS export/import facility
Annex A forms an integral part of this part of ISO/IEC 13238. Annexes B to E are for
information only.
v
Introduction
ISO/IEC 13238 is a three part standard. Part 1 defines an overall framework for
Export/Import facilities.
Part 2 defines facilities for export from and import to SQL databases that conform to ISO/IEC
9075.
This part, Part 3, defines facilities for export from and import to an IRD and or an IRD
Definition that conform to ISO/IEC 10728.
vi
©
INTERNATIONAL STANDARD  ISO/IEC ISO/IEC 13238-3:1998(E)
Information technology — Data Management —
Part 3:
IRDS export/import facility
1. Scope
This part of ISO/IEC 13238 enables the bulk transfer of all or part of the data contained in an
Information Resource Dictionary (IRD) or in an Information Resource Dictionary Definition
conforming to ISO/IEC 10728:1993 IRDS Services Interface.
This part of ISO/IEC 13238 defines a format for such a transfer and also services to generate
the export file and services to import the file. These services are additional to the existing
services defined in the IRDS Services Interface.
This version of this part of ISO/IEC 13238 defines a limited set of Export and Import
services. It is expected that implementations will also provide more sophisticated services
based on the use of the Transfer File structure defined in this part of ISO/IEC 13238.
The physical way in which the transfer takes place is outside the scope of this part of
ISO/IEC 13238. Each transfer may be effected in one of several ways including the physical
transfer of the data using a transportable storage device.
2. Normative references
The following standards contain provisions which, through reference in this text, constitute
provisions of this part of ISO/IEC 13238. At the time of publication, the editions indicated
were valid. All standards are subject to revision, and parties to agreements based on this part
of ISO/IEC 13238 are encouraged to investigate the possibility of applying the most recent
editions of the standards indicated below. Members of IEC and ISO maintain registers of
currently valid International Standards.
ISO/IEC 6429:1992, Information technology - Control functions for coded character sets.
ISO/IEC 9075:1992, Information technology - Database languages - SQL.
ISO/IEC 10027: 1990, Information technology - Information Resource Dictionary System
(IRDS) framework.
ISO/IEC 10646-1:1993, Information technology - Universal Multiple-Octet Coded Character
Set (UCS) - Part 1: Architecture and Basic Multilingual Plane.
ISO/IEC 10728: 1993, Information technology - Information Resource Dictionary System
(IRDS) Services Interface.
ISO/IEC 13238-1:— , Information technology - Data Management - Part 1: Export/import
framework.
To be published.
3. Definitions
For the purposes of this part of ISO/IEC 13238, the following definitions apply.
3.1 Terms from ISO/IEC 10027 IRDS Framework
3.1.1 Application level
3.1.2 IRD
3.1.3 IRD definition level
3.1.4 IRD definition schema level
3.1.5 IRD level
3.1.6 IRD schema
3.1.7 IRDS
3.2 Terms from ISO/IEC 10646-1 Universal Multiple-Octet Coded
Character Set (UCS)
3.2.1 Basic Multilingual Plane (BMP)
3.2.2 Character
3.3 Terms from ISO/IEC 10728 IRDS Services Interface
3.3.1 IRD Object
3.3.2 Name
3.3.3 Object
3.3.4 Object Version
3.3.5 Variation Name
3.4 Additional definitions
3.4.1 Clear text file encoding. A class of techniques for representing data based on first
defining a human readable representation using some specific character repertoire and
then defining an encoding for that repertoire.
3.4.2 Export IRD
. The export of data from an origin or source IRDS into a Transfer File.
3.4.3 Export process. The process of generating a Transfer File from a source
environment.
3.4.4 Exporter. The agent of the export process.
© ISO/IEC ISO/IEC 13238-3:1998(E)
3.4.5 Import IRD. The import of data to a destination or target IRDS from an Transfer
File.
3.4.6 Import process. The process of incorporating the content of a Transfer File into a
target environment.
3.4.7 Importer. The agent of the import process.
3.4.8 IRDS-data. A collection of data comprising the content of all or part of an IRD
Definition and/or an IRD. This is a generic term used for convenience to describe the
content of a Transfer File.
3.4.9 IRDS Transfer File. A Transfer File containing data which defines and describes the
content of an IRD or a subset of an IRD. It is made up of three components: Transfer
File Header component, Transfer File IRD Definition component, and Transfer File
IRD Content component.
3.4.10 Transfer file. A file containing data to be interchanged. It is made up of a header,
and a number of components. Components contain either data, or data definition data.
3.4.11 Transfer File Header. The first component of a Transfer File. This component
contains data that uniquely defines the Transfer File. It contains details of the export
IRD identification and time stamp.
3.4.12 Transfer File IRD Definition. The second (and optional) component of a Transfer
File. This component contains the IRD definition that defines the following IRD
content.
3.4.13 Transfer File IRD Content. The third (and optional) component of a Transfer File.
This component contains the IRD content to be interchanged.
4. Abbreviations
Abbreviations used in this part of ISO/IEC 13238 are:
a) BMP Basic Multilingual Plane ;
b) BNF Bachus Naur Form;
c) IRDS Information Resource Dictionary System;
d) IRD Information Resource Dictionary;
e) TF Transfer File;
f) UTC Co-ordinated Universal Time.
5. Conventions
5.1 Definition of Data in the Transfer File
An extended Bachus Naur Form (BNF) is used to describe the sequence of data in the
Transfer File. The form of BNF used is that defined in ISO/IEC 9075, 3.2.
The names of the syntax units start with a lower case alphabetic character and intermediate
characters are capitalised when they start a word.
5.2 Definition of Services
The conventions used to define services in clause 8 are those used in ISO/IEC 10728:1993
and where operations on the abstract data structure are defined, they are in terms of the data
structure defined in Clause 6 of ISO/IEC 10728.
6. Concepts and facilities
6.1 Overview
This clause describes the Transfer File format and the services which are used to export and
import IRDS data.
The services specified provide for the creation of an operating system file of characters of a
specified encoding and in a defined sequence and its subsequent use in the same or a different
real system. The physical transfer of an Transfer File from one real system to another may
take place by any appropriate means.
The character encoding to be used is specified by this International Standard and hence no
translation of the Transfer File is required or permitted when the file is transferred from one
real system to another.
6.2 Transfer File
6.2.1 Structure
An IRDS Transfer File may contain an IRD Definition (which contains information which
defines the content of an IRD) or a subset of an IRD Definition and/or an IRD or a subset of
an IRD. For ease of reference each of these combinations is referred to in this part of this
International Standard as IRDS-data.
An IRDS Transfer File is made up of three components as follows:
a) Transfer File Header;
b) Transfer File IRD Definition;
c) Transfer File IRD Content.
© ISO/IEC ISO/IEC 13238-3:1998(E)
The Transfer File header is a mandatory component. Both the Transfer File IRD Definition
data and the Transfer File IRD Content are optional. However, one of the two must be
present. The presence or absence of each is indicated in the Transfer File Header.
There may be many Transfer File IRD Definition Data components and/or Transfer File IRD
Content components. This standard requires one component per IRD Working Set.
The reason for the optionality of the IRD Definition Data component is to allow it to be
omitted in situations where data conforming to the same IRD Definition is being transferred
frequently between the same exporter and importer.
Optionality of the IRD Content component allows an IRD Definition to be exported without
any conforming IRD Content. This facility may be used prior to a set of Transfer Files being
created using the same IRD Definition, but containing different IRD Content.
The IRD Definition Data and the IRD Content are each composed of a number of sets of
rows. Each set of rows represents selected data from a single working set.
All IRD Definition and IRD level tables can be exported. In the data for a working set, all the
IRD Object and IRD Object Version rows are included that are referenced by any other rows
selected from the working set.
In the data for a working set, rows from the IRD_REFERENCE_PATH table are included to
describe all of the reference paths used by foreign keys in the rows selected from the working
set.
6.2.2 Transfer File Header
The Transfer File header contains information about the Transfer File, such as date time of
file creation and information about the source of the file such as the person responsible for
creation. Further user defined information may be added.
6.2.3 Transfer File IRD Definition
The Transfer File IRD Definition data consists of the definition of IRD Content which may
then be exported as other components of a Transfer File IRD Content in the same or
subsequent Transfer Files.
A Transfer File IRD Definition is for a set of IRD tables that a user of an IRDS-
implementation has created and that a user wishing to export IRDS-data has selected.
Each IRD Definition has a name conforming to the rules for names in ISO/IEC 10728. This
name is assigned by the exporter of the Transfer File in which the IRD Definition is used.
6.2.4 Transfer File IRD Content component
This component is the IRD Content. The Transfer File IRD Content shall conform (in the
IRDS sense) to an IRD Definition which is named in the Transfer File header. The IRD
Definition may or may not be present in the same Transfer File.
6.3 Export/import services
6.3.1 Export services
There are the following export services:
a) Open a Transfer File for export;
b) Select the rows to be exported from specified tables; this service may be invoked
many times, to select multiple tables and/or multiple sets of rows from a single
table;
c) Clear a previous selection;
d) Export the contents of a Working Set; this service may be invoked many times,
to export both IRD Definition and IRD level working sets;
e) to close the export file and make it available to other users.
The Open Export File Service generates the Transfer File header component.
The Export Working Set Service converts a working set in an IRD Definition or an IRD into
the format defined for the Transfer File.
6.3.2 Import services
There are the following import services:
a) Open a Transfer File for import;
b) Import Working Set;
c) Close IRDS Import File.
Successful invocation of an Import Working Set service applied to an IRD Definition
Working Set contained in the Transfer File, creates appropriate rows in the IRD Definition
tables in the importing IRDS implementation.
Successful invocation of an Import Working Set service applied to an IRD Working Set
contained in the Transfer File, creates appropriate rows in the IRD tables in the importing
IRDS implementation.
If the Transfer File contains an IRD Working Set and the Transfer File IRD Definition
component is not included, the import service makes use of the name of the IRD Definition
given in the Transfer File header component to locate the named IRD Definition in the
importing IRDS-implementation.
6.4 Working Sets
Each invocation of the export service generates rows from the single working set that
represents the current or specified context. If Full Context is specified, additional rows may
© ISO/IEC ISO/IEC 13238-3:1998(E)
be exported from referenced working sets, depending on the selection criteria. The tables
from which rows are to be extracted can be selected using the IRDSSelectForExport service.
6.5 Import Control Tables
Tables are defined in clause 8 which can be populated by the IRDS User and by the import
services to assist the process of matching objects in an import file with objects already stored
in the IRD or IRD Definition.
6.6 Content Modules
Those rows that represent objects contained within one or more IRDS Content Modules may
be selected by using the IRDSSelectForExport service and specifying the tables required and
a WHERE clause that includes appropriate references to IRD_MODULE_OBJ_KEY and
IRD_MODULE_WS_KEY defined in ISO/IEC 10728, 6.1.4.1 Table IRD Object.
7. Specification of the Transfer File
7.1 Character Set
An IRDS Transfer File shall consist of a string of the characters from the Basic Multilingual
Plane (BMP) of ISO/IEC 10646-1.
The file header (syntax element defined in 7.6.2 below) shall contain only
characters from Table 1 of ISO/IEC 10646-1.
7.2 Character Coding
Characters in a Transfer File shall be coded using the UCS-2 coding of ISO/IEC 10646.
7.3 Tokens
7.3.1 Terminal Tokens
The characters defined in ISO 9075, 5.1 and indirectly referenced below by reference to
clauses in ISO/IEC 9075 are defined to be the respective characters defined in ISO/IEC
10646-1 Table 1.
The following terminal BNF tokens are used in the definition of the Transfer File:
::= Defined as the character at row 0
column 002 in ISO/IEC 10646-1.
::= Defined as the character at row D
column 000 in ISO/IEC 10646-1.
Note: This conforms to ISO/IEC 6429:1992, 8.3.15.
::= Defined as the character at row 1
column 002 in ISO/IEC 10646-1.
::= Defined as the character at row A
column 000 in ISO/IEC 10646-1.
Note: This conforms to ISO/IEC 6429:1992, 8.3.75.
::= Defined as the character at row 9
column 000 in ISO/IEC 10646-1.
Note: This conforms to ISO/IEC 6429:1992, 8.3.61.
::=  " Defined as the character at row 2
column 002 in ISO/IEC 10646-1 and
referenced in ISO/IEC 9075, 5.3.
::= any character defined in the
basic multilingual plane of ISO/IEC
10646-1 except  as
defined above and as defined
below.
::= as defined in ISO/IEC 9075, 5.4.
::= } Defined as row D column 007 in
ISO/IEC 10646-1 and referenced in
ISO/IEC 9075, 5.4.
::=  { Defined as row B column 007 in
ISO/IEC 10646-1 and referenced in
ISO/IEC 9075, 5.4.
::= - Defined as row D column 002 in
ISO/IEC 10646-1 and referenced in
ISO/IEC 9075, 5.1.
::= as defined in ISO/IEC 9075, 8.12.
::= as defined in ISO/IEC 9075, 5.4.
 ::= as defined in ISO/IEC 9075, 5.4.
::= as defined in ISO/IEC 9075, 5.3.
::= as defined in ISO/IEC 9075, 5.3.
7.3.2 Commonly used tokens
The following BNF tokens are used in a number of places in the definition of the file
structure:
::=  |
::= 
© ISO/IEC ISO/IEC 13238-3:1998(E)
 ::=
{ } .

::=
|
|

::=
|

 ::=
 ::=
{ } .

::= { | | | } .
::= 
::= 
::=
  
7.4 White Space
The syntactic token  defines characters that are potentially white space.
Where such characters fall inside < character string literal > as defined above, they are part of
the literal. Where such characters fall outside such character string literals they are termed
“white space” and are ignored except in so far as they act to separate one token from another.
Rules for including s in the export/import file are as follows:
1. If two tokens in the BNF definition ARE NOT separated by a space , then s
ARE NOT PERMITTED in the generated result. E.g. .
2. If two tokens in the BNF definition ARE separated by a space, then s ARE
PERMITTED in the generated result.
3. Where the BNF definition includes a constant value (e.g. TABLE_NAME), a
is REQUIRED after this value, even though this is not explicitly shown in the BNF
definition.
4. If a is REQUIRED between two tokens, this is explicitly shown in the syntax
definition.
7.5 IRDS Transfer File Structure
7.5.1 Content
The IRDS Transfer File contains IRDS-data. It is made up of three components as:
(1) Transfer File Header;
(2) Transfer File IRD definition; and
(3) Transfer File IRD content.
The Transfer File Header is the first component of a Transfer File and it contains
information that uniquely defines the Transfer File such as the export IRD identification and
time stamp. The Transfer File IRD definition components are the next optional
components of the Transfer File and they contain the IRD definition that defines IRD content
that may or may not be included in the same Transfer File. The Transfer File IRD content
components are the last optional components of the Transfer File and contain the IRD objects
that were defined by a previous (in this file or another) Transfer File IRD definition.
7.5.2 Definition
Figure 1 defines the syntax of an .
 ::=
[ , ] .
::=
|
Figure 1: File Syntax
7.5.3 General Rules
1. and at least one must be present.
2. When both components and components are
present, the components shall precede all
components.
© ISO/IEC ISO/IEC 13238-3:1998(E)
7.6 Transfer File Header
7.6.1 Content
The Transfer File Header identifies the file as an IRDS Transfer File and is mandatory. The
Transfer File Header contains the following groups of properties:
a) Transfer File Attributes;
b) Transfer Source Attributes;
c) Transfer User Parameters.
7.6.2 Definition
Figure 2 defines the syntax of a .
::=


[]

::=

,
TITLE ,
SYNTAX ,
ENCODING ,
TAGS ,
CODESET ,
TIMESTAMP

::= DMEI-IRDS
::= "ISO/IEC 13238-3:1998 IRDS TRANSFER FILE"
::= BNF
::= CLEAR
::=FULL | SHORT | NUMBER | UNLABELLED
::= "ISO/IEC 10646-1 level 1 UCS-2"
::=
::=

SOURCE_NAME ,
SOURCE_SYSTEM_NAME
[, SOURCE_FILE_VERSION ]
[, SOURCE_ENVIRONMENT ]
[, SOURCE_PROGRAM_NAME ]
[, SOURCE_PROGRAM_VERSION ]
[,SOURCE_PROGRAM_VENDOR ]

::= < character string literal>
::= < character string literal>
::=
::=
::=
::=
::=
::=
, USER_PARAMETERS < character string literal>
Figure 2: Header Syntax
7.6.3 General Rules
1. The identifiers shall consist of:
a) “ISO/IEC 13238-3:1998 IRDS Transfer File” as a constant.
b) : always BNF. This is the only syntax supported by this International
Standard. The field is included to allow for further syntax forms to be prescribed
in future versions of this standard or of other standards with a similar file
structure.
c) : always CLEAR. This is the only token encoding supported by this
International Standard. The field in included to allow for further token encoding
forms to be prescribed in future versions of this standard or of other standards
with a similar file structure.
d) "ISO/IEC 10646-1 level 1 UCS-2".
Note: ISO/IEC 10646-1 defines a number of conformance levels, of which level 1 is prescribed
for an IRDS Transfer File. ISO/IEC 10646-1 defines a number of forms of a coded character set,
of which UCS-2 is prescribed for an IRDS Transfer File.
e) One of FULL, SHORT, NUMBER OR UNLABELLED
© ISO/IEC ISO/IEC 13238-3:1998(E)
constants. FULL means that the actual column names are used. SHORT means
that the first three characters of each word in the column name, excluding the
“IRD” prefix are used as column identifiers. NUMBER means that the column
position is used as the tag. UNLABELLED means that the column values are not
identified, and are placed in the file in the order of their definition.
f) provides the date and time that the file was created in the format
of an SQL expressed as UTC.
2. The other parameters are implementation or user defined:
a) is used to identify the person or group responsible for the
preparation of the Transfer File. It is supplied on the IrdsOpenExportFile call.
b) : is a globally unique identifier assigned to the
publisher's system, such as an OSI Directory name, a DNS name, or an IP
Address.  It is supplied on the IrdsOpenExportFile call.
c) : is a version number assigned to the file by its publisher.  It
is supplied on the IrdsOpenExportFile call.
d) identifies the hardware/system software platform of the
tool used by the publisher.
e) is a unique identifier for the exporting tool or product.
f) enables the exporter name to be qualified with a version
identifier.
g) identifies the provider of the tool used by the publisher.
3. , the user parameters, are optional. If required they are supplied on
the IrdsOpenExportFile call.
7.7 Transfer File IRD definition
7.7.1 Content
The IRD Definition component serves to define the data that may follow in the IRD Content
component of the same or a subsequent Transfer File. The IRD Definition component is
made of the following parts:
a) a component header part;
b) a component content part.
The component content part contains tables.
7.7.2 Definition
Figure 3 defines the syntax of a .
::=

,
[, ] .

::=
COMPONENT_TYPE ,
COMPONENT_TITLE ,
COMPONENT_NAME
::= DMEI-IRDS-DEFINITION
::= "ISO/IEC 10728:1993 IRDS SERVICES INTERFACE IRD
DEFINITION"
Note: A later version of the International Standard may be referenced.
::= .
::=

,
[, ] .

Figure 3: IRD Definition Export Syntax
7.7.3 General Rules
1. The contains data extracted from a single working set. If
more than one working set needs to be exported, then multiple
components are used.
2. Any Time or Timestamp data types within the exported data shall be expressed in
UTC.
3. All data are exported from the abstract data structures defined in Chapter 6 of
ISO/IEC 10728 IRDS Services Interface and are not reproduced in this International
Standard. While any table may be exported, the most relevant tables are IRD specific
as listed in the services interface subclause 5.3. The list in the following table is
provided as an example for reference only by naming tables 8 through 24 as a typical
requirement. The export user may select any set of IRD tables that are considered to
be relevant.
© ISO/IEC ISO/IEC 13238-3:1998(E)
# Code Table Name
08 SGR IRD_SCHEMA_GROUP
09 SCH IRD_SCHEMA
10 SRE IRD_SCHEMA_REFERENCE
11 DTD IRD_DATA_TYPE_DESCRIPTOR
12 DOM IRD_DOMAIN
13 TAB IRD_TABLE
14 VIE IRD_VIEW
15 COL IRD_COLUMN
16 VTU IRD_VIEW_TABLE_USAGE
17 VCU IRD_VIEW_COLUMN_USAGE
18 TCO IRD_TABLE_CONSTRAINT
19 KCU IRD_KEY_COLUMN_USAGE
20 RCO IRD_REF_CONSTRAINT
21 CCO IRD_CHECK_CONSTRAINT
22 CTU IRD_CHECK_TABLE_USAGE
23 CCU IRD_CHECK_COLUMN_USAGE
24 ASS IRD_ASSERTION
Figure 4: IRD Tables
7.8 Transfer File IRD content
7.8.1 Content
The dictionary contents are held in the third component as the Transfer File data. IRD
content to be exported will be in the context of a current user session.
The IRD content component is made of the following parts:
a) a component header part;
b) a component content part.
The component content part contains tables.
7.8.2 Definition
Figure 5 defines the syntax of a .
::=

,
[, ] .

::=
COMPONENT_TYPE ,
COMPONENT_TITLE ,
COMPONENT_NAME ,
COMPONENT_DEFINITION_NAME ,
COMPONENT_SCHEMA_GROUP_NAME

:= DMEI-IRDS-CONTENT
::=
" ISO/IEC 10728:1993 IRDS SERVICES INTERFACE IRD CONTENT"
Note: A later version of the International Standard may be referenced.
::=
::= .
::=
 ::=

,
[, ] .

Figure 5: IRD Content Syntax
© ISO/IEC ISO/IEC 13238-3:1998(E)
7.8.3 General Rules
1. The contains data extracted from a single working set. If
more than one working set needs to be exported, then multiple
components are used.
2. Any Time or Timestamp data types within the exported data shall be expressed in
UTC.
7.9 Transfer File Table Transfer Syntax
7.9.1 Content
IRD definition and dictionary content are transferred using the same tabular structure,
referred to as
The Table Transfer Structure is made of the following parts:
a) a table header part;
b) a table rows part.
The table rows part contains column values for each row.
7.9.2 Definition
Figure 6 defines the syntax of a .
::=

,
  [, ] .

::=
TABLE_NAME
[, TAGS ]
::= "

"
::= FULL | SHORT | NUMBER | UNLABELLED
::=

 [, ] .

::= [ ] 
 ::=  |  |
::= 
::=
 ::=
::=
::=

TABLE_NAME IRD_WORKING_SET,
[, TAGS ]

!! for a row from the IRD Working Set Table

Figure 6: Table Transfer Syntax
7.9.3 General Rules
1. If the value of a column in a row is null, then no instance of is to be
written to the file.
2. shall be one of FULL, SHORT, NUMBER or UNLABELLED
constants. FULL means that the actual column names are used. SHORT means that
the first three characters of each word in the column name, excluding the "IRD" prefix
are used as column identifiers. NUMBER means that the column position is used as
the tag. UNLABELLED means that the column values are not identified, and are
placed in the file in the order of their definition.
3. If = FULL then
::= 
 ::= 
4. If = SHORT then
::= 
 ::=

© ISO/IEC ISO/IEC 13238-3:1998(E)
5. If = NUMBER then
::=
 ::=
6. If = UNLABELLED then
::=
7. If is omitted in , the value from is
used. If is present in , its value overrides, for
this table, the value specified in .
8. Specification of the Import Control Tables
The tables specified in this clause are an extension of the IRD Definition specified in
ISO/IEC 10728.
8.1 Table IRDS Dictionary Import Control
8.1.1 Function
This table has one row for each external Dictionary for which Import Control data is to be
maintained. The rows in the table are created by the IrdsImportWorkingSet service, based on
information in the , and/or they may be maintained by an IRDS User to control
future imports.
8.1.2 Definition
CREATE TABLE IRDS_DICTIONARY_IMPORT_CONTROL
(
IRDS_EXT_DICT_OBJ_KEY IRDS_KEY NOT NULL,
IRDS_EXT_DICT_WS_KEY IRDS_KEY NOT NULL,
PRIMARY KEY (IRDS_EXT_DICT_OBJ_KEY, IRDS_EXT_DICT_WS_KEY),
IRDS_EXT_SYSTEM_NAME CHAR(255) NOT NULL,
IRDS_EXT_DICT_NAME CHAR(255) NOT NULL,
UNIQUE (IRDS_EXT_SYSTEM_NAME, IRDS_EXT_DICT_NAME)
)
8.1.3 Description
1. IRDS_EXT_DICT_OBJ_KEY and IRDS_EXT_DICT_WS_KEY together form the
primary key of the IRD Dictionary Import Control Table.
2. IRDS_EXT_DICT_NAME identifies the Dictionary within the system named
IRDS_EXT_SYSTEM_NAME, from which a Transfer File was created, whose data
is to be imported to the local IRDS.
3. IRDS_EXT_SYSTEM_NAME and IRDS_EXT_DICT_NAME uniquely identify the
Dictionary.
4. The size of IRDS_EXT_SYSTEM_NAME and of IRDS_EXT_DICT_NAME is not
constrained by the local implementation limit on IRDS Names, because the exporting
system may have different values.
8.2 Table IRD Object Import Control
8.2.1 Function
This table has one row for each IRD Object to be mapped from an external dictionary to a
local dictionary. The rows in the table are created by the IrdsImportWorkingSet service,
© ISO/IEC ISO/IEC 13238-3:1998(E)
based on the results of object matching, and/or they may be maintained by an IRDS User to
control future imports.
8.2.2 Definition
CREATE TABLE IRD_OBJECT_IMPORT_CONTROL
(
IRDS_EXT_DICT_OBJ_KEY IRDS_KEY NOT NULL,
IRDS_EXT_DICT_WS_KEY IRDS_KEY NOT NULL,
IRD_IMP_CONT_OBJ_KEY IRDS_KEY NOT NULL,
PRIMARY KEY (IRDS_EXT_DICT_OBJ_KEY, IRDS_EXT_DICT_WS_KEY,
IRDS_IMP_CONT_OBJ_KEY),
CONSTRAINT IMPORTED_OBJECT_COMES_FROM_EXTERNAL_DICTIONARY
FOREIGN KEY (IRDS_EXT_DICT_OBJ_KEY, IRDS_EXT_DICT_WS_KEY)
REFERENCES IRDS_DICTIONARY_IMPORT_CONTROL
ON DELETE CASCADE,
IRD_OBJECT_KEY IRDS_KEY,
CONSTRAINT IMPORTED_OBJECT_MAPS_TO_IRD_OBJECT
FOREIGN KEY (IRD_OBJECT_KEY)
REFERENCES IRD_OBJECT
ON DELETE CASCADE
)
8.2.3 Description
1. IRDS_EXT_DICT_OBJ_KEY, IRDS_EXT_DICT_WS_KEY and
IRDS_IMP_CONT_OBJ_KEY together form the primary key of the Ird Object
Import Control table.
2. IRDS_IMP_CONT_OBJ_KEY is the key of an object in the Transfer File that is to be
mapped to an object in the local IRDS.
3. IRD_OBJECT_KEY is the key of an object (a row in IRD_OBJECT table) in the
local IRDS to which the object in the Transfer File is mapped.
8.3 Table IRD Working Set Import Control
8.3.1 Function
This table has one row for each IRD Working Set that has been imported from an E/I file to a
local working set. The rows in the table are created by the IrdsImportWorkingSet service,
based on the parameters provided to the service, and/or they may be maintained by an IRDS
User to control future imports.
8.3.2 Definition
CREATE TABLE IRD_WORKING_SET_IMPORT_CONTROL
(
IRDS_EXT_DICT_OBJ_KEY IRDS_KEY NOT NULL,
IRDS_EXT_DICT_WS_KEY IRDS_KEY NOT NULL,
IRD_IMP_CONT_WS_KEY IRDS_KEY NOT NULL,
IRD_WORKING_SET_KEY IRDS_KEY NOT NULL,
PRIMARY KEY (IRDS_EXT_DICT_OBJ_KEY, IRDS_EXT_DICT_WS_KEY,
IRDS_IMP_CONT_WS_KEY, IRD_WORKING_SET_KEY),
CONSTRAINT IMPORTED_WS_COMES_FROM_EXTERNAL_DICTIONARY
FOREIGN KEY (IRDS_EXT_DICT_OBJ_KEY, IRDS_EXT_DICT_WS_KEY)
REFERENCES IRDS_DICTIONARY_IMPORT_CONTROL
ON DELETE CASCADE,
CONSTRAINT IMPORTED_WS_MAPS_TO_IRD_WORKING_SET
FOREIGN KEY (IRD_WORKING_SET_KEY)
REFERENCES IRD_WORKING_SET
ON DELETE CASCADE
)
8.3.3 Description
1. IRDS_EXT_DICT_OBJ_KEY, IRDS_EXT_DICT_WS_KEY and
IRDS_IMP_CONT_WS_KEY and IRD_WORKING_SET_KEY together form the
primary key of the Ird Working Set Import Control table.
2. IRDS_IMP_CONT_WS_KEY represents the WS_KEY part of primary and foreign
keys in the content of an Transfer File, that is to be mapped to a working set in the
local IRDS.
3. IRD_WORKING_SET_KEY is the key of a row in the IRD_WORKING_SET table
in the local IRDS, to which the WS_KEY in the Transfer File is mapped.
4. When the IrdsImportWorkingSet service is invoked, a row will be created (if it does
not already exist) mapping the working set to be imported, to the local working set
into which the data is to be imported.
Irds users may insert other rows in this table to allow foreign key references in one working
set to be mapped to another in the local IRDS.
© ISO/IEC ISO/IEC 13238-3:1998(E)
9. Specification of the export/import services
9.1 Relationship to the IRDS Services Interface
The services defined in this clause are additional to those defined in ISO/IEC 10728 Services
Interface under subclause 9.2 Level Independent Services. In this Part of 13238 Pascal
Language Bindings are given.
9.2 Services provided
Services are provided to:
a) Open the Transfer File for Export;
b) Select the rows to be exported from specified tables;
c) Clear a previous selection;
d) Export a single working set or a related set of working sets;
e) Close the Export File;
f) Open the Transfer File for Import;
g) Import a single Working Set;
h) Import the entire Transfer File;
i) Close the Import File.
9.3 Selection of data to be exported
Selection takes place within the context of an IRDS Session.
When not all tables are to be exported, the required tables are specified by invoking the
IRDSSelectForExport service prior to invoking the IRDSExportWorkingSet service. This
service also allows specific rows to be selected.
Each invocation of an IRDSSelectForExport service selects a set of rows from a named table.
The IRDSSelectForExport service may be invoked many times. The effect of multiple calls
is to define multiple sets of rows for export by the IRDSExportWorkingSet service. Multiple
IRDSSelectForExport service calls may name the same table. The effect is to select several
sets of rows from the same table. Although a row may thus be selected several times, a
selected row is exported exactly once.
A previously established set of selection criteria may be cancelled by invoking the
IRDSClearExportSelection service.
9.4 Service Data Types and Data Structures
This subclause defines data types and data structures used in the definition of the
export/import services.
The following are defined in ISO/IEC 10728:
IrdsRetCode
The following are defined in this clause:
type IrdsTFileHandle = integer;
type MissingTablesController = (
kCreateMissingTables,
kSkipMissingTables,
kFailOnMissingTable);
type SkipFailingRowsController = (
kSkipFailingRows,
kDontSkipFailingRows);
type SqlCommitController = (
kCommitAtEndOfFile,
kCommitAfterEachTable,
kCommitAfterEachTableAndEveryNRows);
type UpdateExistingRowsController = (
kUpdateExistingRows,
kDontUpdateExistingRows);
© ISO/IEC ISO/IEC 13238-3:1998(E)
9.5 Open IRDS Export File
9.5.1 Function
Invocation of this service causes an output file to be opened and the header defined by
to be written to the file.
9.5.2 Format
procedure IrdsOpenExportFile
( ExpFilePath: String;
ExpFileName: String;
UserParm: IrdsText;
Tags: String;
PublisherName: String;
PublisherSystemName: String;
PublisherVersion: String;
var CurrTFileHandle: IrdsTFileHandle;
var RetCode: IrdsRetCode );
9.5.3 Input
The following variables may be set:
ExpFilePath := when not null, the path to the directory in which the file is to be placed.
When null, a default path will be used.
ExpFileName := when not null, the name to be used for the export file . When null, a default
file name will be used.
UserParm = when not null, the value is user defined to add extra user information to the TF
header.
Tags = one of the values defined for in 7.9.2.
PublisherName= the value to be included in the header as .
PublisherSystemName= the value to be included in the header as .
PublisherVersion= the value to be included in the header as
9.5.4 Output
The following variables shall be set:
CurrTFileHandle :=  a system handle for the opened export file.
RetCode := with the following error states:
State Class Subclass
92 901: The user does not have the appropriate operating system file access
privileges.
92 902: Invalid File Name
92 903: Specified File Path does not exist
92 904: Other Operating System File Error
92 905: Invalid TAGS parameter.
9.5.5 General Rules
1. More than one IRDS Transfer File may be open at any one time. Use of the
CurrTFileHandle allows the IRDS to relate specific invocations of
IrdsSelectForExport, IrdsClearExportSelection, IrdsExportWorkingSet and
IrdsCloseExportFile to a specific Transfer File.
2. If the file identified by the combination of “ExpFilePath“ and “ExpFileName“ does
not exist, it is created. If the file already existed, its contents are replaced by the data
exported by the series of “IrdsExportWorkingSet” services between an
IrdsOpenExportFile and the following IrdsCloseExportFile.
3. An instance of is written to the file. Constant fields are given the
values specified in clause 7. The variable fields are completed as follows:
a) to be a time between the start and end of the invocation of the
IrdsOpenExportFile service.
b) an implementor defined name of the tool generating the
Transfer File.
c) an implementor
...