SAP Business objects DATA SERVICES Reference Guide
Data Services Reference Guide
BusinessObjects Data Services XI 3.1 (12.1.1)
Copyright
© 2008 Business Objects, an SAP company. All rights reserved. Business Objects
owns the following U.S. patents, which may cover products that are offered and
licensed by Business Objects: 5,295,243; 5,339,390; 5,555,403; 5,590,250;
5,619,632; 5,632,009; 5,857,205; 5,880,742; 5,883,635; 6,085,202; 6,108,698;
6,247,008; 6,289,352; 6,300,957; 6,377,259; 6,490,593; 6,578,027; 6,581,068;
6,628,312; 6,654,761; 6,768,986; 6,772,409; 6,831,668; 6,882,998; 6,892,189;
6,901,555; 7,089,238; 7,107,266; 7,139,766; 7,178,099; 7,181,435; 7,181,440;
7,194,465; 7,222,130; 7,299,419; 7,320,122 and 7,356,779. Business Objects and
its logos, BusinessObjects, Business Objects Crystal Vision, Business Process
On Demand, BusinessQuery, Cartesis, Crystal Analysis, Crystal Applications,
Crystal Decisions, Crystal Enterprise, Crystal Insider, Crystal Reports, Crystal
Vision, Desktop Intelligence, Inxight and its logos , LinguistX, Star Tree, Table
Lens, ThingFinder, Timewall, Let There Be Light, Metify, NSite, Rapid Marts,
RapidMarts, the Spectrum Design, Web Intelligence, Workmail and Xcelsius are
trademarks or registered trademarks in the United States and/or other countries
of Business Objects and/or affiliated companies. SAP is the trademark or registered
trademark of SAP AG in Germany and in several other countries. All other names
mentioned herein may be trademarks of their respective owners.
Third-party
Contributors
Business Objects products in this release may contain redistributions of software
licensed from third-party contributors. Some of these individual components may
also be available under alternative licenses. A partial listing of third-party
contributors that have requested or permitted acknowledgments, as well as required
notices, can be found at: http://www.businessobjects.com/thirdparty
2008-11-28
Contents
Introduction 17Chapter 1
Welcome to Data Services........................................................................18
Overview of this guide...............................................................................24
Data Services Objects 27Chapter 2
Characteristics of objects...........................................................................28
Descriptions of objects ..............................................................................31
Welcome..............................................................................................18
Documentation set for Data Services...................................................18
Accessing documentation....................................................................21
Business Objects information resources..............................................22
About this guide....................................................................................24
Who should read this guide..................................................................25
Object classes .....................................................................................28
Object options, properties, and attributes............................................30
Annotation............................................................................................35
Batch Job.............................................................................................36
Catch ...................................................................................................49
COBOL copybook file format ...............................................................53
Conditional ..........................................................................................63
Data flow .............................................................................................65
Datastore..............................................................................................68
Document...........................................................................................146
DTD....................................................................................................146
Excel workbook format ......................................................................161
File format..........................................................................................170
Data Services Reference Guide 3
Contents
Function..............................................................................................186
Log.....................................................................................................187
Message function...............................................................................197
Outbound message............................................................................198
Project................................................................................................198
Query transform.................................................................................199
Real-time job......................................................................................200
Script..................................................................................................205
Source................................................................................................206
Table...................................................................................................214
Target.................................................................................................220
Target Writer migrated from Data Quality ..........................................269
Template table....................................................................................269
Transform...........................................................................................273
Try......................................................................................................274
While loop...........................................................................................275
Work flow............................................................................................276
XML file..............................................................................................279
XML message....................................................................................284
XML schema......................................................................................286
XML template.....................................................................................306
Smart editor 309Chapter 3
Accessing the smart editor......................................................................310
Smart editor options.................................................................................312
Smart editor toolbar............................................................................312
Editor Library pane.............................................................................312
Editor pane.........................................................................................314
To browse for a function...........................................................................318
To search for a function...........................................................................318
4 Data Services Reference Guide
Contents
Data types 321Chapter 4
Descriptions of data types.......................................................................322
date....................................................................................................323
datetime..............................................................................................325
decimal...............................................................................................326
double ................................................................................................327
int........................................................................................................327
interval................................................................................................328
Large object data types......................................................................328
numeric...............................................................................................335
real.....................................................................................................336
time.....................................................................................................336
timestamp...........................................................................................338
varchar...............................................................................................339
Data type processing...............................................................................341
Date arithmetic...................................................................................341
Type conversion.................................................................................343
Transforms 373Chapter 5
Operation codes......................................................................................374
Descriptions of transforms.......................................................................375
Data Integrator transforms.................................................................379
Data Quality transforms......................................................................464
Platform transforms............................................................................665
Functions and Procedures 719Chapter 6
About functions........................................................................................720
Functions compared with transforms.................................................720
Operation of a function.......................................................................720
Data Services Reference Guide 5
Contents
Arithmetic in date functions................................................................721
Including functions in expressions.....................................................721
Kinds of functions you can use in Data Services...............................725
Descriptions of built-in functions..............................................................730
abs......................................................................................................743
add_months........................................................................................744
ascii....................................................................................................745
avg......................................................................................................746
cast.....................................................................................................747
ceil......................................................................................................750
chr......................................................................................................751
base64_decode..................................................................................752
base64_encode..................................................................................753
concat_date_time ..............................................................................754
count ..................................................................................................754
count_distinct.....................................................................................755
current_configuration .........................................................................757
current_system_configuration............................................................758
dataflow_name ..................................................................................758
datastore_field_value.........................................................................759
date_diff..............................................................................................760
date_part ...........................................................................................761
day_in_month.....................................................................................763
day_in_week......................................................................................764
day_in_year........................................................................................765
db_type...............................................................................................766
db_version..........................................................................................768
db_database_name............................................................................770
db_owner............................................................................................771
decode................................................................................................772
double_metaphone.............................................................................775
6 Data Services Reference Guide
Contents
exec....................................................................................................777
extract_from_xml................................................................................784
file_exists ...........................................................................................787
fiscal_day...........................................................................................788
floor....................................................................................................789
gen_row_num_by_group....................................................................790
gen_row_num ....................................................................................793
get_domain_description.....................................................................794
get_env...............................................................................................795
get_error_filename ............................................................................796
get_file_attribute.................................................................................797
get_monitor_filename ........................................................................798
get_trace_filename ............................................................................799
greatest..............................................................................................800
host_name .........................................................................................802
ifthenelse............................................................................................802
index...................................................................................................804
init_cap...............................................................................................805
interval_to_char..................................................................................807
is_group_changed..............................................................................808
is_set_env..........................................................................................809
is_valid_date......................................................................................810
is_valid_datetime................................................................................812
is_valid_decimal.................................................................................813
is_valid_double...................................................................................815
is_valid_int..........................................................................................816
is_valid_real.......................................................................................817
is_valid_time.......................................................................................819
isempty ..............................................................................................820
isweekend .........................................................................................822
job_name ...........................................................................................823
Data Services Reference Guide 7
Contents
julian...................................................................................................823
julian_to_date.....................................................................................824
key_generation...................................................................................825
last_date ............................................................................................826
least....................................................................................................827
length .................................................................................................829
literal...................................................................................................830
ln.........................................................................................................832
load_to_xml........................................................................................833
log.......................................................................................................838
long_to_varchar..................................................................................839
lookup ................................................................................................840
lookup_ext..........................................................................................846
lookup_seq.........................................................................................857
lower ..................................................................................................863
lpad ....................................................................................................864
lpad_ext..............................................................................................865
ltrim ....................................................................................................868
ltrim_blanks .......................................................................................869
ltrim_blanks_ext ................................................................................870
mail_to................................................................................................871
match_pattern....................................................................................875
match_regex ......................................................................................879
match_simple.....................................................................................891
max.....................................................................................................893
min......................................................................................................894
mod....................................................................................................895
month.................................................................................................896
num_to_interval..................................................................................897
nvl.......................................................................................................899
power..................................................................................................900
8 Data Services Reference Guide
Contents
previous_row_value...........................................................................901
print ...................................................................................................902
pushdown_sql ...................................................................................904
quarter................................................................................................906
raise_exception .................................................................................907
raise_exception_ext ..........................................................................908
rand....................................................................................................909
rand_ext.............................................................................................910
replace_substr ...................................................................................911
replace_substr_ext.............................................................................912
repository_name ................................................................................916
round..................................................................................................917
rpad....................................................................................................918
rpad_ext.............................................................................................919
rtrim ...................................................................................................922
rtrim_blanks .......................................................................................923
rtrim_blanks_ext ................................................................................924
search_replace...................................................................................925
set_env ..............................................................................................934
sleep ..................................................................................................935
soundex..............................................................................................936
sql ......................................................................................................937
sqrt.....................................................................................................941
smtp_to...............................................................................................941
substr..................................................................................................946
sum.....................................................................................................948
sysdate...............................................................................................949
system_user_name ...........................................................................950
systime...............................................................................................951
table_attribute ....................................................................................952
to_char...............................................................................................953
Data Services Reference Guide 9
Contents
to_date...............................................................................................957
to_decimal .........................................................................................958
to_decimal_ext ..................................................................................960
total_rows...........................................................................................961
trunc...................................................................................................963
truncate_table.....................................................................................964
upper..................................................................................................966
varchar_to_long..................................................................................967
wait_for_file........................................................................................968
week_in_month..................................................................................970
week_in_year.....................................................................................971
WL_GetKeyValue ..............................................................................973
word....................................................................................................974
word_ext ............................................................................................976
workflow_name .................................................................................978
year....................................................................................................979
About procedures....................................................................................980
Overview............................................................................................980
Requirements.....................................................................................981
Creating stored procedures in a database.........................................982
Importing metadata for stored procedures ........................................986
Structure of a stored procedure..........................................................987
Calling stored procedures..................................................................989
Checking execution status ................................................................995
Data Services Scripting Language 997Chapter 7
To use Data Services scripting language................................................998
Language syntax.....................................................................................998
Syntax for statements in scripts.........................................................998
Syntax for column and table references in expressions.....................999
Strings..............................................................................................1000
10 Data Services Reference Guide
Contents
Variables...........................................................................................1001
Variable interpolation........................................................................1002
Functions and stored procedures.....................................................1003
Operators.........................................................................................1003
NULL values.....................................................................................1007
Debugging and Validation................................................................1011
Keywords..........................................................................................1013
Sample scripts.......................................................................................1015
Square function................................................................................1016
RepeatString function.......................................................................1016
Metadata in Repository Tables and Views 1019Chapter 8
Auditing metadata..................................................................................1020
AL_AUDIT........................................................................................1020
AL_AUDIT_INFO..............................................................................1022
Imported metadata.................................................................................1024
AL_INDEX........................................................................................1024
AL_PCOLUMN.................................................................................1025
AL_PKEY.........................................................................................1026
ALVW_COLUMNATTR.....................................................................1027
ALVW_COLUMNINFO.....................................................................1028
ALVW_FKREL..................................................................................1030
ALVW_MAPPING.............................................................................1031
ALVW_TABLEATTR.........................................................................1042
ALVW_TABLEINFO..........................................................................1044
Internal metadata...................................................................................1044
AL_LANG.........................................................................................1045
AL_LANGXMLTEXT.........................................................................1046
AL_ATTR..........................................................................................1047
AL_SETOPTIONS............................................................................1048
AL_USAGE......................................................................................1049
Data Services Reference Guide 11
Contents
ALVW_FUNCINFO...........................................................................1053
ALVW_PARENT_CHILD..................................................................1054
Metadata Integrator tables.....................................................................1056
AL_CMS_BV....................................................................................1056
AL_CMS_BV_FIELDS......................................................................1058
AL_CMS_REPORTS........................................................................1059
AL_CMS_REPORTUSAGE.............................................................1060
AL_CMS_FOLDER..........................................................................1062
AL_CMS_UNV.................................................................................1063
AL_CMS_UNV_OBJ........................................................................1064
Operational metadata............................................................................1065
AL_HISTORY...................................................................................1065
ALVW_FLOW_STAT........................................................................1067
Locales and Multi-byte Functionality 1069Chapter 9
Locale support.......................................................................................1070
Locale selection................................................................................1072
Code page support...........................................................................1075
Guidelines for setting locales...........................................................1078
Multi-byte support..................................................................................1084
Multi-byte string functions.................................................................1084
Numeric data types: assigning constant values...............................1084
Byte Order Mark characters.............................................................1086
Round-trip conversion......................................................................1086
Column sizing...................................................................................1087
Limitations of multi-byte support............................................................1087
Definitions..............................................................................................1088
Supported locales and encodings.........................................................1090
Supported languages.......................................................................1091
Supported territories.........................................................................1091
Supported code pages.....................................................................1093
12 Data Services Reference Guide
Contents
Data Quality Fields 1097Chapter 10
Data Quality fields..................................................................................1098
Content types...................................................................................1098
Associate output fields...........................................................................1100
Country ID fields....................................................................................1101
Input Fields.......................................................................................1101
Output fields.....................................................................................1102
Data Cleanse fields................................................................................1103
Input fields........................................................................................1103
Output fields.....................................................................................1105
Geocoder fields......................................................................................1111
Input fields........................................................................................1112
Output fields.....................................................................................1113
Global Address Cleanse fields..............................................................1115
Field category columns in Output tab...............................................1115
Input fields........................................................................................1120
Output Fields....................................................................................1123
Global Suggestion Lists fields...............................................................1141
Input fields........................................................................................1141
Output fields.....................................................................................1143
Match fields............................................................................................1148
Match transform output fields...........................................................1148
Prioritization fields............................................................................1152
USA Regulatory Address Cleanse fields...............................................1152
Field category columns in Output tab...............................................1153
Input fields........................................................................................1157
Output fields.....................................................................................1160
Data Services Reference Guide 13
Contents
Python 1191Chapter 11
Python in Data Services........................................................................1192
About Python in Data Services ........................................................1192
Create an expression with the Python Expression editor.................1196
Built-in objects..................................................................................1200
Data Services-defined classes and methods...................................1202
FlDataCollection class......................................................................1203
FlDataManager class.......................................................................1208
FlDataRecord class..........................................................................1210
FlProperties class.............................................................................1213
FlPythonString class.........................................................................1214
Data Services Python examples......................................................1217
Reserved Words 1227Chapter 12
About Reserved Words..........................................................................1228
Data Quality Appendix 1233Chapter 13
Address Cleanse reference...................................................................1234
Country ISO codes and assignment engines...................................1234
Information codes (Global Address Cleanse)..................................1260
Status codes (Global Address Cleanse)..........................................1263
Quality codes (Global Address Cleanse).........................................1269
Status Codes (USA Regulatory Address Cleanse)..........................1271
USA Regulatory Address Cleanse transform fault codes................1275
About ShowA and ShowL (USA and Canada).................................1278
Data Cleanse reference.........................................................................1289
Data parsing details..........................................................................1289
User-defined pattern matching (UDPM)...........................................1297
Overview of UDPM...........................................................................1298
14 Data Services Reference Guide
Contents
Working with the pattern file.............................................................1299
Regular expressions.........................................................................1301
Creating regular expressions...........................................................1306
Define a pattern................................................................................1308
Alternate expressions.......................................................................1311
Modify the rule file............................................................................1312
What is the rule file?.........................................................................1312
Rule file organization........................................................................1313
Rule example...................................................................................1315
Definition section of a parsing rule...................................................1316
Action section of a parsing rule........................................................1320
Data Cleanse migration tools...........................................................1326
Index 1335
Data Services Reference Guide 15
Contents
16 Data Services Reference Guide
Introduction
1
Introduction
1
Welcome to Data Services
Welcome to Data Services
Welcome
Data Services XI Release 3 provides data integration and data quality
processes in one runtime environment, delivering enterprise performance
and scalability.
The data integration processes of Data Services allow organizations to easily
explore, extract, transform, and deliver any type of data anywhere across
the enterprise.
The data quality processes of Data Services allow organizations to easily
standardize, cleanse, and consolidate data anywhere, ensuring that end-users
are always working with information that's readily available, accurate, and
trusted.
Documentation set for Data Services
You should become familiar with all the pieces of documentation that relate
to your Data Services product.
What this document providesDocument
Documentation Map
Release Summary
Release Notes
Getting Started Guide
Installation Guide for Windows
18 Data Services Reference Guide
Information about available Data Services books,
languages, and locations
Highlights of key features in this Data Services release
Important information you need before installing and
deploying this version of Data Services
An introduction to Data Services
Information about and procedures for installing Data
Services in a Windows environment.
Introduction
Welcome to Data Services
What this document providesDocument
1
Installation Guide for UNIX
Advanced Development Guide
Designer Guide
Integrator's Guide
Management Console: Administrator
Guide
Management Console: Metadata Reports Guide
Migration Considerations Guide
Information about and procedures for installing Data
Services in a UNIX environment.
Guidelines and options for migrating applications including information on multi-user functionality and
the use of the central repository for version control
Information about how to use Data Services Designer
Information for third-party developers to access Data
Services functionality. Also provides information about
how to install, configure, and use the Data Services
Adapter for JMS.
Information about how to use Data Services Administrator
Information about how to use Data Services Metadata
Reports
Information about:
• Release-specific product behavior changes from
earlier versions of Data Services to the latest release
• How to migrate from Data Quality to Data Services
Performance Optimization Guide
Reference Guide
Information about how to improve the performance
of Data Services
Detailed reference material for Data Services Designer
Data Services Reference Guide 19
Introduction
1
Welcome to Data Services
Technical Manuals
What this document providesDocument
A compiled “master” PDF of core Data Services books
containing a searchable master table of contents and
index:
•
Getting Started Guide
•
Installation Guide for Windows
•
Installation Guide for UNIX
•
Designer Guide
•
Reference Guide
•
Management Console: Metadata Reports Guide
•
Management Console: Administrator Guide
•
Performance Optimization Guide
•
Advanced Development Guide
•
Supplement for J.D. Edwards
•
Supplement for Oracle Applications
•
Supplement for PeopleSoft
•
Supplement for Siebel
•
Supplement for SAP
Tutorial
In addition, you may need to refer to several Adapter Guides and
Supplemental Guides.
What this document providesDocument
Salesforce.com Adapter
Interface
Supplement for J.D. Edwards
Supplement for Oracle Applications
Supplement for PeopleSoft
20 Data Services Reference Guide
Information about how to install, configure, and use the Data
Services Salesforce.com Adapter Interface
Information about license-controlled interfaces between Data
Services and J.D. Edwards World and J.D. Edwards OneWorld
Information about the license-controlled interface between Data
Services and Oracle Applications
Information about license-controlled interfaces between Data
Services and PeopleSoft
A step-by-step introduction to using Data Services
Introduction
Welcome to Data Services
What this document providesDocument
1
Supplement for SAP
Supplement for Siebel
Information about license-controlled interfaces between Data
Services, SAP ERP, and SAP BI/BW
Information about the license-controlled interface between Data
Services and Siebel
Accessing documentation
You can access the complete documentation set for Data Services in several
places.
Accessing documentation on Windows
After you install Data Services, you can access the documentation from the
Start menu.
1. Choose Start > Programs > BusinessObjects XI 3.1 >
BusinessObjects Data Services > Data Services Documentation.
Note:
Only a subset of the documentation is available from the Start menu. The
documentation set for this release is available in LINK_DIR\Doc\Books\en.
2. Click the appropriate shortcut for the document that you want to view.
Accessing documentation on UNIX
After you install Data Services, you can access the online documentation by
going to the directory where the printable PDF files were installed.
1. Go to LINK_DIR/doc/book/en/.
2. Using Adobe Reader, open the PDF file of the document that you want
to view.
Data Services Reference Guide 21
Introduction
1
Welcome to Data Services
Accessing documentation from the Web
You can access the complete documentation set for Data Services from the
Business Objects Customer Support site.
1.
Go to http://help.sap.com.
2. Cick Business Objects at the top of the page.
You can view the PDFs online or save them to your computer.
Business Objects information resources
A global network of Business Objects technology experts provides customer
support, education, and consulting to ensure maximum business intelligence
benefit to your business.
Useful addresses at a glance:
ContentAddress
22 Data Services Reference Guide
Introduction
Welcome to Data Services
ContentAddress
1
Customer Support, Consulting, and Education
services
http://service.sap.com/
Data Services Community
https://www.sdn.sap.com/irj/sdn/businessob
jects-ds
Forums on SCN (SAP Community Network)
https://www.sdn.sap.com/irj/sdn/businessob
jects-forums
Blueprints
http://www.sdn.sap.com/irj/boc/blueprints
Information about Customer Support programs,
as well as links to technical articles, downloads,
and online forums. Consulting services can
provide you with information about how Business Objects can help maximize your business
intelligence investment. Education services can
provide information about training options and
modules. From traditional classroom learning
to targeted e-learning seminars, Business Objects can offer a training package to suit your
learning needs and preferred learning style.
Get online and timely information about Data
Services, including tips and tricks, additional
downloads, samples, and much more. All content is to and from the community, so feel free
to join in and contact us if you have a submission.
Search the Business Objects forums on the
SAP Community Network to learn from other
Data Services users and start posting questions
or share your knowledge with the community.
Blueprints for you to download and modify to fit
your needs.Each blueprint contains the necessary Data Services project, jobs, data flows, file
formats, sample data, template tables, and
custom functions to run the data flows in your
environment with only a few modifications.
Data Services Reference Guide 23
Introduction
1
Overview of this guide
http://help.sap.com/
ContentAddress
Business Objects product documentation.Product documentation
Documentation mailbox
documentation@businessobjects.com
Supported platforms documentation
https://service.sap.com/bosap-support
Send us feedback or questions about your
Business Objects documentation. Do you have
a suggestion on how we can improve our documentation? Is there something that you particularly like or have found useful? Let us know,
and we will do our best to ensure that your
suggestion is considered for the next release
of our documentation.
Note:
If your issue concerns a Business Objects
product and not the documentation, please
contact our Customer Support experts.
Get information about supported platforms for
Data Services.
In the left panel of the window, navigate to
Documentation > Supported Platforms >
BusinessObjects XI 3.1. Click the BusinessObjects Data Services link in the main window.
Overview of this guide
About this guide
The Data Services Reference Guide provides a detailed information about
the objects, data types, transforms, and functions in the Data Services
Designer.
For source-specific information, such as information pertaining to a particular
back-office application, refer to the supplement for that application.
24 Data Services Reference Guide
Who should read this guide
This and other Data Services product documentation assume the following:
• You are an application developer, consultant, or database administrator
working on data extraction, data warehousing, data integration, or data
quality.
• You understand your source and target data systems, DBMS, legacy
systems, business intelligence, and messaging concepts.
• 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 protocols, and
so on.)
Introduction
Overview of this guide
1
• You are familiar with Data Services installation environments: Microsoft
Windows or UNIX.
Data Services Reference Guide 25
Introduction
Overview of this guide
1
26 Data Services Reference Guide
Data Services Objects
2
Data Services Objects
2
Characteristics of objects
This section provides a reference of detailed information about the objects,
data types, transforms, and functions in the Data Services Designer.
Note:
For information about source-specific objects, consult the reference chapter
of the Data Services supplement document for that source.
Related Topics
• Characteristics of objects on page 28
• Descriptions of objects on page 31
Characteristics of objects
This section discusses common characteristics of all Data Services objects.
Related Topics
• Object classes on page 28
• Object options, properties, and attributes on page 30
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
Related Topics
• Reusable objects on page 28
• Single-use objects on page 30
Reusable objects
After you define and save a reusable object, Data Services stores the
definition in the repository. You can then reuse the definition as often as
necessary by creating calls to the definition.
28 Data Services Reference Guide
Data Services Objects
Characteristics of objects
Most objects created in Data Services 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 data 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 Services provides access to these objects through the function wizard
wherever they can be used.
2
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.
• Built-in transforms are "reusable" in that every time you drop a transform,
a new instance of the transform is created.
"Saving" a reusable object in Data Services 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 Services stores the description even if the object does not validate.
Data Services Reference Guide 29
Data Services Objects
2
Characteristics of objects
Data Services saves objects without prompting you:
• When you import an object into the repository.
• When you finish editing:
You can explicitly save the reusable object currently open in the workspace
by choosing Save from the Project menu. If a single-use object is open in
the workspace, the Save command is not available.
To save all objects in the repository that have changes, choose Save All
from the Project menu.
Data Services also prompts you to save all objects that have changes when
you execute a job and when you exit the Designer.
Single-use objects
• Datastores
• Flat file formats
• XML Schema or DTD formats
Single-use objects appear only as components of other objects. They operate
only in the context in which they were created.
"Saving" a single-use object in Data Services 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
single-use object.
Data Services stores the description even if the object does not validate.
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.
30 Data Services Reference Guide
Loading...