Business Objects, the Business Objects logo, Crystal Reports, and Crystal Enterprise are
trademarks or registered trademarks of Business Objects SA or its affiliated companies in the
United States and other countries. All other names mentioned herein may be trademarks of
their respective owners.
Business Objects owns the following U.S. patents, which may cover products that are offered
and sold by Business Objects: 5,555,403, 6,247,008 B1, 6,578,027 B2, 6,490,593 and
6,289,352.
Welcome to the The Data Integrator Reference Guide . This guide provides
detailed information about the objects, data types, transforms, and functions
in the Data Integrator Designer.
This book contains the following chapters:
•Chapter 2: Data Integrator Objects — Describes options, properties, and
•Chapter 3: Smart Editor — Describes the editor that can be used to
•Chapter 4: Data Types — Describes the data types used in Data
•Chapter 5: Transforms — Describes the transforms included with Data
•Chapter 6: Functions and Procedures — Describes the functions
•Chapter 7: Data Integrator Scripting Language — Describes the Data
•Chapter 8: Metadata in repository tables and views — Describes the
•Chapter 9: Locales and Multi-Byte Functionality — Describes how Data
•Chapter 10: Reserved Words — Lists words that have special mean ing in
For source-specific information, such as information pertaining to a particular
back-office application, consult the supplement for that application.
attributes for objects, such as data flows and work flows.
create scripts, expressions, custom functions.
Integrator, and how Data Integrator handles data type conversions.
Integrator and how to use these transforms.
included with Data Integrator and how to use these functions.
Integrator scripting language and how you can use this language to
create scripts, expressions, and custom functions.
repository’s reporting tables and views that you can use to analyze an
Data Integrator application.
Integrator supports the setting of locales and multi-byte code pages for
the Designer, Job Server, and Access Server.
Data Integrator. You cannot use these words in names that you create,
such as names of data flows.
Who should read this guide
This and other Data Integrator product documentation assumes the following:
•You are an application developer, consultant or database administrator
working on data extraction, data warehousing, or data integration.
•You understand your source and target data systems, DBMS, legacy
systems, business intelligence, and messaging concepts.
16Data Integrator Reference Guide
•You understand your organization’s data needs.
•You are familiar with SQL (Structured Query Language).
•If you are interested in using this product to design real-time processing
you are familiar with:
•DTD and XML Schema formats for XML files
•Publishing Web Services (WSDL, HTTP/S and SOAP p rotocols, etc.)
•You are familiar with Data Integrator installation environments: Microsoft
Windows or UNIX.
Business Objects information resources
Consult the Data Integrator Getting Started Guide for:
•An overview of Data Integrator products and architecture
•Data Integrator installation and configuration information
•A list of product documentation and a suggested reading path
After you install Data Integrator, you can view technical documentation from
many locations. To view documentation in PDF format, you can:
•Select Start > Programs > Data Integrator version > Data Integrator
Documentation
•Release Notes
•Release Summary
•Technical Manuals
•Select one of the following from the Designer’s Help menu:
•Release Notes
•Release Summary
•Technical Manuals
•Select Help from the Data Integrator Administrator
You can also view and download PDF documentation by visiting Business
Objects Customer Support online. To access this Web site, you must have a
valid user name and password. To obtain your user name and password, go
to http://www.techsupport.businessobjects.com and click Register.
and choose:
Introduction
About this guide
1
Data Integrator Reference Guide17
Introduction
1
About this guide
18Data Integrator Reference Guide
Introduction
About this guide
1
Data Integrator Reference Guide19
Introduction
1
About this guide
20Data Integrator Reference Guide
Data Integrator Reference Guide
Data Integrator Objects
chapter
Data Integrator Objects
2
This chapter contains reference information about general Data Integrator
objects, such as data flows, jobs, and work flows. Topics include:
•Characteristics of objects
•Descriptions of objects
Note: For information about source-specific objects, consult the reference
chapter of the Data Integrator supplement document for that source.
22Data Integrator Reference Guide
Characteristics of objects
This section discusses common characteristics of all Data Integrator objects.
Specifically, this section discusses:
•Object classes
•Object options, properties, and attributes
Object classes
An object’s class determines how you create and retrieve the object. There
are two classes of objects:
•Reusable objects
•Single-use objects
Reusable objects
After you define and save a reusable object, Data Integrator stores the
definition in the repository. You can then reuse the definition as often as
necessary by creating calls to the definition.
Most objects created in Data Integrator are available for reuse. You access
reusable objects through the object library.
A reusable object has a single definition; all calls to the object refer to that
definition. If you change the definition of the object in one place, and then
save the object, the change is reflected to all other calls to the object.
A data flow, for example, is a reusable object. Multiple jobs, such as a weekly
load job and a daily load job, can call the same data flow. If the data flow is
changed, both jobs call the new version of the data flow.
When you drag and drop an object from the object library, you are creating a
new reference (or call) to the existing object definition.
You can edit reusable objects at any time independent of the current open
project. For example, if you open a new project, you can go to the object
library , open a dat a flow, and edit it. The object will remain “dirty” (that is, your
edited changes will not be saved) until you explicitly save it.
Functions are reusable objects that are not available in the object library . Data
Integrator provides access to these objects through the function wizard
wherever they can be used.
Some objects in the object library are not reusable in all instances:
•Datastores are in the object library because they are a method for
categorizing and accessing external metadata.
Data Integrator Objects
Characteristics of objects
2
Data Integrator Reference Guide23
Data Integrator Objects
2
Characteristics of objects
•Built-in transforms are “reusable” in that every time you drop a transform,
a new instance of the transform is created.
Saving reusable objects
“Saving” a reusable object in Data Integrator means storing the language that
describes the object to the repository. The description of a reusable object
includes these components:
•Properties of the object
•Options for the object
•Calls this object makes to other objects
•Definition of single-use objects called by this object
If an object contains a call to another reusable object, only the call to the
second object is saved, not changes to that object’s definition.
Data Integrator stores the description even if the object does not validate.
Data Integrator saves objects without prompting you:
•When you import an object into the repository.
•When you finish editing:
•Datastores
•Flat file formats
•XML Schema or DTD formats
Y ou can explicitly save the reusable object currently open in the wo rkspace by
choosing
workspace, the
To save all objects in the repository that have changes, choose
the
Data Integrator also prompts you to save all objects that have changes when
you execute a job and when you exit the Designer.
Save from the Project menu. If a single-use object is open in the
Save command is not available.
Save All from
Project menu.
Single-use objects
Single-use objects appear only as components of other objects. They ope rate
only in the context in which they were created.
Saving single-use objects
“Saving” a single-use object in Data Integrator means storing the language
that describes the object to the repository. The description of a single-use
object can only be saved as part of the reusable object that calls the singleuse object.
Data Integrator stores the description even if the object does not validate.
24Data Integrator Reference Guide
Object options, properties, and attributes
Each object is associated with a set of options, properties, and attributes:
•Options control the operation of an object. For example, in a datastore,
an option is the name of the database to which the datastore connects.
•Properties document an object. For example, properties include the
name, description of an object, and the date on which it was created.
Properties merely describe an object; they do not affect an object’s
operation.
To view properties, right-click an object and select
•Attributes provide additional information about an object. Attribute values
may also affect an object’s behavior.
To view attributes, double-click an object from an editor and click the
Attributes tab.
Descriptions of objects
This section describes each Data Integrator object and tells you how to
access that object.
The following table lists the names and descriptions of objects available in
Data Integrator:
Data Integrator Objects
Descriptions of objects
Properties.
2
ObjectClassDescription
AnnotationSingle-use Describes a flow, part of a flow, or a diagram in the workspace.
CatchSingle-use Specifies the steps to execute if a given error occurs while a job
is running.
COBOL
copybook file
format
ConditionalSingle-use Specifies the steps to execute based on the result of a
Batch JobReusableDefines activities that Data Integrator executes at a given time
Data flowReusableSpecifies the requirements for extracting, transforming, and
ReusableDescribes the structure defined in a COBOL copybook file.
condition.
including error, monitor and trace messages.
Jobs can be dropped only in the project tree. The object
created is a direct reference to the object in the object library.
Only one reference to a job can exist in the project tree at one
time.
loading data from sources to targets.
Data Integrator Reference Guide25
Data Integrator Objects
2
Descriptions of objects
ObjectClassDescription
DatastoreSingle-use Specifies the connection information Data Integrator needs to
access a database or other data source. Cannot be dropped.
DocumentReusableAvailable in certain adapter datastores, documents are data
structures that can support complicated nested schemas.
DTDReusableA description of an XML file or message. Indicates the format
an XML document reads or writes. See also: XML Schema
File formatReusableIndicates how flat file data is arranged in a source or target file.
FunctionReusableReturns a value.
LogSingle-use Records information about a particular execution of a single
job.
Message
function
Outbound
message
ProjectSingle-use Groups jobs for convenient access.
Query transform Single-use Retrieves a data set that satisfies conditions that you specify.
Real-time jobReusableDefines activities that Data Integrator executes on-demand.
ScriptSingle-use Evaluates expressions, calls functions, and assigns values to
SourceSingle-use An object from which Data Integrator reads data in a data flow.
TableReusableIndicates an external DBMS table for which metadata has been
TargetSingle-use An object in which Data Integrator loads extracted and
ReusableAvailable in certain adapter datastores, message functions can
accommodate XML messages when properly configured.
ReusableAvailable in certain adapter datastores, outbound messages
are XML-based, hierarchical communications that real-time
jobs can publish to adapters.
Real-time jobs are created in the Designer, then configured and
run as services associated with an Access Server in the
Administrator. Real-time jobs are designed according to data
flow model rules and run as a request-response system.
variables.
imported into Data Integrator, or the target table into which data
is or has been placed.
A table is associated with its datastore; it does not exist
independently of a datastore connection. A table retrieves or
stores data based on the schema of the table definition from
which it was created.
transformed data in a data flow.
26Data Integrator Reference Guide
Data Integrator Objects
Descriptions of objects
ObjectClassDescription
Template tableReusableA new table you want added to a database.
All datastores except SAP R/3 datastores have a default
template that you can use to create any number of tables in the
datastore.
Data Integrator creates the schema for each instance of a
template table at runtime. The created schema is based on the
data loaded into the template table.
TransformReusablePerforms operations on data sets.
Requires zero or more data sets; produces zero or one data set
(which may be split).
TrySingle-use Introduces a try/catch block.
While loopSingle-use Repeats a sequence of steps as long as a condition is true.
Work flowReusableOrders data flows and operations supporting data flows.
XML fileSingle-use A batch or real-time source or target. As a source, an XML file
translates incoming XML-formatted data into data that D
NTEGRATOR can process. As a target, an XML file translates the
I
data produced by a data flow, including nested data, into an
XML-formatted file.
XML messageSingle-use A real-time source or target. As sources, XML messages
translate incoming XML-formatted requests into data that a
real-time job can process. As targets, XML messages translate
the result of the real-time job, including hierarchical data, into
an XML-formatted response and sends the messages to the
Access Server.
XML SchemaReusableA description of an XML file or message. Indicates the format
an XML document reads or writes. See also: DTD
XML templateSingle-use A target that creates an XML file that matches a particular input
schema. No DTD or XML Schema is required.
ATA
2
Data Integrator Reference Guide27
Data Integrator Objects
2
Descriptions of objects
Annotation
Class
Single-use
Access
Click the annotation icon in the tool palette, then click in the workspace.
Description
Annotations describe a flow, part of a flow, or a diagram in a workspace. An
annotation is associated with the job., work flow, or data flow where it
appears. When you import or export that job, work flow, or data flow, you
import or export associated annotations.
For more information, see “Creating annotations” on page 59 of the Data Integrator Designer Guide.
Note: An annotation has no options or properties.
28Data Integrator Reference Guide
Data Integrator Objects
Descriptions of objects
Batch Job
Class
Reusable
Access
•In the object library, click the Jobs tab.
•In the project area, select a project and right-click Batch Job.
Description
Note: For information specific to SAP R/3, see Data Integrator Supplement
for SAP.
A batch job is a set of objects that you can schedule and execute together.
For Data Integrator to execute the steps of any object, the object must be part
of a job.
A batch job can contain the following objects:
•Data flows
•Sources
•Transforms
•Targets
•Work flows
•Scripts
•Conditionals
•Try/catch blocks
•While Loops
Y ou can run b atch jobs such that you can automatically recover from jobs that
do not execute successfully. During automatic recovery, Data Integrator
retrieves the results from steps that were successfully completed in the
previous run and executes all other steps. Specifically, Data Integrator
retrieves results from the following types of steps:
•Work flows
•Data flows
•Script statements
•Custom functions (stateless type only)
•SQL function
•EXEC function
2
Data Integrator Reference Guide29
Data Integrator Objects
2
Descriptions of objects
•get_env function
•rand function
•sysdate function
•systime function
Batch jobs have the following built-in attributes:
AttributeDescription
NameThe name of the object. This name appears on the
object in the object library and in the calls to the
object.
DescriptionYour description of the job.
Date createdThe date when the object was created.
Batch and real-time jobs have properties that determine what information
Data Integrator collects and logs when running the job. You can set the
default properties that apply each time you run the job or you can set
execution (run-time) properties that apply for a particular run. Execution
properties override default properties.
To set default properties, select the job in the project area or the object library,
right-click, and choose
Execution properties are set as you run a job. To set execution properties,
right-click the job in the project area and choose
validates the job and opens the Execution Properties window.
You can set three types of execution properties:
Properties to open the Properties window.
Execute. The Designer
•Parameters
•Trace properties
•Global variables
For an introduction to using global variables as job properties and
selecting them at runtime, see “Setting global variable values” on
page 286 of the Data Integrator Designer Guide.
Parameters
Use parameter options to help capture and diagnose errors using log, View
Data, or recovery options.
Data Integrator writes log information to one of three files (in the
$LINK_DIR\log\Job Server name\repository name directory):
•Monitor log file
•Trace log file
30Data Integrator Reference Guide
Loading...
+ 622 hidden pages
You need points to download manuals.
1 point = 1 manual.
You can buy points or you can get point for every manual you upload.