0% found this document useful (0 votes)

2K views

Abinisio GDE Help

Uploaded by

venkatesanmurali

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

0% found this document useful (0 votes)

2K views

Abinisio GDE Help

Uploaded by

venkatesanmurali

We take content rights seriously. If you suspect this is your content, claim it here.

Available Formats

Download as PDF, TXT or read online on Scribd

You are on page 1/ 221

Getting started with Ab Initio Page 1 of 221

Pre N
viou e

GDE Help > Getting started with Ab Initio

Getting started with Ab Initio

Ab Initio Software LLC is a major supplier of enterprise data processing and integration software. Ab initio is Latin, and it means “from first principles” or
“from the beginning.” The phrase applies to the design and implementation of Ab Initio products and the way Ab Initio supports customers. Ab Initio's
solutions are designed “from the beginning” — ab initio — to take into account all the basic and important requirements for developing and operating large
and complex data processing systems.
The world’s leading companies use Ab Initio software to build mission-critical, enterprise-scale applications with unmatched performance and complete
scalability. These applications cover the full spectrum of data processing activities — from real-time operational systems to batch processing analytic systems,
from billing systems to data warehouses to customer relationship management (CRM) systems.
The following topics provide information to help you get started using Ab Initio software:
About Ab Initio software
Getting assistance
Documentation conventions
Accessibility features
Related topics
Getting started with the GDE

Pre N
viou e

GDE Help > Getting started with Ab Initio > About Ab Initio software

About Ab Initio software

The Co>Operating System, the Graphical Development Environment (GDE), and the Enterprise Meta>Environment (EME) Technical Repository form the
basis of Ab Initio software:
Co>Operating System — The Co>Operating System provides a distributed model for process execution, file management, database integration, process
monitoring, checkpointing, and debugging. It contains the building blocks (components) for creating business applications for enterprise application
integration (EAI), population of data warehouses, clickstream analysis, high-volume analytics, and more. You can use an alternate version, the Elementum
version of the Co>Operating System, for smaller projects.
Graphical Development Environment (GDE) — Using the GDE and components, developers build applications exactly as they design them: by drawing the data
sources and destinations, the processing steps the data will move through, and the connections between them. The result is not merely a picture, or even a
specification — it is an executable application, called a graph.
Enterprise Meta>Environment (EME) — The Enterprise Meta>Environment (EME) is an enterprise-class and enterprise-scale metadata solution designed to
manage the metadata needs of business analysts, developers, operational staff, and others. It handles many types of metadata from different technologies in
three categories — business, technical, and operational. The EME stores metadata in three repositories:
Technical Repository — The Technical Repository supports the needs of developers. It stores artifacts of Ab Initio applications, provides full-fledged
source code control and release management — including versioning, branching, tagging, and promotion — and fosters the sharing of code and other
development objects. The Technical Repository is integrated with other Ab Initio development products, such as the GDE. It is usually deployed in
multiple instances to support code promotion as part of a standard SDLC, as well as development environments that are geographically or
organizationally distributed.
Operational Repository — The Operational Repository supports the availability and reporting of real-time operational metrics and is designed to predict
and manage the behavior of applications. This database is integrated seamlessly with Ab Initio’s own job-scheduling technology but can easily work
with third-party products that control the execution of applications. The Operational Repository automatically captures statistics from Ab Initio
applications and can readily be used to receive and store similar statistics generated by other technologies. The Operational Repository can also be
deployed in multiple instances in geographically or organizationally dispersed execution environments.
Metadata Hub — The Metadata Hub acts primarily as a metadata warehouse, pulling in summary metadata from both the Technical Repository and
Operational Repository. The heart of the EME, the Metadata Hub helps your company leverage the power of its metadata by improving the development
process, facilitating analysis, enabling data and metadata governance, and supporting better understanding of operational systems. Business metadata —
including Erwin models, Cognos reports, XML files, and Excel spreadsheets — can be maintained directly in the Metadata Hub and combined with
metadata imported from the Technical Repository. You browse metadata in the Metadata Portal, a Web interface.
Graphic showing the architecture and data flows of the EME’s Metadata Hub.

You can extend the functionality of Ab Initio software with the following:
Continuous Flows — Continuous Flows enables you to run Ab Initio applications in real time rather than in batch mode. Sources can be any type of
continuous record stream, such as a Web log, a transaction log, or a message queue. Continuous applications give you unlimited scalability, with pipeline
and data parallelism, complete integration of distributed environments through the Co>Operating System's ability to run across multiple platforms at once,
and mainframe-like robustness through a distributed checkpoint/restart facility.
Conduct>It — Conduct>It helps you create, manage, and run large-scale data processing systems. Conduct>It provides a framework to create complete
production systems consisting of “plans,” which can include Ab Initio graphs, custom scripts, and third-party programs — and to run these systems
predictably and recoverably.
Data Profiler — The Data Profiler enables business users and developers to analyze and verify data. The Data Profiler uncovers data quality and usability

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 2 of 221

issues, helps users discover cross-field and cross-dataset relationships, identifies functional dependencies, and develops and enforces validation
specifications. Like all Ab Initio software, the Data Profiler works with data of virtually any kind or size.
Business Rules Environment (BRE) — The BRE enables business analysts to contribute business logic to Ab Initio graphs. Inside the BRE, business
analysts write simple expressions, creating a set of rules that meet a business need, such as approving or rejecting a loan application. The BRE then
converts the expressions into the code needed for the graph.
Application Configuration Environment (ACE) — The Application Configuration Environment is Web-based software that helps organizations take
advantage of generalized applications (parameterized graphs and plans) to improve business agility, streamline business processes, and increase
application reusability. It provides a customizable graphical interface that enables business analysts to interactively configure and test a given application
for one or more uses. The resulting configurations can be deployed and run like any other Ab Initio graphs and plans.
Related topics
Connections across the Ab Initio processing platform

Pre N
viou

GDE Help > Getting started with Ab Initio > About Ab Initio software > Connections across the Ab Initio processing platform

Connections across the Ab Initio processing platform

The following diagram shows typical connections between computers that make up the Ab Initio processing platform.
Illustration showing the Application Hub and published Co>Operating Systems, the abinitiorc configuration files, local
and remote technical repositories, and the connected client applications

In this illustration, the Ab Iniitio processing platform includes the following:

Two run hosts — Run host 1 and Run host 2
Run host 1 contains versions 2.15, 2.16, and 3.0 of the Co>Operating System, the Application Hub, a local Technical Repository server and repository,
and the abinitiorc and .abinitiorc configuration files.
Run host 2 contains a remote Technical Repository server and repository
Several Ab Initio client applications, including the GDE, the Data Profiler, and the Business Rules Environment, each of which has a host setting (.aic) file
The Application Hub on Run host 1 connects to the following:
The three Co>Operating Systems and the Technical Repository server on local Run host 1
The Technical Repository server on remote Run host 2
The Ab Initio client applications
Related topics
About Ab Initio software

Pre N
viou

GDE Help > Getting started with Ab Initio > Getting assistance

Getting assistance
This section describes the variety of ways in which you can get help and find additional information while using the GDE. It includes the following topics:
Using Ab Initio Help
Ab Initio documentation
Additional help sources
Ab Initio Online Discussion Browser
Contacting Ab Initio Support

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 3 of 221

Pre N
viou e

GDE Help > Getting started with Ab Initio > Getting assistance > Using Ab Initio Help

Using Ab Initio Help

Ab Initio Help is HTML-based help.
The left pane of the help window is the navigation pane. It contains four tabs for navigating through the help topics:

Tab Description
Contents Displays a table of contents for the topics in tree form. Click the plus signs (+) to reveal the subtopics.
This tab is displayed by default.
Index Displays index entries for the topics. When you start typing in a keyword, the index displays topics that begin with those letters.
For ease of use, most entries use either the gerund form of verbs, or the plural form of nouns. For example, look under running instead of run, or
jobs instead of job.
Search Enables you to search all the topics for the specified words.
Favorites Enables you to bookmark topics so you can refer to them again easily.
The right pane of the help window displays information on the topics you select. The help window also contains a toolbar to help you find the information you
need.

Searching for a topic

Use the Search tab to search for topics containing words you specify.
To search for topics containing specific words:
1. Type the words you want to find in the Type in the word(s) to search for box.
The results of a search will vary depending on the way you enter words in the Type in the word(s) to search for box:

If you enter The results of the search will include

Two or more words separated by either a Only topics that contain all of those words
space or AND
Two or more words surrounded by quotes Only topics that contain that exact string
Two or more words separated by OR Any topics that contain any of those words
Two or more words with the last one Any topics that contain all the words that precede NEAR with at least one of those words separated by no more
preceded by NEAR than 8 words from the word that follows NEAR
Two or more words with the last one Any topics that contain all the words that precede NOT, and do not contain the word that follows NOT
preceded by NOT

NOTE: If you click the button with the right-facing arrow to the right of the Type in the word(s) to search for box, you can click the choices on the pop-
up menu to insert AND, OR, NEAR, or NOT between the words you enter.
2. Click List topics.
The list box displays the titles of the topics returned by the search.
NOTE: For details about making the search more precise, see “Focusing the search”.
3. To display a topic in the right pane, do one of the following:
Double-click the topic title in the results list.
Select the topic title in the results list, then click Display.
NOTE: By default, when you view a topic from the list of results, all occurrences of the search words are highlighted. To turn off this highlighting, choose
Options > Search Highlight Off from the Help toolbar.

Focusing the search

The following information can help you make the results of a search in Ab Initio Help more precise:
You can only search for complete words. You cannot search for part of a word.
For example, if you enter separ in the Type in the word(s) to search for box, the results will not include topics containing the word separate.
You can help focus the results of a search by using the checkboxes at the bottom of the Search tab.
For example, if you select the Match similar words checkbox and enter specify in the Type in the word(s) to search for box, the results will include topics
containing the words specified and specifies as well as those containing specify.
You cannot search for special characters — such as ~, /, &, $, ^, *, (, ), and so on — or use them to narrow a search.
For example, if you enter / in the Type in the word(s) to search for box, you will get an error message. If you enter /foo, the results will include all topics
containing foo, whether or not foo is preceded by /.
You can sort the topics the search returns by Title, Location, or Rank by clicking the appropriate column head in the Select topic list.

Removing search highlighting

If you want to remove the highlights the search function places on the search string in the topics it finds, do one of the following:
Before conducting the search, choose Options > Search Highlight Off on the Help toolbar.
While viewing a topic that has highlighting visible, click Previous and then Next or Back and then Forward

Getting context-sensitive help

You can open context-sensitive help for GDE windows, editors, panes, dialogs, tabs, menu commands, and so on in one of the following ways:
By selecting an item and pressing the F1 key.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 4 of 221

By clicking the Help button on the GDE toolbar and then clicking the item for which you want help.
By choosing Help > Editor Help from the menu bar of one of the GDE editors.
By clicking the Help button for a dialog.

Using bookmarks

Using the Favorites tab, you can add, view, and delete bookmarked pages.
To add a bookmarked page:
1. With the topic you want to bookmark displayed in the right pane, click the Favorites tab in the left pane.
Information about the current topic is displayed in the Current topic box.
2. Click Add.
The topic is added to the list of favorites.
NOTE: This bookmark is relevant only from within help: it is not included in your list of bookmarks in your browser.
To display or delete one of your bookmarked pages:
1. In the Topics list, highlight the topic you want to display or delete.
2. Click Display or Remove.

Using the help toolbar

The Help toolbar contains the following buttons:

Option Description
Hide Hides the left pane with the tabs. If you have hidden the tabs, click Show to restore them.
Locate Highlights the location of the active topic in the table of contents.
NOTE: Some topics are not listed in the table of contents. If a topic is not listed in the table of contents, the Locate option will not work.
Back Displays the topic you were viewing just before the current one.
For example, if you view topics A, B, and C, and then click Back, topic B is displayed.
Forward Displays the topic you were viewing before you clicked Back.
For example, if you view topics A, B, and C, and then click Back, topic B is displayed; if you then click Forward, topic C is displayed. The
Forward key is then grayed out, because C is the last topic in the viewing sequence.
NOTE: To step through each topic in the order they are arranged in the system (in either forward or reverse order), use the Next and Previous
links in the right pane.
Home Returns you to the welcome screen for the help system.
Print Enables you to print either the selected topic, or all the pages in that topic.
Options In addition to the toolbar options, the Options menu enables you to:
Stop downloading information from the Web (Options > Stop)
Refresh the display of the current topic (Options > Refresh)
Set various internet options, such as security options (Options > Internet Options)
Toggle search highlighting (Options > Search Highlight Off/On)
Help Displays this topic (“Using Ab Initio Help”), which contains information about using the features in help to the greatest advantage.

Using the Help and Component Help options

In the GDE, the Properties dialog for graph components contains two help options:

Option What it provides Example

Tab Access to general information about the tab of the For example, if you are on the Parameters tab and choose Help > Tab, help about the
Properties dialog where you opened it Parameters tab is displayed.
This help topic explains how to use the buttons and other controls that are on this tab
for all components.
Component Information specific to the component where you For example, if you click Help > Component in the Properties dialog for the JOIN
opened the Properties dialog component, information about the Join component is displayed.
From this topic you can access links to information about the Join component’s
parameters, a description of join types, and so on.
NOTE: For help about a specific parameter in the Parameters list of the Parameters tab, right-click the name of the parameter, and choose Help from the
pop-up menu.

Accessing Ab Initio Help without the GDE

You can view Ab Initio Help without using the GDE. You can download a Zip archive of the English files and extract them to a location other than the \en
subdirectory of the existing GDE installation.
To obtain the Zip file, contact support@abinitio.com or download it from the Ab Initio Online Discussion Browser.
Related topics
Ab Initio documentation
Additional help sources
Ab Initio Online Discussion Browser
Contacting Ab Initio Support

Pre N
viou

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 5 of 221

GDE Help > Getting started with Ab Initio > Getting assistance > Ab Initio documentation

Ab Initio documentation
Product documentation is available both in online help and, for the base Ab Initio documentation set, as PDFs shipped with the Co>Operating System
software. For a list of these PDFs, open the Graphical Development Environment (GDE) and choose Help > Ab Initio Server Software Documentation. If you
do not have the PDFs you need, contact your Ab Initio account representative.

Online Discussion Browser

You can use the Ab Initio Online Discussion Browser to do the following:
Read release notes and patch notes
Download the latest version of Ab Initio Help in supported languages
Find answers to frequently asked questions
Participate in general user discussions
For instructions on installing the browser, see “Ab Initio Online Discussion Browser”.

Viewing release notes

Release notes are accessible as follows:

Release Notes for each Ab Initio application are accessible from the Help menu of the application.
Release Notes for the Co>Operating System are accessible through the GDE.
Release notes are also accessible from the Ab Initio Online Discussion Browser. Click Release Notes and then Online Help.
Related topics
Using Ab Initio Help
Additional help sources
Ab Initio Online Discussion Browser
Contacting Ab Initio Support

Pre N
viou

GDE Help > Getting started with Ab Initio > Getting assistance > Additional help sources

Additional help sources

The Co>Operating System installation provides the following additional documentation and examples:

File or directory Description Location

CoOperating_System_Release_Notes.pdf The PDF version of the Co>Operating System release notes. $AB_HOME\doc
This document is also available from the GDE.
error-codes.dat or error-codes.html Lists all the Ab Initio error messages and codes. Two versions of $AB_HOME\lib
the file are available: .dat and .html.
examples Contains examples that show how to use the different pieces of the Access from the GDE Help
Co>Operating System. Each subdirectory contains examples for > Examples menu
that functionality — Web Services, Continuous Flows, and so on. command
Server_Software_Installation_Guide_for_Unix.pdf Provides prerequisites and detailed instructions for installing the $AB_HOME\doc
OR Co>Operating System and Application Hub. This document is also
Server_Software_Installation_Guide_for_Windows.pdf available from the GDE (choose Help > Ab Initio Documentation).
MANIFEST Lists all the Ab Initio products installed, their versions (including $AB_HOME
patch level), and platform information.
ReadMe.patchx.txt If applicable, this file lists the changes for that patch version. $AB_HOME\doc
Related topics
Using Ab Initio Help
Ab Initio documentation
Ab Initio Online Discussion Browser
Contacting Ab Initio Support

Pre N
viou e

GDE Help > Getting started with Ab Initio > Getting assistance > Ab Initio Online Discussion Browser

Ab Initio Online Discussion Browser

You can use the Ab Initio Online Discussion Browser to read release notes and patch notes, find answers to frequently asked questions, and participate in
general user discussions. If the browser is not already installed, you need to install it. You also need to make sure you have a key, as described below.

Installing the Online Discussion Browser

The following procedure describes how to access and install the Online Discussion Browser.
NOTE: Before installing the Online Discussion Browser, download and install "NET Framework Version 2.0 Redistributable Package (x86)" from
http://www.microsoft.com/downloads.
To install the Ab Initio Online Discussion Browser:
1. Obtain the Online Discussion Browser installer, AbForum_version.msi. Contact your Ab Initio administrator or support@abinitio.com for a copy.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 6 of 221

2. Double-click the program name to launch the installation.

3. In the Setup Wizard, click Next.
4. Read the end-user license agreement and check I accept the terms in the License Agreement. Click Next.
5. On the Destination Folder page, accept the default location for browser installation (C:\Program Files\Ab Initio\Online Discussion Browser), or type or
browse to a different path. After specifying the location, click Next.
6. Click Install.
7. When the Setup Wizard has finished copying the files, click Finish.

Obtaining and installing a key file

If you already have a key for any Ab Initio desktop product such as the GDE, BRE, or Data Profiler, you do not need to obtain a separate key for the Online
Discussion Browser. The Online Discussion Browser will automatically recognize your existing key.
If you do not already have a key, you must obtain and install one as described below.

Obtaining a key file

If you do need a key file, you can obtain a browser-only key.

To obtain a key file:
1. From the Start menu, choose All Programs > Ab Initio > Online Discussion Browser.
2. In the Key File Error dialog prompting you to request or install a key file, click Yes.
3. In the Request Key dialog, provide the following information:
License (company to whom the software is licensed)
Group or project name (if applicable)
Your name
Your position — employee or contractor
Name of contractor/outsource company (if applicable)
Type of computer (desktop or laptop)
Location (mailing address) of this computer
4. Click Copy to Clipboard to save this information to the clipboard and to close the Request Key dialog.
5. Open your email program and paste the contents of the clipboard into a new email message.
6. Send the email message to your Ab Initio contact person.
Your Ab Initio contact person will receive your request and email a key file to you or otherwise enable your browser.

Installing the key file

The following procedure describes how to install the key file after you have received it from your Ab Initio contact person.
To install the key file:
1. When you receive your key file, save it to a temporary location on your computer.
2. From the Start menu, choose All Programs > Ab Initio > Online Discussion Browser.
3. In the Key File Error dialog, click Yes.
4. In the Key Management dialog, click Install Key File.
5. In the Install Key File dialog, enter or browse to the path of the key file you saved, and click OK.
The Online Discussion Browser installs the key file and prompts you to delete the file in the temporary location.
6. Click Yes to continue.
7. Click Close to close the Key Management dialog.
Related topics
Using Ab Initio Help
Ab Initio documentation
Additional help sources
Contacting Ab Initio Support

Pre N
viou

GDE Help > Getting started with Ab Initio > Getting assistance > Contacting Ab Initio Support

Contacting Ab Initio Support

To contact Ab Initio Support, send email to support@abinitio.com or call +1 781-301-2100.
The standard hours for support are 9 AM to 7 PM ET Monday through Friday.

Collecting necessary information

When reporting a problem, include the following information:

Your Co>Operating System and — if applicable — product versions (to determine these, follow the instructions below)
The platform (operating system and version) your Co>Operating System is running on
The complete error message (if any)
A description of what you were doing when the error message (if any) appeared
For database issues, the type and version of the database (such as DB2 EEE version 7.2) and platform the database server is on
You may be asked to create a Package for Support or a Trace for Support. For more information, see “Using Package for Support” and “Tracing operations
and communications”.

Determining software versions

To determine which version of the GDE and Co>Operating System you are using, do one of the following:
To determine the version of both the GDE and current Co>Operating System host connection:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 7 of 221

Choose Help > About Graphical Development Environment from the GDE menu bar.
TIP: In the About Graphical Development Environment dialog, click the Copy Version Information to Clipboard and paste the information into an email to
support@abinitio.com, together with the additional information listed in the previous section.
To determine the version of Co>Operating System host connection:
1. Choose Run > Execute Command on the GDE menu bar or Press F8
The Execute Command dialog opens.
2. Type m_env -version (or m_env -v) in the dialog’s text box.
The version information appears on the Commands tab of the Application Output window.
Alternatively, choose Settings > Manage Connections on the GDE menu bar to display the Connections dialog. (If the version number is not displayed, click
Test Connection.)
Related topics
Using Ab Initio Help
Ab Initio documentation
Additional help sources
Ab Initio Online Discussion Browser

Pre N
viou e

GDE Help > Getting started with Ab Initio > Documentation conventions

Documentation conventions
Unless otherwise noted in the text, this help system uses the following documentation conventions:

Text conventions

Example Description
mainfile.txt Bold represents user-entered values, file paths, DML keywords, numerical or character values (such as abc or 1), as well as the names of
fields, functions, statements, and parameters.
File > Open Bold represents text that appears in the user interface – for example, “Choose the Open command from the File menu.”
AB_HOME Small caps represent names of configuration, environment, and system variables and names of components.
my_file Italic represents variables as well as emphasis, new terms, and book titles.

Code example conventions

Example Description
source code A fixed-width font represents code fragments, examples, and computer output.
user input A bold fixed-width font represents entries made by the user in an interactive command-line session.
An arrow indicates the result of a computation.
Squares indicate blank spaces where the number of spaces is significant.

DML syntax conventions

Example Description
integer Non-bold text indicates the DML data type of an argument or returned element.
read_xml Bold text, symbols, and punctuation represent syntactical elements that you must enter exactly as they are shown.
my_file Italicized text represents values or variables that you must supply.
... An ellipsis indicates that the preceding item can be repeated one or more times.
a|b|c A vertical bar (|), the logical or symbol, separates alternatives.
( ) Bold parentheses, square brackets, and curly braces are part of the syntax.
[ ]
{ }
[ ] Non-bold square brackets surround one optional item or a series of optional items. If optional items are separated by the logical or
symbol, you may choose one or none. If the or symbol is not present, you may choose as many as you want or none.
[ , argument1 Nested non-bold square brackets indicate nested optional arguments, each of which requires the preceding one. For example, if you want
[ , argument2 to include argument3 in a set of nested arguments, you must also include argument2 and argument1. Here’s how these appear in a line of
[, syntax:
argument3 ] ] ] [ , argument1 [ , argument2 [ , argument3 ] ] ]
{ } Non-bold curly braces indicate a series of choices from which you must select one.

Byte conventions

All -byte terms refer to powers of 2 rather than powers of 10.

Example Description

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 8 of 221

kilobyte (kB) kilobyte (abbreviated kB) represents 1,024 (2 to the 10th power) bytes.
megabyte (MB) megabyte (abbreviated MB) represents 1,048,576 (2 to the 20th power) bytes.
gigabyte (GB) gigabyte (abbreviated GB) represents 1,073,741,824 (2 to the 30th power) bytes.

Conventions for graphical representations of data

The following is an example of the graphical representation of data:

’J’ ’o’ ’h’ ’n’ ’4’ ’2’ ’ ’ ’ ’ ’ ’

The example represents a block of nine bytes. The bytes contain, in order, the native codes for the characters J, o, h, n, 4, 2, and three spaces. Note that:
Each cell represents a single byte of data.
Successive bytes run left to right.
The “first” byte in memory — the one with the lowest address — is leftmost.
Characters are shown in single quotes.
Unless otherwise specified, characters are in the native character set of the machine running the system.
Unless otherwise specified, numeric byte values are decimal.

Pre N
viou

GDE Help > Getting started with the GDE

Getting started with the GDE

The Ab Initio Graphical Development Environment (GDE) provides a graphical method for building business applications, allowing you to take massive
amounts of data from the widest array of sources and process it using any and all hardware resources available. The GDE gives you the power and flexibility
to quickly translate complex specifications into reality.
To familiarize yourself with the GDE before you start work, we strongly recommend that you first install and run the Graph Development Basics tutorial. To
launch the tutorial, choose Help > Tutorial > Graph Development Basics from the GDE menu bar. For instructions on obtaining the tutorial files, see
“Downloading and installing the tutorial”.
For help navigating the GDE, including a description of the GDE window, GDE editors, and other GUI elements, see “GDE UI appearance and behavior”.

Post-installation tasks

Before you can use the GDE, you must have a software activation key and you must have established a connection to a Co>Operating System. These should
already be in place if one of the following is true:
You successfully ran the GDE Setup Wizard to completion after installing the GDE for the first time (or afterward by selecting Help > Setup Wizard).
An Ab Initio administrator set up your GDE.
No further action is necessary to start using the GDE.
If you have not run the wizard to completion, or are an Ab Initio Administrator setting up a GDE, read the following topics to learn more about obtaining keys
and setting up Co>Operating System connections for your users:
Getting a software activation key
Configuring the host connection
Related topics
Starting the GDE
Learning about the GDE and the Co>Operating System

Pre N
viou e

GDE Help > Getting started with the GDE > Starting the GDE

Starting the GDE

You can start the GDE in any of the following ways:
From the Windows Start menu
From a desktop shortcut on your desktop
From the command line
Related topics
Learning about the GDE and the Co>Operating System
GDE UI appearance and behavior

Pre N
viou e

GDE Help > Getting started with the GDE > Starting the GDE > Starting the GDE from the Windows Start menu

Starting the GDE from the Windows Start menu

To start the GDE from the Windows Start menu:
Choose All Programs > Ab Initio > GDE x.xx.x.
Related topics
Starting the GDE from a desktop shortcut

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 9 of 221

Starting the GDE from the command line

Pre N
viou

GDE Help > Getting started with the GDE > Starting the GDE > Starting the GDE from a desktop shortcut

Starting the GDE from a desktop shortcut

You can start the GDE directly from your desktop by setting up and using a Windows shortcut.
To set up a shortcut to the GDE:
1. Right-click the Windows desktop and choose New > Shortcut from the pop-up menu.
2. In the Create Shortcut dialog, browse to the location of the GDE executable file (gde.exe). For example:
C:\Program Files\Ab Initio\Ab Initio GDE x.x.x\Program Files
3. Select gde.exe and click OK.
4. Click Next.
5. Type a descriptive name for the shortcut and click Finish.
NOTE: If you want the GDE to automatically open with a predefined workspace layout, set up a shortcut for the workspace layout. See “Starting the GDE
with a named workspace”.
To start the GDE from a desktop shortcut:
Double-click the shortcut icon.
Related topics
Starting the GDE from the Windows Start menu
Starting the GDE from the command line

Pre N
viou

GDE Help > Getting started with the GDE > Starting the GDE > Starting the GDE from the command line

Starting the GDE from the command line

You can start the GDE from the command line, using arguments that allow you to customize what the GDE does when it starts. For example, you can specify
that the GDE be launched in UTF-8 mode, or that it deploy all graphs in a directory at once (for example, to sync up the .mp files and .ksh scripts after a
promotion).
To start the GDE from the command line
Use:
path\gde.exe
where path specifies the path to the GDE executable.
For example:
C:\Program Files\Ab Initio\Ab Initio GDE 3.0.3\Program Files\gde.exe
Using arguments with the command, you can perform the following tasks from the command line:
NOTE: You can use either the forward slash (/) or the hyphen (-) to introduce the arguments. The examples below all use forward slash (/).

Task and argument Description

Open a specific graph: In the syntax:
[/host settingsfile] @filename settingsfile can be any of the names in the Host connections list in the Connections dialog.
filename is an absolute path.
The at-sign (@) is required for remote paths to differentiate them from command-line flags — local paths do not
require an at-sign.
Examples:
"./gde.exe" d:\emp\localgraph.mp

"./gde.exe" /host Normal \

@/disk1/data/sandbox/mp/remotegraph.mp
Deploy a specific graph: The deploy command opens the specified graph in the GDE from the local machine or given host, deploys the
/deploy [/host settingsfile] @filename graph, and then closes the GDE.
Example:
"./gde.exe" /deploy /host Normal \
@/disk1/data/sandbox/mp/remotegraph.mp
Save a specific graph: The saveas command opens the graph at srcpath for the specified host connection and then saves the graph to
/saveas @dstpath [/host settingsfile] dstpath using the given save format.
[/schema saveformat] @srcpath The supported save formats are 1.14, 1.15, 1.16, and LATEST. If a save format is omitted, LATEST is used by
NOTE: Older batch scripts may be default.
using Examples:
[/eme profilename]. With the "./gde.exe" /saveas \
introduction of the Application Hub, @/disk1/data/sandbox/mp/remotegraph.mp \
that argument is unnecessary, has /host Normal /schema 1.16 \
been deprecated, and will be ignored. @/disk1/data/sandbox/mp/remotegraph2.mp

"./gde.exe" /saveas \
@/disk1/data/sandbox/mp/remotegraph.mp \
/host Normal \
@/disk1/data/sandbox/mp/remotegraph.mp

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 10 of 221

Open the specified sandbox in the Example:

GDE and update all the graphs to use "C:\Program Files\Ab Initio\Ab Initio GDE \
the latest schema: \Program Files\gde.exe" \
/upgrade-sandbox @sandbox-path > /host Normal /upgrade-sandbox \
logfile @/disk1/data/sandbox > upgrade.log
This option is available in GDE Version 1.14 and later.
Prevent redeployment of scripts: Use in conjunction with the /upgrade-sandbox option. When this argument is used, the GDE saves only the .mp file
/no-redeploy and does not save a newly generated script in the run directory.
Example:
"C:\Program Files\Ab Initio\Ab Initio GDE \
1.16.1\Program Files\gde.exe" /host rs5 \
/upgrade-sandbox @/disk2/sand/lname/s1 \
/no-redeploy
This option is available in GDE Version 1.15.5 and later.
Prevent prompting for user input from Use in conjunction with the /upgrade-sandbox option. When this argument is invoked, the GDE runs in the
the output window: background and its output is displayed in a Windows command window. When the GDE completes its task, the
/no-ui-input output command window closes automatically, without prompting for a keystroke.
Example:
"C:\Program Files\Ab Initio\Ab Initio GDE \
1.16.1\Program Files\gde.exe" /host rs5 \
/upgrade-sandbox @/disk2/sand/lname/sand/s1 \
/no-ui-input
This option is available in GDE Version 1.15.5 and later.
Override the GDE’s AB_CHARSET The value of the AB_CHARSET configuration variable determines the character set of your Ab Initio application
default value metadata — including graph names, field names, DML comments, and more. Typically, your Ab Initio
/utf-8 administrator sets the value of this configuration variable in the Co>Operating System’s system configuration file.
/iso-8859-1 The value of AB_CHARSET for the GDE must match that of the Co>Operating System to which the GDE is
connected. For more information, see “Specifying language settings”.
NOTE: The GDE’s AB_CHARSET value has no effect on the language setting that you specify by choosing
Settings > Language from the GDE menu bar. AB_CHARSET governs the character set of your application
metadata, while the GDE Language setting determines the language of menus, menu options, and tooltips. For
more information about the GDE Language setting, see “Settings menu”. For more information about the
AB_CHARSET configuration variable, see “AB_CHARSET”.
Related topics
Starting the GDE from the Windows Start menu
Starting the GDE from a desktop shortcut

Pre N
viou

GDE Help > Getting started with the GDE > Learning about the GDE and the Co>Operating System

Learning about the GDE and the Co>Operating System

There are three online resources (in addition to this online help) for learning about the GDE and the Co>Operating System:
Graph Development Basics — Graph Development Basics is an interactive, multimedia tutorial. It introduces the GDE and guides you through building
graph applications.
To install Graph Development Basics and its supporting sandbox, see “Downloading and installing the tutorial” and the installation documentation distributed
with the tutorial. After the tutorial and sandbox are installed, you run it by choosing Help > Tutorial > Graph Development Basics from the GDE menu bar.
For more information about accessing example sandboxes, see “Installing examples”.
Work>Book 1 — Work through this book to review what you have learned in Graph Development Basics, reinforce your skills, and deepen your
understanding of Ab Initio software. Work>Book 1 contains example graphs and activities.
You can install a sandbox with graphs and other files used in Work>Book 1 activities. To install the associated sandbox, see “Installing examples”. Solution
graphs for the activities are provided in the sandbox. To request a copy of Work>Book 1 (either PDF or printed book), contact Ab Initio Support
(support@abinitio.com).
Ab Initio Online Discussion Browser — Use the Online Discussion Browser to access the Forum and discuss Ab Initio with other users and with Ab Initio
representatives. After you install the Online Discussion Browser, you can launch it by choosing Help > Online Discussion Browser from the GDE menu
bar.
Related topics
Getting started with the GDE
Examples
Ab Initio Online Discussion Browser

Pre N
viou e

GDE Help > Getting started with the GDE > Learning about the GDE and the Co>Operating System > Examples

Examples
Your Co>Operating System installation contains many sandbox examples, available through the GDE. The Graph Development Basics Tutorial Sandbox
supports the Graph Development Basics tutorial. Some of the examples (such as the Cook>Book recipes for solving a variety of problems) are documented in
Ab Initio Help. Other examples (illustrating certain Ab Initio capabilities and demonstrating how to use specific components) are self-documenting.
The set of examples available in your installation depends on your Co>Operating System version and patch level.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 11 of 221

Example Sandbox contents Where documented

Graph Development Basics Graphs and related files that are used in the tutorial exercises. Graph Development Basics
Tutorial Sandbox NOTE: To obtain the tutorial, contact Ab Initio
Support.

ASN.1 Graphs that demonstrate the use of Asn.1 Encoder and Asn.1 Self-documenting through graph labels, component
Decoder components. descriptions, and README files.
Basic Performance Sandbox Sequence of graphs that demonstrate various ways to improve Self-documenting through graph labels, component
performance. descriptions, and README files.
BRE Loader Example Graphs that demonstrate the use of the BRE LOADER “BRE LOADER”
component to generate rulesets for the Business Rules
Environment (BRE).
Component Errors and Logs Graphs that demonstrate error- and log-handling functions, “Error and log example graphs”
implicit flows, and escalation.
Continuous Flows Graphs that demonstrate basic and advanced uses of Self-documenting through graph labels, component
Continuous Flows. descriptions, and README files.
Sandbox includes examples of C++, C#.NET, Java, and
Python clients for the UNIVERSAL Subscribe, Universal
Publish, and Universal Adapter components.
Continuous Flows Course Graphs that demonstrate differences between batch and “From batch to continuous: An imaginary banking
continuous processing and demonstrate fundamental aspects of example”
Continuous Flows programming. “Exploring the graphs in the cflow sandbox”
Continuous Flows with Continuous graphs that use custom Java client code for the Self-documenting through graph labels, component
Custom Java Clients Universal Subscribe, Universal Publish, and Universal Adapter descriptions, and README files.
components. This example also includes supporting javadoc. That
documentation is not accessible through the GDE.
Instead, use your browser to open it at:
default directory\examples\continuous-flows\java-v2
\javadoc\index-files\index1.html.
Cook>Book Graphs that demonstrate how you can use Ab Initio software “Cook>Book”
to solve a wide variety of problems. The solutions range from
the very simple, where the emphasis is on the mechanics of
using the GDE, to the fairly complex, where the algorithms are
described in depth.
Data Manipulation Language Graphs that demonstrate DML data types, transforms, and Self-documenting through graph labels, component
other programming features, as well as common business tasks descriptions, and README files.
— in the following directories: See also “DML examples”.
base_types
business_tasks
compound_types
predefined_named_types
transforms
Data Obfuscation Graphs that demonstrate lookup-based and key-based “Data obfuscation”
obfuscation of several kinds of data fields typically found in
customer records.
Differencing Graph Graphs that compare two datasets that share the same record “Dynamic differencing graph”
format. The results are output in a generic format, and the
necessary metadata for the comparison is computed through
metaprogramming
Promotion script Shell script that promotes Ab Initio code from an Ab Initio Promotion Script Example PDF-based documentation
Environment to a different environment. Common use cases
are when your production environment is not accessible from
other environments or when your company standard requires
you to use a non-Ab Initio product for promotion. The script
can be used as is or you can adapt it for your specific
environment.
SFTP Multiple Files Multi_SFTP_From reusable subgraph and an example graph “SFTP Multiple Files”
that uses it to copy files from a remote machine that does not Self-documenting through graph labels.
have a Co>Operating System installed to a local machine that See also “SFTP FROM” and “SFTP TO”.
does.
Sandbox also includes an example graph that uses PDL and
the SFTP TO component to copy files to a remote machine
from a local machine. Both examples show how to specify a
Unix glob pattern for SFTP programs that don’t support
wildcard matching.
Tracking Graph, subgraphs, and examples that show how to write Self-documenting through graph labels and through Word
reports from raw tracking data, unload statistical data from the documents and release_notes.txt found in each sandbox’s
EME, and create a readable Excel spreadsheet from raw docs directory.
tracking data. See also “Tracking performance”.
Translate Components Examples using various components from the Translate folder Some examples are self-documenting through graph
in the Component Organizer. labels, component descriptions, and README files.
Web Services Web services graphs, reusable subgraphs, and micrographs “Ab Initio Web Services”
that demonstrate how to provide and call Web services to

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 12 of 221

communicate over the network with other graphs and

applications.
Work>Book 1 Solutions and graphs for Work>Book 1. Work>Book 1 (PDF or printed book)
XML Graphs that demonstrate Ab Initio XML processing “XML example graphs”
capabilities.
XML Case Study A graph and associated data for a practical XML processing “XML processing case study”
application.
Related topics
Installing examples
Working with examples

Pre N
viou

GDE Help > Getting started with the GDE > Learning about the GDE and the Co>Operating System > Installing and running examples

Installing and running examples

Depending on your Co>Operating System version and patch level, you will have a number of sandbox examples available to you. For instructions on using
these examples in the GDE, see:
Installing examples
Working with examples
For a list of all sandbox examples, see “Examples”.

Pre N
viou

GDE Help > Getting started with the GDE > Learning about the GDE and the Co>Operating System > Installing and running examples > Installing examples

Installing examples
The GDE installs these example sandboxes under the default directory you designated for the current host connection. If a graph is not currently open, the
GDE installs the example sandboxes under the default directory for the default run host.
Before installing, choose Settings > Manage Connections to verify that the run host and default directory are correct.
To install examples:
1. From the GDE menu bar, choose Help > Examples.
2. In the Install Examples dialog, select an example, or hold down the Shift key and click the right mouse button, or hold down the Ctrl key and click the
right mouse button to select multiple examples.
3. Verify that the displayed host connection and installation path to the default directory are correct.
If necessary, choose Settings > Manage Connections and click Edit to open the Host Connection Settings dialog to make changes.
4. Click Install.
5. On the Examples tab of the Application Output window, monitor the progress of the installation.
NOTE: You can click Cancel at any time to cancel the installation.
6. When the installation is complete, click Open Sandbox.
You are now ready to work with the example graphs.
Related topics
Examples
Working with examples

Pre N
viou e

GDE Help > Getting started with the GDE > Learning about the GDE and the Co>Operating System > Installing and running examples > Working with
examples

Working with examples

The graphs in the example sandboxes you install provide hands-on experience in solving a variety of problems. You can analyze the results of these graphs
and manipulate them to get a better understanding of their behavior. To make the most of these example graphs, see their supporting documentation, either the
internally supplied README files or the lessons provided in this online help.
To work with examples:
1. Choose Project > Open Sandbox from the GDE menu bar.
2. In the Open dialog, browse to and open the sandbox.
3. Examine the examples as follows:
In the Sandbox View, browse to the README files, which are available at the top level of the sandbox and in the mp directory.
From the mp directory, select and open the graphs. The graphs contain descriptive labels explaining their purpose.
Open the Properties dialog for each graph and for each of the components in the graph to review the Comments section, which describes their purpose
and provides other useful information.
For those examples that are described in the help, see the relevant help topics and follow the instructions.
4. Run the graphs and study their results.
5. Manipulate the graphs to better understand their behavior.
NOTE: To preserve an original graph, you may want to make a copy to manipulate.
Related topics
Examples

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 13 of 221

Installing examples

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior

GDE UI appearance and behavior

This section provides an overview of the GDE interface. The topics are as follows:
The GDE window
GDE editors
Visual cues
Customizing appearance and behavior

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > The GDE window

The GDE window

The GDE window is made up of several panes and toolbars, as shown in the following figure:
Screen capture showing the parts of the GDE window.

The different areas are as follows:

Workspace — Is the area in the GDE window below the toolbars in which canvases for graphs and plans are displayed, together with functional panes.
When open,
The Sandbox View and the Component Organizer appear on the right side of the GDE workspace.
The DML Operators and DML Functions panes can be placed on the left side of the GDE workspace.
The Application Output window appears at the bottom of the GDE workspace.
For more information, see “Using workspace layouts”.
Component Organizer — Stores all components, arranged by category (Compress, Continuous, Database, Datasets, and so on). For more information on
component groups, see “Overview of components by category”.
Component description pane — Provides a brief description of the selected component, such as its purpose and when it was introduced. For more
information, see “Component icons in graphs”.
Drawing canvas — Is the area where you draw your graph by adding components and connecting them with flows, or draw your plan by adding graphs
and subgraphs and connecting them with task relationships.
To change how these elements are displayed, use the options in the View category of the Graph Settings dialog and in the Preferences dialog. For more
information, see “Customizing appearance and behavior”.
GDE menu bar— Provides access to the GDE functionality through menu options. The GDE supports menu and keyboard shortcuts, as described in
“Keyboard and mouse shortcuts”.
GDE toolbar — Provides access to common GDE functionality through tools. The toolbar is made up of several individual toolbars:
Breakpoints toolbar — Displays tools for working with breakpoints when debugging transforms. For more information, see “Debugging transforms”.
Debug toolbar — Displays tools used during debugging. For more information, see “Debugging graphs”.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 14 of 221

Edit toolbar — Displays graph editing tools to let you, for example, display the outer frame or crop excess space; some of these are equivalent to options
in the Graph Settings dialog and the Preferences dialog.
Main toolbar — Displays common tools such as New, Open, and Save. For more information, see “Main toolbar”.
Phase toolbar — Displays tools used with phases and checkpoints. For more information, see “Phases and checkpoints”.
Run toolbar — Displays tools used when graphs are running. For more information, see “Running a graph or plan”.
Tool toolbar — Displays common display tools, such as the zoom tool and a tool to toggle the display of the Component Organizer.
Watchers toolbar — Displays tools for working with watchers when debugging data flows in a graph. For more information, see “Debugging data
flows”.
You can toggle the display of toolbars by choosing View > Toolbars and the toolbar you want to display or hide.
Sandbox View — Displays the current sandbox and its contents. A sandbox is a special directory (folder) containing a certain minimum number of specific
subdirectories for holding Ab Initio graphs and related files. For more information, see “Sandbox View”.
Status bar — Displays informational messages, the host connection, and the input values context. For more information, see “Input values context”.
Tab control — Enables you to easily switch between multiple drawing canvases that may be open in the GDE window. The following figure shows
multiple tabs for maximized graphs:
Screen capture showing tabs for multiple, maximized graphs

Related topics
Creating graphs and plans
Visual cues
Running graphs and plans
Customizing appearance and behavior
Using tab view
Saving and deploying graphs and plans

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > The GDE window > Main toolbar

Main toolbar
The GDE Main toolbar contains tools for the following commonly used menu options:

New — Opens a new graph or plan, depending on which option you select from the drop-down list.
Open — Displays the Open dialog, where you can select the graph or plan to open.
Save — Saves the graph with its current name and location.
Lock — Shows the locking status of the graph in the EME technical repository and, if it is not locked, lets you set the lock so you can edit it.
Check In — Checks in the current graph or plan.
Check Out — Checks out a graph or plan.
Validate — Tests the DML syntax of a transform or record format.
Analyze — Describes how a graph and its components transform and transfer data.
Grid/Text Views — Toggles between grid view and text view for the Record Format Editor and Transform Editor.
Print — Opens the Print dialog, where you can print the active record format.
Find Component — Opens the Find Component dialog, where you specify the name of the component you want to search for.
Undo — Reverses the effect of the last action.
Redo — Reverses the effect of the last Undo.
Help — Displays the online help for the selected item.

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > The GDE window > Main toolbar > Pop-up menu commands for graphs and
components

Pop-up menu commands for graphs and components

The possible commands, their descriptions, and the objects to which they apply are as follows:

Menu Object
Description
command
Cut Removes the selection and places it on the clipboard. Component
Subgraph
Copy Copies the selection and places it on the clipboard. Component
Graph
Paste Inserts the contents of the clipboard at the insertion point Component
Graph
Delete Deletes the selected item. Component
Subgraph
Parameters Opens a cascading menu that lists the parameters for the component. Click a parameter to open the corresponding editor Component

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 15 of 221

or dialog, where you can change the value of the selected parameter. Graph
Subgraph
Record Opens a cascading menu that lists the ports for the selected component. Click a port name to open the Record Format Component
Formats Editor, where you can change the record format Graph
Subgraph
EME Datasets Opens a submenu that lists the values of the EME dataset entries for the selected component or subgraph, as defined in Component
its eme_dataset_mapping parameter. Click a dataset in the submenu list to open the EME Dataset Dependencies dialog, Subgraph
which identifies all the components in all the graphs in your environment that are associated with the currently selected
logical dataset in the EME technical repository.
Disable (or Toggles between disabling and enabling the selected component. Use disabling to hide part of a graph at runtime. Component
Enable) Graph
Subgraph
Update Refreshes selected components. Use Update to reread a custom component after making changes, such as adding a port. Component
Subgraph
Validate Verifies the syntax and spelling in DML expressions you write Component
Graph
Subgraph
Find Lookup Searches for the lookup files specified in the graph, and displays the results. For more information on lookup files, see Component
Files “Processing lookup data” Graph
Subgraph
Isolate for If debugging is enabled, isolates a subset of a graph and lets you execute only that subset. For more information, see Component
Debugging “Using isolation mode”. Graph
NOTE: Disabled for graphs
Component Opens the source (.mdc or .mpc) file for the selected component in a text editor. Component
Source Subgraph
View Data Opens the View Data Options dialog, so you can specify which records you want to view, and how you want them Component
formatted. The GDE then displays the records in the View Data window. For detailed information, see “About viewing Graph
data in the GDE” Subgraph
NOTE: Disabled for graphs
View Data Opens the old-style View Data window (available in Co>Operating System versions earlier than Version 2.13). Use this Component
Unformatted option to view the raw, unformatted records in as dataset. For more information, see “View Data (Unformatted) dialog”. Graph
NOTE: Disabled for graphs Subgraph
Profile Dataset Analyzes and computes statistics for the dataset used by the selected input or output component, and then opens the Component
resulting profile in a browser window.
Cancel Profile Cancels the current dataset profile job for the selected input or output component. Component
Redisplay In a browser window, displays the most recent profile generated during this GDE session. Component
Dataset Profile
Record Format Opens the Record Format Editor, where you can edit the record format. Component
Tracking Opens the Tracking window, where you can view runtime information about the graph. Component
Details Subgraph
Tracking Detail Lists the ports for the selected component. Select a port to view its runtime information in the Tracking window. Component
for Port Subgraph
Subgraph Enables you to work with subgraphs. There are several options:
Open — Opens a subgraph in a new window. Component
Open Parent Graph — Opens the parent graph of the selected subgraph. Subgraph
Component
Create From Selection— Creates a subgraph from the selected components.
Graph
Expand— Removes a subgraph's contents, places them back in the graph, and deletes the empty subgraph Component
Create Flow Opens the Create Flow dialog, where you can choose the components and ports you want to connect with a flow. Component
Subgraph
Create Binding Opens the Create Binding dialog, where you can associate ports of components in a subgraph with ports of the subgraph Component
itself. Subgraph
Flow Direction Determines whether flows will be drawn vertically or horizontally. Component
Subgraph
Component Displays help for the selected object. Component
Help Subgraph
Properties Opens the Properties dialog for the object. Component
Graph
Subgraph

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > The GDE window > Main toolbar > Pop-up menu commands for flows and
watchers

Pop-up menu commands for flows and watchers

The possible menu commands, their descriptions, and the objects to which they apply are as follows:

Menu command Description Object

Straight Creates a straight flow, which connects components with the same depth of parallelism, including serial components, to Flow
each other. Watcher

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 16 of 221

Fan In Creates a fan-in flow, which connects a component with a greater depth of parallelism to one with a lesser depth (a Flow
many-to-one pattern). Watcher
Fan Out Creates a fan-out flow, which connects a component with a lesser number of partitions to one with a greater number of Flow
partitions (a one-to-many pattern). Watcher
All to All Creates an all-to-all flow, which connects components having m partitions to components having n partitions such that Flow
each output port partition is connected to each input port partition. Watcher
Auto Automatically creates the appropriate type of flow between components. Flow
Watcher
Two Stage Specifies whether to use two-stage routing, which saves network resources when an all-to-all flow connects components Flow
Routing with layouts containing large numbers of partitions. For more information, see “Setting two-stage routing”. Watcher
Buffered Specifies whether automatic flow buffering is on (default) or off. Flow
Watcher
Compressed Specifies whether the flow is compressed. Compressed flows compress and decompress the data on TCP/IP flows and Flow
flows to and from files. For more information, see “Compressing flows”. Watcher
Encrypted Specifies whether the flow is encrypted. For more information, see “Encrypting flows” Flow
Watcher
Add Watcher On Adds a watcher to the selected flows. A watcher shows the contents of a flow after a graph has run. Use it like a Flow
Flow temporary file to help debug your graph..
Remove Watcher Removes the selected watcher from the flows. Watcher
on Flow
Watcher is Phased Specifies whether the watcher will add phase breaks at run time. By default, the watcher is nonphased. Watcher
Delete Flow Deletes the selected flow. Flow
View Data Opens the View Data Options dialog, so you can specify which records you want to view, and how you want them Watcher
formatted. The GDE then displays the records in the View Data window. For detailed information, see “About viewing
data in the GDE”
View Data Opens the old-style View Data window (available in Co>Operating System versions earlier than Version 2.13). Use this Watcher
Unformatted option to view the raw, unformatted records in as dataset. For more information, see “View Data (Unformatted) dialog”.
Record Format Opens the Record Format Editor, where you can edit the record format. Flow
Watcher
Tracking Detail Opens the Tracking Flow window, where you can view runtime information about the selected flow. Flow
Watcher
Watcher Help Displays help for the selected watcher. Watcher
Related topics
The GDE window
Selecting and deselecting screen elements

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > The GDE window > Selecting and deselecting screen elements

Selecting and deselecting screen elements

To select screen elements on the canvas:

Element Action
Single element Click the element.
Press Tab to move clockwise to an element.
Press Shift+Tab to move counterclockwise to an element.
Range of elements Hold down the Shift key and click elements at both ends of the desired range.
Multiple elements Hold down the Ctrl key as you click the elements you want.
From the GDE menu bar, choose Edit > Select > Elements, select the elements you want, and click OK.
All elements at once Press Ctrl+A
From the GDE menu bar, choose Edit > Select > All.
The GDE uses different highlighting colors to distinguish between active and inactive selected elements. The GDE highlights a selected object using the
colors defined by the Selection and Selected text options in the Colors category of the Preferences dialog. If the canvas loses focus, the screen element is
highlighted with the colors defined by the Inactive selection and Inactive selected text options.
To deselect screen elements on the canvas:

Selected element Action

Single element Click elsewhere.
All elements at once Click elsewhere.
From the GDE menu bar, choose Edit > Select > None.
Related topics
Select Elements dialog
Selected text
Inactive selection

Pre N
viou

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 17 of 221

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > The GDE window > Displaying multiple canvases in tabbed view

Displaying multiple canvases in tabbed view

The GDE window provides a tab control that lets you easily switch between multiple drawing canvases.
To work with tabbed canvases:
1. Open two or more graphs or plans in the GDE window.
2. Maximize one of the drawing canvases containing a graph or plan, either by clicking the Maximize button or by double-clicking the title bar.
A tab control appears for each open drawing canvas. Tabs are displayed in the order in which the graphs were opened.
3. Click a tab to display the corresponding drawing canvas.
Related topics
Creating a new graph or plan
Using tab view

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > The GDE window > Adjusting the view of graphs and plans

Adjusting the view of graphs and plans

You can adjust the view of graphs and plans on the canvas by zooming in and out, and by panning.
To zoom in:
Select the graph or plan and press Ctrl+Plus key (+).
To zoom out:
Select the graph or plan and press Ctrl+Minus key (-).
To pan:
Select the graph or plan that is not fully visible on the GDE canvas and press Ctrl while moving the mouse in the direction you want the image to scroll.

Related topics
Shortcuts for navigating in the GDE

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > GDE editors

GDE editors
The main GDE editors are as follows:

Editor What you can do See

Parameters Editor View, add, edit, and override the parameters of: “Working with the Parameters
The current graph (including any subgraph or component in a graph), plans, and Editor”
sandboxes
The project containing the current graph
Any common projects that may be included
Input Values Editor Define and save sets of values for input parameters declared in a graph “Working with the Input Values
Editor”
Record Format Create and edit record formats using either a grid or text view “Creating a record format”
Editor “Record Format Editor”
Transform Editor Create and edit transforms using either a grid or text view “Creating transforms”
Expression Editor Create DML expressions for transform rules using a simple drag-and-drop technique “Editing rules”
Key Specifier Add or remove key fields, order key fields, or modify the sort sequence of a key specifier “Specifying a key”
Editor using an easy-to-use grid
SQL Editors Create and edit SQL statements that select, update, insert, or delete database records; create Creating and editing SQL statements
and drop database tables; and perform other SQL operations. with the SQL Editors
Package Editor Work with DML objects in a package by providing either a tree view of the package or a “Viewing packages”
text view of all objects contained in the package
GDE text editor and Edit scripts, configuration files, and other text files using a generalized text editor —
viewer

Managing editors in the GDE window

The Editors dialog enables you to activate and control the view of the Package Editor, the Record Format Editor, and the Transform Editor.
When building graphs, you may find yourself working simultaneously with multiple instances of the Package Editor, the Record Format Editor, and the
Transform Editor. These multiple editors are often stacked and hidden by one another. The Editors dialog lists all instances of these open editors and makes it
easy for you to select one from the list to bring it to the front of the GDE window. The following graphic shows the Editors dialog:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 18 of 221

Screen capture showing the Editors dialog listing the open editors.

To bring an open editor to the front of the GDE window:

1. From the Windows menu, choose Editors.
2. Select one of the editors from the list.
3. Click Activate.
The activated editor comes to the foreground of the GDE window.

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues

Visual cues
The GDE provides a variety of visual cues that help you design and test your graphs. The visual cues include the following:
Active and inactive elements
To-do cues
Component icons in graphs
LED status indicators
Flow symbols
Phase and checkpoint notations
Layout notations
Folded component group notations (Resolved Graph view only)
Transaction group notations (Resolved Graph view only)
Tooltips
Color coding in text editors
Menu icons

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Active and inactive elements

Active and inactive elements

The GDE uses different highlighting colors to distinguish between active and inactive elements selected in a graph.
The GDE highlights a selected object using the colors defined by the Selection and Selected text options in the Colors category of the Preferences dialog.
If the canvas loses focus, the screen element is highlighted with the colors defined by the Inactive selection and Inactive selected text options.
By default, both active and inactive elements are blue with black text, as shown here:
Screen
capture of the
active Filter by
Expression
You can customize the settings in the Colors category of the Preferences dialog, so that when you move focus from the canvas the inactive element might look
something like this:
Screen
capture of the
inactive Filter
by Expression

Acting on to-do cues

Before you start acting on to-do cues, connect all the flows in the graph. This will remove some of the to-do cues through propagation. Remove the remaining
to-do cues from the input and output dataset components first, then from the program components (working from the outside in).
Double-click a component with to-do cues to reach the Properties dialog for that component, or double-click the to-do cue directly and the GDE will take you
to the appropriate tab of the Properties dialog.
When the Properties dialog opens, the tab that contains the action item includes a question mark in its title bar. For example:
Screen capture of a to-do cue on a tab of the Properties dialog.

Related topics
Types of to-do cues
Showing and hiding to-do cues
Changing the color of to-do cues

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > To-do cues > Types of to-do cues

Types of to-do cues

The following table lists the different types of to-do cues and how to resolve them.

To-do cue Problem What to do

Layouts The component has no layout. For program components, layout is set Double-click the layout indicator and select the layouts
either by propagation or manually. you want.
Parameters or The component’s required parameters or file locations lack values. Double-click the square box and fill in the missing
file location parameters or file locations.
Port names The record format for the port is not set. Record formats are usually Connect the port to another port with a known record
propagated, but sometimes are set manually. format, or double-click the port and add the new record
format.
Ports The port needs at least one flow. Connect one or more flows to the port.
Flows You are trying to connect two components that require a fan-in or To remove this to-do cue, change the graph.
fan-out flow to connect them, and one of them does not support fan-in
or fan-out.

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > To-do cues > Showing and hiding to-do cues

Showing and hiding to-do cues

To show or hide to-do cues for the current graph:
1. From the GDE menu bar, choose Settings > Graph Settings. The Graph Settings dialog opens.
2. Select the View category.
3. In the Component display area, click the To-do cues checkbox to turn the display of to-do cues on or off. (By default, to-do cues are displayed.)
4. Click OK to apply your changes and close the dialog.
NOTE: To apply this setting to all new graphs that you create, choose Save all settings as customized defaults from the Defaults dropdown list.

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > To-do cues > Changing the color of to-do cues

Changing the color of to-do cues

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 20 of 221

By default, a to-do cue is displayed as a question mark in a yellow square. You can change the color of to-do cues using the To-do cue option in the Colors
category of the Preferences dialog.
For detailed information about changing colors of screen elements, see “Changing colors”.

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Component icons in graphs

Component icons in graphs

The GDE displays the following icons for the following parameters:
A key icon (if the component has a key parameter)
An In-memory icon (if the component has a sorted-input parameter)
Driving input icon for the driving parameter of the JOIN component

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Component icons in graphs > Key icon

Key icon
By default, the GDE displays a key icon in the lower-right corner of components that have a key parameter. When you let the mouse pointer hover over the
key icon, it displays the value of the key parameter — for example:
Screen capture of the key icon on a
component.

Toggling the display of key icons

To toggle the display of key icons:

1. From the GDE menu bar, choose Settings > Preferences. The Preferences dialog opens.
2. Click the Preferences: Appearance category.
3. In the Components area, click the Component key icon checkbox to turn the display of key icons on or off.
4. Click OK to apply your changes and close the dialog.
Related topics
Defining and using key fields
Key Specifier Editor

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Component icons in graphs > In-memory icon

In-memory icon
By default, the GDE displays the In-memory icon in components that have a sorted-input parameter. The In-memory icon appears in the upper-left corner of
the component and shows the setting for the sorted-input parameter, as follows:
Input must be sorted or grouped
In-memory: Input need not be sorted

Toggling the display of in-memory icons

To toggle the display of in-memory icons:

1. From the GDE menu bar, choose Settings > Preferences. The Preferences dialog opens.
2. Click the Preferences: Appearance category.
3. In the Components area, click the In memory icon checkbox to turn the display of In-memory icons on or off.
4. Click OK to apply your changes and close the dialog.

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Component icons in graphs > Driving input icon

Driving input icon

For the JOIN component, the driving input of an in-memory join is shown with a dot on the input port:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 21 of 221

Screen capture showing the driving input on an in-memory join.

For more information about driving input, see “driving”.

Related topics
About sorted input for JOIN
In memory: Input need not be sorted

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > LED status indicators

LED status indicators

For quick diagnosis of the pass/fail state of components and graphs, the GDE displays status indicators when you run a graph. The status is shown with
colored LEDs, as follows:

A white circle means unstarted (or unopened).

A gray circle means conditionalized out.
A green circle means running.
A blue circle means done (success).
A red circle means error.
Files normally start in an unopened state, progress to open, and end in a done state. Components, flows, and graphs normally begin in an unstarted state,
progress to running, and end in a done state. When abnormal events occur, components change to an error state.
If you let the mouse pointer hover over a red status indicator, the GDE displays the error message associated with the failure. If you double-click the red status
indicator, the Application Output window opens (displaying the complete error message in it).
For information on changing the color of LED status indicators, see “Preferences: Colors category”. To change their size, use the LED point size option.
Related topics
Running graphs and plans
Tracking running graphs and their parts
Troubleshooting

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Flow symbols

Flow symbols
A symbol on a flow indicates that it connects a parallel component and a serial component. The following are the four types of flows that can occur, and the
symbols that denote them:
This symbol indicates a straight flow.
This symbol indicates a fan-out flow.
This symbol indicates a fan-in flow.
This symbol indicates an all-to-all flow.
In addition, there are icons to indicate whether a flow is encrypted, compressed, has component folding disabled, or is using flow buffering. Hovering over the
flow also shows this information.
The icons are as follows:
This symbol indicates a compressed flow.
This symbol indicates an encrypted flow.
This symbol indicates a flow that has component folding disabled.
This symbol indicates a flow buffer.
Related topics
Types of flows
Displaying flow pattern symbols
Compressing flows
Encrypting flows
Using component folding

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Phase and checkpoint notations

Phase and checkpoint notations

The following diagram shows a graph that is divided into three phases (0, 1, and 2):

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 22 of 221

Screen capture of a graph with three phases.

The following table shows how phase breaks and numbers are displayed in the GDE.

Visual cue Description

A white phase number against a blue background denotes a phase that has a checkpoint at its downstream boundary.
A blue phase number against a white background denotes a phase that does not have a checkpoint.
A range of white phase numbers against a blue background appears in the following two cases:
A file component accessed by more than one phase, where at least one of the components in any of the phases contains a checkpoint.
A subgraph containing multiple phases, where at least one of the components in the subgraph contains a checkpoint.
A range of blue phase numbers against a white background appears in the following two cases:
A file component accessed by more than one phase, where none of the components in any of the phases contains a checkpoint.
A subgraph containing multiple phases, where none of the components in the subgraph contains a checkpoint.
A blue bar across a flow indicates a phase break that is a checkpoint.
An unfilled blue bar across a flow indicates a phase break that is not a checkpoint.
NOTE: To change the color of a phase break, use the Watcher field in the Colors category of the Preferences dialog.

Toggling the display of phase breaks

To toggle the display of phase breaks:

1. From the GDE menu bar, choose Settings > Graph Settings.
2. Click the View category.
3. In the Graph display area, click the Phase breaks checkbox to turn the display of phase breaks on or off. (By default, phase breaks are displayed.)
4. Click OK to apply your changes and close the dialog.
Related topics
Setting phases and checkpoints
What is a phase?
What is a checkpoint?
Viewing phases

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Layout notations

Layout notations
In the GDE, you set a component’s layout on the Layout tab of its Properties dialog. If you look at a graph, on each component you will see that there is either
a solitary number or an L followed by a number (with or without an asterisk). For example:
Screen capture showing layout notations on components.

The following table explains these layout notations:

Notation Example Meaning

Number 1 The specified number is the depth of parallelism. For example, if it is 1, the component will run serially, if it is
2, it will run two-ways parallel, and so on.
L followed by a number L1 The depth of parallelism is calculated at runtime.
L followed by a number and L1* The layout is propagated from another component. The source of the layout is the nearest component that does
an asterisk not have an asterisk in its layout indicator.

Toggling the display of layout information

To toggle the display of layout information:

1. From the GDE menu bar, choose Settings > Graph Settings.
2. Click the Graph category.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 23 of 221

3. In the Component display area, click the Layouts checkbox to turn the display of layouts on or off. (By default, layouts are displayed.)
4. Click OK to apply your changes and close the dialog.
Related topics
Layout
Layouts of dataset components
Layouts of program components
Parallel processing

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Folded component group notations

Folded component group notations

These cues are visible only in the Resolved Graph view.
The following diagram shows a graph whose components have been folded into two groups (1 and 2):
Screen capture showing the numerals one and two placed to the right of folded components.

The following table shows how folded component group numbers are displayed in the GDE. It describes the default colors. You can change the colors under
Settings > Preferences > Colors category.

Visual
Description
cue
A white number against a green background denotes components belonging to a single folded component group. The Co>Operating System
automatically groups these components into a single process to improve performance at runtime.
Comma-separated white numbers against a green background denote two or more folded component groups, as can occur within a subgraph.
Unlike phase numbers, which are separated by a hyphen, fold group numbers do not indicate a range or a sequential order.
Related topics
Using component folding
Visual cues
Appearance of resolved graphs
Resolved Graph view

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Transaction group notations

Transaction group notations

These cues are visible only in the Resolved Graph view.
The following diagram shows a graph whose transactional components have been organized into two groups, each of which will be treated as a single unit
(Branch transaction group and Bank transaction group):
Screen capture showing transaction group labels placed near the upper left corner of the grouped components.

Comma-separated white transaction group name cues against a green background indicate two or more transaction groups as can occur within a subgraph.
The default colors are shown. You can change the colors under Settings > Preferences > Colors category.
Related topics
Transactional graphs
Visual cues
Appearance of resolved graphs
Resolved Graph view

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Tooltips

Tooltips
The GDE displays information in tooltips for the following component elements:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 24 of 221

Component information
Parameter and layout information
Port information

Component information

If you have customized the component name, you can see the default component name by letting the mouse pointer hover over a component in a graph. For
example:
Screen capture showing
the component default
name in a tooltip.

If you have customized the description of the component in the Comment field of the Properties dialog, the tooltip displays the customized description. For
example:
Screen capture showing the component custiomized description in a tooltip.

Parameter and layout information

The GDE also displays informational text if you let the mouse pointer hover over a parameter or layout.

Port information

If you let the mouse pointer hover over a component port in a graph, the GDE displays a tooltip with the relevant information for that port, including:
Its name
The URL for the file that contains the record format, or (for embedded record formats) the record format itself
Where the record format is propagated from
The following figure shows a tooltip for an out port:
Screen capture of record format
information displayed in a pop-up.

Related topics
Toggling the display of tooltips
Tooltip display speed and duration
About record formats
Record Format Editor

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Tooltips > Toggling the display of tooltips

Toggling the display of tooltips

You can control whether the GDE displays informational pop-up text (tooltips) for items such as components, parameters, and record formats.
To toggle the display of tooltips:
1. From the GDE menu bar, choose Settings > Preferences. The Preferences dialog opens.
2. Click the Preferences: Workspace category.
3. In the Mouse behavior area, click the Show text on hover checkbox to turn the display of pop-up text on or off.
4. Click OK to apply your changes and close the dialog.
Related topics
Tooltips
Tooltip display speed and duration

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Tooltips > Tooltip display speed and duration

Tooltip display speed and duration

Two additional settings in the Preferences: Workspace category control the tooltip display:
Delay — Specifies how long to wait before displaying the tooltip. The valid range is 0 to 5 seconds; the default is 1.
Duration — Specifies how long to display the tooltip. The valid range is 2 to 30 seconds; the default is 20.
Related topics
Tooltips

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 25 of 221

Toggling the display of tooltips

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Color coding in text editors

Color coding in text editors

By default, the GDE text editors use color to distinguish between different types of text, as follows:
Black — Normal text
Green — Comments
Red — Quoted strings
Blue — Keywords (like begin and end)
In addition to improving the readability of the text, color coding provides a level of error checking. For example, if you are typing a string and forget to add
the end quote, all subsequent text will be red — showing you that there is a problem.
Text view of Transform Editor showing colored text for comment, keyword, normal text, and
quoted string

Related topics
Text editor line numbers
Text editor margin
Changing colors

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Visual cues > Menu icons

Menu icons
GDE menu options include their corresponding toolbar icons. For example:
Screen capture
showing a GDE
menu with the
corresponding tool
icons.

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 26 of 221

Customizing appearance and behavior

This section includes the following topics:
Configuring the GDE
Adjusting graph settings
Adding legends and labels to graphs and plans
Displaying multiple graphs

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Configuring the GDE

Configuring the GDE

You can configure the GDE to suit your needs. The Preferences dialog enables you to adjust settings universally for all graphs and plans.
This section includes the following topics:
Using the Preferences dialog
Changing colors
Creating a new color theme
Deleting a color theme
Changing fonts and font sizes
Changing the display of text editors
Using bookmarks in text editors

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Configuring the GDE > Using the
Preferences dialog

Using the Preferences dialog

Using the Preferences dialog, you can specify:
General preferences — These settings include the default Host connection location, the display of messages, and the behavior if a recovery file is found.
Editor preferences — These settings include whether text editors highlight syntax and show line numbers, whitespace, or bookmarks. These settings also
control the display of tabs in text editors, and can define the path to an external text editor.
Appearance preferences — These settings include line thickness, whether the key and In-memory icons are displayed on components, and whether
selected components are highlighted with outlining or flood fill.
Workspace preferences — These settings include zoom level, trim of excess whitespace, restoration of the last workspace layout, docking the Application
Output window, frequency of autosave, maximum number of redo or undo operations, mouse behavior, and restoration of dialog and toolbar positions.
Font/sizes preferences — These settings include the default font used in the GDE drawing canvas, the grid and text view editors, the Application Output
window, the Sandbox View and the Component Organizer, as well as the point size of labels and layouts for components and ports.
Color preferences — These settings include the background color of the drawing canvas and the colors, highlights, and shadows used to identify the
various objects, lines, and other elements that appear on the canvas. These settings also enable you to create customized color themes which apply to all
graphs and plans.
Debug preferences — These settings include options for enabling the breakpoints and watchers separately, for showing the Breakpoints Reached window.
The settings also enable you to customize the use of watchers to query watchers only on failure, default to phased watchers, and to restrict access of the
watcher dataset to the owner.
Advanced preferences — These settings include options for validating DML, enabling the use of conditional components and documentation transforms,
resolving parameters asynchronously, and reporting dependency analysis problems before the file is checked in to the EME technical repository.
To return all options for the current category to their default settings:
Click Defaults > Reset category preferences.
To return preferences for all categories to their default settings:
Click Defaults > Reset all preferences.
NOTE: If you make changes in the Preferences dialog and close it by clicking the X in the upper-right corner instead of clicking OK, the GDE displays a
confirmation box asking whether you want to save your changes.
Related topics
Configuring the GDE
Changing colors
Creating a new color theme
Deleting a color theme
Changing fonts and font sizes
Changing the display of text editors
Using bookmarks in text editors

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Configuring the GDE > Changing
colors

Changing colors
To change colors in a graph or plan:
1. From the GDE menu bar, choose Settings > Preferences. The Preferences dialog opens.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 27 of 221

2. Select the Colors category.

3. From the Theme area drop-down list, select Custom.
4. Click the down arrow next to the screen element whose color you want to change. The color palette opens.
The Colors page of the Preferences dialog

5. Click the new color you want for the screen element.
6. Click OK to save your changes.
Related topics
Configuring the GDE
Using the Preferences dialog
Creating a new color theme
Deleting a color theme
Changing fonts and font sizes
Changing the display of text editors
Using bookmarks in text editors

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Configuring the GDE > Creating a
new color theme

Creating a new color theme

To create a new color theme:
1. From the GDE menu bar, choose Settings > Preferences. The Preferences dialog opens.
2. Select the Colors category.
3. From the Theme drop-down list, select Custom.
4. Select the colors you want and click Save As. The Save As New Color Theme dialog opens.
5. In the Theme Name box, type a unique name for the new color theme, and click OK.
The new color scheme is now available from the Theme drop-down list.
Related topics
Configuring the GDE
Using the Preferences dialog
Changing colors
Deleting a color theme
Changing fonts and font sizes
Changing the display of text editors
Using bookmarks in text editors

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Configuring the GDE > Deleting a
color theme

Deleting a color theme

To delete a color theme:
1. From the GDE menu bar, choose Settings > Preferences. The Preferences dialog opens.
2. Select the Colors category.
3. From the Theme area drop-down list, select the color theme you want to delete.
4. Click Delete.
5. When prompted to confirm the deletion, click OK.
Related topics
Configuring the GDE
Using the Preferences dialog
Changing colors
Creating a new color theme

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 28 of 221

Changing fonts and font sizes

Changing the display of text editors
Using bookmarks in text editors

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Configuring the GDE > Changing
fonts and font sizes

Changing fonts and font sizes

To change fonts and font sizes:
1. From the GDE menu bar, choose Settings > Preferences. The Preferences dialog opens.
2. Select the Fonts/Sizes category.
3. Using the up and down arrows, change the point size of the screen element you want to enlarge or make smaller.
4. Click OK.
Related topics
Configuring the GDE
Using the Preferences dialog
Changing colors
Creating a new color theme
Deleting a color theme
Changing the display of text editors
Using bookmarks in text editors

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Configuring the GDE > Changing
the display of text editors

Changing the display of text editors

You can easily configure GDE text editors using the options in the Preferences dialog.
For example, you can make changes such as the following in the text editors, as described in the procedure below:
Change the font to Times New Roman
Disable auto indenting
Change the color of line numbers to orange
To change fonts, auto indenting, and color in text editors:
1. From the GDE menu bar, choose Settings > Preferences. The Preferences dialog opens.
2. Select the Fonts/Sizes category.
3. Click the large button labeled Change font for Grid and Text View editors, and the Application Output window. The Font dialog appears.
4. In the Font area, scroll down from Courier (the default) to Times New Roman and select it.
5. Click OK to close the Font dialog. You are returned to the Preferences dialog: Font/Sizes category.
6. Select the Editor category.
7. To disable autoindenting, in the Text View editor area find the Auto indent radio buttons and click None.
8. Select the Colors category.
9. Using the scrollbar, scroll to the Text editor line numbers option.
10. Click the down arrow by the option to open the color palette, then click the orange square.
11. Click OK to apply your changes and close the dialog.
NOTE: To return all options to their default settings, click the Defaults drop-down list, and select Reset all preferences to defaults.
Related topics
Configuring the GDE
Using the Preferences dialog
Changing colors
Creating a new color theme
Deleting a color theme
Changing fonts and font sizes
Using bookmarks in text editors

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Configuring the GDE > Using
bookmarks in text editors

Using bookmarks in text editors

By default, the GDE text editor enables you to insert a bookmark in the left margin. Bookmarks enable you to denote lines of code that are of interest to
you, and enable you to move quickly from one bookmark to another.
For information on toggling the display of bookmarks, see “Show bookmarks”.
To insert or remove a bookmark:
1. While in a GDE text editor (for example, text view of the Record Format Editor), place the text cursor in a line.
2. Do one of the following:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 29 of 221

Right-click to display the pop-up menu, then choose Set/Clear Bookmark.

Press Ctrl+F2.
3. Repeat these two steps for each line where you want a bookmark to appear.
To move from one bookmark to the next:
Press F2 to move forward.
Press Shift+F2 to move backward.
Related topics
Configuring the GDE
Using the Preferences dialog
Changing colors
Creating a new color theme
Deleting a color theme
Changing fonts and font sizes
Changing the display of text editors

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Adjusting graph settings

Adjusting graph settings

The Graph Settings dialog enables you to adjust settings for a particular graph, or to save customized settings that will apply to graphs that you subsequently
create.
NOTE: With few exceptions, settings made in the Graph Settings dialog affect the current graph only.
This section includes the following topics:
Using the Graph Settings dialog
Displaying flow pattern symbols
Displaying the outer frame of a graph
Displaying or hiding optional ports

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Adjusting graph settings > Using
the Graph Settings dialog

Using the Graph Settings dialog

Using the Graph Settings dialog, you can specify:
Script settings — These settings include whether or not to remove proxy files after the graph is run, enable context-specific error messages, check shell-
interpreted parameters, save scripts when graphs are saved, display the commands from the script or warning messages in the Application Output window,
run the host setup and host cleanup scripts, fold components, use legacy default error and log record formats. They also include the method of script
generation.
Tracking settings — These settings include the GDE tracking interval, the deployed tracking interval, the display of tracking reports in the Application
Output window, the storage of tracking data in the EME technical repository, and the saving of tracking data for replay.
Dependency analysis setting — This setting controls the level of dependency analysis performed on the graph at checkin.
Catalog settings — These settings include the shared catalogs and lookup files the graph will use, the path to the shared catalog, and the use of
parameterized URLs for data and record formats.
Run Mode setting — This setting enhances graph validation and determines if and how a failed job can be recovered. The setting tells the Co>Operating
System how to run the graph and helps the GDE better interpret the graph during validation.
View settings — These settings include the display of to-do cues, optional ports, layouts, propagation markers, the outer frame of a graph, phase break
markers, flow pattern symbols, port names, and tracking data.
Related topics
Adjusting graph settings
Displaying flow pattern symbols
Displaying the outer frame of a graph
Displaying or hiding optional ports

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Adjusting graph settings >
Displaying flow pattern symbols

Displaying flow pattern symbols

Flow pattern symbols indicate the type of flow connections between components. You can specify when to include pattern symbols on flows, as follows:
If fanning — Show flow pattern symbols on all fan-in , fan-out , and all-to-all flows in a graph.
Always — Show flow pattern symbols on all flows in a graph.
Never — Hide all flow pattern symbols on all flows in a graph.
To have the GDE display all flow pattern symbols in a graph:
1. From the GDE menu bar, choose Settings > Graph Settings.
The Graph Settings dialog opens.
2. Select the View category.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 30 of 221

3. Under the View flow patterns area, select Always.

4. Click OK to close the dialog.
NOTE: With few exceptions, settings made in the Graph Settings dialog affect the current graph only.
Related topics
Adjusting graph settings
Flow pattern line
Flow symbols
Types of flows

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Adjusting graph settings >
Displaying the outer frame of a graph

Displaying the outer frame of a graph

By default, the outer frame of a graph is not displayed.
To display the outer frame of a graph:
From the GDE menu bar, choose View > Outer Frame.
Alternatively:
1. From the GDE menu bar, choose Settings > Graph Settings.
The Graph Settings dialog opens.
2. Select the View category.
3. In the Graph display area, select Outer frame.
4. Click OK to close the dialog.
NOTE: With few exceptions, settings made in the Graph Settings dialog affect the current graph only.
The following figure shows a graph with an outer frame:
Screen capture showing the outer frame of a graph.

Related topics
Adjusting graph settings
Using the Graph Settings dialog
Displaying flow pattern symbols
Displaying or hiding optional ports

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Adjusting graph settings >
Displaying or hiding optional ports

Displaying or hiding optional ports

Many components include optional ports. By default, optional ports are displayed — for example, the JOIN component:
Screen capture of the Join component with optional ports
displayed.

If components in your graph have optional ports that you are not using, you can increase the readability of your graph by hiding them. For example, the
following figure shows the Join component with the optional ports hidden:
Screen capture of
the Join
component with
optional ports
hidden.

To toggle the display of optional ports on all components in a graph, do either of the following:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 31 of 221

On the GDE main toolbar, click .

From the GDE menu bar:
a. Choose Settings > Graph Settings.
The Graph Settings dialog opens.
b. Select the View category.
c. In the Component display area, select Optional ports.
d. Click OK to close the dialog.
NOTE: With few exceptions, settings made on the Graph Settings dialog affect the current graph only.
Related topics
Adjusting graph settings
Displaying flow pattern symbols
Displaying the outer frame of a graph

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Adding legends and labels to graphs
and plans

Adding legends and labels to graphs and plans

You can add legends (comments) to graphs, or change the graphs’ names and corresponding labels to make them more meaningful. This section includes the
following topics:
Adding legends to a graph or plan
Renaming a graph or plan

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Adding legends and labels to graphs
and plans > Adding legends to a graph or plan

Adding legends to a graph or plan

The procedures below describe how to:
Add a legend
Move a legend
Edit a legend
Change the font, font size, or color of a legend
To add a legend to a graph or plan:
1. Do one of the following:
On the GDE main toolbar, click .
From the GDE menu bar, choose Insert > Legend.
In the GDE, press Alt+I, G.
2. Click the spot in the graph where you want to add a comment or title.
Screen capture of the
legend text box.

NOTE: If you used the keyboard shortcut to add the legend, the text box appears at the top center of the graph. You can move the legend after you create it.
3. Type the text, then click outside the box.
To move a legend:
1. Select the legend.
2. Do one of the following:
Drag it to a new location
Use the up, down, left, right arrow keys to move it to a new location
To edit a legend:
1. Select the legend and then click it or press Enter.
2. Make your changes to the text, then click outside the box, or press Esc.
To change the font type, size, or color of a legend:
Do one of the following to open the Font dialog:
Double-click the legend.
Press Alt+Enter.
For instructions on using the Font dialog, see “Changing colors”.
Related topics
Selecting and deselecting screen elements
Keyboard and mouse shortcuts

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Adding legends and labels to graphs
and plans > Renaming a graph or plan

Renaming a graph or plan

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 32 of 221

The default naming convention for graphs is Graph1, Graph2, Graph3, or Plan1, Plan2, Plan3, and so on. The name appears in the title bar of the graph
window. In addition, the name of the selected graph or plan appears in the title bar of the GDE window.
When you save a graph, the Co>Operating System appends an .mp extension to the name. When you save a plan, the Co>Operating System appends a .plan
extension to the name.
The corresponding label for a graph or a plan appears within the outer frame of the graph when you select Outer frame in the Graph display area of the View
category of the Graph Settings dialog. The label does not include the appended extension.
To rename the current graph or plan:
1. From the GDE menu bar, choose File > Save As.
2. In the File name box, type a new filename.
3. Click Save.
Related topics
Adding legends and labels to graphs and plans

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Displaying multiple graphs

Displaying multiple graphs

You can control the view of multiple graphs in the GDE window, improving efficiency, productivity, and ease of use. The following sections describe the
available methods.
Using tab view
Using workspace layouts

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Displaying multiple graphs > Using
tab view

Using tab view

The GDE window provides a tab view that lets you switch between multiple drawing canvases that are open in the GDE window. The tabbed canvases can
contain a graph or subgraph, or a plan or subplan. You can also organize tabs into groups associated with vertical or horizontal panes you create within the
GDE canvas. These physical groupings can be saved as workspace layouts that you can open in a later GDE session.
The following graphic shows multiple tabs for maximized graphs:
Screen capture showing tabs for multiple, maximized graphs

To create tabbed graphs or plans:

1. Open two or more graphs (or plans) in the GDE window.
2. Maximize one of the drawing canvases containing a graph or plan, either by clicking the Maximize button or by double-clicking the title bar.
A tab control appears for each open drawing canvas. Tabs are displayed in the order in which the graphs were opened.
3. Click a tab to display that drawing canvas and graph or plan in the foreground.
To restore the original (untabbed) appearance of your workspace:
Click the Restore Window button .
NOTE: For information on first saving a tabbed view, see the procedure below about saving the tab groups and their panes as a workspace layout.

Tab view buttons

You can use several buttons to navigate between and work with multiple drawing canvases. These buttons appear to the right of the tabs when more graphs are
open than can fit visibly in the space you have allotted for your graphs. (If you resize your graph, the buttons will appear or disappear as required.) The
buttons are:
Screen capture showing Scroll Left, Scroll Right,
Active Files, and Close buttons for tab controls.

The GDE displays a Tab Menu button when more than one drawing canvas is open. It displays a list of names for the open tabs. A bar appears at the top of the
button when one or more of the tabs are hidden from display.
The GDE displays scroll buttons to the immediate right of the row of tabs. A solid scroll button means you can scroll in the direction indicated. A hollow
scroll button means you are at the end of the tabs for the direction indicated.
To access a particular tab:
1. Left-click the Tab Menu icon to display the pop-up menu of open graphs or plans:
Screen capture
showing the pop-
up menu for the
tabs in the GDE
window

2. From the menu, choose the name of the graph or plan you want to switch to.
To navigate between multiple or partially hidden tabs:
Click the solid left scroll button to scroll left.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 33 of 221

Click the solid right scroll button to scroll right.

To close a particular tab:
Do one of the following:
Click the Close button on the tab.
Right-click the tab and select Close from the menu.
If the middle mouse button is enabled, place the cursor on the tab and middle-click it.
To close all tabs in a group:
1. Right-click the tab that you want to remain open.
2. Select Close All But This from the menu:
Screen capture showing the
"Close All But This" pop-up
menu command

Tab groups

Tab groups let you divide the canvas into two or more panes where you can group and organize your open tabs. Each pane has its own set of tab control
buttons.
To create a tab group and pane:
1. Left-click the tab that you want to be in your new group, hold the left-mouse button down and drag the pointer on to the canvas. A document icon appears
behind the mouse pointer.
2. Release the mouse button to display the tab group menu:
Screen capture showing the
tab group menu

3. Choose New Horizontal Tab Group or New Vertical Tab Group, depending on which group layout you want to create.
4. Once the panes are created, you can resize them or scroll through them like any other pane.
To move a tab to a different group:
Click the tab you want to move, and drag it to the row of tabs in the group you want to move it to.
To move a tab and add it to a new group:
1. Left-click the tab that you want to move to a new or different group, hold the left-mouse button down and drag the pointer onto a pane. A document icon
appears behind the mouse pointer.
2. Release the mouse button to display the tab group menu. The menu commands you see depend on the format of your existing panes:
Screen capture show pop-
up menu to move a tab and
add it to a new group

3. Choose one of the following:

New Vertical Tab Group — To create a new group for the tab.
Move to Next Tab Group — To move the tab to the next visible group.
To save the tab groups and their panes as a workspace layout:
1. Choose Window > Save Workspace Layout.
2. Enter a name in the dialog and click OK. For more information on creating and using workspace layouts, see “Using workspace layouts”.
To close a tab group pane:
Do one of the following:
Close each tab individually.
Click the Close button repeatedly until all tabs are closed.
Related topics
Using workspace layouts
Shortcuts for navigating in the GDE

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Displaying multiple graphs > Using
workspace layouts

Using workspace layouts

This section contains the following topics:
About workspace layouts
Retrieving the last workspace layout
Saving a workspace layout
Loading a workspace layout
Starting the GDE with a named workspace
Renaming a workspace layout
Redefining a workspace layout
Deleting a workspace layout

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Displaying multiple graphs > Using

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 34 of 221

workspace layouts > About workspace layouts

About workspace layouts

A workspace layout is the configuration of non-maximized canvases containing graphs and plans displayed in the GDE workspace.
Screen capture showing the workspace layout in the GDE window .

You can improve efficiency when designing graphs and plans by:
Opening the GDE automatically with its last saved workspace layout
Saving the arrangement of your open graphs and plans, their non-maximized positions, and their zoom values as a named workspace layout, which you can
later select and reopen
NOTE: Graphs and plans must have already been saved before they can be saved in a workspace layout.
A workspace layout can include multiple saved graphs and plans. However, it does not include subgraphs. Any subgraph displayed in its own window is
ignored. Also, multiple windows containing the same document are not supported. Only one instance of the document window is stored in the workspace
layout.
Saved workspace layouts are listed in the Workspace Layouts dialog:
Screen capture showing the expanded list of
workspace layouts

By default, the dialog provides a collapsed view of all existing workspace layouts. When a workspace layout entry is expanded, all of the documents in the
workspace layout are listed, together with their host connection. Workspace layouts can be renamed, redefined, or deleted.
The first workspace layout listed in the dialog is the Default layout. This is the workspace layout stored when the GDE is closed, if the Remember last
workspace layout preference is selected. It is the workspace layout that will open the next time the GDE is started. The Default layout cannot be deleted or
renamed.
Related topics
Retrieving the last workspace layout
Saving a workspace layout
Loading a workspace layout
Starting the GDE with a named workspace
Renaming a workspace layout
Redefining a workspace layout
Deleting a workspace layout
Using tab view

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Displaying multiple graphs > Using
workspace layouts > Retrieving the last workspace layout

Retrieving the last workspace layout

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 35 of 221

You can configure the GDE to open with the last workspace layout displayed by the GDE.
To configure the GDE to retrieve the last workspace layout:
1. From the GDE menu bar, choose Settings > Preferences. The Preferences dialog opens.
2. Select the Workspace category and select the Remember last workspace layout checkbox.
3. Click OK to close the dialog.
When the GDE is next opened, the workspace layout is automatically displayed.
Related topics
About workspace layouts
Saving a workspace layout
Loading a workspace layout
Starting the GDE with a named workspace
Renaming a workspace layout
Redefining a workspace layout
Deleting a workspace layout

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Displaying multiple graphs > Using
workspace layouts > Saving a workspace layout

Saving a workspace layout

You can name and save any number of workspace layouts.
To save a workspace layout:
1. Arrange graphs and plans as you want them in the GDE workspace. Confirm that each is saved.
2. From the GDE menu bar, choose Window > Save Workspace Layout. The Save Workspace Layout dialog opens.
Screen capture showing the Save Workspace
Layout dialog

3. In the Layout name box, do either of the following:

Type a unique, descriptive name for the workspace layout.
Select the name of an existing workspace layout from the drop-down list. You can modify this name or reuse it. If you choose to reuse it, the GDE
prompts to verify that you want to overwrite the existing layout of the same name.
4. Click OK to close the dialog.
Related topics
About workspace layouts
Retrieving the last workspace layout
Loading a workspace layout
Starting the GDE with a named workspace
Renaming a workspace layout
Redefining a workspace layout
Deleting a workspace layout

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Displaying multiple graphs > Using
workspace layouts > Loading a workspace layout

Loading a workspace layout

You can load saved workspace layouts into the GDE workspace. Opening a workspace layout also opens any corresponding sandboxes in the Sandbox View.
To use a workspace layout effectively, we recommend that you load it into an empty GDE workspace. However, you are not prevented from loading a
workspace layout into a workspace containing open graphs or plans. In this case, loading a saved workspace layout will open its documents in addition to
those already displayed. If any previously open plan or graph is also included in the workspace layout, it will be resized and positioned to fit that layout. Other
documents will remain open, but will be moved behind the loaded workspace layout.
If errors occur during opening, they are reported and must be resolved before opening can proceed. If a graph or plan cannot be opened, processing proceeds
to the next document in the list.
To load a saved workspace layout:
1. Close any open graphs, subgraphs, or plans in the GDE workspace.
2. From the GDE menu bar, choose Window > Workspace Layouts. The Workspace Layouts dialog opens:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 36 of 221

Screen capture showing the Workspace Layouts dialog

listing layouts in unexpanded form.

3. Do either of the following:

Double-click a workspace layout entry.
Select a workspace layout entry and click Select Layout.
4. Click OK to close the dialog.
Related topics
About workspace layouts
Retrieving the last workspace layout
Saving a workspace layout
Starting the GDE with a named workspace
Renaming a workspace layout
Redefining a workspace layout
Deleting a workspace layout

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Displaying multiple graphs > Using
workspace layouts > Starting the GDE with a named workspace

Starting the GDE with a named workspace

You can use a desktop shortcut to automatically start the GDE with a specified workspace layout.
To set up a shortcut to a GDE workspace layout:
1. Right-click the Windows desktop and choose New > Shortcut from the pop-up menu.
2. In the Create Shortcut dialog, browse to the location of the GDE executable file (gde.exe).
For example:
C:\Program Files\Ab Initio\Ab Initio GDE 1.15.4\Program Files
3. Select gde.exe and click OK.
4. At the end of the path in the Create Shortcut dialog, type:
-workspace “workspace-layout-name”
5. Click Next.
6. Type a descriptive name for the shortcut and click Finish.
The shortcut icon appears on the desktop. Double-clicking the icon start the GDE and automatically opens the named workspace layout.
Related topics
About workspace layouts
Retrieving the last workspace layout
Saving a workspace layout
Loading a workspace layout
Renaming a workspace layout
Redefining a workspace layout
Deleting a workspace layout
Starting the GDE

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Displaying multiple graphs > Using
workspace layouts > Renaming a workspace layout

Renaming a workspace layout

With the exception of the Default workspace layout, you can rename any of the workspace layouts that you have created.
To rename a workspace layout:
1. From the GDE menu bar, choose Window > Workspace Layouts.
2. Right-click the workspace layout whose name you want to change, and choose Rename from the pop-up menu.
3. Revise the name in the editable text box.
4. Click outside the text box to save the new name.
Related topics
About workspace layouts
Retrieving the last workspace layout
Saving a workspace layout
Loading a workspace layout

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 37 of 221

Starting the GDE with a named workspace

Redefining a workspace layout
Deleting a workspace layout

Pre N
viou

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Displaying multiple graphs > Using
workspace layouts > Redefining a workspace layout

Redefining a workspace layout

With the exception of the Default workspace layout, you can redefine any of the workspace layouts that you have created.
To redefine a workspace layout:
1. Close any open graphs, subgraphs, or plans in the GDE workspace.
2. Load the workspace layout. For instructions, see “Loading a workspace layout”.
3. Change the workspace layout as needed:
Rearrange and resize the constituent graphs and plans.
Delete graphs and plans.
Add graphs and plans.
4. From the GDE menu bar, choose Window > Save Workspace Layout.
5. From the Layout name drop-down list, select the name of the original workspace layout.
6. Click OK.
The GDE prompts you to verify that you want to overwrite the existing layout of the same name.
7. Click Yes.
The next time you open that layout, it will display the newly defined configuration.
Related topics
About workspace layouts
Retrieving the last workspace layout
Saving a workspace layout
Loading a workspace layout
Starting the GDE with a named workspace
Renaming a workspace layout
Deleting a workspace layout

Pre N
viou e

GDE Help > Getting started with the GDE > GDE UI appearance and behavior > Customizing appearance and behavior > Displaying multiple graphs > Using
workspace layouts > Deleting a workspace layout

Deleting a workspace layout

With the exception of the Default workspace layout, you can delete any of the workspace layouts that you have created.
To delete a workspace layout:
1. From the GDE menu bar, choose Window > Workspace Layouts.
2. Do one of the following:
Right-click the workspace layout you want to delete, and choose Delete from the pop-up menu.
Select the workspace layout, and press the Delete key.
3. In the confirmation dialog, click OK.
The deleted workspace layout is removed from the list.
Related topics
About workspace layouts
Retrieving the last workspace layout
Saving a workspace layout
Loading a workspace layout
Starting the GDE with a named workspace
Renaming a workspace layout
Redefining a workspace layout

Pre N
viou e

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts

Keyboard and mouse shortcuts

You can access the GDE menu functionality using either the mouse or the keyboard.
NOTE: For information on using the GDE and other Ab Initio products with assistive technologies, see Accessibility features.
The documentation always specifies the mouse actions to perform a given task, and frequently provides the corresponding keyboard shortcuts (and where
appropriate, with links to alternative methods such as wizards).
Every menu command in the GDE has a keyboard equivalent, shown by an underscore under the shortcut letter used together with the Alt key, or an explicitly
named shortcut key(s), such as Ctrl+A. Consider the following figure:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 38 of 221

Screen capture showing shortcuts documented in a GDE menu.

As shown in the figure, the shortcut for the View menu is v; the shortcut for the Component Organizer is c or F9. For example, to scale your graph to fit the
canvas height and width using only the keyboard, do one of the following:
Press Ctrl+Shift+W.
Press Alt+v to open the View menu, press the right arrow key to select Zoom > Full Content, then press Enter.
NOTE: If underscores are not displayed for menu options on your system, press the Alt key.
Related topics
Shortcuts for navigating in the GDE
Shortcuts for the Component Organizer
Shortcuts for the Parameters Editor
Shortcuts for GDE menu commands
Shortcuts for opening editors and dialogs
Shortcuts for working with text editors
Keyboard shortcuts in the View Data window
Accessibility features

Pre N
viou e

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Shortcuts for navigating in the GDE

Shortcuts for navigating in the GDE

This topic describes shortcuts for navigating in the GDE canvas, between GDE panes, in GDE menus, and within dialogs and wizards.
NOTE: The GDE uses different highlighting colors to distinguish between active and inactive selected elements. To change the highlighting color, use the
Selection option in the Colors category of the Preferences dialog.

In this area To do this Press this

Workspace Move through all the top-level panes of the GDE (Component Organizer, Alt+F6
Sandbox View, Application Output window, and the GDE canvas)
Move through screen elements in a graph Tab
Move backwards through screen elements in a graph Shift+Tab
Move between different graphs or tabbed canvases Ctrl+Tab
Zoom in on a graph or plan Ctrl+Plus key (+)
Zoom out on a graph or plan Ctrl+Minus key (-)
Pan a graph or plan that is not fully visible on the GDE canvas Shift and move the mouse in the direction in
which you want to scroll the image.
Menus Open a top-level menu in the GDE Alt, followed by the single letter shortcut
Close a menu without making a selection Alt
Access the pop-up menu for a screen element Shift+F10
Move down through menu commands Down arrow
Move up through menu commands Up arrow
Toolbars Move through all the toolbars Alt, then Ctrl+Tab
Move forward through all the buttons on the current toolbar Right arrow or Tab
Move backward through all the buttons on the current toolbar Left arrow or Shift+Tab
Open a drop-down list on a toolbar button Down arrow
Open a toolbar options menu Tab to move to the toolbar options menu, press
Return or Down arrow
Dialogs, editors, and Move forward horizontally across tabs in a dialog or editor Ctrl+Tab
wizards Move backward horizontally across tabs in a dialog or editor Shift+Ctrl+Tab
Move vertically through all the fields and buttons in dialogs F6
Select elements in a drop-down list Down arrow

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 39 of 221

Set focus on an item in a list box Alt+click the item

Move down through items in a list box Alt, Down arrow
Move up through items in a list box Alt, Up arrow
Move through fields within a grid of an editor Tab
Move forward from one grid area to another in an editor F6
Move backward from one grid area to another in an editor Shift+F6
Step forward through pages of a wizard Right arrow
Step backwards through pages of a wizard Left arrow
Related topics
Shortcuts for the Component Organizer
Shortcuts for the Parameters Editor
Shortcuts for GDE menu commands
Shortcuts for opening editors and dialogs
Shortcuts for working with text editors

Pre N
viou

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Shortcuts for the Component Organizer

Shortcuts for the Component Organizer

You can sort the contents of the Component Organizer alphabetically by right-clicking the Component Organizer’s top folder and selecting Sort alphabetically
from the menu. Once you do this, the following keyboard shortcuts become available.

To do this Press or type this

Show or hide the Component Organizer Press F9
Set focus on the Component Organizer when it is visible Press F9 twice
Find and highlight any component from the alphabetical list (when the focus is on the Component Organizer) Type the first letters of its name
Insert the highlighted component into your graph Press Enter
View the properties of the highlighted component Press Alt+Enter
Related topics
Shortcuts for navigating in the GDE
Shortcuts for the Parameters Editor
Shortcuts for GDE menu commands
Shortcuts for opening editors and dialogs
Shortcuts for working with text editors

Pre N
viou

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Shortcuts for the Parameters Editor

Shortcuts for the Parameters Editor

You can use the following keyboard shortcuts in the Parameters Editor.

To do this Press this

Show or hide the Attributes grid Press F9
Show or hide the Project Overrides grid Press Ctrl+F9
Refresh the Parameters Editor Press F5
Find a string Press Ctrl+F
Find the next instance of a string Press F3
Find all instances of a string Press Shift+Ctrl+F
Find and replace a string Press Ctrl+H
Related topics
Shortcuts for navigating in the GDE
Shortcuts for the Component Organizer
Shortcuts for GDE menu commands
Shortcuts for opening editors and dialogs
Shortcuts for working with text editors

Pre N
viou e

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Shortcuts for GDE menu commands

Shortcuts for GDE menu commands

The GDE provides keyboard shortcuts for the following types of commands:
Breakpoint debug commands

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 40 of 221

Edit commands
File commands
Help commands
Run commands
Tool commands
Tracking commands
View commands

Pre N
viou

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Shortcuts for GDE menu commands > Breakpoint debug commands

Breakpoint debug commands

To do this Press this

Continue This Partition F5
Continue All Partitions Alt+F5
Set Breakpoint F9
Step over a statement F10
Step into a statement F11
Stop debugging Shift+F5

Pre N
viou e

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Shortcuts for GDE menu commands > Edit commands

Edit commands

To do this Press this

Undo Ctrl+Z
Redo Ctrl+Y
Select all Ctrl+A
Delete Delete
Cut Ctrl+X
Copy Ctrl+C
Paste Ctrl+V
Find Ctrl+F
Find Next F3
Validate the active graph Ctrl+F5
Open the Parameters Editor for the graph or selected component F11
Display and edit the code generated from the active graph. You can edit the script start and script end. F7
Display the script that the GDE will run (this script can be slightly different from the deployed graph; there is no equivalent menu option Shift+F7
for this shortcut)
Display the start script for the graph Alt, E, S, S
Open the selected subgraph Enter
Open the parent graph Alt+Left
arrow
Straighten flows Alt+1
Open the Properties dialog for a selected component Alt+Enter

Pre N
viou e

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Shortcuts for GDE menu commands > File commands

File commands

To do this Press this

Close the graph Ctrl+W
Create a new graph Ctrl+N
Create a new plan Ctrl+Alt+N
Open an existing graph Ctrl+O
Print a graph Ctrl+P
Print the current view Ctrl+Shift+P

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 41 of 221

Save the current graph Ctrl+S

Pre N
viou

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Shortcuts for GDE menu commands > Help commands

Help commands

To do this Press this

Get help F1
Get context-sensitive help Shift+F1

Pre N
viou e

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Shortcuts for GDE menu commands > Run commands

Run commands

To do this Press this

Run the current graph F5
Stop the current graph Shift+F5
Open the Input Values Editor Shift+F11
Execute a remote command F8

Pre N
viou

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Shortcuts for GDE menu commands > Tool commands

Tool commands

To do this Press this

Select the edit tool Ctrl+1
Select the zoom tool Ctrl+2

Pre N
viou e

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Shortcuts for GDE menu commands > Tracking commands

Tracking commands

To do this Press this

Open the Tracking window Ctrl+F2
Load the default tracking and output file-pair for the current graph (accelerator for the Tracking and Output > Load menu item) Alt+F2

Pre N
viou e

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Shortcuts for GDE menu commands > View commands

View commands

To do this Press this

Open the Application Output window F2
Open the Component Organizer F9
Open the Sandbox View Ctrl+F9
View tracking details in the Tracking window Ctrl+F2
Scale the current graph to fit the screen height and width Ctrl+Shift+F

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 42 of 221

Scale the current graph to fit the screen height Ctrl+Shift+H

Scale the current graph to fit the screen width Ctrl+Shift+W
Scale the graph so the selected components fit the screen Ctrl+Shift+S
View the next error in the Application Output window F4
Related topics
Shortcuts for navigating in the GDE
Shortcuts for the Component Organizer
Shortcuts for the Parameters Editor
Shortcuts for opening editors and dialogs
Shortcuts for working with text editors

Pre N
viou

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Shortcuts for opening editors and dialogs

Shortcuts for opening editors and dialogs

To do this Do this
Open the Expression Editor On the Parameters tab of the Properties dialog, double-click the name of a parameter that takes an
expression as a value
Open the Key Specifier Editor On the Parameters tab of the Properties dialog, double-click key in the list of parameters
Open the Record Format Editor Double-click the port for which you want to open the editor
Open the Transform Editor or Package Editor Hold down the Shift key while double-clicking the component for which you want to open the
editor
Open the Transform Editor for a specific transform Hold down the Shift key while double-clicking the output port of a component for the transform
for which you want to open the editor.
Open the Parameters Editor Press F11
Open the Parameters tab of the Properties dialog Double-click the square yellow to-do cue on a component
Refresh the Parameters Editor Press F5
Open the Layout tab of the Properties dialog Double-click the yellow double-question-mark to-do cue on a component
Open the Description tab of the Properties dialog Double-click an area on a component that has no to-do cues
Navigate directly to the most commonly used Hold down the Shift key while double-clicking the component
parameter for a component
Related topics
Shortcuts for navigating in the GDE
Shortcuts for the Component Organizer
Shortcuts for the Parameters Editor
Shortcuts for GDE menu commands
Shortcuts for working with text editors

Pre N
viou e

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Shortcuts for working with text editors

Shortcuts for working with text editors

The following sections describe a variety of shortcuts you can use when working with GDE text editors.
Moving
Selecting
Finding and replacing
Cutting, copying and pasting
Inserting lines
Bookmarking
Indenting text
Changing case
Showing blank spaces

Moving

To do this Press this

Move right Right arrow
Move left Left arrow
Move right a word Ctrl+Right arrow
Move left a word Ctrl+Left arrow
Move to line start Home
Move to line end End
Move to numbered line Ctrl+G

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 43 of 221

Move down a line Down arrow

Move up a line Up arrow
Move a line down Alt+Down arrow
Move a line up Alt+Up arrow
Move down a page Page Down
Move up a page Page Up
Move to document end Ctrl+End
Move to document start Ctrl+Home
Move to matching brace Ctrl+]
Move to next Bookmark F2
Move to previous Bookmark Shift+F2
Scroll down window Ctrl+Down arrow
Scroll up window Ctrl+Up arrow
Scroll left window Ctrl+Page Up
Scroll right window Ctrl+Page Down

Selecting

To do this Press this

Select left Shift+Left arrow
Select right Shift+Right arrow
Select left one word Shift+Ctrl+Left arrow
Select right one word Shift+Ctrl+Right arrow
Select to line start Shift+Home
Select to line end Shift+End
Select a line down Shift+Down arrow
Select a line up Shift+Up arrow
Select multiple rows left mouse click/drag
Select column down a line Shift+Alt+Down arrow
Select column up a line Shift+Alt+Up arrow
Select column right Shift+Alt+Right arrow
Select column left Shift+Alt+Left arrow
Column select Alt+left mouse click/drag
Select line Ctrl+Alt+F8
Select page down Shift+Page Down
Select page up Shift+Page Up
Select to document end Shift+Ctrl+End
Select to document start Shift+Ctrl+Home
Select All Ctrl+A

Finding and replacing

To do this Press this

Find Ctrl+F
Find Next F3
Find Previous Shift+F3
Find and Replace Ctrl+Alt+F3
Replace Ctrl+H

Cutting, copying and pasting

To do this Press this

Delete Delete
Delete backwards Backspace
Cut Ctrl+X or Shift+Delete
Cut a line Ctrl+L
Copy Ctrl+C or Ctrl+Insert
Paste Ctrl+V or Shift+Insert

Inserting lines

To do this Press this

Insert line above Shift+Ctrl+N

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 44 of 221

Bookmarking

To do this Press this

Set/Clear Bookmark Ctrl+F2

Indenting text

To do this Press this

Indent one or more lines of text Tab
Outdent one or more lines of text Shift+Tab

Changing case

To do this Press this

Make selection lowercase Ctrl+U
Make selection uppercase Shift+Ctrl+U

Showing blank spaces

To do this Press this

Show/hide blanks Ctrl+Alt+T
Related topics
Shortcuts for navigating in the GDE
Shortcuts for the Component Organizer
Shortcuts for the Parameters Editor
Shortcuts for GDE menu commands
Shortcuts for opening editors and dialogs

Pre N
viou e

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Keyboard shortcuts in the View Data window

Keyboard shortcuts in the View Data window

View Data: General keyboard shortcuts
View Data keyboard shortcuts in grid view
View Data keyboard shortcuts in tree view
View Data keyboard shortcuts in formatted text view

Pre N
viou e

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Keyboard shortcuts in the View Data window > View Data: General keyboard
shortcuts

View Data: General keyboard shortcuts

These general keyboard shortcuts are available in all of the View Data views.

To do this Press this

Select all Ctrl+A
Extend the selection up Shift+Up arrow
Extend the selection down Shift+Down arrow
Extend the selection to the right Shift+Right arrow
Extend the selection to the left Shift+Left arrow
Related topics
View Data keyboard shortcuts in grid view
View Data keyboard shortcuts in tree view
View Data keyboard shortcuts in formatted text view

Pre N
viou e

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 45 of 221

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Keyboard shortcuts in the View Data window > View Data keyboard shortcuts
in grid view

View Data keyboard shortcuts in grid view

You have many keyboard shortcut options in the View Data window when the window is in grid view. Some of the options depend on what is currently
selected.

Expanding and collapsing subrecords

To do this Press this

Expand the currently selected subrecord plus key on the numeric keypad
Expand the selected subrecord and all its subrecords Ctrl + plus key on numeric keypad
Expand all subrecords and all their subrecords in the current column Ctrl+Shift + plus key on numeric keypad
Expand all subrecords in the current column one level Shift + plus key on numeric keypad
Collapse the currently selected subrecord minus key on the numeric keypad
Collapse the currently selected subrecord and all its subrecords Ctrl + minus key on numeric keypad
Collapse all subrecords in the current column Shift + minus key on numeric keypad
Collapse all subrecords and their subrecords in the current column Ctrl+Shift + minus key on numeric keypad

When nothing is selected

To do this Press this

Select the first record Insert
Scroll up one line Up arrow
Scroll down one line Down arrow
Scroll right Right arrow
Scroll left Left arrow
Scroll to the top Ctrl+Home
Scroll to the bottom Ctrl+End

When an entire record is selected but no individual field

To do this Press this

Select the preceding row and scroll it into view Up arrow
Select the following row and scroll it into view Down arrow
Select the first field of the record Insert
Deselect the record Ctrl+Insert
Scroll up one record Up arrow
Scroll down one record Down arrow
Scroll to the top and select the first record Ctrl+Home
Scroll to the bottom and select the last record Ctrl+End

When a field is selected

To do this Press this

Select the corresponding field in the previous record and scroll it into view — unless the field is a subfield Up arrow
NOTE: If the field you start with is a subfield, pressing the Up arrow selects its parent. However, once you have navigated to the top-level
parent, another press of the Up arrow will take you to the previous record and select the subfield you started with; if that subfield is
collapsed, the next visible parent item is selected, and so on.
Select the corresponding field in the next record and scroll it into view — if the field is not a subfield Down
NOTE: If the field you start with is a subfield, pressing the Down arrow takes you to the next record and selects the highest-level parent. arrow
Subsequent presses of the Down arrow select child sub-items, and then the field you started with. However, if any of the sub-items are
collapsed, subsequent presses of the down arrow move to subsequent records in the View Data window — working as far as possible through
the visible hierarchy of sub-items.
Select the next corresponding sub-item or subfield or its parent and scroll it into view Right arrow
Select the next corresponding sub-item or subfield or its parent and scroll it into view Left arrow
Select the first field in the current record and scroll it into view Home
Select the last field in the current record and scroll it into view End
Deselect the field leaving the currently selected record selected Ctrl+Insert
Scroll to the top and select the first field of the first record Ctrl+Home
Scroll to the bottom right and select the last field of the last record Ctrl+End

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 46 of 221

When an entire column is selected

To do this Press this

Select the entire column of the parent (if the selected column is a sub-item or subfield) Up arrow
Select the entire column of sub-items or subfields (if the selected column is a sub-item) Down arrow
Select the next sibling sub-item or subfield and scroll it into view Right arrow
Select the previous sibling sub-item or subfield and scroll it into view Left arrow
Select the first column and scroll it into view Home
Select the last column and scroll it into view End

Scrolling

To do this Press this

Scroll all the way to the left (if a field is selected when you press Home, the first field in the current record becomes selected) Home
Scroll all the way to the right (if a field is selected when you press Home, the last field in the current record becomes selected.) End
Scroll back or forward one screen. Page Up or Page Down
NOTE: If a field or sub-item is selected, the windows scrolls one screen and the corresponding field (or one of its parents,
depending on what is expanded) is selected.
Related topics
View Data keyboard shortcuts in tree view
View Data keyboard shortcuts in formatted text view
View Data: General keyboard shortcuts

Pre N
viou

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Keyboard shortcuts in the View Data window > View Data keyboard shortcuts
in tree view

View Data keyboard shortcuts in tree view

When a field (row) and cell are selected

The following shortcuts are available when a field (row) is selected — whether or not a value or sub-item is also selected.

To do this Press this

Select the row above as well as the corresponding cell Up arrow
Select the row below as well as the corresponding cell Down arrow
Scroll left to display the first record and select the corresponding cell Home
Scroll right to display the last record and select the corresponding cell End
Select the first cell in the first row and scroll to it Ctrl+Home
Select the last cell in the last row and scroll to it Ctrl+End
Select the row and cell that are one screen back and scroll to display them Page Up
Select the row and cell that are one screen forward and scroll to display them Page Down

When a field (row) is selected but no individual cell

To do this Press this

Scroll left to display the first record and select the value in that record that is in the current row Insert
Select the row above Up arrow
Select the row below Down arrow
Scroll left to display the first record Home
Scroll right to display the last record End
Select the first row and scroll to it Ctrl+Home
Select the last row and scroll to it Ctrl+End
Select the row that is one screen back and scroll to display it Page Up
Select the row that is one screen forward and scroll to display it Page Down

Expanding and collapsing

The following keyboard shortcuts apply to subrecords whether the subrecord name is selected in the Fields column or a subrecord placeholder ( [record] ) is
selected in a record.

To do this Press this

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 47 of 221

Expand the currently selected subrecord plus key on the numeric keypad
Collapse the currently selected subrecord minus key on the numeric keypad
Expand the selected subrecord and all its subrecords Ctrl + plus key on numeric keypad
Collapse the currently selected subrecord and all its subrecords Ctrl + minus key on numeric keypad

When a record (a column) is selected

To do this Press this

Select the next record to the right and scroll to make it visible if necessary Right Arrow
Select the next record to the left and scroll to make it visible if necessary Left Arrow
Scroll to display the first record and select it Home
Scroll to display the last record and select it End
Scroll to display the first record and first field, and select the first record Ctrl+Home
Scroll to display the last record and last field, and select the last record Ctrl+End

When nothing is selected

To do this Press this

Scroll up one page Page Up
Scroll down one page Page Down
Scroll to display the first record Home
Scroll to display the last record End
Scroll to display the first record and first field Ctrl+Home
Scroll to display the last record and last field Ctrl+End
Related topics
View Data keyboard shortcuts in grid view
View Data keyboard shortcuts in formatted text view
View Data: General keyboard shortcuts

Pre N
viou e

GDE Help > Getting started with the GDE > Keyboard and mouse shortcuts > Keyboard shortcuts in the View Data window > View Data keyboard shortcuts
in formatted text view

View Data keyboard shortcuts in formatted text view

To do this Press this

Select all Ctrl+A
Move up a page Page up
Move down a page Page down
Move the cursor to the top of the record Ctrl+Home
Move the cursor to the bottom of the record Ctrl+End
Copy the selection to the Clipboard Ctrl+C
Display the View Data Find dialog Ctrl+F
Display the Print Options dialog Ctrl+P
Related topics
View Data keyboard shortcuts in grid view
View Data keyboard shortcuts in tree view
View Data: General keyboard shortcuts

Pre N
viou

GDE Help > Working with graphs and plans

Working with graphs and plans

Ab Initio software is based on application assembly using graphic data flow and control flow diagrams, allowing you to use the GDE to visually build
complex business management applications represented by graphs and plans. The visual representation makes the overall structure of the application easier to
understand.
This section includes the following topics:
About graphs and graph programming
Creating graphs and plans
Reusing graphs and graph elements
Customizing appearance and behavior
Running graphs and plans

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 48 of 221

Viewing job output

Saving and deploying graphs and plans
Tracking performance
Managing jobs

Pre N
viou

GDE Help > Working with graphs and plans > About graphs and graph programming

About graphs and graph programming

This section describes graphs, their associated metadata, and filesystems, and explains how to create and run them. It includes the following topics:
About graphs
About plans
About metadata and file extensions
Related topics
Working with graphs and plans
The Co>Operating System and the GDE

Pre N
viou

GDE Help > Working with graphs and plans > About graphs and graph programming > About graphs

About graphs
A graph is a picture that represents the streams of data and the various processing stages as the data moves from one stage to another.
Ab Initio graphs represent in a data flow diagram what might take thousands of lines of code to program, dramatically reducing the time it takes to develop,
test, and maintain applications. The GDE data flow diagram model allows you to think in terms of meaningful processing steps, and visually captures the flow
of information through the application. We call this development method graph programming.

Graph building blocks

In the GDE you build an application by manipulating components, the building blocks of the graph. You simply drag and drop components onto the GDE canvas, then click and drag to link
them. The inputs and outputs are dataset components, the processing steps are program components, and the data conduits are flows. When it’s time to run the
application, the Co>Operating System turns the diagram into a collection of processes running on computers.

Graph symbols

The symbols for Ab Initio graphs are similar to those found in the traditional data flow model. The symbols representing the basic parts of Ab Initio graphs
displayed on the GDE canvas are the following:

Symbol Meaning
Boxes for processes and data transforms

Arrows for data flows between processes

Cylinders for serial input and output files

Divided cylinders for parallel input and output files

Grid boxes for database tables

The following example shows a simple graph that reads customer records, generates new records with a different format, and selects those that qualify as
“good” customers using a selection criterion.
Screen shot of basic graph showing Dataset and Program components and connecting
flows.

For more information, see “What is a graph?”.

Related topics
About plans
About metadata and file extensions

Pre N
viou

GDE Help > Working with graphs and plans > About graphs and graph programming > About plans

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 49 of 221

About plans
A plan is a picture that represents an interrelated series of tasks executed by Conduct>It to achieve a specific business objective. A plan can include graphs,
programs, embedded and external scripts, and other plans.
In a plan, you encapsulate graphs, programs, and scripts in units called tasks. Plans let you arrange and rearrange tasks, pass parameters between them, and
control the system resources they consume. All the tasks, the run sequence, the conditional logic, and the relationships between tasks are represented
graphically. Most of the actions and controls that apply to graphs also apply to plans.

Plan symbols

The following are the symbols for tasks, relationships, and methods in a plan:

Item Symbol Description

Conditional task Implements conditional logic in your plan. The decision logic in a conditional task depends on an expression
or program you specify.
Conditional task I Indicate control direction taken in a conditional task.
arrows c

Graph task I Points to an Ab Initio graph.

Plan task Points to a plan located in an external file.

Program task Points to an external program, or to an external or embedded script.

Subplan Icon of a Subplan. Groups tasks as part of a plan, and allows you to run tasks iteratively. Using subplans, like using subgraphs,
simplifies your main plan. Also, you can reuse a subplan in other plans.

Connection point Indicates where you can connect one task to another.
LED status Indicates the status of a plan, task, or method. See “Tracking features”.
indicator
Loop Indicates a subplan that executes repeatedly.
Method Indicates that an optional action has been assigned to a task.
Resource Indicates a task that requests shared system resources.
Task relationship Indicates a dependency between tasks.
To-do cue Indicates a missing parameter you must supply for the plan to run.
A plan looks like this on the GDE canvas:
Image of a typical plan.

For more detailed information, see “What is a plan?” and “Differences between graphs and plans”.
Related topics
About graphs
About metadata and file extensions
What is Conduct>It?

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 50 of 221

Pre N
viou

GDE Help > Working with graphs and plans > About graphs and graph programming > About metadata and file extensions

About metadata and file extensions

In the process of building graphs and plans, you supply metadata that is stored in collection of associated files. The graphs, plans, and associated files are
maintained in an Ab Initio sandbox or project. For information about sandboxes, see “Working with sandboxes”.

Metadata

Metadata is data about data. When you build a graph, you provide the GDE with the following types of metadata:
Record formats — Metadata that describes the fields of a record on a port, specifying attributes such as data type and length. Record formats can be
embedded in the graph or saved as separate files (.dml extension).
Key specifiers — Metadata that specifies how to group and order data. The GDE automatically embeds key specifiers.
Transform functions — Metadata that describes how to manipulate data and compute new data from it. Transform functions can be embedded in the graph
or saved as separate files (.xfr extension).
Metadata also includes field and column definitions, database DDL, the graphs and plans themselves, transform rules, business processes, job statistics,
version history, and so forth.
You can either embed the metadata in the graph or save it as a file in a sandbox or in any location to which the run host can connect. The metadata can also be
stored in an EME technical repository. For information about metadata stored in the EME technical repository, see “Technical Repository Guide for
Developers” and “Technical Repository Business Metadata Guide”.

File extensions

The files containing the metadata have the following standard file extensions.

Extension Description
.cfg Database table configuration files for use with 2.1 database components
.dat Data files (either serial files or multifiles)
.dbc Database configuration files
.dml Data Manipulation Language (DML) files or record format definitions
.mdc Dataset or custom dataset components
.mg Micrograph object files
.mp Stored Ab Initio graphs or graph components
.mpc Program components or custom components
.plan Plan files
.task File for a user-defined task in Conduct>It
.xfr Transform function definitions or packages
These file extensions are similar to the subdirectories created by the GDE when you create a sandbox.
Related topics
Metadata and file types

Pre N
viou

GDE Help > Working with graphs and plans > Creating graphs and plans

Creating graphs and plans

This section describes the basic steps involved in creating graphs and plans. It includes the following topics:
Creating a new graph or plan
Associating graphs with a sandbox
Inserting components into a graph
Resolving to-do cues
Connecting components
Specifying a database for table components
Specifying component parameters
Specifying graph-level parameters
Specifying layout
Specifying the record format
Setting layout and record format propagation
Opening an autosaved graph or plan
Related topics
Working with sandboxes

Pre N
viou e

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 51 of 221

GDE Help > Working with graphs and plans > Creating graphs and plans > Creating a new graph or plan

Creating a new graph or plan

You add and connect components that process data records on the graph canvas. When you first open the GDE, it automatically displays a new, blank graph
named Graph1, which you can rename and save. You can create a new plan by selecting File > New > Plan from the GDE menu bar. For information about
creating and designing plans, see “What is Conduct>It?”.
NOTE: Before creating a new graph or plan, it is strongly recommended that you create a sandbox in which to save the graph or plan. For more information,
see “Creating a sandbox”.
To open a sandbox:
1. If the sandbox you want is not already open, do one of the following:
From the GDE menu bar, choose Project > Open Sandbox.
In the Sandbox View, right click and choose Open Sandbox from the pop-up menu.
2. In the Open dialog, ensure that Host is selected, and browse to the sandbox you want.
Screen capture of the Open dialog showing the selected sandbox and host

3. Click Open.
The sandbox directory tree appears in the Sandbox View pane.
Screen capture showing a newly-opened
sandbox as represented in the GDE’s
Sandbox View pane.

4. If the sandbox is checked in to an EME technical repository, right-click the sandbox folder at the top of the tree and choose Check Out from the pop-up
menu. Follow the instructions in the Checkout Wizard.
To create a new graph:
1. Open a canvas for a new graph in one of the following ways:
From the GDE menu bar, choose File > New > Graph.
From the GDE main toolbar, click .
In the GDE, press Ctrl+N.
2. From the GDE menu bar, choose File > Save As and do the following:
a. Ensure that Host is selected.
b. In the Look in field of the Save As dialog, select the mp directory in the sandbox.
c. In the File Name field, type a description name and click Save.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 52 of 221

Screen capture showing the Save as [Host] dialog

3. If the sandbox is associated with an EME technical repository, check in the graph in one of the following ways:
From the GDE menu bar, choose Project > Check in and follow the instructions in the Checkin Wizard.
Right-click the project item in the Sandbox View, choose Check In from the pop-up menu, and follow the instructions the Checkin Wizard.
Related topics
Associating graphs with a sandbox
Inserting components into a graph
Connecting components
Specifying component parameters
Specifying graph-level parameters
Setting layout and record format propagation
Opening an autosaved graph or plan

Pre N
viou

GDE Help > Working with graphs and plans > Creating graphs and plans > Associating graphs with a sandbox

Associating graphs with a sandbox

When a sandbox is selected in the Sandbox View and you create a graph, that graph is associated with that sandbox. The status bar at the bottom of the GDE
window names the sandbox that is associated with the graph, as shown below:

You can change the sandbox association for a graph that has not yet been saved, either using the GDE menu bar or using the status bar.
To change the sandbox association of an unsaved graph using the GDE menu bar:
1. From the GDE menu bar, choose the Settings > Associate Graph with Sandbox menu command.
2. In the Associate Graph with Sandbox dialog, select the open sandbox with which you want to associate the graph.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 53 of 221

Screen capture of the Associate Graph with Sandbox dialog

3. Click OK.
That status bar shows the updated sandbox name:

4. After the graph is associated with the correct sandbox, choose File > Save from the GDE menu bar.
To change the sandbox association of an unsaved graph using the status bar:
1. On the status bar, click the up arrow next to the Sandbox item in the status bar:

2. Choose the sandbox name from the pop-up list.

3. After the graph is associated with the correct sandbox, choose File > Save from the GDE menu bar.
Related topics
Creating a new graph or plan
Associating graphs with a sandbox
Inserting components into a graph
Connecting components
Specifying component parameters
Specifying graph-level parameters
Setting layout and record format propagation
Opening an autosaved graph or plan

Pre N
viou e

GDE Help > Working with graphs and plans > Creating graphs and plans > Inserting components into a graph

Inserting components into a graph

You build GDE graphs by placing the following types of components on the GDE canvas and connecting them in a data flow diagram:
Dataset components that input and output data
Program components that process the data
Subgraphs that group dataset and program components
Connector graphs (Specialized graphs that extract metadata from third-party applications and load that metadata into a technical repository.)

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 54 of 221

NOTE: The Co>Operating System to which you are connected supplies the components and connector graphs that are available in the Component
Organizer.
You can insert components into a graph in the following ways:
Inserting components using the Component Organizer
Inserting components using the menu command
Inserting custom components
Inserting and running connector graphs
The components you insert in the graph display yellow to-do cues and optional ports.

To-do cues

The yellow to-do cues indicate that information must be supplied to the component before you can run the graph. The following figure shows newly added
components, their respective to-do cues, and optional ports.
Screen capture of components in graph displaying to-do cues

You can resolve some of these to-do cues by connecting the components, which automatically propagates component layout and port properties information.
For other to-do cues, you must supply the missing information in the component’s Properties dialog. For more information, see “Resolving to-do cues”.

Optional ports

Optional ports are ports that do not need to be connected to a flow in order for the component to run. You can hide the optional ports in one of the following
ways:
Click the Optional Ports button on the Tool toolbar.
Choose View > Optional Ports from the GDE menu bar.
Uncheck the Optional ports option in the View category of the Graph Settings dialog.
When the optional ports are hidden the unconnected component looks like this:
Screen capture show
unconnected component
when optional ports are
hidden

Related topics
Components
Creating a new graph or plan
Connecting components
Specifying component parameters
Specifying graph-level parameters
Setting layout and record format propagation
Opening an autosaved graph or plan

Pre N
viou

GDE Help > Working with graphs and plans > Creating graphs and plans > Inserting components into a graph > Inserting components using the Component
Organizer

Inserting components using the Component Organizer

If the Component Organizer is not open, do one of the following to open it:
From the GDE menu bar, choose View > Component Organizer or press F9.
Click on the GDE main toolbar.
Screen capture showing the Component
Organizer with its two top-level folders --
Components and Connector Graphs

NOTE: The Connector Graphs folder does not contain components. It contains connector graphs that help you load metadata in to and extract metadata from
the EME technical repository. For more information, see “Connector graphs”.
To insert a component from the Component Organizer:
1. In the Component Organizer, double-click the Components folder to display the folders for each of the component groups.
2. Double-click any group folder to display the components that reside in it. For example, double-click Dataset to show Input File, Input Table, Intermediate
File, and so on.
NOTE: You can also right-click the Components folder and choose Sort Components folder alphabetically to see all the components from all categories in

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 55 of 221

alphabetical order.
3. Do one of the following:
Double-click the name of a component in the Component Organizer.
Select the name of a component in the Component Organizer and press Enter.
Click the name of a component in the Component Organizer and drag the component into the graph.
Right-click a component name in the Component Organizer, then choose Insert In Graph from the pop-up menu.
Related topics
Inserting components using the menu command
Overview of components by category
Datasets components
Creating a new graph or plan
Associating graphs with a sandbox
Inserting components into a graph
Connecting components
Specifying component parameters
Specifying graph-level parameters
Setting layout and record format propagation
Opening an autosaved graph or plan

Pre N
viou e

GDE Help > Working with graphs and plans > Creating graphs and plans > Inserting components into a graph > Inserting components using the menu
command

Inserting components using the menu command

You can use the Insert menu to add dataset and program components to a graph. A dataset component represents data records or acts on data records to form
the inputs and outputs of a graph. A program component represents the processing stages of a graph.
To insert a dataset component using the Insert menu command:
From the GDE menu bar, choose Insert then choose one of the following: Input File, Output File, Intermediate File, Lookup File, Input Table, or
Output Table.
To insert a component from the Insert menu by browsing:
1. From the GDE menu bar, choose Insert > Component. The Open dialog is displayed. showing the component folders provided by the currently selected
host connection.
2. In the Open dialog, double-click a component file (.mpc file), dataset component file (.mdc file), or subgraph component file (.mp file), and click Open.
The GDE inserts a copy of the component in the currently active graph.
Related topics
Inserting components using the Component Organizer
Inserting custom components
Overview of components by category
Inserting components into a graph
Connecting components
Specifying component parameters
Setting layout and record format propagation
Opening an autosaved graph or plan

Pre N
viou e

GDE Help > Working with graphs and plans > Creating graphs and plans > Inserting components into a graph > Inserting custom components

Inserting custom components

Custom components are created for general use in your organization. They are typically stored as subgraph and program components in a common sandbox
for inclusion in your private project.
To insert a custom component:
1. In the Sandbox View include a common sandbox that contains a components directory of custom components. For more information, see “Including a
common sandbox”.
2. Expand the components directory.
3. Drag the custom program component (.mpc file) or the custom subgraph component (.mp file) to the canvas.
Related topics
What is a custom component?
Inserting components into a graph
Connecting components
Resolving to-do cues

Pre N
viou

GDE Help > Working with graphs and plans > Creating graphs and plans > Inserting components into a graph > Inserting and running connector graphs

Inserting and running connector graphs

Load connector graphs extract metadata from third-party applications and load that metadata into an EME technical repository. Unload connector graphs

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 56 of 221

unload metadata from a technical repository into third-party applications. For more information, see “Connector graphs”.
To insert a connector graphs:
1. In the Component Organizer, expand the Connector Graphs folder.
2. Expand the appropriate subfolder.
3. Do one of the following:
Double-click a connector graph.
Right-click the connector graph, and choose Open from the pop-up menu.
To run a connector graphs:
Do one of the following:
Click the Run button on the toolbar.
Choose Run > Start from the menu bar.
Press F5.

Pre N
viou e

GDE Help > Working with graphs and plans > Creating graphs and plans > Resolving to-do cues

Resolving to-do cues

The yellow highlighted areas with question marks on a component are called to-do cues. These cues prompt you for additional information the GDE needs
before it can run the graph. For information on resolving to-do cues, see “To-do cues”.

Pre N
viou

GDE Help > Working with graphs and plans > Creating graphs and plans > Connecting components

Connecting components
Components have ports. A port is a connection point that allows data to flow into or out of a component. Most components have at least one port. The data
moving into or out of a component is called a flow, represented by an arrow between the ports of two components.
Figure showing the Out port, In port, and
flow between two components

You connect components with flows, which carry the stream of data from one component to another, in one of the following ways:
Drawing on the canvas
Using the Create Flow dialog
To create a flow between two components by drawing on the canvas:
1. Move the mouse pointer over the out port of a component until it changes appearance to look like as it does in the following figure:
Screen capture
showing how
the cursor
changes when
you select a

2. Press and hold the left mouse button. The port changes to the color specified by the Highlighted port fill option in the Color category of the Preferences
dialog (the default is green).
3. Drag the pointer to the in port of the component to which you want to connect the flow.
4. When the pointer again looks as it does in the figure and the port of the target component changes color, release the mouse button.
The following figure shows flows connecting three components:
Screen capture showing components connected by flows.

To create a flow between two components using the Create Flow dialog:
1. Insert components on the GDE canvas.
2. Choose Insert > Flow from the GDE menu bar. The Create Flow dialog opens:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 57 of 221

Screen capture of the Create Flow dialog

3. From the Source Component drop-down list, select the component from which you want the flow to start.
4. From the Source Port list, select the port from which the flow is to start.
5. From the Target Component list, select the component to connect to.
6. From the Target Port list, select the port on the target component where the flow will end.
7. Click OK to create the flow and dismiss the dialog.
Related topics
Components, flows, and ports
Types of flows
Displaying flow pattern symbols
Creating a new graph or plan
Associating graphs with a sandbox
Inserting components into a graph
Specifying component parameters
Specifying graph-level parameters
Setting layout and record format propagation
Opening an autosaved graph or plan

Pre N
viou e

GDE Help > Working with graphs and plans > Creating graphs and plans > Specifying a database for table components

Specifying a database for table components

Table components access their data from database tables. To access data from a table, you must identify ify the database for the table component, identify the
database tables for use, and associate the table with an EME dataset. The following topics describe the methods for doing this:
Specifying a database using an existing .dbc file
Specifying a database using a new .dbc file

Pre N
viou e

GDE Help > Working with graphs and plans > Creating graphs and plans > Specifying a database for table components > Specifying a database using an
existing .dbc file

Specifying a database using an existing .dbc file

When specifying a database with an existing .dbc file, you need to identify the database, open the existing database configuration file (.dbc) file, designate the
database tables for use, and generate the record format metadata.
NOTE: For dependency analysis to succeed, the database configuration file must be located in a directory in the current sandbox or in an included common
sandbox, typically in the db directory.
To specify a database with an existing .dbc file:
1. Double-click a component that uses a dataset, such as an INPUT TABLE component.
2. In the resulting Properties dialog, click the Data tab.
NOTE: For some components, such as UPDATE TABLE, the location of the .dbc file is parameterized, and you specify the database on the Parameters tab
of the Properties dialog.
3. In the Configuration file area, click Config File and select Browse from the drop-down list to open the Select Database Configuration File dialog:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 58 of 221

Screen capture showing the available .dbc files in the Select Database
Configuration File dialog.

4. If necessary, select the directory from the Look in drop-down list.

5. Select the .dbc file in the list box and click Select to display the path to the .dbc file in the Configuration file box on the Data tab.
6. In the Data location area on the Data tab, do one of the following:
Select Name, click the Browse button to open the Select Table dialog (shown below), select a table from the list, and click OK:
Screen capture showing the available tables in the
Select Table dialog.

Select Select statement and type a SELECT or INSERT statement in the field; or click Edit to open the Select Tables dialog (shown below), where you
can select multiple tables and click the arrow button to move them to the Selected list, and click OK:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 59 of 221

Screen capture showing the available tables in the Select Tables dialog.

7. On the Data tab of the Properties dialog, click Apply.

The GDE automatically generates the database record format and populates the EME dataset field with the path to the logical dataset in the EME technical
repository:
Screen capture showing the fully populated Data tab.with the automatically generated
EME dataset.

8. Click the Ports tab to see the embedded record format.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 60 of 221

Screen capture showing the generated record format on the Ports tab.

9. Click OK.
Related topics
Specifying a database using a new .dbc file
Specifying a database for table components

Pre N
viou

GDE Help > Working with graphs and plans > Creating graphs and plans > Specifying a database for table components > Specifying a database using a
new .dbc file

Specifying a database using a new .dbc file

When specifying a new database, you need to identify it, create a database configuration file (.dbc) file, specify the database tables location, designate the
database tables for use, and generate the record format metadata.
To specify a database with a new .dbc file:
1. Double-click a component that uses a dataset, such as an INPUT TABLE component.
2. In the resulting Properties dialog, click the Data tab.
NOTE: For some components, such as UPDATE TABLE, the location of the .dbc file is parameterized, and you specify the database on the Parameters tab
of the Properties dialog.
3. In the Configuration file area, choose New from the Config File drop-down menu to display the Select Database dialog:
Screen capture showing the list of databases in
the Select Database dialog

4. Select a database from the list of supported databases and click OK.
The Edit Database Configuration editor displays a template for database-specific configuration file:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 61 of 221

Screen capture showing the template for the database configuration file in the Edit Database
Configuration editor.

5. Follow the instructions in the configuration file to fill in required or other fields as necessary.
For more information on modifying the database configuration file for each database type, see “Overview of required values”.
6. Save the file to the current sandbox’s db directory and close the editor.
7. In the Data location area of the Properties dialog, do one of the following:
Select Name, click the Browse button to open the Select Table dialog (shown below), select a table from the list, and click OK:
Screen capture showing the available tables in the
Select Table dialog.

Select Select statement and type a SELECT statement in the field; or click Edit to open the Select Tables dialog (shown below), where you can select
multiple tables and click the arrow buton to move them to the Selected list, and click OK:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 62 of 221

Screen capture showing the available tables in the Select Tables dialog.

8. On the Data tab of the Properties dialog, click Apply.

9. Click the Ports tab to see the embedded record format.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 63 of 221

Screen capture showing the generated record format on the Ports tab.

10. Click OK.

Related topics
Specifying a database using an existing .dbc file
Specifying a database for table components

Pre N
viou

GDE Help > Working with graphs and plans > Creating graphs and plans > Specifying component parameters

Specifying component parameters

Depending on the components you have inserted into a graph, you might need to do one of the following, as described below:
Resolve to-do cues
Specify values for the parameters
You might also want to specify record formats.

Resolving the to-do cues

Setting the parameter values

You must define any parameter preceded by a to-do cue before you can run a graph. But before setting parameter values, connect the flows in the graph — this
way the parameters might propagate automatically.
To set the value for a component parameter:
1. Double-click the component to open the Properties dialog.
2. Click the Parameters tab.
3. Select a parameter in the Parameters list at the top of the tab, where the parameter and its current value (if it has one) appear.
4. Depending on the parameter selected, do one of the following:
If the parameter does not have a value, type an appropriate entry in the Value box at the bottom of the tab.
If the parameter has a value next to its name in the list, accept this value by doing nothing or type a new value in the Value box.
Depending on the parameter, the Value box might display a list of choices. For example, the join-type parameter for a JOIN component lists the values
Inner Join, Full Outer Join, and Explicit. Choose the appropriate value.
Click Use file and type a filename in the File box.
5. To accept the current entry and set another parameter, select another parameter.
6. To accept the changes and leave the dialog open, click Apply; or click OK to accept the changes and close the dialog.
Related topics
Using parameters in graphs
Creating a new graph or plan
Associating graphs with a sandbox
Inserting components into a graph
Connecting components
Specifying graph-level parameters
Setting layout and record format propagation
Opening an autosaved graph or plan

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 64 of 221

Pre N
viou

GDE Help > Working with graphs and plans > Creating graphs and plans > Specifying graph-level parameters

Specifying graph-level parameters

Use the Graph Properties dialog to view the description of and the parameters used by the selected graph.
To open the Properties dialog for a graph:
Do one of the following:
Double-click the graph background.
Right-click the graph background and choose Properties from the pop-up menu.
Make sure nothing in the graph is selected, and from the Edit menu, choose Properties.
Make sure nothing in the graph is selected, then press Alt+Enter.
Related topics
Creating graphs and plans
Running graphs and plans
Creating a new graph or plan
Associating graphs with a sandbox
Inserting components into a graph
Connecting components
Specifying component parameters
Setting layout and record format propagation
Opening an autosaved graph or plan

Pre N
viou

GDE Help > Working with graphs and plans > Creating graphs and plans > Specifying layout

Specifying layout
Every component in a graph — both dataset and program components — has a layout. A layout is one of the following:
A URL that specifies the location of a serial file
A list of URLs that specify the locations of the working directories of a program component
A URL that specifies the location of the control partition of a multifile
A list of URLs that specify the locations of:
The partitions of an ad hoc multifile
The working directories of a program component
Before you can run a graph, you need to specify the layout for each component to supply the Co>Operating System with the necessary file location and
partition information. For detailed information, see “Layout”.
You can specify the layout in one of the followng ways:
Specify the layout for a dataset component
Specify the layout for a program component
Propagate the layout from a neighboring component
Use the layout from another component

Pre N
viou e

GDE Help > Working with graphs and plans > Creating graphs and plans > Specifying layout > Specify the layout for a dataset component

Specify the layout for a dataset component

To specify the layout for a dataset component:
1. Double-click the dataset component in the graph,
2. In the Properties dialog, click the Data tab.
3. On the Data tab, enter the URL for the data location.
4. If this is a multifile component and the data location is for partitions, define the partitions of the ad hoc multifile.
5. If the graph is checked into an EME technical repository, provide the necessary information in the EME dataset area.
6. Click OK.
Related topics
Specifying layout
Layout
Specify the layout for a program component
Propagate the layout from a neighboring component
Use the layout from another component

Pre N
viou e

GDE Help > Working with graphs and plans > Creating graphs and plans > Specifying layout > Specify the layout for a program component

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 65 of 221

Specify the layout for a program component

To specify the layout for a program component:
1. Double-click the program component in the graph.
2. In the Properties dialog, click the Layout tab.
3. Under Layout source, select URL, and enter the path to the input or output file.
4. Click OK.
Related topics
Specifying layout
Layout
Specify the layout for a dataset component
Propagate the layout from a neighboring component
Use the layout from another component

Pre N
viou e

GDE Help > Working with graphs and plans > Creating graphs and plans > Specifying layout > Propagate the layout from a neighboring component

Propagate the layout from a neighboring component

To propagate the layout from a neighboring component in the graph:
1. Double-click a program component in the graph.
2. In the Properties dialog, click the Layout tab.
3. Under Layout source, click Propagate from neighbors.
4. Click OK.
Related topics
Specifying layout
Layout
Specify the layout for a dataset component
Specify the layout for a program component
Use the layout from another component

Pre N
viou e

GDE Help > Working with graphs and plans > Creating graphs and plans > Specifying layout > Use the layout from another component

Use the layout from another component

You can specify to use the layout from another component either through the Properties dialog or through the Parameters Editor.

Specify layout through the Properties dialog

To use the layout from another component in the graph through the Properties dialog:
1. Double-click a program component in the graph.
2. In the Properties dialog, click the Layout tab.
3. Under Layout source, click Component, and select a component from the drop-down list.
4. Click OK.

Specify layout through the Parameters Editor

To use the layout from another components in the graph through the Parameters Editor:
1. Press F11 to open the Parameters Editor.
2. In the Parameter sets tree select the component whose layout you want to change.
3. In the Parameters grid, scroll to and select the Layout parameter.
4. From the Parameters Editor menu bar, choose Edit > Set Same As.
5. The Select a parameter dialog appears, displaying an expandable tree of all the components in the curent graph.
6. Expand the component whose layout you want to use
7. Select the Layout parameter.
8. Click OK.
Related topics
Specifying layout
Layout
Specify the layout for a dataset component
Specify the layout for a program component
Propagate the layout from a neighboring component

Pre N
viou e

GDE Help > Working with graphs and plans > Creating graphs and plans > Specifying the record format

Specifying the record format

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 66 of 221

Every component in a graph must have a record format on its ports. Ab Initio record formats describe virtually any kind of data, from simple to complex,
including the following:
ASCII strings, decimals, dates, binary data types (integers, floating point), EBCDIC strings, EBCDIC dates, packed decimals, zoned decimals
Fixed-length and variable-length fields
Arbitrary delimiters
Fields that define the lengths of other fields
Fields that depend on their position in a file (such as header records)
Fields that are defined by expressions of other fields
Conditional fields, which specify how to interpret the data in other fields
Vectors or arrays of any data type
Subrecords, records within records, and arrays of subrecords (like the OCCURS DEPENDING clause in COBOL)
Hierarchical and nested records
Unions (like COBOL REDEFINES)
Before you can run a graph, you need to describe the format of your data by specifying a record format. For more information, see “Creating a record format”.

Pre N
viou

GDE Help > Working with graphs and plans > Creating graphs and plans > Setting layout and record format propagation

Setting layout and record format propagation

To expedite the graph building process, the GDE automatically assigns component layout and port properties when you connect flows. This is called
propagation, and it is the default behavior.
NOTE: Before setting the layouts or record formats for program components, connect the flows in the graph. Most program component layouts and record
formats propagate automatically.
Screen capture showing a propagated
layout and record format on a
component.

Layouts

When the GDE propagates a layout, it puts an asterisk (*) next to the layout marker (L1*). The GDE propagates layout between components connected by
either straight or all-to-all flows. If a component has both a straight and an all-to-all flow connected to it, the GDE propagates the layout for that component
from the component connected to it by the straight flow.
To display or hide layout markers, on the menu bar of the GDE, choose Settings > Graph Settings, select the View category, and select or deselect the Layouts
checkbox.

Record formats

When the GDE propagates a record format, it puts an asterisk (*) next to the port name (out*). The GDE propagates record formats between components
connected by any type of flow.
To display or hide the port names, on the menu bar of the GDE, choose Settings > Graph Settings, select the View category, and in the View port names area,
select or deselect Always .
NOTE: By default, the GDE does not automatically propagate record formats through components, such as Reformat, that typically change the data.

Disabling/re-enabling propagation

You can disable or re-enable layout and record format propagation at the component. While not recommended, the GDE also enables you to disable
propagation at the graph level.
To disable or re-enable propagation on a component:
1. Double-click the component to display the Properties dialog.
2. On the Layout tab and Ports tab, deselect or select Propagate from Neighbors.
To disable or re-enable propagation across a graph:
WARNING! Disabling propagation across the graph may cause the execution of the graph to fail.
From the Edit menu, deselect or select Propagation > Record Formator Propagation > Layout.
Related topics
Creating a new graph or plan
Associating graphs with a sandbox
Inserting components into a graph
Connecting components
Specifying component parameters
Specifying graph-level parameters
Opening an autosaved graph or plan

Pre N
viou e

GDE Help > Working with graphs and plans > Creating graphs and plans > Opening an autosaved graph or plan

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 67 of 221

Opening an autosaved graph or plan

The GDE automatically saves all edited graphs and plans periodically so that changes can be recovered should the GDE unexpectedly close. These files are
saved in a special directory, separate from the original files, and can be recovered when you restart the GDE.
NOTE: For autosave files to be generated, the Autosave every: n edits checkbox must be selected in the Workspace category of the Preferences dialog.
The autosave files are stored in the Windows application-specific data directory. This directory is typically C:\Documents and Settings\username\Application
Data\Ab Initio\Autosave. These autosave files enable you to recover your most recent edits up to the time that the autosave file was last written. The amount
of work lost depends on the intervals between autosaves.
NOTE: When you edit a recovered graph or plan, until you save it properly, the autosave mechanism is disabled, and edits will be lost in the event of
another system failure. We strongly recommend that you immediately save the graph or plan before continuing to edit it. Once you save it, the autosave
mechanism is re-enabled.
The GDE gives you different options for using an autosave file, depending on whether you have previously saved the file.

For graphs or plans not previously saved

At startup, the GDE automatically checks for autosave files for unsaved graphs or plans. When notified of the existence of an autosaved file, you can do one of
the following:
To recover your work, click Yes and save the file.
To ignore the autosave file, click No.
You can choose to delete the autosave file. If you do delete it, it is moved to the Recycle bin. If you delete an autosave file by mistake, you can manually
restore the file from the Windows Recycle bin.
To retain the autosave file and cancel opening of the graph or plan, click Cancel.

For graphs or plans previously saved

When you reopen a graph or plan, the GDE automatically checks for a corresponding autosave file. When notified of the existence of an autosave file, you can
do one of the following:
To recover your work, click Open Autosave File and save the file with the same name as the original.
To ignore the autosave file, click Open Last Saved Version.
If you open the last saved version of the graph, the autosave file is deleted and moved to the Windows Recycle bin. If you delete an autosave file by mistake,
you can manually restore the file from the Recycle bin.
To retain the autosave file and cancel opening of the graph or plan, click Cancel.

Related topics
Creating a new graph or plan
Associating graphs with a sandbox
Inserting components into a graph
Connecting components
Specifying component parameters
Specifying graph-level parameters
Setting layout and record format propagation

Pre N
viou e

GDE Help > Working with graphs and plans > Reusing graphs and graph elements

Reusing graphs and graph elements

Subgraphs are reusable graph segments constructed with built-in components. The creation and use of subgraphs is covered by the following topics:
About custom components and subgraphs
Using subgraphs

Pre N
viou e

GDE Help > Working with graphs and plans > Reusing graphs and graph elements > About custom components and subgraphs

About custom components and subgraphs

Ab Initio provides the following kinds of objects in addition to built-in components for developing graphs:
Custom components
Subgraphs
The following decision tree will help you decide whether a custom component or a subgraph best suits your needs.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 68 of 221

Block diagram showing the factors that determine whether

you should use a custom component, subgraph, or macro.

When to use a custom component

If the solution to the task is a single executable (as depicted by the left branch of the tree), you need to use a custom component. You may be able to use an
existing program or script to perform some type of data transformation. Alternatively, you can write a new program or script for the current task.
A custom component lets you integrate your program or script into an Ab Initio graph. You can use a custom component in the same way that you would use
an Ab Initio built-in component.
For details about creating custom components, see “Creating custom components”.

When to use a subgraph

If you can construct the solution to the task from Ab Initio built-in components, and you can keep the number and arrangement of components static from one
run of the graph to another, you can use a subgraph.
When you use a subgraph, you can define the component parameters at runtime. You can change the value of the parameters from one run of the graph to
another, but the number and arrangement of the components themselves remain static.
Related topics
Using subgraphs

Pre N
viou e

GDE Help > Working with graphs and plans > Reusing graphs and graph elements > Using subgraphs

Using subgraphs
A subgraph is a graph fragment. Just like graphs, subgraphs contain components and flows. A subgraph groups together components that perform a subtask in
a graph.
This section includes the following topics:
Creating a subgraph
Saving a subgraph as a component
Creating parameters for subgraphs
Using parameters to make subgraphs reusable
Viewing subgraphs
Adding ports to a subgraph
Editing subgraphs
Expanding subgraphs

Pre N
viou e

GDE Help > Working with graphs and plans > Reusing graphs and graph elements > Using subgraphs > Creating a subgraph

Creating a subgraph
You can create a subgraph starting from scratch or from components in an existing graph.
To create a new subgraph from scratch:
1. From the Insert menu, choose Empty Subgraph.
The New Empty Subgraph dialog opens.
2. In the New graph name box, enter the name you want to use for this subgraph.
You can use alphanumeric characters, numbers, and special characters such as underscores in the name. Non-alphanumeric characters are eliminated when
you deploy the graph.
3. Click OK.
An empty subgraph icon, labeled with the name you specified, is displayed in the workspace.
4. Double-click the empty subgraph.
The subgraph expands into a drawing canvas.
5. Create the subgraph on the canvas by inserting components from the Component Organizer and connecting them with flows.
6. Add ports to the subgraph.
7. (Optional) Create parameters for the subgraph.
To create a subgraph from components in an existing graph:
1. In an existing graph, select the components that the subgraph should contain.
2. From the GDE menu bar, choose Edit > Subgraph > Create From Selection.
The Create Subgraph From Selection dialog opens.
3. In the New graph name box, enter a name for the subgraph.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 69 of 221

You can use alphanumeric characters, numbers, and special characters such as underscores in the name. Non-alphanumeric characters are eliminated when
you deploy the graph.
The GDE moves the selected components from the active graph into the subgraph. Ports on the new subgraph replace interrupted flows. If the selected
component is the outermost graph itself, this command wraps a new graph around it. Subgraph components have a double-line border for easy identification,
as follows:
Icon that
represents a
subgraph
component.

4. (Optional) Create parameters for the subgraph.

Related topics
Saving a subgraph as a component
Viewing subgraphs
Editing subgraphs
Expanding subgraphs

Pre N
viou e

GDE Help > Working with graphs and plans > Reusing graphs and graph elements > Using subgraphs > Saving a subgraph as a component

Saving a subgraph as a component

When you build a subgraph, it becomes a part of the graph in which you build it. If you want to use it in other graphs, or in other places in the original graph,
you need to save it as a component.
To save a subgraph as a component:
1. Select the subgraph.
2. From the File menu, choose Save Subgraph “subgraph_name” As.
3. Navigate to the Components folder in the sandbox.
If one does not already exist, create a Components folder in the sandbox.
4. Under Files of type, select Program Components (*.mpc, *.mp).
5. Click Save.
NOTE: This operation does not affect the containing graph, and does not save it. You must save the full graph separately.
A subgraph you save in this way becomes a linked subgraph. If you insert an instance of such a subgraph into a graph from the sandbox and then double-click
it, the GDE displays “(linked)” after the name of the subgraph.

Pre N
viou e

GDE Help > Working with graphs and plans > Reusing graphs and graph elements > Using subgraphs > Updating instances of linked subgraphs

Updating instances of linked subgraphs

If your graph uses a linked subgraph that has been updated in the sandbox, you can update the instance of the linked subgraph in the graph.
To update the instances of a linked subgraph in an existing graph:
1. Select the instances of the subgraph you want to update in the graph.
2. From the GDE Edit menu, choose Update.
For an example of a linked subgraph, see “Creating a quantiling subgraph” in the Cook>Book.
When you build a subgraph, it becomes a part of the graph in which you build it. If you want to use it in other graphs, or in other places in the original graph,
you need to save it as a component.

Related topics
Creating a subgraph
Creating parameters for subgraphs
Viewing subgraphs
Adding ports to a subgraph
Editing subgraphs
Expanding subgraphs

Pre N
viou

GDE Help > Working with graphs and plans > Reusing graphs and graph elements > Using subgraphs > Creating parameters for subgraphs

Creating parameters for subgraphs

You can create parameters for a subgraph by doing either of the following, as described below:
Using the Parameters Editor.
Using the Create button in the Properties: Parameters tab category.
Alternatively, you can export parameters from a component within the subgraph, as described in “How to export or unexport a component parameter”. When
you export a parameter from a component in a subgraph, the GDE creates a new parameter for the containing subgraph. The value you set for this parameter
determines the value of all internal parameters exported under that name. Components in a subgraph can share exported parameters.
To create a parameter using the Parameters Editor:
1. From the GDE menu bar, choose Edit > Parameters.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 70 of 221

2. Select the subgraph in the project tree.

3. Enter the parameter name in the Name column, or right-click a row, choose Insert, and edit the default parameter name.
4. In the Value column, enter the parameter value. The value can be another parameter — for example, $ myParameter.
To create a parameter from the subgraph:
1. In the graph, right-click the subgraph and choose Properties.
2. On the Parameters tab, click Create.
3. In the Parameter Properties dialog, enter the parameter name, select a type, and click OK.
4. In the Parameters dialog, under Parameters, select the parameter in the list.
5. Under Value, enter the value for the parameter.
For information about parameter types and kinds, see Properties: Parameters tab.

Pre N
viou

GDE Help > Working with graphs and plans > Reusing graphs and graph elements > Using subgraphs > Using parameters to make subgraphs reusable

Using parameters to make subgraphs reusable

You can use input parameters to make a subgraph reusable. For example, suppose:
You have a subgraph that reads a file of records, performs a complex transformation on the records, and generates a log file within the subgraph to keep
track of how many records it processes.
You want to use this subgraph in several different graphs, and want each instance of the subgraph to produce a separate log file with a unique name.
To accomplish this, create an input parameter for the graph and use a $ reference to that parameter as the URL of the log file within the subgraph. Then, when
you run a graph using the subgraph, the GDE will prompt you for a value for the input parameter. The value you supply becomes the URL of the log file.
To create the input parameter and the $ reference:
1. From the GDE menu bar, choose Edit > Parameters.
2. In the Parameters Editor, select the graph that contains the subgraph in the project tree.
3. In the Name column, enter logFileURL as the input parameter name.
4. With logFileURL selected, make sure that the Input box is checked in the Attributes pane.
This creates a parameter that requires a value when you run the graph.
5. In the Value column for logFileURL, specify a prompt for the file URL, such as enter log file URL.
6. Open the subgraph containing the log file.
7. In the File Properties: Description tab category for the log file, specify the URL as $logFileURL.
When you run the graph in the GDE, the Input Values Editor opens. After you enter the path to the log file in the Value column for logFileURL and click OK,
the graph uses the specified log file location.
To resolve parameter references, the GDE uses the first value it finds as it progresses through the following:
The component containing the referencing parameter
The containing graph and any of its container graphs
A top-level graph parameter
A project parameter
A parameter of any common projects included by the project
A shell variable defined in a host profile’s setup commands
A Unix environment variable
For additional information on references, refer to “$ and ${ } substitution parameter interpretation”.
Related topics
Creating a subgraph
Saving a subgraph as a component
Viewing subgraphs
Adding ports to a subgraph
Editing subgraphs
Expanding subgraphs

Pre N
viou

GDE Help > Working with graphs and plans > Reusing graphs and graph elements > Using subgraphs > Viewing subgraphs

Viewing subgraphs
Before you can view the contents of a subgraph, Permit View must be selected in the Protection area of the Description tab in the Graph Properties dialog for
the subgraph.
To view the contents of a subgraph:
Double-click the icon for the subgraph in the graph.
A new window opens with the subgraph in it, looking as it does in the following figure:
GDE representation of a subgraph with its contents visible.

To return to the graph, with the subgraph in its original state:

Click the Close button in the top right corner of the window.
Related topics
Creating a subgraph

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 71 of 221

Saving a subgraph as a component

Creating parameters for subgraphs
Adding ports to a subgraph
Editing subgraphs
Expanding subgraphs

Pre N
viou e

GDE Help > Working with graphs and plans > Reusing graphs and graph elements > Using subgraphs > Adding ports to a subgraph

Adding ports to a subgraph

To add ports to a subgraph:
1. If it is not open, open the subgraph so you can see its contents.
2. Click a port of a component in the subgraph just as you would to connect a flow.
3. Drag the mouse pointer to the outer frame of the subgraph.
A port appears on the outside of the frame of the subgraph.
For each component that will receive the subgraph’s input, connect the input port to the left edge of the canvas.
An in port appears on the outside of the canvas at the connection point.
Connect diagnostic ports, which are on the bottom edges of the Ab Initio built-in components, to the bottom edge of the canvas.
An out port appears on the outside of the canvas at each connection point.
For each component that will produce the subgraph’s output, connect the output port to the right edge of the canvas.
An out port appears on the outside of the canvas at the connection point.

Subgraph port binding

A port binding associates ports of components in a subgraph with ports of the subgraph itself. You create port bindings automatically when you add ports to a
subgraph. In the example below, the dotted gray lines represent the port bindings. The outer port always has the same properties as the inner port.
GDE representation of a subgraph with port bindings showing as dotted gray
lines.

Deleting a port binding

To delete a port binding:

1. In the subgraph, right-click the component attached to the binding line.
2. Choose Delete Binding from the pop-up menu, and then choose the associated port.
The port binding is removed from the graph.
Related topics
Creating a subgraph
Saving a subgraph as a component
Creating parameters for subgraphs
Viewing subgraphs
Editing subgraphs
Expanding subgraphs

Pre N
viou e

GDE Help > Working with graphs and plans > Reusing graphs and graph elements > Using subgraphs > Editing subgraphs

Editing subgraphs
Before you can edit a subgraph, Permit Edit must be selected on the Description tab in the Graph Properties dialog for the subgraph.
To edit a subgraph:
1. Do one of the following:
Double-click the subgraph.
Select the subgraph and choose Subgraph > Open from the shortcut menu.
2. Make the changes you want to the contents of the subgraph.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 72 of 221

3. On the GDE menu bar, choose File > Save or File > Save Component “subgraph_name” As to save this subgraph for use as a component in another graph.
4. Choose File > Close Subgraph “subgraph_name” to finish.
Related topics
Creating a subgraph
Saving a subgraph as a component
Creating parameters for subgraphs
Viewing subgraphs
Adding ports to a subgraph
Expanding subgraphs

Pre N
viou e

GDE Help > Working with graphs and plans > Reusing graphs and graph elements > Using subgraphs > Expanding subgraphs

Expanding subgraphs
A subgraph encapsulates components and flows that perform a subtask in a graph or a subtask in a subgraph. By using subgraphs and nested subgraphs and
giving them descriptive names, you can layer the tasks in a graph, reduce the number of immediately visible components, and make the view of the graph
simpler and easier to understand.
If you determine that the graph would be better served by having its subgraph components exposed, you can expand the subgraph, restoring its components
and flows to its parent subgraph or to the top level of the graph.
NOTE: Expanding a subgraph removes the subgraph as its own entity.
To expand a subgraph:
Do one of the following:
Select the subgraph and choose Edit > Subgraph > Expand from the GDE menu bar.
Right-click the subgraph and choose Subgraph > Expand from the pop-up menu.
Related topics
Creating a subgraph
Saving a subgraph as a component
Creating parameters for subgraphs
Viewing subgraphs
Adding ports to a subgraph
Editing subgraphs

Pre N
viou e

GDE Help > Working with graphs and plans > Running graphs and plans

Running graphs and plans

This section contains the following topics:
About graph settings
Running a graph or plan
Stopping a graph or plan
Running a graph from the command line
Starting the GDE from the command line
Tracking running graphs and their parts

Pre N
viou e

GDE Help > Working with graphs and plans > Running graphs and plans > About graph settings

About graph settings

The GDE uses graph settings to determine:
Which options to include in the script that will be generated by the current graph. For details, see “Graph Settings: Script category”.
How the tracking feature will work. For details, see “Graph Settings: Tracking category”.
The level and scope of dependency analysis performed on a graph or an input values set at checkin. For details, see “Graph Settings: Dependency Analysis
category”.
Whether the current graph will use a shared catalog, as well as how it will use the catalog. For details, see “Graph Settings: Catalog category”.
The run mode in which the graph will run — batch, continuous, or continuous nonrecoverable. For details, see “Graph Settings: Run Mode category”.
Which items, such as to-do cues and optional ports, appear in a graph. For details, see “Graph Settings: View category”.
You specify the graph settings in the various category pages of the Graph Settings dialog.

Pre N
viou

GDE Help > Working with graphs and plans > Running graphs and plans > Running a graph or plan

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 73 of 221

Running a graph or plan

Before you run a graph or plan, make sure the following are done:
The graph is fully constructed.
(For graphs only) Flows are connected.
All required parameters are set (you don't see any to-do cues on the graph).
Host connection settings are defined.
To run a graph or plan:
Do one of the following:
From the GDE menu bar, choose Run > Start.
From the Run toolbar, click the Run button .
Press F5.
Run the graph from the command line.
During execution, components are marked with LED status indicators.
You can get detailed tracking information by right-clicking a component or flow and choosing Tracking Detail from the pop-up menu.

Pre N
viou

GDE Help > Working with graphs and plans > Running graphs and plans > Stopping a graph or plan

Stopping a graph or plan

You can stop a graph or plan in the middle of its execution.
To stop a graph or plan:
Do one of the following:
From the GDE menu bar, choose Run > Stop.
From the Run toolbar, click the Stop button .
This stops the graph in the middle of the record, or stops the plan in the middle of a method.
To shut down a continuous graph:
Do one of the following:
From the GDE menu bar, choose Run > Stop or Shutdown > Shutdown.
From the Run toolbar, click the Shutdown button .
This command cleanly shuts down the continuous graph after the next naturally occurring checkpoint has been fully committed.
To force a shutdown of a continuous graph:
Do one of the following:
From the GDE menu bar, choose Run > Stop or Shutdown > Force Shutdown.
From the Run toolbar, click the Force Shutdown button .
This command inserts a checkpoint as soon as possible and cleanly shuts down the continuous graph or continuous nonrecoverable graph after the inserted
checkpoint has been fully committed.
Related topics
Running a graph or plan
Running a graph from the command line
Tracking window

Pre N
viou e

GDE Help > Working with graphs and plans > Running graphs and plans > Running a graph from the command line

Running a graph from the command line

You can run a graph from the command line in either of two ways:
Deploy the graph as a script, then run the script.
For example (after having deployed the graph my_graph to the run directory):
cd my_sandbox/run
./my_graph.ksh
Run the .mp (graph) file directly using the air sandbox run command.
For example:
cd my_sandbox/mp
air sandbox run my_graph.mp
NOTE: To run an .mp file with air sandbox run, you must have Script generation set to Dynamic in the Script category of the Graph Settings dialog.

Input parameters

If a graph does not have any input parameters, you can simply specify the name of the script (or of the graph, if you are using air sandbox run) to run it.
However, if a graph has one or more are required input parameters, you must supply values for the parameters when you run the graph or script. Otherwise, it
will fail with a runtime error.
How you supply an input parameter’s value depends on the each kind of parameter it is:
Keyword — Specify the parameter’s name (preceded by a hyphen) before its value.
For example:
air sandbox run my_graph.mp -IN_FILE customers_info
Or:
./my_graph.ksh -IN_FILE customers_info
Positional — Specify only the parameter’s value, in a prescribed order in relation to other parameters’ values on the command line.
For example:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 74 of 221

air sandbox run my_graph.mp customers_info

Or:
./my_graph.ksh customers_info
(The order in which positional values must be specified is the same as the order in which the parameters appear in the Parameters Editor.)
Environment — Create an environment variable with the same name as the parameter, and assign to it the value you want to specify for the parameter.
For example:
export IN_FILE=customers_info
air sandbox run my_graph.mp
Or:
export IN_FILE=customers_info
./my_graph.ksh

Input values sets

If a graph has input values sets (.pset files) associated with it, you can invoke it implicitly through any one of these sets using air sandbox run (see “Input
Values Editor”). The input parameters get their values from the .pset file, and you do not have to worry about assigning the values correctly for each kind of
parameter. For example, you do not have to type the following:
air sandbox run my_graph.mp -IN_FILE customers_info
Instead, you could type something like this (assuming my_graph_input_values.pset is the valid name of an input values set file associated with the graph):
air sandbox run my_graph_input_values.pset
Consider a graph called test_graph, with two required input parameters, IN_FILE and OUT_FILE. As seen in the Parameters Editor, their definitions look like
this:
Screen capture of the Parameters Editor.

Both parameters are required, and both are Keyword parameters (as specified by their Kind).
To invoke test_graph from the command line as a deployed script, you must specify the parameters’ values explicitly, as follows:
test_graph.ksh -IN_FILE your_file -OUT_FILE my_file
Alternatively, you could store these input values in an input values set, then invoke the graph simply by specifying the set. For example:
air sandbox run test_graph_input_values.pset
Using air sandbox run, when you invoke a graph like this through one of its input values sets, the details of the parameters’ kind (Keyword, Positional,
Implicit, or Environment) are hidden (and you do not have to worry about them).
Optionally, you can specify the parameters’ values explicitly on the command line using air sandbox run:
air sandbox run test_graph.mp -IN_FILE your_file -OUT_FILE my_file

Pre N
viou

GDE Help > Working with graphs and plans > Running graphs and plans > Tracking running graphs and their parts

Tracking running graphs and their parts

You can track and view the runtime information of a graph or of a graph’s components and flows in real-time as they are running. When tracking is enabled,
the GDE displays color-coded status indicators (LEDs) on the graph components and in the Tracking window.
For information about tracking plans, see “Tracking features”.
Related topics
GDE tracking
LED status indicators
Tracking a graph
Tracking graph components or flows
Tracking a port
Accessing tracked graph components and flows

Pre N
viou

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 75 of 221

GDE Help > Working with graphs and plans > Running graphs and plans > Tracking running graphs and their parts > Tracking a graph

Tracking a graph
By default, when you run a graph, the GDE automatically enables tracking. You can adjust settings for tracking in the Tracking category of the Graph Settings
dialog. You can monitor the tracking details while the graph is running.
To track a graph:
1. Before running the graph or while the graph is running, do one of the following:
From the GDE menu bar, choose View > Tracking Details, or press Ctrl+F2.
Right-click the graph and choose Tracking Detail from the pop-up menu.
The Tracking window opens.
2. Click the Run Graph button or press F5.
The Tracking window displays the runtime information.
Related topics
GDE tracking
Tracking running graphs and their parts
LED status indicators
Tracking graph components or flows
Tracking a port

Pre N
viou e

GDE Help > Working with graphs and plans > Running graphs and plans > Tracking running graphs and their parts > Tracking graph components or flows

Tracking graph components or flows

You can monitor the tracking details of individual graph components and flows while the graph is running.
To track graph components and flows while they are running:
1. Right-click the component or flow you want to track, and choose Tracking Details from the pop-up menu.
The Tracking window opens.
2. Click the Run Graph button or press F5.
The Tracking window displays the runtime information.
Related topics
GDE tracking
Tracking a graph
Tracking a port
Accessing tracked graph components and flows

Pre N
viou

GDE Help > Working with graphs and plans > Running graphs and plans > Tracking running graphs and their parts > Tracking a port

Tracking a port
You can monitor the tracking details of a designated port on a component while the graph is running.
To track a port while the graph is running:
1. Right-click the component whose port you want to track.
2. Choose Tracking Detail from the pop-up menu.
The Tracking window opens.
3. Click the Run Graph button or press F5.
The Tracking window displays the runtime information.
Related topics
GDE tracking
Tracking running graphs and their parts
LED status indicators
Tracking a graph
Tracking graph components or flows

Pre N
viou

GDE Help > Working with graphs and plans > Running graphs and plans > Tracking running graphs and their parts > Accessing tracked graph components
and flows

Accessing tracked graph components and flows

You can have the GDE highlight a tracked component or flow in the graph. You turn on the highlighting by selecting a component or flow in the Tracking
Details window. This enables you to easily access and look at the component or flow to better understand the underlying factors resulting in the specific
tracking data.
To access a component or flow in the graph:
In the Tracking Details dialog, right-click a component or flow and choose Go To from the pop-up menu.
The GDE highlights the object on the canvas. If necessary, the GDE scrolls directly to the object bringing it into view.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 76 of 221

Related topics
GDE tracking
Tracking a graph
Tracking graph components or flows
Tracking a port

Pre N
viou e

GDE Help > Working with graphs and plans > Viewing job output

Viewing job output

Job output is displayed in the Application Output window. This section contains the following topics:
About the Application Output window
Looking at the messages
Customizing the window

Pre N
viou

GDE Help > Working with graphs and plans > Viewing job output > About the Application Output window

About the Application Output window

The Application Output window is a tabbed, dockable window at the bottom of the GDE window that opens automatically whenever you:
Execute a shell command from the GDE
Install an example sandbox
Run a graph or plan
Find lookup files
Create a Package for Support
Check in or check out a graph, project, or plan
Trace operations and communications of a graph or plan
Validate a graph or record format, or the syntax of a function or expression
Create data directories for the Ab Initio Environment
Output appears sorted into different tabs according to the kind of output generated.
The following figure shows an example of the Application Output window:
Screen capture showing the Application Output window and its tabs.

Window contents

The Application Output window is made up of four sections:

Tabs — The window is tabbed so it can show many different kinds of output. (For details on the tabs, see “Application Output window”.)
Job drop-down list — Displays the name of the current job and any prior jobs. An icon indicates whether the job ran successfully. Choose a name from the
drop-down list to see the output messages for prior jobs. For more information on the job icons, see “State”.
Message area — Displays the output for the operation.
Window action buttons — Click the window icon to expand the Application Output window to the full size of your screen; click the X to close the
Application Output window.
Task buttons — Click the appropriate button to perform the following tasks:
Print — Print the contents of the displayed tab.
Save As — Save the contents of the displayed tab to a file. Closing the window does not stop the job from running.
Help — Display help for the Application Output window.
Related topics
Viewing job output
Looking at the messages
Customizing the window

Pre N
viou

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 77 of 221

GDE Help > Working with graphs and plans > Viewing job output > Looking at the messages

Looking at the messages

The Application Output window displays a series of status messages as it performs the specified operation.
When you run and save a graph, the job output information is saved with the graph. The next time you open the graph, the saved job output information is
displayed in the Application Output window. A note at the top of the content reminds you that the information may not be up to date. If you make changes to a
graph after it is run and save it without rerunning it, the outdated information is retained. Rerun the graph to get the accurate output.
The GDE displays messages in the Job tab as it processes the graph, such as “Transferring files...,” “Logging in...,” and “Building graph....” If the graph run is
successful, the final message is “Done”.
If the graph fails:
1. The GDE displays “Failed” in the Graph Terminated with Error dialog. To view the first error, do one of the following:
In the Graph Terminated with Error dialog, click View First Error.
From the keyboard, press F4.
The Graph Terminated with Error dialog closes and the first error message scrolls to the top of the Job tab of the Application Output window:
Screen capture showing errors in the Application Output window.

2. Resolve the error using the following aids:

For more information on the error, click Show Details. (Click Hide Details to hide the details.)
Click Go to Component to select the component in which the error occurred, and to open the component’s Properties dialog.
Press Ctrl+F to search for a word or phrase in the text of the message.
3. To move to the next error, press F4 or choose View > Next Error from Job from the GDE menu bar
4. When all of the errors have been resolved, rerun the graph.
Related topics
Viewing job output
About the Application Output window
Customizing the window
Interpreting error messages

Pre N
viou e

GDE Help > Working with graphs and plans > Viewing job output > Customizing the window

Customizing the window

By default, the Application Output window is dockable. That is, whenever the Application Output window overlaps the GDE, it attaches itself to the GDE
window.

Making it undockable

To make the Application Output window a separate window:

1. From the GDE menu bar, choose Settings > Preferences.
2. In the Preferences dialog, select the Workspace category.
3. Deselect the Allow docking of Application Output window checkbox.

Changing font information

You can change the font family, style, and point size of the text in the Application Output window (the defaults are Times New Roman, Regular, 10 point).
To change the font information:
1. Choose Settings > Preferences.
2. In the Preferences dialog, select the Font/Sizes category.
3. Click Change font for Grid and Text View editors, and the Application Output window to open the Font dialog.
4. Change the font family, style, size, and other attributes.
5. Click OK twice to close both dialogs.
Related topics
Viewing job output
About the Application Output window

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 78 of 221

Looking at the messages

Pre N
viou e

GDE Help > Working with graphs and plans > Saving and deploying graphs and plans

Saving and deploying graphs and plans

You can save graphs in the GDE with the .mp extension and save plans with the .plan extension, or you can deploy them as .ksh scripts that can be run from
the command line on a host machine. This section describes:
Saving graphs or plans in the GDE
Deploying graphs as scripts

Pre N
viou

GDE Help > Working with graphs and plans > Saving and deploying graphs and plans > Saving graphs or plans in the GDE

Saving graphs or plans in the GDE

You save graphs and plans to a sandbox, either a local sandbox or a sandbox associated with the Enterprise Meta>Environment (EME) technical repository.
Before saving a graph or a plan, ensure that there is a sandbox available. For more information, see “Sandbox overview”.
When you save graphs in the GDE, they have the .mp extension and are saved to the mp directory in the sandbox. Plans have the .plan extension and are saved
to the plan directory in the sandbox. If you purchased the EME Technical Repository, you can save graphs and plans to the EME technical repository for
version control.
To save an existing graph or plan at the default location in the default format:
1. Do one of the following:
From the GDE menu bar, choose File > Save.
From the GDE main toolbar, click .
In the GDE, press Ctrl+S.
To save a graph or plan with a new name, location or format:
1. From the GDE menu bar, choose File > Save As.
2. Do one of the following:
When saving a new graph, browse to the appropriate sandbox’s mp directory in the Look in box of the Save As dialog.
When saving a plan, browse to the appropriate sandbox’s plan directory in the Look in box of the Save As dialog.
3. In the File name box, type a descriptive name for the file.
4. From the Files of type list, select Graphs (*.mp) or Plans (*.plan), as appropriate.
Save As dialog showing the selected mp directory and the Graphs (*mp) File
type.

Optionally, you can save graphs and plans in a format that runs on older releases of the Co>Operating System and is editable in older releases of the GDE.
Some restrictions apply. For more information see “Saving graphs and plans across GDE versions”.
5. Click Save.

Pre N
viou e

GDE Help > Working with graphs and plans > Saving and deploying graphs and plans > Saving graphs or plans in the GDE > Saving graphs and plans across
GDE versions

Saving graphs and plans across GDE versions

Graphs and plans created in one version of the GDE cannot always be opened in earlier versions.
However, you usually can save a graph or plan in an earlier format so that it can be run by an earlier Co>Operating System and can be edited by an earlier

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 79 of 221

GDE.
WARNING! You might lose new features when saving to an earlier format.
Be aware of the following:
Graphs or plans created in the most current format cannot be opened by GDE versions that were released before the format changed, and plans created for
the most current Co>Operating System version cannot be run by the previous Co>Operating System version.
If you save a graph or plan that uses new features introduced by the current version of either the GDE or the Co>Operating System, you may be unable to
open or run that graph or plan with earlier versions:
For any given graph feature whose attributes affect runtime behavior, you will be unable to open or run that graph in a GDE version earlier than the one
that introduced the feature. Likewise, the graph will not run on a Co>Operating System version prior to one that introduced the feature.
Saving to an earlier version may cause attributes of a graph or plan that don’t affect its runtime behavior to be lost. For example, if you suppress a
validation error on a component in your current-version graph, and then save it as an earlier-version graph, the suppression information will be lost.
Not every graph or plan can be saved in an earlier format; whether or not depends on its contents. The GDE alerts you if a graph or plan cannot be saved in
an earlier format.
The following sections provide information about saving graphs and plans across different versions.
Related topics
Saving graphs to earlier formats
Saving plans to earlier formats

Pre N
viou

GDE Help > Working with graphs and plans > Saving and deploying graphs and plans > Saving graphs or plans in the GDE > Saving graphs to earlier formats

Saving graphs to earlier formats

You can usually save a graph in an earlier format so that it is editable by an earlier version of the GDE (the Files of type list in the GDE Save As dialog
displays the earlier formats available to you).
NOTE: Graphs created in GDE versions earlier than 1.14 and resaved by GDE Version 1.16 are saved in GDE 1.14 format. You cannot save such a graph to
its original format unless you use an earlier GDE.
Before you can open a graph created with a later-version GDE in an earlier-version GDE, you must save the graph to the earlier version.
WARNING! In Version 3.0, the connector components and associated DML files were reorganized and their locations changed. If you save a graph from
Version 3.0.1 (or later versions) back to an earlier version graph format, connector components in the graph will contain references to their Version 3.0
locations. In many cases you will have to change these references back to their pre-3.0 values before you can run the graph in the legacy Co>Operating
System.
Similarly, some connector components contain references to record format files whose installed locations have changed in Version 3.0.1. The correct legacy
pathnames must be restored before the components can be run in the legacy Co>Operating System.
To save a graph to an earlier format:
1. From the GDE menu bar, choose File > Save As. The Save As dialog opens.
2. Select the Local or Host connection setting, and select the location for the file in the Look in drop-down list.
3. From the Files of type list, select one of the following:
Graphs (*.mp) — Saves the graph in the most recent format.
GDE 1.16 Graphs (*.mp) — Saves the graph in a format that can be read by GDE Version 1.16 starting with Version 1.16..
GDE 1.15 Graphs (*.mp) — Saves the graph in a format that can be read by GDE Version 1.15 starting with Version 1.15.5.
GDE 1.14 Graphs (*.mp) — Saves the graph in a format that can be read by GDE Version 1.14, and 1.15 through 1.15.4.
4. Type a name.
5. Click Save to apply your changes and close the dialog.
Related topics
Saving plans to earlier formats
Saving graphs and plans across GDE versions

Pre N
viou e

GDE Help > Working with graphs and plans > Saving and deploying graphs and plans > Saving graphs or plans in the GDE > Saving plans to earlier formats

Saving plans to earlier formats

You can save a plan in an earlier format so that it can be run by an earlier version of the Co>Operating System.
Plans created in 2.14 or 2.15 format and resaved in GDE 3.0 will be saved in 3.0 format. To save such a plan to its original format, you must do so explicitly.
To save a plan to an earlier format:
1. From the GDE menu bar, choose File > Save As.
2. From the Files of type list, select one of the following:
Plans (*.plan) — Saves the plan in the most recent format.
2.15.3 Plans (*.plan) — Saves the plan in a format that can be run by Co>Operating System Version 2.15.3.
2.15.2 Plans (*.plan) — Saves the plan in a format that can be run by Co>Operating System Version 2.15.2.
2.15.1 Plans (*.plan) — Saves the plan in a format that can be run by Co>Operating System Version 2.15.1.
1.14/2.14 Plans (*.plan) — Saves the plan in a format that can be run by Co>Operating System Version 2.14 and opened by GDE Version 1.14.
3. Enter a name and make other necessary changes.
4. Click Save to apply your changes and close the dialog.
Related topics
Saving graphs to earlier formats
Saving graphs and plans across GDE versions

Pre N
viou

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 80 of 221

GDE Help > Working with graphs and plans > Saving and deploying graphs and plans > Saving graphs or plans in the GDE > Saving graphs and plans to an
EME technical repository

Saving graphs and plans to an EME technical repository

To save a graph or plan to an EME technical repository:
From the GDE menu bar, choose Project > Check In.
For detailed information on using the EME technical repository to save graphs, see “Checking in sandboxes, graphs, plans, and files”.

Pre N
viou e

GDE Help > Working with graphs and plans > Saving and deploying graphs and plans > Deploying graphs as scripts

Deploying graphs as scripts

You can save a graph as a .ksh script to the host, along with its supporting files, and then run it from the command line. Deployment is especially useful for
running production jobs.
NOTE: You do not deploy plans. Instead you can schedule them to run as a cron job. For complete information, see “Plan execution and scheduling”.
To deploy a graph as a script:
From the GDE menu bar, choose Run > Deploy Script. The active graph is deployed as a script and the Deploy Job dialog opens, reporting the results.
Scripts are typically saved in the run directory of a sandbox.
To run a script:
Enter it from a shell. For example:
scriptname.ksh
If a script includes paths that use a leading dot (.), you must run the script from its current directory.
NOTE: You cannot automatically create a graph (.mp file) from a deployed .ksh script, but it might be possible to manually reconstruct the components.
How successful this manual conversion is depends on the complexity of the graph. For more information, contact Ab Initio Support.
Related topics
Running a graph from the command line
Tracking the execution of a graph
About custom components and subgraphs
Graph Settings: Script category
Starting the GDE from the command line
Viewing scripts

Pre N
viou

GDE Help > Working with graphs and plans > Saving and deploying graphs and plans > Deploying graphs as scripts > Viewing scripts

Viewing scripts
To display the code generated from the active graph:
Press F7.
You can edit the script start and script end.
To display the script that the GDE will run:
Press Shift + F7.
This script can be slightly different from the deployed graph.

Pre N
viou

GDE Help > Working with graphs and plans > Tracking performance

Tracking performance
You can track the performance of a graph by doing the following:
You can generate tracking data for a deployed script by setting the AB_REPORT configuration variable in the shell you’re running the script in. This will
generate, either to standard output or to a file, information in the same format as GDE text tracking (see “GDE text tracking”).
For more information see “Tracking the execution of a graph”.
You can use operating system utilities, a number of which give useful information about the consumption of system resources while a graph is running.
For more information and some examples, see “Finding the right degree of parallelism for your graph”, and “Observing the performance of the serial write
graph”.
You can use GDE tracking and GDE text tracking.
You can use a speedometer.
This section gives an overview of the following:
GDE tracking
GDE text tracking
Viewing and replaying tracking data
Analyzing tracking data
Using a speedometer
Related topics

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 81 of 221

Optimizing performance

Pre N
viou

GDE Help > Working with graphs and plans > Tracking performance > GDE tracking

GDE tracking
You select GDE tracking for a graph by right-clicking in the GDE and choosing Tracking Detail, or by pressing Ctrl+F2.
This gives you a dialog containing various tracking information that is continuously updated as the graph runs; you set the data update interval on the Tracking
category page of the Graph Settings dialog (which you reach by choosing Settings > Graph Settings in the GDE menu).
Here’s what the GDE Tracking window looks like:
Screen capture of the GDE tracking dialog.

By clicking the View button in the dialog, you can select which information columns you want to see. The kB/s and eff. CPU data is shown only while the
graph is running. These values are not directly captured in text tracking (see the next section), but you can calculate them yourself as follows:
kB/s (kilobytes per second processed) is calculated by dividing the total kilobytes processed at the end of the graph (or of a phase) by the total elapsed time
of the graph (or of the phase).
eff. CPU (effective CPU time) is calculated by dividing the CPU time by the elapsed time for the graph.
You can also select GDE tracking for an individual port of a component by selecting a component, right-clicking, and then choosing Tracking Detail for Port
> port name.
For more information, see “Tracking window”.
Related topics
Tracking performance
GDE text tracking
Viewing and replaying tracking data
Analyzing tracking data

Pre N
viou

GDE Help > Working with graphs and plans > Tracking performance > GDE text tracking

GDE text tracking

You turn on text tracking in the GDE by selecting the Text tracking box on the Tracking page of the Graph Settings dialog (reached through Settings > Graph
Settings on the GDE menu).
Screen capture of the Graph Settings dialog, showing how to select text tracking in the
GDE.

This setting displays tracking information on the Job tab of Application Output window in the GDE. Text tracking information is the same tracking
information you would get for a deployed script if you specified a value for AB_REPORT of:
flows processes scroll=true
The reporting interval is taken from the GDE reporting interval specified on the Tracking category page of the Graph Settings dialog.
Here’s what GDE text tracking looks like in its default form:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 82 of 221

Screen capture of the GDE, showing what text tracking results look like in default form.

In the figure, A marks a section with process information (specified by processes in AB_REPORT), and B marks a flows section (specified by flows in
AB_REPORT).

Changing the GDE text tracking settings

You can change the GDE text tracking settings by explicitly giving a different set of values to AB_REPORT in the graph’s script start (reached through the
Script page of the Graph Settings dialog). If you do this, you must now also set the reporting interval explicitly in AB_REPORT, along with all the other
settings.
Related topics
Tracking performance
GDE tracking
Viewing and replaying tracking data
Analyzing tracking data

Pre N
viou

GDE Help > Working with graphs and plans > Tracking performance > Viewing and replaying tracking data

Viewing and replaying tracking data

You can save the tracking data for a graph so that you can view that data at a later time. This feature displays the tracking data but does not actually rerun the
graph. There are two ways to save tracking data — phase tracking and interval tracking. These compare as follows:

Type of Disk space Useful for graph analysis and

What it saves What it shows
tracking used performance tuning?
Phase Saves data only from the completed phases as they appear Shows the end result Uses less No
tracking at the end of the graph run disk space
Interval Saves data at intervals you specify in the GDE tracking Replays the graph run — showing Uses more Yes
tracking interval and Deployed tracking interval settings on the its state at each interval in addition disk space You can use the Tracking
Graph Settings: Script category page to the end result window to explore the data
further
This section includes two topics:
Using phase tracking
Using interval tracking

Using phase tracking

When you use phase tracking, you create a phase tracking file and then view it.
To create a phase tracking file:
Choose File > Tracking and Output > Save from the GDE main menu.
OR
Choose the Save tracking from the ends of phases only option on the Start and Save dialog.
The GDE creates a .tracking and .log file-pair for this execution of the graph.
To view a phase tracking file:
1. Choose File > Tracking and Output > Load from the GDE main menu.
2. Select a .tracking or .log file.
The GDE loads the file-pair, and displays the final tracking data on the canvas and the output in the Application Output window’s Job tab.
NOTE: The default file-pair names and directory locations for the Save and Load actions depend on several factors, for more information on default
behaviors, see “A note about default directories”.

Using interval tracking

When you use interval tracking, you create an interval tracking file and then replay it.

How replay works

Replaying a graph has the effect of rerunning the tracking data through the GDE, not rerunning the graph itself.
Suppose you run a graph with a tracking interval of one second. The entire graph runs to completion in, say, 40 seconds.
The readings change very quickly in the GDE Tracking window — by default, every second (which is the lowest time interval). The changes occur too

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 83 of 221

quickly for you to be able to see them clearly. You would like to maintain the same granularity of detail in the tracking interval, and yet have time to examine
the data more conveniently as it changes. With tracking replay, you can do that.
You set up a replay file for the graph, as described in the “Creating an interval tracking file” section. Then to rerun the tracking data — but at a slower rate so
that you can follow it better —you choose Run > Replay in the GDE and, instead of the original interval of 1 second, specify a Replay Interval of, say, 10
seconds.
When you click OK, the original tracking data is replayed, but this time at 10-second intervals rather than the original 1-second intervals.
Note that this feature replays only GDE tracking as shown on the graph canvas and in the GDE Tracking window (provided you invoke it). It does not replay
GDE text tracking output, which appears in the Jobs tab of the Application Output window.

Creating an interval tracking file

To create an interval tracking file:

1. From the GDE menu, choose Run > Start and Save Tracking. You see the Start and Save dialog:
Screen capture of the Start and Save dialog, showing how to specify that
tracking data be saved for replay.

2. Select either the run/tracking sandbox directory or the Ab Initio Environment directory as the location where you want the GDE to save the tracking file.
3. Select the Save full tracking for replay option. (This option is not available if you selected Save tracking to the EME technical repository.)
4. Click OK.
The GDE runs the graph and creates an interval tracking file. If an Ab Initio Environment is in use (recommended), the default filename is
$AI_ADMIN_TRACKING/graphname or psetname_timestamp_PID.tracking. Because the default name contains a timestamp, these tracking filenames are
always unique.
NOTE: The interval tracking file’s default directory and name depends on whether your graph is part of a standalone project or sandbox, an Ab Initio
Environment, or whether it is to be saved in an EME technical repository — as indicated by your directory Save tracking selection. For full information on the
possible directories and filenames, see “Start and Save Tracking (graph) dialog”.

Replaying an interval tracking file

To replay an interval tracking data:

1. From the GDE menu, choose Run > Replay. You see the Replay Graph dialog:
Screen capture of the Replay Graph dialog, showing how to specify a
replay interval.

2. In the Replay Graph dialog Tracking File textbox, accept the default path and filename or browse to a new path and filename. You can enter a
parameterized path in this field.
Make sure the Tracking File textbox has the correct pathname of the tracking file written previously.
NOTE: If a default name appears in the Tracking File text box but clicking the OK button displays an error, it means the tracking filename does not match
the graph name — because tracking was saved with a different name or to a different location. Click the browse button to locate the file.
3. Click OK.
Related topics
Tracking performance
GDE tracking
GDE text tracking
Analyzing tracking data

Pre N
viou

GDE Help > Working with graphs and plans > Tracking performance > Analyzing tracking data

Analyzing tracking data

The Tracking log analyzer is a graph you can use to analyze text tracking log files. It can analyze anything from one text tracking log file from the run of one
graph to a whole directory of such files from the runs of many graphs.
You can produce a text tracking log file from the run of a graph by:
Running the m_report_tracking utility command on the file of saved raw tracking data from the run of the graph.
Running a graph in the Ab Initio Environment, in which case the text tracking for the graph gets saved to the log file specified by the AI_SERIAL_LOG
parameter (for more information, see “The Ab Initio Environment”).
You can find the Tracking log analyzer and instructions for its use in the Reusable Solutions section of the Ab Initio Online Discussion Browser.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 84 of 221

Related topics
Tracking performance
GDE tracking
GDE text tracking
Viewing and replaying tracking data

Pre N
viou e

GDE Help > Working with graphs and plans > Tracking performance > Using a speedometer

Using a speedometer
Use the speedometer to measure the following while running a graph:
Kilobytes per second
CPU seconds per second
Records per second
Input and output
To open a speedometer for a graph:
On the menu bar of the GDE, choose Insert > Speedometer.
You can open multiple speedometers to monitor more than one type of measurement concurrently.

Choosing what to measure

To choose which measurement the speedometer displays:

1. Right-click the speedometer.
2. From the shortcut menu, choose one of the following measurements:
Bytes/s — The number of kilobytes per second flowing through the graph during the last tracking interval.
CPUs/sec — A CPU second is the equivalent of one CPU working exclusively on a graph for one second. When a graph is using all of the available
CPU, this value should equal the number of processors used.
Records/sec — The number of records flowing through the graph during the last tracking interval.
3. From the shortcut menu, choose the I/O type to measure:
Inputs — Measures the graph’s inputs
Outputs — Measures the graph’s outputs

Reading the speedometer

The dial displays the current rate of processing. To the right of the dial, the speedometer displays the figures for the current and average rates of processing.
The window on the far right displays a record over time of the rate of processing.
Related topics
Tracking performance
GDE tracking
GDE text tracking
Viewing and replaying tracking data
Analyzing tracking data

Pre N
viou e

GDE Help > Working with graphs and plans > Managing jobs

Managing jobs
The execution of a graph is a job, identified to the Co>Operating System by a jobname that is unique to the directory in which the job runs for the duration of
the run. If a graph fails or you stop it, and then rerun it, it keeps the same jobname.
You can manage several factors that affect the way a job runs. You encounter some of these when constructing the graph, and others when setting up the
environment in which the job runs. If the job fails, you make choices about how to proceed. You can track the job as it runs to see the factors that determine its
outcome.
The following topics describe managing a job:
Preparing to run a job
Running a job
Phases and checkpoints
Failure and recovery
Flow buffering and deadlock
Job tracking in the GDE
About raw tracking data

Pre N
viou

GDE Help > Working with graphs and plans > Managing jobs > Preparing to run a job

Preparing to run a job

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 85 of 221

Before you can run a job, you must set up the computers on which the job will run, enable the Co>Operating System to make the connections between them,
verify that the input and output files are accessible, and make sure the graph is complete.
The following topics provide details:
Computers that run a job
Connecting the GDE and the run host
Developer’s checklist before running a job

Pre N
viou e

GDE Help > Working with graphs and plans > Managing jobs > Preparing to run a job > Computers that run a job

Computers that run a job

A job can run on a variety of configurations of computers that may contain any combination of the following:
A GDE computer
A run host
One or more processing computers

GDE computer

The GDE computer is the computer running the GDE.

Run host

The run host is the computer that starts and controls execution of an Ab Initio graph:
When you run a graph from the GDE, the GDE computer must connect to a run host to run the graph:
For GDE versions earlier than 1.15 — The GDE computer connects to a Co>Operating System on the run host.
The run host must have at least one Co>Operating System installed.
For GDE versions 1.15 and later — The GDE computer connects to the Application Hub on the run host.
The run host must have the Application Hub and at least one Co>Operating System installed.
When you run a graph from a deployed script, the run host is the computer on which you invoke the script.
To run a deployed script, a run host must have at least one Co>Operating System installed.

Processing computers

Processing computers are the computers that run the actual processes of the graph. They must each have the Co>Operating System installed.

Possible configurations

The GDE computer, the run host, and the processing computer can be completely separate, one and the same, or any combination thereof. For instance, it is
common for one symmetric multiprocessor (SMP) to serve as both run host and processing computer for a job.

Examples

The following examples illustrate two possible configurations for computers running a job.

Example 1

Here a job is initiated from the GDE and executed across a run host and three processing computers:
Diagram showing a GDE computer connected to a run host
that is connected to three processing computers.

Run host and three processing computers

Example 2

Here a symmetric multiprocessor computer serves as both the run host and the processing computer(s):
Diagram showing a GDE computer connected
to a symmetric multiprocessor computer.

SMP as both run host and processing computer(s)

Related topics
Connecting the GDE and the run host
Running a job
Developer’s checklist before running a job

Pre N
viou e

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 86 of 221

GDE Help > Working with graphs and plans > Managing jobs > Preparing to run a job > Connecting the GDE and the run host

Connecting the GDE and the run host

Before you can run a job from the GDE, the GDE computer must connect to the run host. The GDE connects to the Application Hub on the run host, using the
path specified in the Host Connection Settings dialog.
Once the GDE connects to the Application Hub, the Application Hub publishes to the GDE a list of the available Co>Operating Systems on the run host — if
you want to use a Co>Operating System other than the default, you can make a choice from this list in the Host Connection Settings dialog of the GDE.
The GDE instructs the Application Hub to initiate the job using the default Co>Operating System or the one specified in the Host Connection Settings
dialog.
You must supply the GDE with the information it needs to make the connection to the run host. You do this in the Host Connection Settings dialog of the
GDE. If you are uncertain about what you should specify in any of the fields of the Host Connection Settings dialog, see your Co>Operating System
administrator.
After you have supplied the required information in the Host Connection Settings dialog, click Test connection to make sure the information you have
provided works to make the connection.

Related topics
Computers that run a job
Running a job
Developer’s checklist before running a job

Pre N
viou e

GDE Help > Working with graphs and plans > Managing jobs > Preparing to run a job > Developer's checklist before running a job

Developer’s checklist before running a job

You can avoid unnecessary failures by using the following checklist before running a job:
Make sure the graph is complete:
All required parameters set
All required ports connected by flows
All layouts specified
Record formats specified for all used ports
Make sure the GDE has the information it needs to connect to the run host (for details, see “Connecting the GDE and the run host”):
For GDE versions lower than 1.15 — Make sure you have supplied all required information and specified any options you want to use in the Graph
Settings and Host Connection Settings dialogs.
For GDE versions 1.15 and higher — Make sure you have supplied all required information and specified any options you want to use in the Host
Connection Settings and Graph Settings dialogs.
Make sure all configuration variables are set appropriately (see your Co>Operating System administrator if you are uncertain).
Make sure all input data files exist and are accessible.
Make sure the directory or multidirectory for the output files exists.
Output files do not need to exist before execution, but the directory in which the Co>Operating System will create the output files must exist. If the output file
will be a multifile, the multidirectory must exist.
Make sure metadata files containing record formats (.dml files) and transform functions (.xfr files) referenced by the graph exist and are accessible.
Related topics
Computers that run a job
Running a job
Before running a job

Pre N
viou

GDE Help > Working with graphs and plans > Managing jobs > Running a job

Running a job
To run a job, you invoke the shell script that the GDE generates from a graph. The script contains a set of commands that define the graph.

Invoking the script

You can invoke the script in two ways:

From the GDE
From a command line

From the GDE

To invoke the script from the GDE, click the Run button or choose Run > Start from the GDE menu bar:
For GDE versions lower than 1.15:
The GDE computer connects to the Co>Operating System on the run host to initiate the job.
The GDE writes the script to the run directory temporarily as GDE-graphname.ksh, and invokes it there.
The run directory is the directory on the run host to which the GDE connects to write files and run graphs.
If there is an active sandbox, the run directory is the directory specified by the sandbox's RUN parameter. If there is no active sandbox, the host directory
specified in the GDE’s Host Settings dialog is used as the run directory.
You can explicitly specify the run directory for a graph — whether or not it is in a

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 87 of 221

sandbox — on the Host tab of the Run Settings dialog in the GDE by deselecting the Use Host Settings Directory checkbox and entering a path in the Host
Directory box.
For details about these directories and dialogs, see the GDE Help for a version lower than 1.15.
For GDE versions 1.15 and higher:
The GDE connects to the Application Hub on the run host. The GDE instructs the Application Hub to initiate the job using the Co>Operating System
specified in the Host Connection Settings dialog of the GDE.
The GDE writes the script to the run directory temporarily as GDE-graphname.ksh, and invokes it there.
The run directory is the directory on the run host in which the GDE writes files and runs graphs.
By default, the run directory is the directory specified by the RUN parameter of the sandbox that contains the graph. If the graph is not in a sandbox, the
default directory specified in the GDE’s Host Connection Settings dialog is used as the run directory. If the default directory is not specified, the home
directory on the run host of the user running the graph is used as the run directory.
You can explicitly specify the run directory for a graph — whether or not it is in a
sandbox — on the Script tab of the Graph Settings dialog in the GDE.
When execution of the graph is completed, the GDE removes the script.
When you save a graph to a directory that is a sandbox, the GDE changes the run directory for that graph to the directory specified by the RUN parameter of
the sandbox.

From a command line

To invoke the script from a command line, type the pathname of the deployed script for the graph.
You deploy the script for a graph by choosing Run > Deploy Script on the GDE menu bar. The GDE deploys the script to the run directory as graphname.ksh.
The Deploy Job dialog appears.
To see the name of the deployed script and the directory to which the GDE deployed it, click Details on the Deploy Job dialog.

For more information

For a detailed explanation of what happens when you run a job, see “How a job runs”.
Related topics
Preparing to run a job

Pre N
viou

GDE Help > Working with graphs and plans > Managing jobs > Phases and checkpoints

Phases and checkpoints

You can design a graph to execute in consecutive stages, called phases, in order to control the use of resources. You can have checkpoints at the boundaries
between phases so that in case of failure you can continue the job from the last completed checkpoint instead of having to run it again from the beginning.

What is a phase?

A phase is a stage of a graph that runs to completion before the start of the next phase. By dividing a graph into phases, you can make the best use of resources
such as memory, disk space, and CPU cycles — ensuring, for example, that sufficient resources will be available for an especially demanding part of the job.
The boundary between two phases is called a phase break, and it belongs to the first of the two phases.
In the process of completing one phase before the next begins, the component immediately before a phase break writes all the data passing through it into
temporary files in the layout of the component immediately after the phase break (layout is discussed in “Layout”). When the first phase completes, the
components after the phase break read these temporary files to begin the next phase.

What is a checkpoint?

A checkpoint is a point at which the Co>Operating System saves all the information it would need to restore a job to its state at that point. In case of failure,
you can recover completed phases of a job up to the last completed checkpoint.
You can have checkpoints only at phase breaks. When you set a phase in the GDE, by default it has a checkpoint at its phase break. You can remove the
checkpoint by clicking the Toggle Checkpoint button .
As the execution of the graph successfully passes the first checkpoint, the Co>Operating System saves all the information it needs to restore the job to its state
at that checkpoint.
As the execution of the graph successfully passes each succeeding checkpoint, the Co>Operating System:
Deletes the information it has saved to be able to restore the job to its state at the preceding checkpoint
Deletes the temporary files it has written in the layouts of the components in all phases since the preceding checkpoint
Commits the effects on the file system of all phases since the preceding checkpoint

Representation in the GDE

The following figure shows a graph in the GDE that has been divided into phases:
Screen capture of a graph in the GDE that is divided into phases.

How phases and checkpoints look in a graph

In the above graph:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 88 of 221

A phase number appears beside each component:

A white phase number inside a solid blue box denotes a phase that has a checkpoint at its phase break.
A blue phase number against a white background denotes a phase that does not have a checkpoint at its phase break.
A phase break that has a checkpoint is indicated by a solid blue bar across a flow .
A phase break from which the checkpoint has been removed is indicated by an unfilled blue bar across a flow .
Note that, although phase 3 appears to have a checkpoint because of the number 3 in a solid blue box, a checkpoint at the end of a graph is meaningless.
Functionally, phase 3 is just the last phase of the graph.
Before inserting phases or checkpoints into a graph, see “Checkpoints versus phases”.
Related topics
Checkpoints versus phases
Considerations when using phases and checkpoints
Using phases with file components
Example of using phases and checkpoints
Setting phases and checkpoints
Viewing phases
Deleting phases and checkpoints

Pre N
viou e

GDE Help > Working with graphs and plans > Managing jobs > Phases and checkpoints > Checkpoints versus phases

Checkpoints versus phases

It is important to understand the information in this topic before inserting phases or checkpoints into a graph.
The following figure shows a graph divided into phases:
Icon for a phase with a checkpoint as described in the surrounding text.

In the above graph:

A phase number appears beside each component:
A white phase number inside a solid blue box denotes a phase that has a checkpoint at its phase break.
A blue phase number against a white background denotes a phase that does not have a checkpoint at its phase break.
A phase break that has a checkpoint is indicated by a solid blue bar across a flow .
A phase break from which the checkpoint has been removed is indicated by an unfilled blue bar across a flow .
Note that, although phase 3 appears to have a checkpoint because of the number 3 in a solid blue box, a checkpoint at the end of a graph is meaningless.
Functionally, phase 3 is just the last phase of the graph.

Terminology

The use of the terms phase, phase break, and checkpoint can be confusing, because each term is commonly used in two different ways:
Checkpoint refers to either of the following:
A phase break at which there is a checkpoint
The whole phase that has a checkpoint at its phase break
Such a phase is also often called a checkpointed phase or a phase with a checkpoint.
Thus, it would be common usage to say, referring to the above graph: “There is a checkpoint at the end of phase 0” or “Phases 0 and 1 are checkpoints.”
Phase refers to either of the following:
Any phase, whether or not it has a checkpoint at its phase break
A phase from which the checkpoint has been removed, as distinguished from one with a checkpoint
Thus, it would be common usage to say, referring to the above graph: “This graph is divided into three phases” or “Phase 2 is just a phase, not a checkpoint.”
Phase break refers to either of the following:
Any phase break, whether or not it has a checkpoint at it
A phase break without a checkpoint as opposed to a phase break with a checkpoint — called a checkpoint
Thus, it would be common usage to say, referring to the above graph: “This graph has three phase breaks” or “This graph has two checkpoints and one phase
break.”

Checkpoints may use fewer resources

A phase break without a checkpoint is not necessarily more efficient than one with a checkpoint, and in some cases a checkpoint may actually use fewer
resources than a phase break without a checkpoint.
As an illustration, consider the following graph fragment with phase breaks at A, B, and C — A and C are checkpoints; B is not:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 89 of 221

A screen capture of a graph fragment as discussed in the surrounding text.

In this graph fragment:

The graph passes checkpoint A at the end of phase 1.
Phase 2, which has no checkpoint at its phase break (B), alters or overwrites the existing data file, Deselected Customers.
Since there is no checkpoint at B, the Co>Operating System must retain the original version of the Deselected Customers file until it reaches the end of phase
3 and passes checkpoint C, in order to be able to roll back to checkpoint A should recovery be necessary.
If there were a checkpoint at B, the Co>Operating System could commit the new version and discard the previous version of the Deselected Customers file as
soon as the graph passed B.

Use checkpoints, not phases

Because a phase break without a checkpoint is typically no more efficient in its use of resources than one with a checkpoint, you should leave the checkpoints
at all phase breaks unless the logic of the graph requires otherwise.
For example, you would need a phase break without a checkpoint in a situation where both of the following apply:
The phase break is necessary to control the use of resources.
In case of a failure, you do not want the job to roll back to that phase break; rather, you want it to roll back to the end of an earlier phase.
Related topics
Phases and checkpoints
Considerations when using phases and checkpoints
Using phases with file components
Example of using phases and checkpoints
Setting phases and checkpoints
Viewing phases
Deleting phases and checkpoints

Pre N
viou e

GDE Help > Working with graphs and plans > Managing jobs > Phases and checkpoints > Considerations when using phases and checkpoints

Considerations when using phases and checkpoints

There are some important considerations to keep in mind when using phases and checkpoints.

Disk space

Because the component immediately before a phase break (the boundary between one phase and the next) writes all the data passing through it into temporary
files in the layout of the component immediately after the phase break, you must allow enough space in the layout of the component after the phase break to
hold all the data passing through the phase break. If you do not, the job will fail.

Trading speed for control

Executing a job in phases breaks pipeline parallelism, due to the separate execution of the phases. This often slows performance to some extent, but phased
execution compensates for the loss of speed by preventing resource-intensive stages from competing with each other.

Trading speed for safety

Just as executing a graph in phases trades speed for better use of resources, using checkpoints trades speed for safety. You still lose the advantage of pipeline
parallelism due to the separate execution of the phases, and in addition the job must perform a small amount of extra I/O at checkpoints to save the
information needed for recovery. But in case of failure you can recover the job from the last completed checkpoint.

Referencing files between phases

Co>Operating System versions lower than 2.12.2 check all input files for existence and create all output files at the beginning of graph execution. This means
that you cannot, for example, reference a file in phase 1 that the graph creates in phase 0 — the job will fail, because when the Co>Operating System checks
for the existence of the phase 1 file at the beginning of graph execution, it will not find it. To solve such problems, use an Intermediate File component, or
insert an m_touch command in the start script with the path to the file as an argument.
Beginning with Co>Operating System version 2.12.2, the Co>Operating System checks input files for existence and creates output files at the beginning of the
phase in which they are written or read, so the problem of referencing files between phases no longer exists. Be aware that if you set the
AB_COMPATIBILITY configuration variable to an earlier version, the Co>Operating System maintains the earlier behavior.
Related topics
Phases and checkpoints
Checkpoints versus phases
Using phases with file components

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 90 of 221

Example of using phases and checkpoints

Setting phases and checkpoints
Viewing phases
Deleting phases and checkpoints

Pre N
viou

GDE Help > Working with graphs and plans > Managing jobs > Phases and checkpoints > Using phases with file components

Using phases with file components

File components are passive entities; that is, they hold data, but they do not process data. The phase of a file component is determined by the phase of each of
the program components connected to it:
The phase number displayed on a file component represents the phase in which this file is accessed by the program components attached to it.
NOTE: If a file component is not connected to a program component, it does not display a phase number. A lookup file component never displays a phase
number, because a lookup is loaded into memory at the beginning of the phase in which it is used (see “An inside view of LOOKUP FILE”).
A range of phase numbers displayed on a file component represents the minimum and maximum phases in which the file component is accessed.
NOTE: A range of phase numbers does not indicate an uninterrupted span of phases. Not all phases within the range necessarily access the file component.
You cannot directly manipulate the phase of a file component. To increment and decrement its phase, you must change the phase of the program components
writing to or reading from the file component:
To change the phase in which a file component is written, you must change the phase of the component writing to it.
To change the phase in which a file is read, you must change the phase of the component reading it.
To modify the phase of the entire flow, you can:
Increment an input file if there are program components downstream on that flow.
Decrement an output file if there are program components upstream on that flow.
Related topics
Phases and checkpoints
Checkpoints versus phases
Considerations when using phases and checkpoints
Example of using phases and checkpoints
Setting phases and checkpoints
Viewing phases
Deleting phases and checkpoints

Pre N
viou e

GDE Help > Working with graphs and plans > Managing jobs > Phases and checkpoints > Example of using phases and checkpoints

Example of using phases and checkpoints

The following figure shows a graph divided into three phases. Two of the phases (phases 0 and 1) are checkpoints, and one of the phases (phase 2) is not a
checkpoint.
Screen capture of a graph in the GDE that is divided into phases.

The effect of phases and checkpoints in a graph

Although phase 3 appears to be a checkpoint because of the number 3 in a solid blue box, a checkpoint at the end of a graph is meaningless. Functionally,
phase 3 is just the last phase of the graph.
The graph uses phases and checkpoints to achieve the following:
Placing Input A and Reformat A in a separate phase from Input B and Reformat B guarantees that Reformat B does not begin to run until Reformat A
finishes running. Thus the two Reformat processes do not compete for resources.
The checkpoint at the end of phase 0 saves the results of the reformatting performed by Reformat A, so that if the job should fail during the next phase, the
first phase does not need to rerun when you restart the job.
The checkpoint at the end of phase 1 saves the results of the whole reformatting process, so that if the job should fail during the sorting phase — phase 2
— the reformatting of the first two phases does not need to rerun when you restart the job.
Placing the TRUNCATE TABLE component in phase 2 and the OUTPUT TABLE component in phase 3 ensures that Truncate Table will run before
Output TablE. Truncate Table needs to run first to remove old data from the table before loading new data.
Using a phase break rather than a checkpoint at the end of phase 2 means that if Output Table fails to complete its load of the database table, the graph will
roll back to the end of phase 1, not the end of phase 2. This ensures that Truncate Table will always run before Output Table loads the database.
Note that this example is oversimplified for clarity. In a graph that you develop to solve an actual business challenge, it is unlikely that only one or two
components will use enough resources to merit inserting a phase. Typically, a phase contains many components.
Related topics
Phases and checkpoints
Checkpoints versus phases
Considerations when using phases and checkpoints
Using phases with file components
Example of using phases and checkpoints
Setting phases and checkpoints
Viewing phases

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 91 of 221

Deleting phases and checkpoints

Pre N
viou

GDE Help > Working with graphs and plans > Managing jobs > Phases and checkpoints > Setting phases and checkpoints

Setting phases and checkpoints

To set phases with checkpoints:
1. Click the Edit Phases button on the Tool toolbar to turn on the Phase toolbar:
Screen
capture
of the

Phase numbers indicating phase 0 appear beside each component.

NOTE: No phase number appears for lookup components or other graph components to which no file component is connected.
2. In the graph, select all the components you want to place in phase 1.
3. Click the Increment Phase button .
I
The phase number beside each selected component, and all downstream components, becomes 1. Phase breaks appear on the flows between phases.
NOTE: The Increment Phase button is disabled if adjusting the phases would inadvertently introduce a gap in the phase numbers. The Decrement Phase
button is disabled if adjusting the phases would mark a negative phase.
4. Select all the components you want to place in phase 2 and click Increment Phase again.
5. Repeat steps 2, 3, and 4 as many times as needed, until all components are associated with a phase.
To change phase numbers after you have set them:
1. Select the phase for which you want to change the phase number.
2. Click the Increment Phase button or the Decrement Phase button to change the phase number.
To select phases in a graph one after another:
Repeatedly click the Show Phase button .

NOTE: By default, all phases are checkpoints, which save graph status. If you do not want to save graph status at a phase break, you can remove the
checkpoint by selecting the phase and clicking the Toggle Checkpoint button from to . The phase no longer saves graph status and the number is in a
white box .
Related topics
Deleting phases and checkpoints

Pre N
viou e

GDE Help > Working with graphs and plans > Managing jobs > Phases and checkpoints > Viewing phases

Viewing phases
To turn on the Phase toolbar:
Click the Edit Phases button on the Tool toolbar.
Screen
capture
of the

Phase numbers appear beside each component.

Related topics
What is a phase?
Setting phases and checkpoints

Pre N
viou

GDE Help > Working with graphs and plans > Managing jobs > Phases and checkpoints > Deleting phases and checkpoints

Deleting phases and checkpoints

To delete all the phases and checkpoints in a graph:
1. Click the Edit Phases button on the Tool toolbar to turn on the Phase toolbar:
Screen
capture
of the

Phase numbers appear beside each component.

2. Select the highest numbered phase in the graph.
To select phases in a graph one after another, repeatedly click the Show Phase button .
3. Click the Decrement Phase button as many times as necessary to reset all phases to 0, the default.
The phase breaks disappear.
Related topics
Setting phases and checkpoints

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 92 of 221

Pre N
viou

GDE Help > Working with graphs and plans > Managing jobs > Failure and recovery

Failure and recovery

If any of the processes associated with the run of a job — including those on the run host and on all processing computers — fails, the Co>Operating System
attempts to:
Terminate all processes running on all computers
Roll back the job to its state at the last completed checkpoint — or, if the job has no checkpoints, roll back the job to its initial state
Provide an error message detailing the cause of the failure
Related topics
Recovery and cleanup
Rollback
Recovery
Considerations when using phases and checkpoints

Pre N
viou

GDE Help > Working with graphs and plans > Managing jobs > Failure and recovery > Rollback

Rollback
Rollback is the action of restoring all files and processes to their state at the completion of the most recently completed checkpoint, as if the job had never
progressed beyond that point. Once a job is rolled back, you can rerun it without repeating the portion before the checkpoint.
The effects of a committed checkpoint cannot be rolled back. In other words, you can only roll back a job to the last completed checkpoint. You cannot roll
back a job further than that; and when you rerun the job, it reruns only from that checkpoint.
You cannot roll back a job to its initial state unless it contains no checkpoints, or unless it fails before it reaches the first checkpoint.
CAUTION! If a job modifies a database, rolling back the job will not restore the database to its original state. You must implement a recovery strategy with
regard to the database before rerunning the job. For details, see “Non-automatic recovery”.

Automatic rollback

When a job fails — due to a disk running out of space, for example, or unexpected data causing a transform function to fail — the Co>Operating System can
typically roll back the job automatically.
In some cases — such as the crash of an operating system or of the network involved in a job — an automatic rollback cannot happen immediately. But even
in such cases, once you correct the condition that caused the failure and restart the job, the Co>Operating System performs the automatic rollback and then
continues the job.
NOTE: In certain rare circumstances, the Co>Operating System cannot roll back the job automatically. If this happens, you must perform a manual rollback
to recover the job. Consult your Co>Operating System administrator.
Related topics
Recovery
Rollback and recovery

Pre N
viou

GDE Help > Working with graphs and plans > Managing jobs > Failure and recovery > Recovery

Recovery
In most cases, you can recover a failed job by simply rerunning the graph after determining the cause of the failure through investigation or debugging and
correcting it. You do not need to modify the graph to pick up where it left off, or to determine how much of it completed. When the Co>Operating System
rolls back a job, it deletes all temporary files and storage created since the last completed checkpoint and terminates all processes, eliminating any need to
repair partially written or appended files or modified directories. Once rolled back, the job is ready to rerun from the last completed checkpoint.
For information about debugging a graph, see “Fundamentals of troubleshooting”.
NOTE: If you do not roll back and rerun the job, you need to clean up temporary files and directories manually. For details, see the m_cleanup command or
consult your Co>Operating System administrator.
When you rerun a job, the Co>Operating System performs a fast-forward recapitulation of the successful checkpointed phases, and then reruns the failed
phase. During the recapitulation, no programs run and no data flows. However, the monitoring system does not distinguish between the recapitulation and an
actual execution. If you enable tracking in the GDE, you observe what looks like very fast execution of the recapitulated phases.
Related topics
Rollback
Rollback and recovery

Pre N
viou e

GDE Help > Working with graphs and plans > Managing jobs > Flow buffering and deadlock

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 93 of 221

Flow buffering and deadlock

With automatic flow buffering turned on (the default in the GDE), deadlock is a rare occurrence.

Deadlock

Deadlock occurs when a program cannot progress, causing a graph to hang. The likelihood of deadlock occurring depends on the patterns of data flows.
A graph carries a potential for deadlock when flows diverge and converge within a single phase. If the flows converge at a component that reads its input
flows in a particular order, that component may wait for records to arrive on one flow even as the unread data accumulates on others, because components
have a limited buffering capacity.
If for any reason automatic flow buffering is turned off, the solution to this problem is to place the diverging and converging flows in different phases.

Automatic flow buffering

Automatic flow buffering examines your graph as you are building it, and adds flow buffering
on any flow that might cause deadlock. The GDE represents flow buffers by a blue dot
on the flow .
All graphs use automatic flow buffering by default.

Exception: Custom components

Custom components that you build to execute your own programs, unlike built-in components, cannot use automatic flow buffering. If such a component is
programmed to read from multiple flows in a specific order, it carries the possibility of causing deadlock. To avoid this possibility, insert a MULTI
REFORMAT component in the graph in front of the custom component. Using this built-in component to process the input flows applies automatic flow
buffering to them before they reach the custom component, thus avoiding the possibility of deadlock.

Pre N
viou e

GDE Help > Working with graphs and plans > Managing jobs > Job tracking in the GDE

Job tracking in the GDE

The Co>Operating System generates tracking information as a job runs. When you run a job from the GDE, the GDE can display this information in two
ways.

The Tracking window

You can open one or several Tracking windows in the GDE and track all, or any combination of, the flows and components in a graph. If you execute the
graph with Tracking windows open, they display tracking information as the graph runs.

Text tracking

If you want more detail than the Tracking windows provide, you can activate text tracking. Text tracking displays Co>Operating System tracking reports on
the Jobs tab of the GDE’s Application Output window. For details about activating text tracking in the GDE, see “Graph Settings: Tracking category”.
A text tracking report is the same report the Co>Operating System displays at the command line when you run a job from a deployed script. For information
about interpreting Co>Operating System tracking reports, see “Tracking the execution of a graph”.
Related topics
Analyzing tracking data

Pre N
viou

GDE Help > Working with graphs and plans > Managing jobs > About raw tracking data

About raw tracking data

The Co>Operating System generates tracking information in one particular format and passes that information on to the GDE, the Technical Repository Web
Interface, and other client applications, each of which filters and displays it in different ways.
Conceptual diagram showing how the underlying tracking
data can be displayed as record counts in the GDE, as
command line output, and as an EME TR job object.

The following topics discuss raw tracking data and its uses:
Creating reports from raw tracking data
Saving raw tracking data
Text tracking reports
Summary reports

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 94 of 221

Interpreting raw tracking data

Pre N
viou

GDE Help > Working with graphs and plans > Managing jobs > About raw tracking data > Creating reports from raw tracking data

Creating reports from raw tracking data

Though you don’t directly see this underlying information — called raw tracking data — you can save it to a file and manipulate it in several ways to create
useful reports.

Goal Action For information, see

Display a text tracking report immediately Use the m_report_tracking utility with AB_REPORT="flows processes" or set “Text tracking reports”
in the Application Output window Text tracking in the Graph Settings: Tracking category in the GDE. “Text tracking”
Create a file containing a summary Use the m_report_tracking utility with AB_REPORT="summary". “Summary reports”
tracking report
Convert tracking information quickly to a Use the tracking.dml file with either the m_dump command or View Data in the “Interpreting raw
structured form and view it GDE. tracking data”
Create a customized tracking report Use the tracking.dml file to load the raw tracking data into graphs. “Customized tracking
reports”

Pre N
viou e

GDE Help > Working with graphs and plans > Managing jobs > About raw tracking data > Saving raw tracking data

Saving raw tracking data

To use raw tracking data, you must save it in a file. There are several ways to do this. Your choice depends on whether you want to save or discard
intermediate values and whether you are running graphs from the GDE or running deployed scripts from the command line. See:
Save with intermediate values (interval tracking)
Save without intermediate values (phase tracking)

What are intermediate values?

As a graph runs, the GDE updates certain values such as the record counts on flows. The update frequency is controlled by the GDE tracking interval (in
Graph Settings: Tracking category). Depending on this value, it is not unusual to see a record count refreshed many times during a single graph execution.
Values that the GDE updates during a graph’s run are intermediate values. You can choose to preserve such values as part of the raw tracking data, or you can
discard them and retain only the final values from the end of each graph phase. The first type of tracking is called interval tracking; the second type is called
phase or phase-end tracking.
NOTE: You must keep intermediate values if you intend to replay graph tracking data. For information, see “Viewing and replaying tracking data”.

Save with intermediate values (interval tracking)

There are two ways to save raw tracking data in such a way that intermediate values are preserved.
When running graphs from the GDE — Use the Run > Start and Save Tracking dialog and select the Save full tracking for replay option.
When running from the command line — Set the AB_TRACKING_RAW_DATA configuration variable.
To save raw tracking data so as to preserve intermediate values in the GDE:
1. From the GDE main menu, choose Run > Start and Save Tracking.
2. In the Start and Save Tracking dialog, choose the Save full tracking for replay option and click OK.
The GDE runs the graph and creates a replayable tracking file. For more information on default filenames and locations, see “A note about default
directories”.
This procedure is equivalent to setting the AB_TRACKING_RAW_DATA variable. Note, however, that any value you have specified in the graph Start script
will override this setting.
To set AB_TRACKING_RAW_DATA from the command line:
1. Type:
% export AB_TRACKING_RAW_DATA=path_to_file/graphname.tracking
2. Run the graph from a deployed script.
As the graph runs, raw tracking records are appended to the tracking file.

Save without intermediate values (phase tracking)

There are three ways to save raw tracking data in such a way that intermediate values are discarded. You can use:
The GDE Save tracking from the ends of phases only option in the Start and Save Tracking dialog
The GDE Save tracking data to technical repository option in the Start and Save Tracking dialog
The File > ,Tracking and Output > Save menu item
To save tracking data when you run the graph:
1. From the GDE main menu, select Run > Start and Save Tracking.
2. In the Start and Save Tracking dialog, choose the Save tracking from the ends of phases only option and click OK.
The GDE saves a tracking file whose default name and location depend on several factors. For more information, see “Start and Save Tracking (graph) dialog
options and their output” and “A note about default directories”.
When you reload the graph in the GDE and then use File > ,Tracking and Output > Load, the raw tracking file is loaded and its contents displayed.
To save tracking data in the EME technical repository:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 95 of 221

Do one of the following to store the raw tracking data in the job object in the technical repository:
Shell — From the command line, run your deployed script with the -reposit-tracking option.
GDE — In the GDE choose Run > Start and Save Tracking dialog, select Save tracking to the EME technical repository, and select the Save phase-only
tracking once, at end of graph or the Save phase-only tracking at each interval option.
To view the information in the technical repository:
In a shell session, enter:
air cat Jobname > path_to_file/graphname.tracking

Pre N
viou

GDE Help > Working with graphs and plans > Managing jobs > About raw tracking data > Text tracking reports

Text tracking reports

Applying the m_report_tracking utility to a raw tracking file immediately displays a text tracking report in the GDE Application Output window.
To view a text tracking report in the Application Output window:
In the GDE, press F8 to display the Execute Command dialog, and type the following (on one line):
AB_REPORT="flows processes" m_report_tracking
path_to_file/graphname.tracking
Setting AB_REPORT before m_report_tracking on the same line exports AB_REPORT to the environment, but only for the duration of the command.
Since the raw tracking data is stored in a file, you don’t need to worry about capturing the text report from standard output. You can simply replay it as needed
after the graph has been run, and you can use AB_REPORT options such as split-cpu or skew.
To replay the report at a slower interval, use the -pause option. For example, the following syntax displays output as if the tracking interval had been set to one
second:
AB_REPORT="flows processes" m_report_tracking -pause 1
path_to_file/graphname.tracking
Related topics
GDE text tracking
m_report_tracking

Pre N
viou e

GDE Help > Working with graphs and plans > Managing jobs > About raw tracking data > Summary reports

Summary reports
Applying the m_report_tracking utility to a raw tracking data file produces a graph tracking summary report in a plain text file.
To produce a summary report from raw tracking data:
1. Run the graph.
2. Type the following in a shell session or the Execute Command dialog in the GDE:
AB_REPORT="summary=mysummary.txt" m_report_tracking
path_to_file/graphname.tracking
The summary report is written to a new file mysummary.txt in the sandbox’s run folder. Sample output from the DML overview.mp graph looks like this:
job-start 0 2010-09-29 13:46:36
component Dedup_Sorted 0 finished 0.225
component Filter_by_Expression 0 finished 0.259
component Reformat 0 finished 0.255
component Rollup 0 finished 0.290
flow Dedup_Sorted.in 0 closed 14 1148
flow Dedup_Sorted.out 0 closed 10 820
flow Filter_by_Expression.in 0 closed 10 820
flow Filter_by_Expression.out 0 closed 8 656
flow Reformat.in 0 closed 8 656
flow Reformat.out0 0 closed 8 744
flow Rollup.in 0 closed 14 1148
flow Rollup.out 0 closed 6 96
phase-end 2 2010-09-29 13:46:39
To read raw tracking data from standard input, use the dash (-) option:
air cat Jobname | AB_REPORT="flows" m_report_tracking -
NOTE: The job must be in the EME technical repository.

About the m_report_tracking utility

To see the options available to m_report_tracking, type the command at the command line or the Execute Command dialog with no arguments:
m_report_tracking
And to see the available settings for AB_REPORT, type:
m_env -describe AB_REPORT
Related topics
Tracking summary reports
Tracking the execution of a graph
m_report_tracking

Pre N
viou e

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 96 of 221

GDE Help > Working with graphs and plans > Managing jobs > About raw tracking data > Interpreting raw tracking data

Interpreting raw tracking data

Tracking data in its raw form has been designed to minimize storage requirements rather than to promote readability. The raw data contains arrays of
encodings and refers to graph objects by IDs rather than names. Although it is possible to view the raw data using either the GDE View Data feature or the
m_dump utility, the results are not likely to be very informative or revealing.
It is also possible to write a graph to process raw tracking data. Such a graph can replace the raw data’s somewhat cryptic tags and IDs with human-readable
names and tracking metrics. The only reason to write such a graph would be to obtain tracking information that is sorted, filtered, or aggregated in some way
not already provided by the standard reports.
The following sections provide general instructions on how to:
Parse and view records from the GDE using the View Data menu option
Parse and view records from the command line using the m_dump command
Load tracking data into a graph and create a customized report

About the tracking.dml file

The tracking.dml file makes it possible to create a structured, records-based view of the raw tracking data. Located in the include folder of the directory where
the Co>Operating System is installed, the tracking.dml file uses conditional DML to describe the format of each of the raw tracking records.

View raw data from the GDE

The tracking.dml file can help you to read and view raw tracking data as a series of records.
To parse and view raw tracking data quickly from the GDE:
1. Place an INPUT FILE or an OUTPUT FILE component in your graph.
2. Point the Data Location URL at the tracking file.
3. Define the input or output port as $AB_HOME/include/tracking.dml.
4. Select the component.
5. Choose the View Data menu option.

View raw data from the command line

The tracking.dml file can help you to dump raw tracking data as a series of records.
To parse and view raw tracking data quickly from the command line:
Type:
% m_dump $AB_HOME/include/tracking.dml path_to_file/graphname.tracking

Customized tracking reports

When you need more than a simple dump of the tracking data records, you can write a graph to filter, transform, and otherwise process the records as required.
To load tracking data into a graph to produce a customized report:
1. Assign the Data location of an INPUT FILE component to point to the raw tracking data file.
2. Use $AB_HOME/include/tracking.dml to define the file’s output port.
The data flowing from the INPUT FILE’s output port is structured as fields and records.
3. Process the records as required.
Related topics
m_dump

Pre N
viou e

GDE Help > Working with sandboxes

Working with sandboxes

A sandbox is a single directory tree in which graphs and related files are stored and are treated as a group for purposes of version control, navigation,
migration, and promotion. The sandbox subdirectories contain files of specific types and have standard names that indicate their function. Sandboxes can be
associated with the Ab Initio Environment and can be checked in to an EME technical repository. For more information about sandboxes and their features,
see “Sandboxes”.
This section describes how to work with sandboxes. It includes the following topics:
Creating a sandbox
Creating data directories for sandboxes in the Ab Initio Environment
Associating a sandbox with a project in the EME technical repository
Opening a sandbox
Identifying sandboxes in the GDE
Adding subdirectories to a sandbox
Creating sandbox parameters
Including a common sandbox
Removing a common sandbox
Overriding common sandbox parameters
Maintaining sandboxes under source control in the EME technical repository
Related topics
Overview of the Ab Initio Environment

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 97 of 221

Working with the technical repository

Pre N
viou

GDE Help > Working with sandboxes > Creating a sandbox

Creating a sandbox
Before creating graphs or plans, you should create a sandbox to contain them. The GDE enables you to create private or public sandboxes that are associated
with the Ab Initio Environment (the preferred method) or basic sandboxes that are not associated with the Ab Initio Environment. For information about the
Ab Initio Environment, see “Overview of the Ab Initio Environment”.
You can also create a sandbox from an existing project in an EME technical repository. For information about working with the repository, see “Technical
Repository Guide for Developers”.
The following sections describe alternative methods for creating sandboxes:
Creating a private sandbox associated with the Ab Initio Environment
Creating a public sandbox associated with the Ab Initio Environment
Creating a basic private sandbox
Creating a basic common sandbox
Creating a sandbox from an existing project in an EME technical repository
Sandbox parameter prefixes

Pre N
viou

GDE Help > Working with sandboxes > Creating a sandbox > Creating a private sandbox associated with the Ab Initio Environment

Creating a private sandbox associated with the Ab Initio Environment

Create a user-specific private sandbox when you want to associate the sandbox with the Ab Initio Environment, and you do not want to share its common
definitions and functionality with other projects.
To create a private sandbox associated with the Ab Initio Environment:
1. From the GDE menu bar, choose Project > Create Sandbox to open the Create Sandbox dialog:
Screen capture of Create Sandbox dialog for private project associated with the Ab Initio Environment

2. From the Host connection drop-down list, select the run host on which you want to create the sandbox.
3. From the Project Type drop-down list, select Ab Initio Private Project.
4. In the Relative Location text box, type the name of the sandbox directory — for example, Project_A.
5. If you want to create the sandbox in a different location from the default displayed in the Root directory text box, type the path or browse to the new root
directory.
By default, the Root directory text box displays the resolved value for $AI_ADMIN_PRIVATE_ROOT, the root directory where the sandbox directory named
in Relative Location will be created. For example:
/disk1/AB_INITIO_ENVIRONMENT/private_sand
6. Click OK.
The GDE displays a message asking whether you want to create data directories that are specific to you for the data used by this private sandbox.
For information about these directories, see “Project data directories”.
7. Click Yes to open the Create Data Directories dialog:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 98 of 221

Screen capture of the Create Data Directories dialog

8. In the Host field, select the appropriate run host connection from the drop-down list.
9. In the Directory field, type the path or click the Browse button to navigate to the directory where the sandbox is located.
10. In the AI_TEST_FLAG text box, type the name you want to use for your user-specific data directories.
The value you type here overrides the value of the AI_TEST_FLAG parameter in the sandbox’s sandbox.pset file.
NOTE: The prefix for parameters in the private project is AI_, except PROJECT_DIR and RUN. For more information, see “Sandbox parameter prefixes”.
11. To create data directories in all associated common projects, select the Include Common Projects checkbox.
12. Click OK.
The new sandbox is opened in the Sandbox View of the GDE:
Screen capture showing a newly-opened
sandbox as represented in the GDE’s
Sandbox View pane.

The Data Directories tab in the Application Output window reports the directories that have been created:
Screen capture showing the Create Data Directories tab in the Application Output window, listing the directories that were created.

13. If you want the sandbox to be checked in to the EME technical repository, choose Project > Check In from the GDE menu bar and follow the instructions
in “Using the Checkin Wizard”.

Related topics
Creating a public sandbox associated with the Ab Initio Environment
Creating a basic private sandbox

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 99 of 221

Creating a basic common sandbox

Creating a sandbox from an existing project in an EME technical repository

Pre N
viou e

GDE Help > Working with sandboxes > Creating a sandbox > Creating a public sandbox associated with the Ab Initio Environment

Creating a public sandbox associated with the Ab Initio Environment

Create a public sandbox when you want to share its common definitions and functionality with other projects associated with the Ab Initio Environment.
To create a public sandbox associated with the Ab Initio Environment:
1. From the GDE menu bar, choose Project > Create Sandbox to open the Create Sandbox dialog:
Screen capture of Create Sandbox dialog for public sandbox associated with the Ab Initio Environment

2. From the Host connection drop-down list, select the run host on which you want to create the sandbox.
3. From the Project Type drop-down list, select Ab Initio Public Project.
4. In the Relative Location text box, type the name of the sandbox directory — for example, XYZ_Common.
5. If you want to create the sandbox in a different location from the default displayed in the Root directory text box, type the path or browse to the new root
directory.
By default, the Root directory text box displays the resolved value for $AI_ADMIN_PUBLIC_ROOT, the root directory where the sandbox directory named
in Relative Location will be created. For example:
/disk1/AB_INITIO_ENVIRONMENT/sand
6. Select the Use Custom Prefix option if you want to create a custom prefix, such as XYZ_, rather than accepting the default, which is based on the relative
path.
NOTE: This prefix is applied to the name of each sandbox parameter, except PROJECT_DIR and RUN. For more information, see “Sandbox parameter
prefixes”.
7. Click OK.
The GDE creates the sandbox and asks you if you want to open it.
8. Click Yes. The new sandbox is opened in the Sandbox View of the GDE:
Screen capture of the the public sandbox
as represented in the GDE’s Sandbox
View pane.

9. If you want the sandbox to be checked in to the EME technical repository, choose Project > Check In from the GDE menu bar and follow the instructions
in “Using the Checkin Wizard”.
Related topics
Creating a private sandbox associated with the Ab Initio Environment
Creating a basic private sandbox
Creating a basic common sandbox
Creating a sandbox from an existing project in an EME technical repository

Pre N
viou e

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 100 of 221

GDE Help > Working with sandboxes > Creating a sandbox > Creating a basic private sandbox

Creating a basic private sandbox

Create a basic private sandbox when you do not want it to be associated with the Ab Initio Environment and do not want to share its common definitions and
functionality with other projects.
To create a basic private sandbox:
1. From the GDE menu bar, choose Project > Create Sandbox to open the Create Sandbox dialog:
Screen capture showing the Create Sandbox dialog for a basic private sandbox

2. From the Host connection drop-down list, select the run host on which you want to create the sandbox.
3. From the Project Type drop-down list, select Basic sandbox.
4. In the Directory text box, type the path or browse to the directory where you want to create the sandbox. For example:
/disk1/projects/private_sand/Ajax_Co
5. In the Location Parameter text box, accept the default, PROJECT_DIR. Although you can change the name, it is not recommended.
6. In the Parameter Prefix text box, type AI_.
NOTE: This prefix is applied to the name of each sandbox parameter, except PROJECT_DIR and RUN. For more information, see “Sandbox parameter
prefixes”.
7. Click OK.
The GDE creates the sandbox and asks you if you want to open it.
8. Click Yes. The new sandbox is opened in the Sandbox View of the GDE:
Screen capture showing a basic private
sandbox as represented in the GDE’s
Sandbox View pane.

9. If you want the sandbox to be checked in to the EME technical repository, choose Project > Check In from the GDE menu bar and follow the instructions
in “Using the Checkin Wizard”.
Related topics
Creating a private sandbox associated with the Ab Initio Environment
Creating a public sandbox associated with the Ab Initio Environment
Creating a basic common sandbox
Creating a sandbox from an existing project in an EME technical repository

Pre N
viou

GDE Help > Working with sandboxes > Creating a sandbox > Creating a basic common sandbox

Creating a basic common sandbox

Create a basic common sandbox when you do not want it to be associated with the Ab Initio Environment and want to share its common definitions and
functionality with other sandboxes that are also not associated with the Ab Initio Environment.
To create a basic common sandbox:
1. From the GDE menu bar, choose Project > Create Sandbox to open the Create Sandbox dialog:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 101 of 221

Screen capture showing the Create Sandbox dialog for a basic private sandbox

2. From the Host connection drop-down list, select the run host on which you want to create the common sandbox.
3. From the Project Type drop-down list, select Basic sandbox.
4. In the Directory text box, type the path or browse to the directory where you want to create the common sandbox. For example:
/disk1/projects/common_sand/ABC_Division
5. In the Location Parameter text box, accept the default, PROJECT_DIR. Although you can change the name, it is not recommended.
6. In the Parameter Prefix text box, type meaningful identifying characters followed by an underscore — for example, ABC_.
NOTE: This prefix is applied to the name of each sandbox parameter, except PROJECT_DIR and RUN. For more information, see “Sandbox parameter
prefixes”.
7. Click OK.
The GDE creates the common sandbox and asks you if you want to open it.
8. Click Yes. The new sandbox is opened in the Sandbox View of the GDE:
Screen capture showing a sandbox as
represented in the GDE’s Sandbox
View pane.

9. If you want the sandbox to be checked in to the EME technical repository, choose Project > Check In from the GDE menu bar and follow the instructions
in “Using the Checkin Wizard”.
Related topics
Creating a private sandbox associated with the Ab Initio Environment
Creating a public sandbox associated with the Ab Initio Environment
Creating a basic private sandbox
Creating a sandbox from an existing project in an EME technical repository

Pre N
viou e

GDE Help > Working with sandboxes > Creating a sandbox > Creating a sandbox from an existing project in an EME technical repository

Creating a sandbox from an existing project in an EME technical repository

You can create your own sandbox from a project that currently exists in an EME technical repository.
To create a sandbox from an existing project in a repository:
1. From the GDE menu bar, choose Project > Check Out to launch the Checkout Wizard:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 102 of 221

Screen capture of the Settings page of the Checkout Wizard, showing setttings for creating a
sandbox for a project in the EME technical project.

2. From the Host connections drop-down list, select the run host.
3. In the EME Technical Repository area, select the appropriate technical repository and branch, and then type the path or browse to the location of the
project.
4. In the Sandbox area, type the path or browse to the location where you want the sandbox to be created.
5. Click Next.
If the sandbox does not already exist, a message asks if you want to create it.
6. Click Yes.
If the project you have identified relies on common projects, the wizard’s Common Projects page lists each of the common projects.
7. For each listed common project, click the Browse button to specify the path in the filesystem for the respective sandbox.
8. Click Next.
9. Click Do Checkout.
The GDE creates the sandbox and asks you if you want to open it.
10. Click Yes.
The Application Output window shows the successful completion of the checkout.
11. From the GDE menu bar choose Project > Check In to open the Checkin Wizard and associate this sandbox with the repository.
For an example of creating a sandbox for an existing project in the repository, see “Creating a sandbox from a private project”.
Related topics
Creating a private sandbox associated with the Ab Initio Environment
Creating a public sandbox associated with the Ab Initio Environment
Creating a basic private sandbox
Creating a basic common sandbox

Pre N
viou

GDE Help > Working with sandboxes > Creating a sandbox > Sandbox parameter prefixes

Sandbox parameter prefixes

When you create a project, you have the option of specifying a prefix for the names of its default parameters. The prefix makes the names unique and thus
prevents collisions between them and the parameters of projects that include them. For this reason, parameter name prefixes are usually useful only for
projects that you intend to use as common projects.
For example, a parameter called COMMON_DML (DML with the prefix COMMON_) in an included project would have a name distinct from the DML
parameter in the client project; without the prefix, both parameters would have the same name, and the common project DML parameter would be shadowed
(hidden and made inaccessible) by the client project’s DML parameter.
If you set a project’s parameter prefix to AI_, for example, its default parameters will be named AI_DML, AI_XFR, AI_DB, and AI_MP as the project is
created.
NOTE: The RUN and PROJECT_DIR parameters are exceptions. No prefix is ever applied to them. Those parameters are used internally, and their names
and values must not be changed.
Related topics
Sandbox overview
Creating a sandbox
Sandbox subdirectories
Sandbox parameters
Sandboxes and the technical repository

Pre N
viou e

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 103 of 221

GDE Help > Working with sandboxes > Creating data directories for sandboxes in the Ab Initio Environment

Creating data directories for sandboxes in the Ab Initio Environment

If you created a private sandbox in the Ab Initio Environment using the Ab Initio Private Project option in the Create Sandbox dialog, you need to create
associated project data directories for data used by that sandbox. If you did not create the data directories at the time you created the sandbox, you can create
them as a separate operation.
In many organizations, multiple users simultaneously run the same graph from the same project associated with the Ab Initio Environment. Without dedicated
data directories for each user, your and other users’ data would be overwritten in the administrator-level directory. To preserve your data, you need to create
serial and multifile data directories that are specific to you. For more information about these directories, see “Project data directories”.
To create user-specific data directories:
1. Do one of the following to open the Create Data Directories dialog:
Select a sandbox in the Sandbox View, and choose Project > Create Data Directories from the GDE menu bar.
In the Sandbox View, right-click the sandbox icon at the top of the tree and choose Create Data Directories from the pop-up menu.
Screen capture showing the Create Data Directories dialog

2. In the Host field, select the appropriate run host connection from the drop-down list.
3. In the Directory field, type the path or click the Browse button to navigate to the directory where the sandbox is located.
4. In the AI_TEST_FLAG text box, type the name you want to use for your user-specific data directories.
The value you type here overrides the value of the AI_TEST_FLAG parameter in the sandbox’s sandbox.pset file.
5. To create data directories in all associated common projects, select the Include Common Projects checkbox.
6. Click OK.
The Data Directories tab in the Application Output window reports the directories that have been created:
Screen capture showing the Create Data Directories tab in the Application Output window, listing the directories that were created.

Related topics
Creating a sandbox
Adding serial data directories for a project

Pre N
viou e

GDE Help > Working with sandboxes > Associating a sandbox with a project in the EME technical repository

Associating a sandbox with a project in the EME technical repository

After you have created a sandbox, you can associate it with a project in an EME technical repository by checking it in to a specified repository and creating
the project.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 104 of 221

To associate a sandbox with a project in the technical repository:

1. From the GDE menu bar, choose Project > Check In.
2. Follow the instructions in “Using the Checkin Wizard”.
For more information, see “Checking in sandboxes, graphs, plans, and files”.
Related topics
Creating a sandbox

Pre N
viou e

GDE Help > Working with sandboxes > Opening a sandbox

Opening a sandbox
To open a sandbox:
1. Do one of the following:
From the GDE menu bar, choose Project > Open Sandbox.
In the Sandbox View, right-click and choose Open Sandbox from the pop-up menu.
2. In the Open dialog, navigate to the sandbox directory of your choice, select it, and click Open.
Related topics
Sandbox overview
Creating a sandbox
Sandboxes and the technical repository

Pre N
viou e

GDE Help > Working with sandboxes > Identifying sandboxes in the GDE

Identifying sandboxes in the GDE

You can have multiple sandboxes open in the Sandbox View of the GDE, each represented by a tab.
The status bar at the bottom of the GDE window indicates which sandbox is associated with the currently open graph.
The tab at the bottom of the Sandbox View indicates which sandbox is currently selected.
Screen capture showing the sandboxes associated with the current graph and with the currently active sandbox in Sandbox
View.

Pre N
viou

GDE Help > Working with sandboxes > Adding subdirectories to a sandbox

Adding subdirectories to a sandbox

Sandboxes have a default subdirectory structure, which in most cases is sufficient to contain all the files associated with the graphs. However, there may be
occasions when you want to add additional subdirectories to contain special reference or resource files for the graphs in a sandbox.
To add a subdirectory to a sandbox:
1. Open the sandbox and press F8 to open the Execute Command dialog.
2. In the Execute Command dialog type the path to the new directory — for example:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 105 of 221

mkdir $AI_XFR/my_directory
NOTE: The Execute Command dialog runs command from $PROJECT_DIR/run.
3. Right-click the project directory item in the Sandbox View and choose Refresh to display the new sandbox directory structure.
4. If you want to reference the new subdirectory directly, create a sandbox parameter for it.
For more information, see “Creating sandbox parameters”.

If your sandbox is under source control in the EME technical repository

If your sandbox is under source control in the EME technical repository, you may or may not want to add the subdirectory (and its contents) to the project.
Some subdirectories you may want to maintain locally.
When you check the project in to the repository, the Checkin Wizard will detect the presence of the new subdirectory and prompt you to specify whether you
want it to be checked in.

If you are using the Ab Initio Environment

In an Ab Initio Environment, you can edit the project templates so that any projects subsequently created will have the additional subdirectories by default. For
more information, see “Project templates”.
Related topics
Sandbox overview
Creating a sandbox
Sandbox subdirectories
Sandboxes and the technical repository

Pre N
viou e

GDE Help > Working with sandboxes > Creating sandbox parameters

Creating sandbox parameters

You can create sandbox parameters to store any values that you want to make available, for whatever reason, to graphs in that sandbox.
For example, although data files are not usually stored in sandboxes, you can create sandbox parameters to point to data files outside the sandbox. For
example, suppose you have the following clients data file:
/my_data_path/clients.dat
You could define a sandbox parameter called DATA_PATH, set it to the value my_data_path, and reference the dataset like this on the Data tab of a
component’s Properties dialog.
Screen capture of part of an Input File component’s Description
properties page, showing how you reference a file by its
subdirectory location in the sandbox.

To create a sandbox parameter:

1. From the GDE menu bar, choose Project > Open Sandbox.
2. If the project is under source control in the EME technical repository, right-click the sandbox directory item at the top of the tree in the Sandbox View and
choose Check out from the pop-up menu.
3. In the Sandbox View, right-click the sandbox directory item and choose Edit Parameters from the pop-up menu to open the Parameters Editor.
4. In the Parameter sets pane of the Parameters Editor, select .project.pset for your sandbox:
Screen capture showing the locked .project.pset file in the Parameters Editor

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 106 of 221

5.
If the sandbox is under source control in the technical repository, click the Lock button on the Parameters Editor toolbar.
6. In the first open row at the bottom of the Parameters grid, type the parameter name in the Name column, and enter its value in the Value column:
Screen capture showing a newly added parameter in the Parameters grid of the Parameters Editor

7. In the Description text box, type a description for the new parameter.
8. Choose File > Save from the Parameters Editor menu bar, and close the Parameters Editor.
9. If the project is under source control in the EME technical repository, choose Project > Check In from the GDE menu bar, and follow the instructions in
“Using the Checkin Wizard”.

Pre N
viou

GDE Help > Working with sandboxes > Including a common sandbox

Including a common sandbox

When you include one sandbox in another as a common sandbox, you make its parameters accessible to the including client sandbox. The common sandbox’s
parameter definitions are then shared with the sandbox that includes it.
To include a sandbox as a common sandbox:
1. Open the sandbox in which you want to include the sandbox.
For example, if you wanted to include XYZ_COMMON as a common sandbox of a sandbox called Project_A, you would first open Project_A.
2. If your project is under source control in the EME technical repository, right-click the .project.pset file in the Sandbox View, and choose Lock from the
pop-up menu:
Screen capture showing how to lock selected .project.pset file in
the Sandbox View

3. In the Sandbox View, right-click the sandbox directory item — Project_A in this example —and choose Include New Common Sandbox from the pop-up
menu to open the following dialog:
Screen capture showing how to use the Include New Common Sandbox
dialog.

4. In the Name text box, type a name for the parameter set of the common sandbox you are including. This name is used in the following ways:
As the label for the included sandbox’s parameter set, this label appears in the left pane of the Parameters Editor.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 107 of 221

As the name of the parameter in the including client sandbox that references the parameter set for the included common sandbox. This parameter
appears in the Parameters grid of the Parameters Editor.
The name you use should be meaningful and consistent:
If you are including one or more common sandboxes, each with a unique name, we recommend that you use the sandbox name in the Name field. In this
example, common sandbox XYZ_COMMON uses name XYZ_COMMON for its parameter set.
If you are including multiple common sandboxes with the same name but from different locations, we recommend that you customize the name to make
it readily apparent which parameter set applies to which included sandbox. For example, suppose you had the following common sandboxes:
/disk1/Div-1/Common
/disk1/Div-2/Common
In this case, you could type Div-1_Common or Div-2_Common in the Name field.
NOTE: The Include New Common Sandbox dialog for Format 2 sandboxes provides a field for the sandbox path only. The name used for the parameter set
label and referencing parameter is always the same as the name of the sandbox.
5. In the Sandbox field, browse to the location of the common sandbox that you want to include, and select it.
6. Click OK to include the specified common sandbox in the including client sandbox.
The tree in the Sandbox View now includes the new common sandbox:
Screen capture showing the including and included project in the Sandbox View

7. If you want to see the included sandbox’s parameter set in the Parameters Editor, double-click the .project.pset file for the including sandbox at the bottom
of the Sandbox View.
The parameter set in the common sandbox is visible in the Parameter sets pane of the Parameters Editor, and the parameter referencing the parameter set is
visible in the Parameters grid for the including client sandbox:
Screen capture showing the parameter set name and referencing parameter in the Parameters Editor

8. If the sandbox is under source control in the EME technical repository, choose Project > Check in from the GDE menu bar and follow the instructions in
“Using the Checkin Wizard”.
NOTE: Be sure to check in common sandboxes before checking in your private sandbox, in reverse order of inclusion. For example, if Project_A includes
Project_B, which in turn includes Project_C, you would first check in Project_C, then Project_B, and then Project_A.
Related topics
Sandbox overview
Creating a sandbox
Sandbox subdirectories
Sandbox parameters
Sandboxes and the technical repository

Pre N
viou e

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 108 of 221

GDE Help > Working with sandboxes > Removing a common sandbox

Removing a common sandbox

If you no longer want to use the parameter definitions of an included common sandbox, you can remove the common sandbox.
NOTE: Removing a common sandbox may change parameters that are visible to the graphs.
To remove a common sandbox:
1. In the Sandbox View of the including client sandbox, lock the .project.pset file.
2. Right-click the included common sandbox, and choose Stop Including Common Sandbox from the pop-up menu.
Related topics
Including a common sandbox

Pre N
viou e

GDE Help > Working with sandboxes > Overriding common sandbox parameters

Overriding common sandbox parameters

Common sandboxes — sandboxes that are included by another client sandbox — supply parameter values to the including client sandbox. You can override
the values of input parameters in included common sandboxes. The methods for creating and editing override values depend on whether the including client
sandbox is a Format 3 sandbox or a Format 2 sandbox. The following sections describe how to create and edit override values:
Creating parameter overrides from Format 3 sandboxes
Editing parameter overrides from Format 3 sandboxes
Creating parameter overrides from Format 2 sandboxes
Editing parameter overrides from Format 2 sandboxes

Pre N
viou e

GDE Help > Working with sandboxes > Overriding common sandbox parameters > Creating parameter overrides from Format 3 sandboxes

Creating parameter overrides from Format 3 sandboxes

In Format 3 sandboxes you can create override values in the .sandbox.pset and .project.pset files for parameters declared in either a Format 2 or a Format 3
common sandbox. If your sandbox is under source control in the EME technical repository, overrides declared in .project.pset are checked in; override values
defined in .sandbox.pset are not checked in. The following sections describe how to override non-dependent and dependent parameters.
Overriding non-dependent parameters in Format 3 sandboxes
Overriding dependent parameters in Format 3 sandboxes

Pre N
viou

GDE Help > Working with sandboxes > Overriding common sandbox parameters > Creating parameter overrides from Format 3 sandboxes > Overriding non-
dependent parameters in Format 3 sandboxes

Overriding non-dependent parameters in Format 3 sandboxes

You can override input parameters that are not dependent on other parameters.
To override a non-dependent parameter in a common sandbox:
1. Right-click the including sandbox’s name in the Sandbox View of the GDE, and choose Edit Parameters from the pop-up menu:
Screen capture showing how to invoke the Parameters
Editor for a sandbox.

2. If the Project overrides grid is not displayed, click the expansion arrow in the middle of the right pane of the Parameters Editor:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 109 of 221

Screen capture showing the expansion arrow for the Common project overrides grid in the Parameters Editor

3. In the Parameter sets pane, select either the .sandbox.pset or .project.pset item:
Changes made to the .sandbox.pset file are saved locally.
Changes made to the .project.pset file can be checked in to the EME technical repository.
NOTE: If you choose .project.pset, click the Lock button in the toolbar to lock the file.
4. From the Parameters Editor menu bar, choose Edit > Create Project Override to open the Create Project Override dialog:
Screen capture showing the Create Project Override
dialog.

5. Make a selection from the Parameter to override drop-down list:

Screen capture showing how to select a common project
parameter to override.

This list includes all eligible common sandbox input parameters that are visible from the sandbox you are currently editing. Each parameter name appears only
once in the list, even if it is declared in more than one common sandbox.
NOTE: Any parameter that already has an override is not listed.
6. Under Project to override, select the common sandbox where you want to make the override. This is important when the parameter you selected is declared
in more than one of the visible common sandboxes.
There are two ways to specify the common sandbox location of the parameter you selected:
First match — Select this option to override the parameter in the first common sandbox in which it is found; that is, closest to the including client
sandbox.
The editor looks at the chain of included sandboxes, beginning with those included directly in the sandbox you are editing, and continuing up through any

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 110 of 221

sandboxes that those common sandboxes include, until it reaches the root project. As soon as it finds a declaration for the parameter you selected, it sets the
override for that declaration.
Choose project — From the drop-down list, select the specific sandbox in which you want the selected parameter to be overridden.
If the parameter you selected in Parameters to override is declared in more than one common sandbox, all of those common sandboxes are displayed here.
7. Click OK to close the dialog. The override parameter you created is displayed in a new row in the Project overrides grid of the Parameters Editor:
Screen capture showing the newly added override in the Project overrides grid

8. In the Project overrides grid, do one of the following:

Type the new override value in the parameter’s Value cell and press Enter; or click the Edit button , type the new value in the text editor, and choose
File > Save.
If this is a Choice parameter, select one of the declared values from the drop-down list in the Value column.
9. Choose File > Save from the Parameters Editor menu bar, and close the Parameters Editor.
10. If the sandbox is under source control in the EME technical repository and you made the change in the project.pset file, choose Project > Check in from
the GDE menu bar, and follow the instructions in “Using the Checkin Wizard”.
NOTE: Be sure to check in common sandboxes before checking in your private sandbox, in reverse order of inclusion. For example, if Project_A includes
Project_B, which in turn includes Project_C, you would first check in Project_C, then Project_B, and then Project_A.
Related topics
Overriding common sandbox parameters

Pre N
viou

GDE Help > Working with sandboxes > Overriding common sandbox parameters > Creating parameter overrides from Format 3 sandboxes > Overriding
dependent parameters in Format 3 sandboxes

Overriding dependent parameters in Format 3 sandboxes

You can override input parameters that are dependent on parameters of type Choice, specifying the specific case you want to override.
To override a dependent parameter in a common sandbox:
1. Right-click the including sandbox’s name in the Sandbox View of the GDE, and choose Edit Parameters from the pop-up menu:
Screen capture showing how to invoke the Parameters
Editor for a sandbox.

2. If the Project overrides grid is not displayed, click the expansion arrow in the middle of the right pane of the Parameters Editor:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 111 of 221

Screen capture showing the expansion arrow for the Common project overrides grid in the Parameters Editor

5. Make a selection from the Parameter to override drop-down list:

Screen capture showing how to select a common project
parameter to override.

This list includes all eligible common sandbox parameters that are visible from the sandbox you are currently editing. Each parameter name appears only once
in the list, even if it is declared in more than one common sandbox.
NOTE: Any parameter that already has an override is not listed.
6. Under Project to override, select the common sandbox where you want to make the override. This is important when the parameter you selected is declared
in more than one of the visible common sandboxes.
There are two ways to specify the common sandbox location of the parameter you selected:
First match — Select this option to override the parameter in the first common sandbox in which it is found; that is, closest to the including client
sandbox.
The editor looks at the chain of included sandboxes, beginning with those included directly in the sandbox you are editing, and continuing up through any

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 112 of 221

sandboxes that those common sandboxes include, until it reaches the root project. As soon as it finds a declaration for the parameter you selected, it sets the
override for that declaration.
Choose project — From the drop-down list, select the specific sandbox in which you want the selected parameter to be overridden.
If the parameter you selected in Parameters to override is declared in more than one common sandbox, all of those common sandboxes are displayed here.
7. Click OK to open the Choose Dependent Case dialog:
Screen capture showing how to specify which case of the dependent parameter to override

8. Select the specific case for the dependent parameter from the drop-down list. The list includes all the declared values for the Choice parameter.
9. Click OK to close the dialog. The override parameter you created is displayed in a new row in the Project overrides grid of the Parameters Editor:
Screen capture showing the override for a dependent parameter case in the Project overrides grid

10. In the Project overrides grid, type the new override value in the parameter’s Value cell and press Enter; or click the Edit button , type the new value in
the text editor, and choose File > Save.
11. Choose File > Save from the Parameters Editor menu bar, and close the Parameters Editor.
12. If the sandbox is under source control in the EME technical repository and you made the change in the project.pset file, choose Project > Check in from
the GDE menu bar, and follow the instructions in “Using the Checkin Wizard”.
NOTE: Be sure to check in common sandboxes before checking in your private sandbox, in reverse order of inclusion. For example, if Project_A includes
Project_B, which in turn includes Project_C, you would first check in Project_C, then Project_B, and then Project_A.
Related topics
Overriding common sandbox parameters

Pre N
viou e

GDE Help > Working with sandboxes > Overriding common sandbox parameters > Editing parameter overrides from Format 3 sandboxes

Editing parameter overrides from Format 3 sandboxes

You can edit the existing override value for a parameter in a common sandbox:
If you want the change to be checked in to the EME technical repository, edit the override value in the .project.pset file.
If you do not want the change to be checked in to the technical repository, edit the override value in the .sandbox.pset file.
To edit an override value for a parameter in a common sandbox:
1. Right-click the including sandbox’s name in the Sandbox View of the GDE, and choose Edit Parameters from the pop-up menu.
2. In the Parameter sets pane of the Parameters Editor, do one of the following:
Select the .project.pset file item and click the Lock button in toolbar.
Select .sandbox.pset.
3. If the Project overrides grid is not displayed, choose View > Project Overrides, or click the expansion arrow in the middle of the right pane of the
Parameters Editor. The Parameters Editor shows all existing parameters, including the override parameters for the included project.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 113 of 221

Screen capture showing a new value for the override in the Project overrides grid in the Parameters Editor

4. In the Project overrides grid, type the new override value in the override parameter’s Value cell and press Enter; or click the Edit button , type the new
value in the text editor, and choose File > Save.
5. Choose File > Save from the Parameters Editor menu bar, and close the Parameters Editor.
6. If the sandbox is under source control in the EME technical repository and you made the change in the project.pset file, choose Project > Check in from
the GDE menu bar, and follow the instructions in “Using the Checkin Wizard”.
NOTE: Be sure to check in common sandboxes before checking in your private sandbox, in reverse order of inclusion. For example, if Project_A includes
Project_B, which in turn includes Project_C, you would first check in Project_C, then Project_B, and then Project_A.
Related topics
Overriding common sandbox parameters

Pre N
viou

GDE Help > Working with sandboxes > Overriding common sandbox parameters > Creating parameter overrides from Format 2 sandboxes

Creating parameter overrides from Format 2 sandboxes

In Format 2 sandboxes you can create override values in the .air-project-parameters and air-sandbox-overrides files for input parameters of types String and
Choice. If your sandbox is under source control in the EME technical repository, overrides declared in .air-project-parameters are checked in; override values
defined in .air-sandbox-overrides are not checked in. The following sections describe how to override non-dependent and dependent parameters.
Overriding non-dependent parameters in Format 2 sandboxes
Overriding dependent parameters in Format 2 sandboxes

Pre N
viou e

GDE Help > Working with sandboxes > Overriding common sandbox parameters > Creating parameter overrides from Format 2 sandboxes > Overriding non-
dependent parameters in Format 2 sandboxes

Overriding non-dependent parameters in Format 2 sandboxes

You can override input parameters of types String and Choice that are not dependent on other parameters.
NOTE: In Format 2 sandboxes, you must create an override of a parameter in .air-project-parameters before you can override it in .air-sandbox-overrides.
To override a non-dependent parameter in a common sandbox:
1. Right-click the including sandbox’s name in the Sandbox View of the GDE, and choose Edit Parameters from the pop-up menu:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 114 of 221

Screen capture showing how to invoke the Parameters

Editor for a sandbox.

2. If the Project overrides grid is not displayed, click the expansion arrow in the middle of the right pane of the Parameters Editor:
Screen capture showing the expansion arrow the the Project overrides grid in the Parameters Editor

3. In the Parameter sets pane, select .air.project.parameters, and click the Lock button in the toolbar to lock the file.
4. From the Parameters Editor menu bar, choose Edit > Create Project Override to open the Create Project Override dialog:
Screen capture of the Create Project Override dialog

5. Make a selection from the Parameter to override drop-down list, which includes all eligible common sandbox input parameters of types String and Choice
that are visible from the sandbox you are currently editing.
NOTE: Any parameter that already has an override is not listed.
Under Project to override, the First match setting specifies that the selected parameter will be overridden in the first common sandbox in which it is found; that
is, closest to the including client sandbox.
The editor looks at the chain of included sandboxes, beginning with those included directly in the sandbox you are editing, and continuing up through any
sandboxes that those common sandboxes include, until it reaches the root project. As soon as it finds a declaration for the parameter you selected, it sets the
override for that declaration.
6. Click OK to close the dialog. The override parameter you created is displayed in a new row in the Project overrides grid of the Parameters Editor:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 115 of 221

Screen capture showing a new override in the Project overrides grid of the Parameters Editor

7. In the Project overrides grid, do one of the following:

If this is a String parameter, type the new override value in the parameter’s Value cell and press Enter; or click the Edit button , type the new value in
the text editor, and choose File > Save.
If this is a Choice parameter, select one of the declared values from the drop-down list in the Value column:
Screen capture showing an override for a parameter of type Choice in the Project overrides grid of the Parameters Editor

8. Choose File > Save from the Parameters Editor menu bar, and close the Parameters Editor.
9. If the sandbox is under source control in the EME technical repository, choose Project > Check in from the GDE menu bar, and follow the instructions in
“Using the Checkin Wizard”.
NOTE: Be sure to check in common sandboxes before checking in your private sandbox, in reverse order of inclusion. For example, if Project_A includes
Project_B, which in turn includes Project_C, you would first check in Project_C, then Project_B, and then Project_A.
Related topics
Overriding common sandbox parameters
Sandbox overview
Creating a sandbox
Sandbox subdirectories
Sandbox parameters
Sandboxes and the technical repository

Pre N
viou e

GDE Help > Working with sandboxes > Overriding common sandbox parameters > Creating parameter overrides from Format 2 sandboxes > Overriding
dependent parameters in Format 2 sandboxes

Overriding dependent parameters in Format 2 sandboxes

In Format 2 sandboxes you can override only parameters dependent on AB_PARAMETER_ENV.
NOTE: In Format 2 sandboxes, you must create an override of a parameter in .air-project-parameters before you can override it in .air-sandbox-overrides.
To override a parameter dependent on AB_PARAMETER_ENV in a common sandbox:
1. Right-click the including sandbox’s name in the Sandbox View of the GDE, and choose Edit Parameters from the pop-up menu:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 116 of 221

Screen capture showing how to invoke the Parameters

Editor for a sandbox.

3. Select .air-project-parameters, in the Parameter sets pane, and click the Lock button in the Parameters Editor toolbar to lock the file.
4. From the Parameters Editor menu bar, choose Edit > Create Project Override to open the Create Project Override dialog:
Screen capture of the Create Project Override dialog

5. Select the dependent parameter from the Parameter to override drop-down list, which includes all eligible common sandbox input parameters of types
String and Choice that are visible from the sandbox you are currently editing.
NOTE: Any parameter that already has an override is not listed.
Under Project to override, the First match setting specifies that the selected parameter will be overridden in the first common sandbox in which it is found; that
is, closest to the including client sandbox.
The editor looks at the chain of included sandboxes, beginning with those included directly in the sandbox you are editing, and continuing up through any
sandboxes that those common sandboxes include, until it reaches the root project. As soon as it finds a declaration for the parameter you selected, it sets the
override for that declaration.
6. Click OK to close the dialog. The override parameter you created is displayed in a new row in the Project overrides grid of the Parameters Editor:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 117 of 221

Screen capture showing the override for the sandbox case of the AB_PARAMETER_ENV parameter in the Project overrides
grid

NOTE: In a Format 2 sandbox, the override always applies to the sandbox case of the parameter dependent on AB_PARAMETER_ENV.
7. In the Project overrides grid, type the override value in the Value cell and press Enter; or click the Edit button , type the new value in the text editor, and
choose File > Save.
NOTE: In a Format 2 sandbox, the override always applies to the sandbox case of the parameter dependent on AB_PARAMETER_ENV.
8. Choose File > Save from the Parameters Editor menu bar, and close the Parameters Editor.
9. If the sandbox is under source control in the EME technical repository, choose Project > Check in from the GDE menu bar, and follow the instructions in
“Using the Checkin Wizard”.
NOTE: Be sure to check in common sandboxes before checking in your private sandbox, in reverse order of inclusion. For example, if Project_A includes
Project_B, which in turn includes Project_C, you would first check in Project_C, then Project_B, and then Project_A.
Related topics
Sandbox overview
Creating a sandbox
Sandbox subdirectories
Sandbox parameters
Sandboxes and the technical repository

Pre N
viou

GDE Help > Working with sandboxes > Overriding common sandbox parameters > Editing parameter overrides from Format 2 sandboxes

Editing parameter overrides from Format 2 sandboxes

You can edit the existing override value for a parameter in a common sandbox:
If you want the change to be checked in to the EME technical repository, edit the override value in the .air-project-parameters file.
If you do not want the change to be checked in to the technical repository, edit the override value in the .air-sandbox-overrides file.
NOTE: For you to edit the value in the .air-sandbox-overrides file for a sandbox under source control in the technical repository, the override value must
first have been defined in .air-project-parameters.
To edit an override value for a parameter in a common sandbox:
1. Right-click the including sandbox’s name in the Sandbox View of the GDE, and choose Edit Parameters from the pop-up menu:
Screen capture showing how to invoke the Parameters
Editor for a sandbox.

2. If the Project overrides grid is not displayed, click the expansion arrow in the middle of the right pane of the Parameters Editor:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 118 of 221

Screen capture showing the expansion arrow the the Project overrides grid in the Parameters Editor

3. In the Parameter sets pane, select .air-sandbox-parameters or .air-project-parameters, depending on whether you want to check the change in to the EME
technical repository. If you select .air-project-parameters, click the Lock button in the Parameters Editor toolbar to lock the file.
4. In the Project overrides grid, type the new value for the override parameter in the Value cell and press Enter; or click the Edit button , type the new
value in the text editor, and choose File > Save.
Screen capture showing the override parameter in the Project overrides grid of the Parameters Editor

5. Choose File > Save from the Parameters Editor menu bar, and close the Parameters Editor.
6. If the sandbox is under source control in the EME technical repository, choose Project > Check in from the GDE menu bar, and follow the instructions in
“Using the Checkin Wizard”.
NOTE: Be sure to check in common sandboxes before checking in your private sandbox, in reverse order of inclusion. For example, if Project_A includes
Project_B, which in turn includes Project_C, you would first check in Project_C, then Project_B, and then Project_A.
Related topics
Sandbox overview
Creating a sandbox
Sandbox subdirectories
Sandbox parameters
Sandboxes and the technical repository

Pre N
viou e

GDE Help > Working with sandboxes > Maintaining sandboxes under source control in the EME technical repository

Maintaining sandboxes under source control in the EME technical repository

After you have created sandboxes, you can maintain them under source control in an EME (Enterprise Meta>Environment) technical repository.
The following topics provide instructions for checking sandboxes, graphs, plans, and files in to and out of an EME technical repository:
Using the Checkin Wizard
Using the Checkout Wizard
Related topics
Working with the technical repository
Using source control in an EME technical repository

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 119 of 221

Pre N
viou

GDE Help > Using source control in an EME technical repository

Using source control in an EME technical repository

An Enterprise Meta>Environment (EME) technical repository stores the named and versioned collection of files and technical metadata for the Ab Initio
applications that you develop. It fosters the sharing of code by supporting source code control and release management — including versioning, branching,
tagging, and promotion. Multiple instances of the technical repository can be deployed to support code promotion and development environments that are
geographically or organizationally distributed.
After you have created sandboxes, you can check them in and maintain them as projects under source control in a technical repository.
The following topics provide information about an EME technical repository and its use for source control, as well as instructions for checking sandboxes,
graphs, plans, and files in and out.
Working with the technical repository
Source control basics
Projects and sandboxes
Using the Checkin Wizard
Using the Checkout Wizard
Dependency analysis basics
Technical Repository Guide for Developers

Pre N
viou e

GDE Help > Using source control in an EME technical repository > Using the Checkin Wizard

Using the Checkin Wizard

You use the Checkin Wizard to check in sandboxes, graphs, plans, or other files to an EME technical repository. For more information, see “Checking in
sandboxes, graphs, plans, and files”.
NOTE: To preserve the most recent changes to a graph or plan, you must save the graph or plan in a sandbox before checking it in. If you have any open
unsaved files when you start the Checkin Wizard, you are prompted to save them, one at a time.
To use the Checkin Wizard:
1. Do one of the following:

To check in: Do one of the following;

The entire sandbox, including all files and directories, as well as all project In the Sandbox View, right-click the sandbox folder at the top of the tree,
parameters and choose Check In from the pop-up menu. This checks in the currently
selected sandbox in the Sandbox View.
From the GDE menu bar, choose Project > Check In. This checks in the
active sandbox shown in the status bar at the bottom of the GDE window.
NOTE: If no sandbox is currently open, choosing Project > Checkin allows
you to select any sandbox for checkin.
An individual graph, together with all related files in the same project that In the mp directory in the Sandbox View, right-click the graph and choose
have been modified, such as record format, transform, and configuration Check In from the pop-up menu.
files, as well as project parameters and the deployed script In the GDE workspace, select the graph and choose File > Check In from
the GDE menu bar, or click the Check In Current Document button on
the toolbar.
An individual plan, and all related files in the same project that have been In the plan directory in the Sandbox View, right-click the plan and choose
modified, such as graphs (and their related files) and the deployed script Check In from the pop-up menu.
In the GDE workspace, select the plan and choose File > Check In from
the GDE menu bar, or click the Check In Current Document button on
the toolbar.
An individual file only In any directory in the Sandbox View, right-click an individual file and
choose Check In from the pop-up menu.
An input values set file In the pset or mp directory in the Sandbox View, right-click an input
values set file and choose Check In from the pop-up menu.
Input values sets with the extension .input.pset are ignored by default when a
project is checked in to an EME technical repository. Input values set files
must be named something like graph-name.pset.
Any sandbox, graph, plan, or file From the GDE menu bar, choose Project > Check In. On the Settings page
of the Checkin Wizard, browse to the object that you want to check in.
NOTE: A checkin option controls whether files that are related to an individual graph or plan being checked in are checked in as well. For more
information, see “Find required files”.
NOTE: If the sandbox includes common sandboxes and you are checking in for the first time, you must check in those common sandboxes first, in reverse
order of inclusion. For example, if Project_A includes Project_B, which in turn includes Project_C, you would first check in Project_C, then Project_B, and
then Project_A.
2. Provide the necessary information on each of the following pages of the Checkin Wizard:
Settings page
Required Files page
Comment page

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 120 of 221

Dependency analysis page

Summary page
Related topics
Checking in sandboxes, graphs, plans, and files
Using the Checkout Wizard

Pre N
viou e

GDE Help > Using source control in an EME technical repository > Using the Checkout Wizard

Using the Checkout Wizard

Use the Checkout Wizard to check out projects, graphs, plans, and files from an EME technical repository. For more information, see “Checking out projects,
graphs, plans, and files”.
To use the Checkout Wizard:
1. Do one of the following:

To check out: Do one of the following;

The entire sandbox, including all files and directories, as well as all project From the GDE menu bar, choose Project > Checkout.
parameters, for the first time NOTE: If no sandbox is currently open, choosing Project > Checkin
allows you to select any sandbox for checkout.
An existing open sandbox, including all files and directories, as well as all In the Sandbox View, right-click the sandbox project folder at the top of
project parameters the tree, and choose Check Out from the pop-up menu. This checks out
the currently selected sandbox in the Sandbox View.
From the GDE menu bar, choose Project > Checkout. This checks out
the active sandbox shown in the status bar at the bottom of the GDE
window.
An individual graph, together with all related files in the same project that In the mp directory in the Sandbox View, right-click the graph and
have been modified, such as record format, transform, and configuration choose Check Out from the pop-up menu.
files, as well as project parameters and the deployed script In the GDE workspace, select the graph and choose File > Check Out
from the GDE menu bar, or click the Check Out Current Document
button on the toolbar.
An individual plan, and all related files in the same project that have been In the plan directory in the Sandbox View, right-click the plan and
modified, such as graphs (and their related files) and the deployed script choose Check Out from the pop-up menu.
In the GDE workspace, select the plan and choose File > Check Out
from the GDE menu bar, or click the Check Out Current Document
button on the toolbar.
An individual file only In any directory in the Sandbox View, right-click an individual file and
choose Check Out from the pop-up menu.
Any sandbox, graph, plan, or file From the GDE menu bar, choose Project > Check Out. On the Settings
page of the Checkin Wizard, browse to the object that you want to check
out.
NOTE: If the sandbox includes common sandboxes and you are checking out for the first time, you must check out those common sandboxes first, in
reverse order of inclusion. For example, if Project_A includes Project_B, which in turn includes Project_C, you would first check out Project_C, then
Project_B, and then Project_A.
2. Provide the necessary information on each of the following pages of the Checkout Wizard:
Settings page
Sandbox Configuration page
Common Projects page
Switch Parameter Values page
Conflicts page
Summary page
Related topics
Checking out projects, graphs, plans, and files
Using the Checkin Wizard

Pre N
viou e

GDE Help > Working with data

Working with data

The graphs you develop in the GDE acquire, format, and use data from disparate sources. Every time you use a GDE editor to create a record format,
transform function, key specifier, or expression, the GDE generates code in Ab Initio’s Data Manipulation Language (DML). The DML describes the data and
the transformation logic as formatted data flows through the graph, computing output values from input values.
For normal data manipulation and transformation, the GDE generates the DML for you, so you can concentrate on your data and your business. Alternatively,
you can write DML directly into the Value box in the Properties dialog, or use any text editor.
For example, this hand-coded DML record format would be automatically generated in the Record Format Editor as shown in the illustration below:
record
decimal (6) cust_id;
string (18) last_name;
string (16) first_name;

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 121 of 221

string (26) street_addr;

string (12) city;
string (2) state;
decimal (5) zip;
string (1) gender;
decimal (7) income;
string (“\n”) newline;
end
Screen capture showing Fields tab of Record Format Editor illustrating automatically
generated DML record format

This section describes various tasks involved in using logical collections of data (or datasets) in a graph. It includes the following topics:
Specifying record formats
Defining and using key fields
Using transform functions
Using packages
Working with user-defined functions
Using databases in graphs
Creating and editing SQL statements with the SQL Editors
Related topics
DML (Data Manipulation Language)

Pre N
viou e

GDE Help > Working with data > Specifying record formats

Specifying record formats

To use datasets in a graph you must first specify record formats to describe the structure of the data they contain. This section contains the following topics
about records and record formats:
About records
About record formats
Specifying the record format of a port
Parameter references in record formats
Creating a record format
Supported data types

Pre N
viou e

GDE Help > Working with data > Specifying record formats > About records

About records
In general, a record is one complete entry in a file or a database table. A record about a customer might contain fields for account number, account type, name,
address, and telephone number.
In Ab Initio software, a record is a DML object that contains a sequence of named fields (called columns in a database table), each of which can be a different
DML base or compound type. Most record types are fairly simple, containing only data fields. For more information, see “What is DML?”
Related topics
About record formats
Record Format Editor
DML (Data Manipulation Language)

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 122 of 221

Pre N
viou

GDE Help > Working with data > Specifying record formats > About record formats

About record formats

A record format describes how data should be interpreted. An accurate description of record structure is a prerequisite to being able to use and access fields of
that structure. When you create record formats, it is good practice to give your fields descriptive names so others will know what they contain.
For example, you might have a database of employees where each record contains four fields:
Six characters for the employee’s first name
Ten characters for the employee’s last name
Three characters for the employee’s age
Six characters for the employee’s date of hire
One employee’s record might look like this (where each square represents one character or byte in the record):

J o h n S m i t h 0 4 5 0 6 0 9 6 5
You can type the DML for the record format directly on the Properties: Ports tab, or create it using the Record Format Editor:
Screen capture of the Record Format Editor.

The equivalent DML is:

record
string(6) first_name;
string(10) last_name;
decimal(3) age;
date("YYYY-MM-DD") date_of_hire;
end;
Related topics
About records
Record Format Editor
Creating a record format
Supported data types

Pre N
viou e

GDE Help > Working with data > Specifying record formats > Specifying the record format of a port

Specifying the record format of a port

You can assign a record format to a dataset or program component on the Ports tab of the component’s Properties dialog:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 123 of 221

Screen capture of the Properties: Ports tab.

On this tab, you specify the record format of a component port using one of the following:
A record type specifier
A reference to a record format in a standalone file (usually with a .dml extension)
A type specifier other than record
Although this is not commonly done, it is perfectly valid. For example, the following type specifier indicates that the record format is simply a five-character
string:
string (5)
Record formats are usually composed of multiple fields. You define a field by using a keyword that represents a DML base or compound type, followed by
additional information that the DML type needs (such as the size of the field), and any optional information.
Related topics
About record formats
Properties: Ports tab
Record Format Editor
Supported data types

Pre N
viou

GDE Help > Working with data > Specifying record formats > Viewing/editing record formats as text

Viewing/editing record formats as text

You view or edit the record format on a component’s port by clicking the Edit button on the Ports tab of the component’s Properties dialog. This invokes the
Record Format Editor, where you can choose:
View > Text View to access the record format as text
View > Grid View to access the record format in the GDE’s grid presentation
If you choose to access the record format as text, you are using the GDE’s text editor. See “GDE text editor and viewer” and “GDE text editor toolbar” for
descriptions of the editor’s features.

Pre N
viou

GDE Help > Working with data > Specifying record formats > Parameter references in record formats

Parameter references in record formats

When using the Record Format Editor to write record formats for ports, you can reference parameters defined in the graph or in the sandbox. Using parameter
references within a record format allows the graph to be more dynamic at runtime. For more information, see “Parameter references and scope”.
This section contains information about:
Resolving parameter references during parameter evaluation
Viewing resolved record formats

Pre N
viou e

GDE Help > Working with data > Specifying record formats > Parameter references in record formats > Resolving parameter references during parameter
evaluation

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 124 of 221

Resolving parameter references during parameter evaluation

To resolve references during parameter evaluation, you must set the record format interpretation type.
To set the interpretation type:
1. On the Ports tab of the Properties dialog, select the port.
2. If the parameter you are referencing is a path to a file, select the Interpret option File contents. For more information, see “The Interpret option”.
Setting the interpretation type for the file contents automatically sets the interpretation type for the file path to PDL (Parameter Definition Language).
NOTE: This option is available only if you are using dynamic script generation, available with Co>Operating System Version 2.15.2 or later and defined in
the Graph Settings: Script category. For more information, see “Parameters and script generation settings”.
3. From the Interpretation drop-down list, select the appropriate interpretation type.
The following graphic shows the selected port, the parameter reference, the Interpret option, and the Interpretation drop-down list in the Properties dialog.
Labeled screenshot of the Ports tab of the Properties dialog.

Related topics
Viewing resolved record formats
When parameter references are evaluated
The Interpret option
Parameter interpretation

Pre N
viou

GDE Help > Working with data > Specifying record formats > Parameter references in record formats > Viewing resolved record formats

Viewing resolved record formats

By default, the Record Format Editor displays an unresolved value for any parameter reference. You can open read-only views of the resolved, expanded
value in either text view or grid view of the Record Format Editor.
In addition, you can see the resolved value in any of the following places in the Parameters Editor:
The Resolved Value box
The tooltip for a transform
The Resolution Details dialog

Displaying resolved values in text view

To open a read-only text view of the Record Format Editor displaying resolved values:
From Record Format Editor menu bar, choose View > Resolved View.
A secondary read-only Record Format Editor window displays the resolved value, as shown in the following graphic.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 125 of 221

Graphic showing text view of the Transform Editor with unresolved values and a
secondary instance of the Transform Editor with resolved values.

Displaying resolved values in grid view

To open a read-only grid view of the Record Format Editor displaying resolved values:
1. From the Record Format Editor menu bar, choose View > Grid View.
A message informs you of the presence of parameter references and prompts you to open the record format in a read-only view.
2. Click Yes.
The following graphic shows the text view of the editable instance of the Record Format Editor with a parameter reference and the grid view of the read-only
Record Format Editor with a resolved value.
NOTE: Grid view of the Record Format Editor cannot open with resolved values if any invalid DML is present in the record format.
Graphic showing text view of the Transform Editor with unresolved values and a
secondary instance of the Transform Editor in grid view with resolved values.

Updating resolved values

To update the resolved value in the Record Format Editor:

In either the read-only text view or grid view of the Record Format Editor, choose View > Refresh from the menu bar.
The file contents of the read-only Record Format Editor are updated with the latest changes.
Related topics
Resolving parameter references during parameter evaluation

Pre N
viou e

GDE Help > Working with data > Specifying record formats > Creating a record format

Creating a record format

To create a record format:
1. Click the component for which you want to create a record format and choose Properties from the pop-up menu. The Properties dialog opens.
2. Click the Ports tab.
For detailed information about the options on this tab, see “Properties: Ports tab”.
3. Select a port in the Ports pane.
4. Click Embed in the Record format source field, then click New. The Record Format Editor opens.
5. In the Record Format Editor, supply a name, data type, and length (or delimiter) for the record fields.
For example, suppose you want to create a record format where default values are assigned to four fields as follows:

Field name Data type Default value

firstname 8-character string Empty string ""
end_date date with format string "YYYYMMDD" Empty string ""

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 126 of 221

count 4-byte integer 0

newline one-character string "\n"
The following figure shows the Record Format Editor for the four fields. Set the default value for each field in the Attributes pane.

Screen capture showing Fields tab of Record Format Editor with four fields illustrating the example

6. To validate your new data record, do one of the following:

From the editor main menu, choose File > Validate.
Click .
7. When you are finished, save the record format in one of two ways:
From the editor main menu, choose File > Save As to save the record format in a separate (.dml) file. Specify the filename in the Save As dialog.
From the editor main menu, choose File > Save As Embedded to embed the record format as a string in the graph.
8. From the editor main menu, choose File > Close to close the Record Format Editor.
9. Click OK to apply your changes and close the Properties dialog.
NOTE: Alternatively, you can create a record format from a COBOL copybook using either the Import from COBOL Copybook dialog or the cobol-to-dml
utility.
Related topics
Record Format Editor
Supported data types
Transform functions

Pre N
viou e

GDE Help > Working with data > Specifying record formats > Supported data types

Supported data types

The Record Format Editor supports the following data types:
Integers
Reals
Decimals
Strings
Dates and datetimes
Voids
Vectors
User-defined types

Integers

An integer is a DML base type that you use to describe data that is a binary number. When you define an integer, you specify its size. Optionally, you can
specify:
Whether the integer is signed or unsigned. If you don’t specify either of these, the value is assumed to be signed.
How the integer is encoded or the ordering of bytes in a multibyte number (big endian or little endian).
For more information, see “Integers”.

Reals

A real (or float) is a DML base type that describes data as a binary floating-point number. Reals are used for calculations involving fractional values.
When you define a real, you specify its size. Optionally, you can indicate how the real is encoded or the ordering of bytes in a multibyte number (big endian or
little endian).
For more information, see “Reals”.

Decimals

A decimal is a DML base type that describes data as a decimal number that is stored as a character — the same way a character is stored in a string. Of course,
decimals can include a decimal point as well as the characters that represent the digits.
For more information, see “Decimals”.

Strings

A string is a DML base type that describes data as text. A string can be of fixed or variable length.
For more information, see “Strings”.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 127 of 221

Dates and datetimes

A date is a DML base type that interprets data as a string representing a calendar date. A datetime is a base type that interprets data as a string representing a
calendar date and a time of day.
For more information, see “Dates and datetimes”.

Voids

A void type is a base type that specifies the size of a block of data whose meaning or internal structure is not necessary to describe. A void can be of fixed or
variable length.
For more information, see “Voids”.

Vectors

A vector is a one-dimensional collection of identically typed data items. You can create vectors using the Vector definition dialog, or you can create a vector
by entering DML code. There are two basic vector types: simple and compound.

Simple vectors

In a simple vector, each element consists of one type specifier. All elements in a vector must be the same type; the element type can be any base type or
another DML compound type. For example, you might have a vector of seven integer (1) elements, each of which stores a number that represents a day of the
week:

1 2 3 4 5 6 7

Compound vectors

In a compound vector, each vector element consists of two or more types. All elements in the vector must be the same types; these types can be any base or
compound DML types. For example, you might have a vector of seven elements, each of which is integer (1); string(3). In this vector, each element stores a
number and a text abbreviation for one day of the week:

1 Mon 2 Tue 3 Wed 4 Thu 5 Fri 6 Sat 7 Sun

User-defined types

User-defined types (sometimes called named types) are custom DML types that you define in terms of other existing DML types. To create a user-defined
type, you associate a unique name with a type definition. Once you create a user-defined type, you can use it as a DML type specifier, as well as in the
definition of other user-defined types.
A user-defined type enables you to associate a complex type with a convenient and meaningful name. Wherever you use the name of a user-defined type,
DML effectively substitutes the type definition.
For example, if record formats or transforms in your graph use identically formatted groups of fields repeatedly, you can create user-defined types to describe
those groups. Then you need only refer to the names of the grouped fields to reuse their type descriptions.
User-defined types also give you the flexibility of redefining the user-defined types without having to change any of the references to the user-defined type.
An example is shown in “Redefining user-defined types”.
Furthermore, user-defined types can be used for local or global variables. An example of this is shown in “User-defined variables and lookups”.
Related topics
Vectors
Vector declaration syntax
Declaring fixed-size vectors
Declaring delimited vectors
Declaring data-sized vectors
Declaring self-sized vectors
Declaring length-prefixed vectors
Creating and initializing vectors
Designing user-defined types
Storing user-defined types in a package file

Pre N
viou e

GDE Help > Working with data > Defining and using key fields

Defining and using key fields

A key is the field or fields of a record upon which the ordering, partitioning, or grouping of the records is based. For example, to group records based on a
field named age, specify age as the key.
A natural key consists of one or more fields that occur naturally in the data and that uniquely identify specific records. For example, a Social Security number
for a person or a serial number for a piece of equipment is a natural key. In contrast, a surrogate key consists of one or more fields that are added to the data
for the express purpose of providing a unique identifier.
To specify a key, you use a key specifier. Key specifiers describe the ordering, partitioning, and grouping of relationships between records. They are used by
components that sort, components that partition, and components that process groups of records. For detailed information, see “Keys and key specifiers”.
A key specifier can contain zero, one, or multiple fields.
This section includes these topics:
Specifying a key

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 128 of 221

Valid key types

Sort sequences
Configuring the lookup type of a lookup file

Pre N
viou

GDE Help > Working with data > Defining and using key fields > Specifying a key

Specifying a key
To specify a key:
1. Open the Key Specifier Editor for the component whose key you want to specify:
Screen capture of Key Specifier Editor

2. To add a field to a key specifier, insert it in the Key Fields pane by doing one of the following:
Double-clicking the field name in the Source Fields pane.
Selecting the field name in the Source Fields pane, and click Add.
Clicking Add All to add all fields to the Key Fields pane.
3. For each field in the key specifier, specify its order and sequence, as follows:
In the Order column, select Ascending or Descending from the drop-down list.
In the Sequence column, for key fields of type string, select machine, phonebook, index, or custom.
For detailed information about sort sequences, see “Sort sequences”.
4. To reorder any key field:
a. Select the field in the Key Fields pane.
b. Click Move Up or Move Down to reorder it in the list.
5. Click OK to save your changes and close the editor.
Related topics
Valid key types
Sort sequences
Keys and key specifiers

Pre N
viou e

GDE Help > Working with data > Defining and using key fields > Valid key types

Valid key types

A key can be an object of any of the following data types:
date
datetime
decimal
integer
real
string
record
subrecords (nested records within records — see “Subrecord keys”)
vector (as of Co>Operating System Version 2.12.2r5)
dml_key_t predefined named type
You cannot use an object of any of the following data types as a key specifier:
void
vector element
union and union fields
this_record

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 129 of 221

function fields
NOTE: If you need to use a function field in a component containing a key, use an upstream REFORMAT or other component to compute the field.
Records containing disallowed types
Related topics
Subrecord keys
Specifying a key
Sort sequences
Configuring the lookup type of a lookup file
Predefined named types
Keys and key specifiers

Pre N
viou

GDE Help > Working with data > Defining and using key fields > Valid key types > Subrecord keys

Subrecord keys
You can use a subrecord as a key parameter in the PARTITION BY KEY, SORT, SORT WITHIN GROUPS, and CHECK ORDER components. For
example, you can have a key {r} with the following record format:

record
record
int a, b;
end r;
end

Pre N
viou e

GDE Help > Working with data > Defining and using key fields > Sort sequences

Sort sequences
Ab Initio software supports four types of sort sequences:

Sort Sequence
Description
Value
machine Uses character code values in the sequence in which they are arranged in the character set of the string. For ASCII-based character sets,
digits are the lowest-value characters, followed by uppercase letters, followed by lowercase letters.
For EBCDIC character sets, lowercase letters are the lowest-value characters, followed by uppercase, followed by digits.
For Unicode character sets, the order is from the lowest character code value to the highest.
phonebook Digits are treated as the lowest value characters, followed by the letters of the alphabet in the order AaBbCcDd..., followed by spaces. All
other characters, such as punctuation, are ignored. The order of digits is 0, 1, 2, 3, 4, 5, 6, 7, 8, 9.
index Is the same as phonebook ordering, except that punctuation characters are not ignored; they have lower values than all other characters.
The order of punctuation characters use the machine sequence.
custom Uses the user-defined sort order. You construct a custom sequence by naming groups of characters, or by naming the characters
themselves. For more information, see “Defining a custom sort sequence for strings” and “Custom sort sequence modifiers”.
By default, DML sequences strings according to the codes of their character sets; these are commonly called character codes, or code points. However, some
graphs require modified sequences that treat some characters as greater or less than others, or ignore certain characters altogether. For detailed information,
see “Defining a custom sort sequence for strings”.
Related topics
Vector key sort order
Valid key types

Pre N
viou

GDE Help > Working with data > Defining and using key fields > Sort sequences > Defining a custom sort sequence for strings

Defining a custom sort sequence for strings

Some graphs require modified sequences for strings that treat some characters as greater or less than others, or ignore certain characters altogether.
To define a custom sort sequence for a string:
1. Open the Key Specifier Editor.
2. Add a string type field to the Key Fields pane; for example enter string or a user-defined type such as type my_type = string(‘\0’).
3. For the key field’s Sequence, select custom from the drop-down list, then click the Edit button . The Sequence Specifier Editor opens.
4. Add character groups to the Selected character groups list in the order in which you want them to be evaluated, by doing one of the following:
Double-click the character group in the Available character groups list.
Select the character group in the Available character groups list, and click Add.
When the predefined character groups cannot provide the results you want, create a character group in the User-defined character group text box, and
click Add.
5. For each character group, specify one of the following modifiers:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 130 of 221

Normal — Makes no modifications to the sort sequence for the character group.
Fold — Considers the character group equivalent for collation.
Ignore — Ignores the specified character group during collation.
6. If you want to reorder a character group, select it in the Selected character group list and click Move Down or Move Up.
7. To modify the sort sequence for all the text in the key field that is currently selected in the Key Specifier Editor, specify one of the following
modifications:
Fold Case — Makes all upper- and lowercase letters of the alphabet equivalent.
Numbers as text — Sorts numbers using DML’s default character order rather than numeric order.
8. Click OK to save your changes and close the editor.
When you add a custom sequence, the information is added to the value of key. For example, if you define the sort sequence for a key field of street to ignore
whitespace and punctuation, the key value is:
{street ignore whitespace ignore punctuation}

Examples

To make all uppercase and lowercase letters of the alphabet equal:

Select Fold Case.
To treat all numbers the same:
1. Add digit to the Selected character groups list.
2. Select Fold.
To ignore all punctuation and whitespace:
1. Add whitespace and punctuation to the Selected character groups list.
2. For each character group, click Ignore.

Pre N
viou e

GDE Help > Working with data > Defining and using key fields > Sort sequences > Vector key sort order

Vector key sort order

When the data is sorted on a vector key (as in a SORT or MERGE component), vectors are compared as follows:
Vectors are compared element-by-element according to the comparison rules for the vector's element type.
Earlier elements in the sequence are more significant than later elements.
If two vectors of different lengths have equal elements up to the length of the shorter vector, the shorter vector is considered less than the longer one.
A zero-length vector is considered less than any nonzero-length vector.
If an entire vector evaluates to NULL, it is considered less than any non-NULL vector.

Pre N
viou e

GDE Help > Working with data > Defining and using key fields > Configuring the lookup type of a lookup file

Configuring the lookup type of a lookup file

You define the Special attribute (in the Key Specifier Editor) of a key field in a lookup file to determine the type of lookups that can be performed against that
lookup file.
By default, the Special attribute is set to exact. If a key is an exact type, lookup operations involve searching for a specific value. You can also define a key in
a lookup file as an interval or a regular expression (regex).
For detailed information, see “Specifying an interval lookup modifier”.
Related topics
Specifying a key
Types of lookup operations
Specifying a regex lookup modifier

Pre N
viou

GDE Help > Working with data > Using transform functions

Using transform functions

This section contains these topics:
About transform functions
Creating transforms
Rules in transform functions
Statements in transform functions
Local variables in transform functions
Adding comments to transform functions
Parameter references in transforms
Specifying where a transform is stored
Making recursive calls in transforms

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 131 of 221

Pre N
viou e

GDE Help > Working with data > Using transform functions > About transform functions

About transform functions

Transform functions (or transforms) drive nearly all data transformation and computation in Ab Initio graphs. Typical simple transforms can:
Extract the year from a date
Combine first and last names into a full name
Determine the amount owed in sales tax from a transaction amount
Validate and cleanse existing fields
Delete bad values or reject records containing invalid data
Set default values
Standardize field formats
Merge or aggregate records
A transform function is a collection of transform rules, local variables, and statements. The transform expresses the connections between the rules, variables,
and statements, as well as the connections between these elements and the input and output fields.
Transform functions are associated with transform and other components that have either a transform parameter or package parameter.
Some of the components with a transform parameter are Aggregate, CALL STORED PROCEDURE, CONTINUOUS ROLLUP, Dedup Sorted, ftp
MULTIPLE FROM, Fuse, Join, Match Sorted, Normalize, READ MULTIPLE BLOCK-COMPRESSED DATA, Reformat, Rollup, Scan, and WRITE
MULTIPLE FILES.
Some of the components with a package parameter are asn.1 decoder, CONTINUOUS UPDATE TABLE, FILTER BY EXPRESSION, update table,
write-blocked COMPRESS LOOKUP, validate records, and WRITE XML TRANSFORM.
Each component that has a transform or package parameter:
Determines the values that are passed to the transform function, or multiple transform functions in the case of a package parameter
Interprets the results of the transform function or functions
Related topics
Creating transforms
Creating transform functions
Transform functions
Using packages
Syntax

Pre N
viou e

GDE Help > Working with data > Using transform functions > Creating transforms

Creating transforms
To create a transform, you create rules, variables, and statements and describe the relationships between them using the Transform Editor. You can prioritize
rules of a transform, and you can save the value of a transform parameter to a file.
The Transform Editor has two views: grid and text. In grid view, you create a rule by dragging and dropping. In text view, you create a transform using the
Ab Initio Data Manipulation Language (DML). You can switch back and forth between grid and text views as needed to create and modify transforms. For
more information, see “What is DML?”.
NOTE: DML guarantees the order of execution of statements and prioritized rules. However, DML cannot guarantee the order in which expressions are
evaluated or the order of assignment to output fields.
CAUTION! A package cannot contain a transform function that has the same name as the package.
This section includes these topics:
Grid view of the Transform Editor
Text view of the Transform Editor
DML function and operator palettes
The following figure shows grid view of the Transform Editor:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 132 of 221

Screen capture showing the four panes of the Transform Editor.

To display the Transform Editor in grid view:

1. Double-click a graph component that has a transform parameter. The Properties dialog opens.
2. On the Parameters tab, double-click the transform parameter (or select transform in the Parameters list, then click New or Edit).
3. The Transform Editor opens. If the editor opens in text view, choose View > Grid.
TIP: You can also display the Transform Editor without going through the Properties dialog: Shift-double-click a component that has a transform
parameter.
You can also use the Transform Editor in text view to create transforms using DML. For more information, see “Text view of the Transform Editor”.
Related topics
Creating rules
Statements in transform functions
Local variables in transform functions
Adding comments to transform functions
Transform Editor: Grid view menus
Transform Editor: Grid view toolbar
Creating transforms

Pre N
viou

GDE Help > Working with data > Using transform functions > Creating transforms > DML function and operator palettes

DML function and operator palettes

Use the DML Functions Palette and DML Operators Palette to drag-and-drop predefined functions and operators into the Record Format Editor, Transform
Editor, and other editors instead of typing them.
To use these palettes:
1. From the GDE menu bar, choose either View > Functions or View > Operators. The appropriate palette opens.
For example, the following figure shows the DML Functions palette.
This screen shot shows the DML
Functions palette with its available
functions.

2. Click the plus sign beside the appropriate category to expand it.
For example, to reach the today function, expand the Date Functions category and scroll down to the function.
3. Click the function and drag-and-drop it into the editor.
4. Question marks show information that must be added (such as input arguments). For example:
datetime_day_of_year(?)
Add the missing information.
You can dock the palettes in the main GDE window, so they are readily available. The following figure displays the DML Functions and DML Operators
palettes docked in the GDE main window:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 133 of 221

This screen capture shows the DML Functions and DML Operators palettes docked in the left side of the GDE main window.

Pre N
viou

GDE Help > Working with data > Using transform functions > Rules in transform functions

Rules in transform functions

This section includes these topics:
Creating rules
Editing rules
Prioritizing rules
Generating default rules

Pre N
viou e

GDE Help > Working with data > Using transform functions > Rules in transform functions > Creating rules

Creating rules
A rule, or transform rule, is an instruction in a transform function that directs the construction of one field in an output record. You create rules using the
Transform Editor in either grid view or text view.
NOTE: Because there is no graphical mechanism for working with NULLs in rules, the best way to work with NULLs is by using DML code in text view of
the Transform Editor.

Using grid view

Use grid view of the Transform Editor to create rules using drag-and-drop techniques.
To create a rule:
1. If it is not already open, display the Transform Editor grid.
2. Click the Transform Rules tab.
3. Drag an input field from the Inputs pane into a cell on the Transform Rules tab. Arrows indicate the flow of data.
To use another input field in the rule, drag another input field into the cell.
4. To alter the data in the fields you have dragged into the cell, do one of the following:
Type an expression incorporating the field names.
Right-click the rule, then choose Edit Rule from the shortcut menu to open the Expression Editor. For more information, see “Editing rules”.
5. Connect an input field to an output field as follows:
a. Select the rule port.
b. Press and hold the left mouse button and drag the pointer to the field name in the Outputs pane to which you want to connect the rule.
c. When the editor displays an arrow pointing to the field name, release the mouse button.
TIP: To quickly copy a field from the input to the output with no changes, simply drag the field from the Inputs pane to the Outputs pane.
The following figure shows how a transform is displayed in grid view:
Screen capture of a transform in grid view.

NOTE: When you create transforms in grid view, the transforms are automatically translated into DML code. To view the generated code, select View >
Text from the Transform Editor main menu.

Using text view

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 134 of 221

Use the Transform Editor in text view to create transforms by entering the DML code directly.
NOTE: For more information about working with DML, see these topics:
Creating transform functions
Transform functions
Syntax
To create a rule:
1. If it is not already open, display the Transform Editor in text view.
2. Enter statements using the syntax described in “Working with transform rules”.
The following figure shows the transform in text view:
Screen capture of a transform in text view.

Related topics
Working with transform rules
Generating default rules
Editing rules
Prioritized transform rules
Prioritizing rules
Transform rule evaluation results
Examples of unprioritized transform rules
Examples of prioritized transform rules
NULL values in transform rules
Using wildcards in transform rules

Pre N
viou e

GDE Help > Working with data > Using transform functions > Rules in transform functions > Editing rules

Editing rules
The Expression Editor enables you to create DML expressions using drag-and-drop techniques. It has three panes:
Fields — Displays the input record formats available for use in an expression.
Functions — Displays the built-in and any user-defined DML functions.
Operators — Displays the built-in DML operators.
The following figure shows the Expression Editor:
This screen capture shows the Expression Editor.

To create or edit an expression:

1. In the Transform Editor, select a rule, then choose Edit > Rule or press F2. The Expression Editor opens.
2. Do one of the following:
Double-click or drag-and-drop fields, functions, and operators from the panes in the top half of the editor to insert them into the Expression pane at the
bottom of the editor.
Press the Alt key and drag-and-drop a subrecord field name to the bottom pane to automatically create an elided name.
Type directly into the Expression pane.
3. To check that you have used correct syntax and spelled all field names correctly, click Validate.
Related topics
DML expressions

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 135 of 221

Expression Editor
Creating transform functions

Pre N
viou e

GDE Help > Working with data > Using transform functions > Rules in transform functions > Editing transforms in the BRE

Editing transforms in the BRE

From the GDE, you can directly access the BRE to open and edit transforms associated with the REFORMAT, FILTER, and JOIN components that were
created as rulesets in the BRE.
To edit a transform created by the BRE, do either of the following in a graph:
Right-click the subgraph representing the BRE ruleset, and select Edit ruleset in BRE from the pop-up menu.
Double-click a subgraph created by the BRE, right-click a component in the subgraph, and select Edit ruleset in BRE.

Pre N
viou

GDE Help > Working with data > Using transform functions > Rules in transform functions > Prioritizing rules

Prioritizing rules
With prioritized rules, you can attach more than one transform rule to a single output field. The rules are attempted starting with the assignment of lowest-
numbered priority, proceeding to assignments of higher-numbered priorities, then finally to an assignment for which no priority has been given. The last rule
attached to the output field is always given a blank priority, which places it after all others in priority.
The transform attempts to evaluate the rules in increasing order of priority (with the rule with blank priority, if any, coming last). If a rule results in NULL, the
next rule is tried. Once any rule for a particular output returns something other than NULL, that value “wins” and no other rules are attempted.
If none of the rules gives a non-NULL value, the default value for the field is assigned. If there is no default value and the field cannot be NULL, an error is
raised (and, usually, the input record is rejected).
You can set rule priority using the Transform Editor in either grid view or text view or a combination of both. The best way to view all your rule priorities at
once is to use the Transform Editor in text view.
NOTE: DML guarantees the order of execution of statements and prioritized rules. However, DML cannot guarantee the order in which expressions are
evaluated or the order of assignment to output fields.
This section describes how to prioritize rules:
Using grid view
Using text view

Using grid view

In the Transform Editor grid, priorities are initially assigned to rules in the order in which they are attached to the output field. The last rule attached to the
output field is always given a blank priority, which places it after all others in priority.
By default, rule priorities before the last rule are indexed from 1, and each rule must have a distinct priority. The priorities for the rules assigned to a given
output field do not have to be consecutive.
To set the priority of a rule in the Transform Editor grid:
1. Do one of the following:
Click a rule, then choose Edit > Priority from the editor main menu.
Click a rule, then choose Set Priority from the pop-up menu.
The Assignment Priority dialog opens:
Screen capture of the Assignment Priority
dialog.

2. Enter an integer to represent the priority you want to assign to the active rule.
3. Click OK to apply your change and close the dialog box.

Using text view

To set the priority of a rule in text view:

1. If it is not already open, display the Transform Editor in text view.
2. Enter the rule priority by adding the appropriate integer in the DML line between the double colons for the transform rule.
For example, say you want to give the following rule a priority of 1:
out.id :: in.id;
The new line would be:
out.id :1: in.id;
Related topics
Creating transform functions
Working with transform rules
How input expressions evaluate to NULL
Making transform functions with NULL input values succeed
Intentionally setting the value of an output field to NULL

Pre N
viou

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 136 of 221

GDE Help > Working with data > Using transform functions > Rules in transform functions > Generating default rules

Generating default rules

If you have input fields that are not referenced explicitly in other rules, you can add default rules to have a transform assign the values of these input fields to
output fields. The values of these input fields will be assigned to output fields that have the same name as the input field.
To generate default rules:
1. If it is not already open, display the Transform Editor grid.
2. Click the Transform Rules tab.
3. From the Transform Editor main menu, choose Edit > Add Default Rules. The Add Default Rules dialog opens.
4. Select one of the following options:
Match Names — Generates one default rule for each unreferenced input field that matches an output field.
For example, if you select Match Names, the resulting rules in DML code are:
out.id :: in.id;
out.source :: in.source;
out.gender :: in.gender;
...
Screen capture showing the results of the Match Names option.

Use Wildcard (.*) Rule — Generates one default rule for all unreferenced input fields with matching output fields. The resulting rule in DML code is:
out.* :: in.*;
For example:
Screen capture showing the result of the Use Wildcard (*) Rule option.

5. Choose File > Save or Save As to save the transforms

6. In the Properties dialog, click OK to apply your changes and close the dialog.

Pre N
viou e

GDE Help > Working with data > Using transform functions > Rules in transform functions > Working with DML wildcards in rules

Working with DML wildcards in rules

In addition to generating default (wildcard) rules in the Transform Editor grid, you can also use wildcards when you create rules using DML code. For detailed

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 137 of 221

information, and an explanation of how wildcards in DML-coded rules are expanded and propagated to subfields, see “Using wildcards in transform rules”.

Pre N
viou

GDE Help > Working with data > Using transform functions > Statements in transform functions

Statements in transform functions

Although not required, transform functions can contain several kinds of statements. Among other things, statements can:
Modify existing global or local variables
Add programming logic such as if and while statements with variables to affect the flow of control in a transform
Call a user-defined function
NOTE: A statement cannot assign to an output field.
You can use the Transform Editor grid to enter statements, although the grid does not provide drag-and-drop methods for building statements — you can only
type DML statements directly into the grid. If you enter statements using the Transform Editor grid, they will end up in the proper place when the transform
function is automatically converted to DML.
To create a statement in the current transform function:
1. Open the Transform Editor.
2. In grid view, click the Statements tab.
3. Enter statements using the syntax described in “Working with statements”.
NOTE: Be sure to place statements after any local variable declarations and before the rules of the transform function.
Alternatively, you can enter DML statements in text view of the Transform Editor.
To work with transforms using DML, see these topics:
Creating transform functions
Transform functions
Syntax
Working with transform rules
Prioritized transform rules
Working with transform rules
Transform rule evaluation results
Examples of unprioritized transform rules
Examples of prioritized transform rules
NULL values in transform rules
Using wildcards in transform rules
Working with local variables
Syntax: Declaring and initializing a local variable
When to use not NULL
Working with statements
Statement syntax
The assignment statement
The if statement
The while loop statement
The for loop statement
The block statement
The switch statement
Examples of switch statements
The expression statement

Pre N
viou e

GDE Help > Working with data > Using transform functions > Local variables in transform functions

Local variables in transform functions

You can often simplify or consolidate rules in a transform function by using a local variable. A local variable is a named storage location in an expression or
transform function. You declare a local variable within the transform function in which you want to use it. The local variable is reinitialized each time the
transform function is called, and it persists for a single evaluation of the transform function. For detailed information, see “Working with local variables”.
You declare, initialize, and delete local variables inside transforms. You can do this using drag-and-drop techniques in the Transform Editor grid:
To declare (or modify) local variables, select the Variables tab and choosing Edit > Local Variable.
To initialize local variables, drag the variable from the Variables tab and drop it in the Output pane:
Screen capture showing the drag-and-drop technique.

Alternatively, enter the equivalent DML code in the text view of the Transform Editor. For example:
out::rollup(in)=
begin
let string(7) myvar="a";
let decimal(2) mydec=2.2;

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 138 of 221

end;
This section includes these topics:
About the Variables Editor
Declaring or modifying local variables
Initializing local variables
Deleting local variables

Pre N
viou e

GDE Help > Working with data > Using transform functions > Local variables in transform functions > About the Variables Editor

About the Variables Editor

The Variables Editor provides an easy-to-use grid for declaring or editing local variables for transform functions.
The following figure shows the Variables Editor:
Screen capture of the Variables Editor.

The Variables Editor has four main areas:

Fields tab — Specifies the name of the local variable, its data type, and its delimiter or length.
Attributes grid — Specifies the attributes for the local variable, such as its character set and maximum length.
Comment fields — Enables you to insert comments before and after a selected local variable. The specified strings are embedded in the transform function
as a comment.
Status window — Displays messages about incorrect or incomplete entries. A yellow square at the beginning of a row indicates an incorrect or incomplete
entry in that row. Placing the cursor in a cell in that row displays a message in the status window if the entry in the cell is incorrect or incomplete.

Click to expand the status window into a text editor for reading long messages.

Pre N
viou e

GDE Help > Working with data > Using transform functions > Local variables in transform functions > Declaring or modifying local variables

Declaring or modifying local variables

To declare a local variable using grid view:
1. If it is not already open, display the Transform Editor grid.
2. From the Transform Editor main menu, choose Edit > Local Variable. The Variables Editor opens.
3. Fill in the appropriate information for the variable.
4. From the Variables Editor main menu, choose File > Save As Embedded.
5. From the Variables Editor main menu, choose File > Close to close the Variables Editor. You return to the Transform Editor.
6. To close the Transform Editor, from the main menu choose File > Save, then File > Close.
To declare a local variable using text view:
1. If it is not already open, display the Transform Editor in text view.
2. Enter local variable syntax, as described in “Working with local variables”.
3. To close the Transform Editor, from the main menu choose File > Save, then File > Close.
To work with transforms using DML, see these topics:
Creating transform functions
Transform functions
Syntax
Working with transform rules
Prioritized transform rules
Working with transform rules
Transform rule evaluation results
Examples of unprioritized transform rules
Examples of prioritized transform rules
NULL values in transform rules

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 139 of 221

Using wildcards in transform rules

Working with local variables
Syntax: Declaring and initializing a local variable
When to use not NULL

Pre N
viou

GDE Help > Working with data > Using transform functions > Local variables in transform functions > Initializing local variables

Initializing local variables

To initialize a local variable in grid view:
1. If it is not already open, display the Transform Editor grid.
2. Click the Variables tab. The rightmost Outputs pane displays the variables in the active transform function.
Screen capture showing that when you select the Variables tab, the Output pane displays the variables in the
active transform function.

3. In a cell in the Variables tab, enter the expression that results in the desired value for the variable.
4. Click-and-drag from the Variable tab’s port to the name of the variable (in the Outputs pane) to which you want to assign the value.
NOTE: Local variable initialization is executed in order; therefore, later variables can depend on values in earlier variables.
5. (Optional) To specify that the variable cannot take the value of NULL, select the variable and from the pop-up menu, choose Declare not NULL. The not
NULL qualifier can be used to improve performance.
Screen capture showing the "Declare not NULL" menu command in the Variables pop-up menu

6. To close the Transform Editor, from the main menu choose File > Save, then File > Close.
To initialize a local variable in text mode:
1. If it is not already open, display the Transform Editor in text view.
2. Enter the appropriate DML code, as described in “Syntax: Declaring and initializing a local variable”.
3. To close the Transform Editor, from the main menu choose File > Save, then File > Close.

Pre N
viou

GDE Help > Working with data > Using transform functions > Local variables in transform functions > Deleting local variables

Deleting local variables

To delete a local variable in grid view:
1. If it is not already open, display the Transform Editor grid.
2. Display the Variables Editor.
3. Click the gray area at the beginning of the cell containing the variable you want to delete, then press Delete.
4. Delete or edit any rules or statements that reference the deleted variable.
5. To close the Transform Editor, from the main menu choose File > Save, then File > Close.
To delete a local variable in text view:
1. If it is not already open, display the Transform Editor in text view.
2. Delete the DML code that declares the variable.
3. Delete or edit any rules or statements that reference the deleted variable.
4. To close the Transform Editor, from the main menu choose File > Save, then File > Close.

Pre N
viou

GDE Help > Working with data > Using transform functions > Local variables in transform functions > Editing local variables

Editing local variables

To edit a local variable in grid view:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 140 of 221

1. If it is not already open, display the Variables Editor.

2. Change the fields as desired. For more information, see “About the Variables Editor”.
3. From the Variables Editor main menu, choose File > Save As Embedded.
4. From the Variables Editor main menu, choose File > Close to close the Variables Editor.
To edit a local variable in text view:
1. If it is not already open, display the Transform Editor in text view.
2. Edit the variable, as described in “Working with local variables”.

Pre N
viou

GDE Help > Working with data > Using transform functions > Adding comments to transform functions

Adding comments to transform functions

You can add comments at the beginning and end of a transform function, and before or at the end of a selected rule, variable, or statement. For detailed
information, see “Comments in transform functions”.

Using grid view

To add comments at the beginning and end of the transform function:

1. In the Transform Editor, click the Documentation tab.
2. Type descriptive text in the upper text box. This comment will appear in text view as the first row above the transform function.
3. Type descriptive text in the Comment to follow the transform function text box. This comment will be appended to the end statement of the transform
function.
To add comments for individual rules, variables, and statements of the transform function:
1. Select the Transform Rules, Variables, or Statements tab.
2. Type your comment in the upper or lower text box, as follows:.
If you want the comment to appear above the selected row in text view, type the comment in the Comment to precede the selected transform
rule/variable/statement text box.
If you want the comment to appear at the end of a row in text view, type the comment in the Comment for the selected transform rule/variable/statement.
The following figure shows comments entered for a selected transform rule in the Transform Editor grid view.
Screen capture showing before and after comments for a row in grid view of the Transform Editor

The following figure shows the results as they appear in text view. In addition to comments for the selected transform rule, text view also shows comments
preceding and following the transform function. Those comments were entered through the Documentation tab of the Transform Editor grid view.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 141 of 221

Screen capture showing before and after comments for a row in text view of the Transform Editor

Using text view

To add a comment to a transform function:

In text view of the Transform Editor, add comments using either of the following formats:
/* comment in C and Java style */
// comment in C++ and Java style

Pre N
viou e

GDE Help > Working with data > Using transform functions > Parameter references in transforms

Parameter references in transforms

When using the Transform Editor to write transforms, you can reference parameters defined in the graph or in the sandbox. Using parameter references within
a transform allows the graph to be more dynamic at runtime. For more information, see “Parameter references and scope”.
This section includes information about:
Resolving parameter references
Viewing resolved transforms

Pre N
viou

GDE Help > Working with data > Using transform functions > Parameter references in transforms > Resolving parameter references

Resolving parameter references

To resolve references during parameter evaluation, you must set the transform interpretation type appropriately.
To set the interpretation type:
1. Depending on how you accessed the Transform Editor, select the appropriate Interpretation type, in one of two ways:
On the Parameters tab of the Properties dialog, first select the transform name.
If the parameter you are referencing is a path to a file, you must specify the Interpret option File contents. For more information, see “The Interpret option”.
Setting the interpretation type for the file contents automatically sets the interpretation type for the file path to PDL (Parameter Definition Language).
NOTE: This option is available only if you are using dynamic script generation, available with Co>Operating System Version 2.15.2 or later and defined in
the Graph Settings: Script category. For more information, see “Script generation”.
Next, select the correct interpretation type from the Interpretation drop-down list, as shown in the following graphic.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 142 of 221

Parameters tab of Properties dialog showing the identifying the Transform name, the
Interpret option, and the Interpretation drop-down list.

In the Parameters Editor, first select the transform name or value.

If the parameter you are referencing is a path to a file, you must select File Contents from the drop-down list for the Interpret attribute for the transform. For
more information, see “The Interpret option”.
Setting the interpretation type for the file contents automatically sets the interpretation type for the file path to PDL (Parameter Definition Language).
NOTE: This option is available only if you are using dynamic script generation, available with Co>Operating System Version 2.15.2 or later and defined in
the Graph Settings: Script category. For more information, see “Script generation”.
Next, select the appropriate value from the Interpretation drop-down list for the parameter, as shown in the following graphic.
Parameters Editor with selected transform name and Interpretation attribute

Related topics
Viewing resolved transforms
When parameter references are evaluated
The Interpret option
Shell parameter interpretation
Constant parameter interpretation

Pre N
viou e

GDE Help > Working with data > Using transform functions > Parameter references in transforms > Viewing resolved transforms

Viewing resolved transforms

By default, the Transform Editor displays an unresolved value for any parameter reference in the transform. You can open read-only views of the resolved,
expanded value in either text view or grid view of the Transform Editor.
In addition, you can see the resolved value for the entire transform in any of the following places in the Parameters Editor:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 143 of 221

The Resolved Value box

The tooltip for a transform
The Resolution Details dialog

Displaying resolved values in text view

To open a read-only text view of the Transform Editor displaying resolved values:
From the Transform Editor menu bar, choose View > Resolved View.
A secondary read-only Transform Editor window displays the resolved value, as shown in the following graphic.
Graphic showing text view of the Transform Editor with unresolved values and a secondary instance of the Transform
Editor with resolved values.

Displaying resolved values in grid view

To open a read-only grid view of the Transform Editor displaying resolved values:
1. From the Transform Editor menu bar, choose View > Grid View.
A message informs you of the presence of parameter references and prompts you to open the transform in a read-only view.
2. Click Yes.
The following graphic shows the editable text view of the Transform Editor with a parameter reference and the read-only grid view of the Transform Editor
with the resolved value.
NOTE: Grid view of the Transform Editor cannot open with resolved values if any invalid DML is present in the transform.
Graphic showing text view of the Transform Editor with unresolved values and a secondary instance of the Transform Editor
in grid view with resolved values.

Updating resolved values

To update the resolved value in the Transform Editor:

In either the read-only text view or grid view of the Transform Editor, choose View > Refresh from the menu bar.
The file contents of the read-only Transform Editor are updated with the latest changes.
NOTE: You can use the read-only instance of the Transform Editor to insert breakpoints within the referenced parameter. For more information, see
“Setting breakpoints”.
Related topics
Resolving parameter references

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 144 of 221

Pre N
viou

GDE Help > Working with data > Using transform functions > Specifying where a transform is stored

Specifying where a transform is stored

You can specify where a transform is stored on the Parameters tab of the component Properties dialog; you cannot do this using DML code.
There are four options:
Embedded — Embeds the transform as part of the component. Using this option reduces the number of small files you need to save outside the graph.
However, an embedded transform is not as easy to reuse or share as a transform saved as a file.
Host — Saves the transform as a file on the computer running the Co>Operating System.
Local — Saves the transform as a file on the computer running the GDE.
EME Technical Repository — Saves the transform as a technical repository object at the specified path.
Related topics
Storing transform functions
Using text alternatives

Pre N
viou

GDE Help > Working with data > Using transform functions > Making recursive calls in transforms

Making recursive calls in transforms

You can make recursive calls in transform functions only by using DML code. You can do this using the Transform Editor in text view, or — if the transform is in a
file — you can use any text editor to edit the file. For more information, see “Recursive calls in transform functions”.

Pre N
viou e

GDE Help > Working with data > Using packages

Using packages
A package is a named collection of related DML objects. A package can hold types, transform functions, and variables, as well as other packages. Packages
provide a means of locating in one place DML objects that are needed more than once in a given graph, or needed by multiple developers. Packages enable
developers to avoid redundant code, which makes maintaining DML objects more efficient.
Packages are useful in these types of situations:
The record formats of multiple ports use common record formats and/or type specifiers.
Multiple components use common transforms.
This section includes these topics:
About packages
Viewing packages
Accessing objects in packages
Including packages
Creating a user-defined type

Pre N
viou e

GDE Help > Working with data > Using packages > About packages

About packages
Packages can be stored in standalone files or can be embedded in a component. Package files use the file extension .xfr or .dml.
Because packages are always associated with components and ports, you can access packages through grid mode of either the Transform Editor or the Record
Format Editor by selecting View > Package. For more information, see “Viewing packages”.

Packages and multistage components

Multistage transform components require packages because, unlike other transform components, they are driven by more than one transform function. These
components each take a package as a parameter and, in order to process data, look for particular variables, functions, and types in that package. For example, a
multistage component might look for a type named temporary_type, a transform function named finalize, or a variable named count_items.

Include files

The term include file is sometimes used to refer to a standalone file of DML code, even if that code does not include an actual “collection” of related DML
objects — and might include only a single DML object. However, there is really no need to think of include files as technically different from package files.
Therefore, for the sake of clarity, the term package file is used to refer to any DML in a file that is incorporated into a graph using an include statement. The
term package is used to refer either to a package file, or to a package embedded in a component.
NOTE: To edit an include file directly from the Transform Editor, choose Edit > Open Include File from the editor menu.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 145 of 221

The global package

The global package is the package that contains all the built-in DML elements (such as the built-in functions and data types).
Related topics
Package files
Viewing packages
Accessing objects in packages
Including packages
Creating a user-defined type

Pre N
viou

GDE Help > Working with data > Using packages > Viewing packages

Viewing packages
The Package Editor enables you to view and easily manipulate packages of DML objects. For instructions on how to access the Package Editor, see “Package
Editor”.
The Package Editor displays all the DML objects in a package using a tree view. For example, the following figure shows a package named utils.xfr as viewed
in the Package Editor. As shown, it has three user-defined types (text, ssn_type, and iso_date) and a transform (apply_discount):
Screen capture of the Package Editor.

Package Editor folders

In the Package Editor, the DML objects are grouped under the appropriate folders; each object includes an icon denoting the object type.
The folders and their corresponding icons and actions are as follows:

Icon Folder Description Action

Includes Lists the included package. Double-click the icon to open another
Package Editor.
User-Defined Lists the named user-defined type (usually a record format). Double-click the icon to open the Record
Types NOTE: Certain transform components require types to have specific names. For Format Editor.
example, normalize uses a type named temporary_type.
Globals Lists the global variables, which store temporary values. A global variable must Double-click the icon to open the Variables
have a value. Editor for all globals.
Functions Lists the transform and user-defined functions. Double-click the icon to open a Transform
NOTE: Multistage transforms require transforms to have specific names. Editor.
CAUTION! A package cannot contain a function that has the same name as the
package.
Record Format Lists the main type associated with a port. Double-click the icon to open the Record
NOTE: This folder is displayed only if you are editing a port. Format Editor.
The icons use modifiers to indicate the status of the object values, as described in “Icon modifiers”.

Icon modifiers

The Package Editor uses the following modifiers to indicate the status of the object values:
Checked — You already assigned values.
Yellow — You must assign values.
Gray — You should not assign values.
No marks — Values are optional.
Related topics
About packages
Accessing objects in packages
Including packages
Creating a user-defined type

Pre N
viou e

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 146 of 221

GDE Help > Working with data > Using packages > Accessing objects in packages

Accessing objects in packages

You can use tree view of the Package Editor to easily manipulate the objects in a package, or switch to text view to edit the DML code directly.
This section includes the following topics:
Manipulating objects using the tree view
Editing DML objects in the package
Related topics
About packages
Viewing packages
Including packages
Creating a user-defined type
Creating user-defined functions

Pre N
viou

GDE Help > Working with data > Using packages > Accessing objects in packages > Manipulating objects using the tree view

Manipulating objects using the tree view

Use the tree view of the Package Editor to easily add and delete objects, or move DML objects from one package to another.
To delete an object:
In the Package Editor, click the object you want to delete, then select Delete from the pop-up menu.
To move an object from one package to another:
1. Open the source and target packages in the Package Editor.
2. In the Package Editor, click the object you want to copy, then select Copy from the pop-up menu.
3. In another Package Editor, click a folder, then select Paste from the pop-up menu.
NOTE: It doesn’t matter which folder you select — the object will be grouped under the correct folder.
If there are any problems, such as conflicts with types that already exist in the package, the GDE displays an error message and does not copy the object.
Otherwise, the object is added to the new package.
Related topics
About packages
Accessing objects in packages
Editing DML objects in the package

Pre N
viou

GDE Help > Working with data > Using packages > Accessing objects in packages > Editing DML objects in the package

Editing DML objects in the package

Using the Package Editor, you can access the DML objects in two different ways: individually and as a whole package.
To access the entire package at once:
1. From the Package Editor main menu, choose View > Text View. The Transform Editor opens the package file in text view, displaying the DML code for
the entire package.
2. Edit the file as needed.
Alternatively, you can open the package file using any text editor.
The following figure shows the utils package as viewed in text view of the Transform Editor:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 147 of 221

Screen capture of the Package Editor in text view.

To edit an individual object in the package:

1. In the Package Editor, click the object you want to edit, then select Edit from the pop-up menu.
Depending on the object type, either the Transform Editor or Record Format Editor opens so you can edit the object.
2. Make the necessary changes, then close the editor.
3. You return to the Package Editor. To close the editor, do one of the following:
From the Package Editor main menu, choose File > Close.
Click the X in the upper-right corner of the editor.
Related topics
About packages
Accessing objects in packages
Manipulating objects using the tree view

Pre N
viou

GDE Help > Working with data > Using packages > Including packages

Including packages
A package can include other packages.
To include a package:
1. Open the Package Editor for the component that will use the included package.
2. Select the Includes folder, then do one of the following:
From the pop-up menu, choose Insert.
From the Package Editor main menu, choose Edit > Insert.
The Open dialog opens.
3. Do one of the following:
Click Browse, navigate to, then double-click the package you want to include.
Type the path to the package in the File name box, then click Open.
Related topics
About packages
Viewing packages
Accessing objects in packages
Creating a user-defined type
Creating user-defined functions

Pre N
viou e

GDE Help > Working with data > Using packages > Creating a user-defined type

Creating a user-defined type

To add a user-defined type to a package:
1. Open the Package Editor for the component that will use the user-defined type.
2. In the Package Editor, click the User-Defined Types folder, then do one of the following:
From the pop-up menu, choose Insert.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 148 of 221

From the Package Editor main menu, choose Edit > Insert.
The Add User-Defined Type dialog opens.
3. In the Type Name box, enter the name of the user-defined type.
4. Click OK to add the data type and close the dialog.
The user-defined type is added to the package.
Related topics
About packages
Viewing packages
Accessing objects in packages
Including packages
Creating user-defined functions

Pre N
viou e

GDE Help > Working with data > Working with user-defined functions

Working with user-defined functions

Transform functions get record definition information from their input or output ports. This enables transform functions to be independent of data definitions,
so they are reusable. In some cases, you might want to override this data type independence by creating a user-defined function. Create a user-defined function
when:
You need to operate on a part of a complex record format containing hundreds of fields.
You have complex, repeatable transformations that you want to treat as a function.
The GDE associates user-defined functions with a package; use the Package Editor to add, modify, or delete user-defined functions.
This section describes how to create and use user-defined functions. The topics are:
Creating user-defined functions
Modifying user-defined functions
Deleting user-defined functions
Reusing user-defined functions

Pre N
viou e

GDE Help > Working with data > Working with user-defined functions > Creating user-defined functions

Creating user-defined functions

You create user-defined functions in two steps:
1. Create the function and its arguments and parameters.
2. Associate rules or variables with the new function.
Related topics
Working with user-defined functions
Modifying user-defined functions
Deleting user-defined functions
Reusing user-defined functions

Pre N
viou e

GDE Help > Working with data > Working with user-defined functions > Creating user-defined functions > Creating the function

Creating the function

To create a user-defined function:
1. Select the transform to whose package you want to add the function.
2. Shift-double-click the transform to open the Transform Editor.
3. In grid view of the Transform Editor, choose View > Package. The Package Editor opens.
4. Click the Functions folder, then do one of the following:
From the pop-up menu, choose Insert.
From the Package Editor main menu, choose Edit > Insert.
The Function Definition dialog opens.
5. In the Name box, enter the name of the function.
6. (Optional) To add an input or output argument to the function, follow the instructions in “Adding arguments to a user-defined function”.
7. (Optional) Use the Move Up or Move Down tools to reposition the function in the package. The package executes functions in sequential order.
8. Click OK to apply your changes and close the dialog.

Adding arguments to a user-defined function

To add arguments to a function:

1. In the Arguments area of the Function Definition dialog, select Input or Output.
2. Click Add. The new argument is displayed. Accept the default name or rename the argument by typing over the name.
3. Click the new argument, then click Edit. The Record Format Editor opens.
4. Use the editor to enter and test the record format for the argument.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 149 of 221

5. Close the Record Format Editor by selecting File > Save, then File > Close. You return to the Function Definition dialog.
6. The record definition for the argument is displayed in the Argument Type box.
7. Click OK to apply your changes and close the Function Definition dialog.
Related topics
Working with user-defined functions
Creating user-defined functions
Associating rules with the function

Pre N
viou

GDE Help > Working with data > Working with user-defined functions > Creating user-defined functions > Associating rules with the function

Associating rules with the function

To associate rules or variables with the user-defined function:
1. In the Package Editor, double-click the user-defined function to open the Transform Editor.
2. Use the Transform Editor to add rules and variables as needed.
3. Exit the editor when you are done.
The user-defined function is now ready to use.
Related topics
Working with user-defined functions
Creating user-defined functions
Creating the function

Pre N
viou

GDE Help > Working with data > Working with user-defined functions > Modifying user-defined functions

Modifying user-defined functions

You can modify the name, inputs, outputs, and record definitions of user-defined functions.
To modify a user-defined function:
1. In the Package Editor, double-click the user-defined function you want to modify. The Transform Editor opens.
2. From the Transform Editor main menu, choose Edit > Definition. The Function Definition dialog opens.
3. Make the necessary changes:

To do this Follow these steps

Change the name of a user-defined function Type a new name in the Name box.
Modify an input or output record definition 1. In the Arguments box, select the argument you want to edit.
2. Click Edit to open the Record Format Editor.
3. Use the editor to change and test the record format for the argument.
Delete an input or output argument from a user-defined 1. In the Arguments box, select the argument you want to delete.
function NOTE: You must always have at least one output argument; however, you can delete all input
arguments.
2. Click Delete.
4. Click OK to save your changes and close the Function Definition dialog.
5. From the Transform Editor main menu, choose File > Save to save your changes, then choose File > Close to close the editor.
6. From the Package Editor main menu, choose File > Close to close the editor.
Related topics
Working with user-defined functions
Creating user-defined functions
Deleting user-defined functions
Reusing user-defined functions

Pre N
viou e

GDE Help > Working with data > Working with user-defined functions > Deleting user-defined functions

Deleting user-defined functions

CAUTION! Because the system will not prompt you to verify the deletion, use delete with caution.
To delete a user-defined function:
1. In the Package Editor, click the user-defined function you want to delete.
2. Do one of the following:
From the pop-up menu, choose Delete.
From the Package Editor main menu, choose File > Delete.
I
From the Package Editor toolbar, click .
Related topics
Working with user-defined functions
Creating user-defined functions

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 150 of 221

Modifying user-defined functions

Reusing user-defined functions

Pre N
viou e

GDE Help > Working with data > Working with user-defined functions > Reusing user-defined functions

Reusing user-defined functions

You can reuse user-defined functions in two ways:
Copy the user-defined function from one package to another. For details, see “Manipulating objects using the tree view”.
Include the package that contains the user-defined function in another package. For details, see “Including packages”.

Related topics
Working with user-defined functions
Creating user-defined functions
Modifying user-defined functions
Deleting user-defined functions
Using the include statement

Pre N
viou

GDE Help > Working with data > Using databases in graphs

Using databases in graphs

This section contains the following topics:
Supported databases
Using a database in a graph
Creating and editing SQL statements with the SQL Editors
Exporting and unexporting table parameters

Pre N
viou e

GDE Help > Working with data > Using databases in graphs > Supported databases

Supported databases
The Graphical Development Environment (GDE) supports the following databases:

Adabas Microsoft Excel

DB2 for OS/390 Microsoft OLE DB
DB2 UDB Enterprise Edition Microsoft SQL Server (Windows only)
DB2 UDB Enterprise - Extended Edition MySQL
DB/400 on iSeries via DB2/Connect NCR Teradata
DB/400 on iSeries via ODBC Netezza
HP Neoview ODBC
Greenplum Oracle
IBM IMS Sybase ASE
Informix Sybase IQ
Microsoft Access

Pre N
viou e

GDE Help > Working with data > Using databases in graphs > Using a database in a graph

Using a database in a graph

To use a supported database in a graph:
1. Set up a database configuration file for the database you want to use.
For information on how to do this, see “Setting up a new connection to a database”.
2. Create a new table in the database, or access an existing table.
For an example of creating a table in a graph, see “Exercise 1: Creating a table in a database”.
3. Use the appropriate graph components to add, update, manipulate, input or output the table data, as desired.
For examples, see:
Exercise 2: Loading data into a table
Exercise 3: Updating the table
Exercise 4: Unloading and reloading the table
Exercise 5: Truncating a table
Exercise 6: Lookups in a table

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 151 of 221

Pre N
viou

GDE Help > Working with data > Using databases in graphs > Creating and editing SQL statements

Creating and editing SQL statements

The following topics describe how to select a database table and use the SQL Editors to create SQL statements in the GDE:
Selecting a database table
Creating and editing SQL statements with the SQL Editors
When to use the SQL Editors and when to use graph logic

Pre N
viou

GDE Help > Working with data > Using databases in graphs > Creating and editing SQL statements > Selecting a database table

Selecting a database table

If you are creating an SQL statement for the first time in an SQL-enabled component, you must select one or more tables, views, or aliases from the Select
Tables dialog from which to construct the SQL statement.
NOTE: INPUT TABLE, JOIN WITH DB, and CALL STORED PROCEDURE are examples of SQL-enabled components.
NOTE: For purposes of the Help, the concepts of database table, view, and alias name are interchangeable.
The Select Table dialog lets you choose a single table; it is associated with the DELETE, INSERT, and UPDATE Statement SQL Editors. The Select Tables
dialog lets you choose multiple tables; it is associated with the SELECT Statement SQL Editor. Which dialog you get depends on the SQL-enabled
component you are using and the parameter or text box that will be associated with the table or SQL statement. After you select one or more tables, the GDE
automatically displays the appropriate SQL Editor. When working in the SQL Editor, you can use the Select Table dialog or the Select Tables dialog to choose
a different table at any time.

Single table

To select a database table, view, or alias:

1. Do one of the following:
Choosean SQL text box on the component’s Data tab and click Edit. An example of an SQL text box is the Select statement text box.
Choose an SQL parameter on the Parameters tab and click the Browse button or click
S Edit.
NOTE: For details on SQL-enabled components and their parameters or text boxes, see “How to reach this dialog” in the “Select Table dialog” and “Select
Tables dialog” topics.
The Select Table dialog appears.
2. In the Owner or schema drop-down list, accept the default user or select a different database username. The dialog will display the objects this user or
schema can access in the Available tabbed section.
3. Based on the type of object you want, choose the Tables, Views, or Aliases tab and highlight the object’s name.
If the object list is long and you must scroll to locate an object’s name, or if you are unsure of its exact name, you can enter complete or partial text in the
Filter text box. Doing so displays full or partial matches in the Available section. Do not enter a wildcard; stem matching is built in.
4. (Optional) If you do not want your table and its fields to have qualified names based on their database or schema name, uncheck Schema qualified name.
NOTE: This feature is available only when Owner or schema is set to <current user>. Otherwise, qualified names are displayed by default and cannot be
hidden.
5. Click OK.
This closes the dialog and inserts the object’s name in the Source text box (for INPUT TABLE components) or Destination text box (for OUTPUT TABLE
components) on the Data tab.

Multiple tables

To select multiple database tables, views, or aliases:

1. Do one of the following:
Choose an SQL parameter on the component’s Data tab and click Edit.
Choose an SQL parameter on the component’s Parameters tab and click New.
NOTE: For details on SQL-enabled components and their parameters or text boxes, see “How to reach this dialog” in the Select Table dialog and Select
Tables dialog topics.
The Select Tables dialog appears.
2. In the Owner or schema drop-down list, accept the default user or select a different database username. The dialog will display the objects this user or
schema can access on the Available tabbed section.
3. Choose the Tables, Views, or Aliases tabs and highlight one or more object names that you want to use in your SQL SELECT statement.
If the object list is long and you must scroll to locate an object’s name, or if you are unsure of its exact name, you can enter complete or partial text in the Find
text box. Doing so displays full or partial matches in the Available section. Do not enter a wildcard as stem matching is built in.
4. (Optional) If you want a table and its fields to have qualified names based on their database or schema name, select Schema qualified name. You can mix
qualified and unqualified names by toggling this checkbox.
NOTE: This feature is available only when Owner or schema is set to <current user>. Otherwise, qualified names are displayed by default and cannot be
hidden.
B
5. For each selection, double-click the highlighted column or click Move Right to move your selections to the Selected pane.
6. Repeat Steps 2 through 5 for each additional table that you want to use in your SELECT statement.
7. When done, click OK.
This closes the dialog and inserts the object’s name in the Source text box (for INPUT TABLE components) or Destination text box (for OUTPUT TABLE
components) on the Data tab, or opens the SQL Editor: SELECT Statement dialog for other components.
Related topics

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 152 of 221

Creating and editing SQL statements with the SQL Editors

When to use the SQL Editors and when to use graph logic

Pre N
viou

GDE Help > Working with data > Using databases in graphs > Creating and editing SQL statements > Creating and editing SQL statements with the SQL
Editors

Creating and editing SQL statements with the SQL Editors

How you access the SQL Editor dialogs and text window depends on the SQL-enabled component you are using. Access methods include:
Through SQL parameters on the component’s Parameters or Data tab
Through the component’s Associate Table with EME Dataset dialog
Through SQL parameters in the Parameters Editor
See the individual editor help topics listed below for component-specific details.
If you are creating an SQL statement for the first time, you may have to first select one or more tables from the Select Tables dialog before the SQL Editor
dialog appears. For more information, see “Selecting a database table”.

The SQL Editors

You use SQL Editors to create and edit SQL statements that select, update, insert, or delete database records; create and drop database tables; and perform
other SQL operations. These specialized editors — optimized for the major SQL operations and your SQL-enabled component — help you enter valid and
complex SQL. A simple text editor is also available. The editors are:
SQL Editor: DELETE Statement dialog
SQL Editor: INSERT Statement dialog
SQL Editor: SELECT Statement dialog
SQL Editor: UPDATE Statement dialog
SQL Editor text view

The SQL-enabled components

The SQL-enabled components are:

CALL STORED PROCEDURE
INPUT TABLE
JOIN WITH ADABAS
JOIN WITH DB
JOIN WITH IMS
MULTI UPDATE TABLE
OUTPUT TABLE
RUN SQL
UPDATE TABLE
The SQL Editors have these common features:
The editors use generic SQL syntax, functions, and operators that are shared across databases. The editors and the validation feature also support the
Oracle and SQL-92 dialects.
In general, the editors support any SQL-enabled database that appears in a component’s database configuration file list.
The editors create SQL statements based on the database schema and user selections. The generated SQL syntax is common across most databases but may
require some manual editing in Text Mode.
When appropriate, the editors automatically display or generate DML record formats from your field selections. For example, this feature is in use when you
create SQL for a JOIN WITH DB component or when you use an out port.
Although you can write complex SQL in the SQL Editors, there are cases where it is best to use a component or non-SQL graph logic. To make the most
effective use of the SQL Editors, see “When to use the SQL Editors and when to use graph logic”.
Related topics
SQL Editor views and navigation
SQL Editor workflow
Selecting a database table
When to use the SQL Editors and when to use graph logic

Pre N
viou

GDE Help > Working with data > Using databases in graphs > Creating and editing SQL statements > Creating and editing SQL statements with the SQL
Editors > SQL Editor views and navigation

SQL Editor views and navigation

SQL Editors have three views that you access from the View menu. They are:
Grid view — A drag-and-drop interface for generating complex and syntactically valid SQL. Grid view does not support all SQL syntax; see below for
more information.
Text view — A simple text editor for manually entering SQL.
Resolved view — A read-only view showing the current SQL syntax with the resolved value of each parameter.
If you are using an editor in text view, there are two cases where you will not be able to switch to grid view: after entering SQL syntax that is not supported in
grid view, and after entering SQL syntax that is not valid.
Unsupported SQL syntax

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 153 of 221

If you enter SQL syntax in text view that is not supported in grid view, you must continue editing in text view or switch to graph logic. If you encounter
syntax that grid view does not support, it usually means that you should implement your logic in a component or a graph rather than in an SQL statement. For
best practices, see “When to use the SQL Editors and when to use graph logic”.
Invalid SQL syntax
If you enter invalid SQL syntax in text view, you must correct it before switching to grid view. Use the validation feature on the SQL Editor toolbar to help
you debug your SQL.

Grid view features

Screen capture of the SQL Editor with callouts showing the Record format pane, SQL Statement pain, SQL
Editor toolbar, and Expression grid.

Navigation

Screen capture showing four menu options with the SQL Editor toolbar beneath.

These menus and toolbars help you navigate and work in the SQL Editors:
SQL Editor menus
SQL Editor toolbar
Related topics
Creating and editing SQL statements with the SQL Editors
SQL Editor workflow

Pre N
viou

GDE Help > Working with data > Using databases in graphs > Creating and editing SQL statements > Creating and editing SQL statements with the SQL
Editors > SQL Editor workflow

SQL Editor workflow

The workflow of each specialized SQL Editor is optimized for the SQL operation it helps you to carry out, and each editor has context-sensitive help that
describes its workflow in detail. This section describes similarities for the dialogs’ Use record format or Source pane, Expression grid, and SQL statement
pane.
In general, you create valid SQL syntax by dragging available table or port fields to the editor’s SELECT, WHERE, and AND clause grids. Based on your
actions, the editor generates syntactically correct SQL for the operations your component supports. Using the pop-up menu or a keyboard shortcut, you can
open the SQL Expression Editor — a drag-and-drop interface where you can associate fields with SQL functions and operators. In addition, you can validate
your syntax at any time.

Use record format or Source pane

Two screen captures showing the Use record format pane and the
Source pane side-by-side.

The leftmost area of the dialog displays one or more tables from which you can construct your SQL statement. Depending on the component from which the
SQL Editor was opened, you can access only one table, multiple tables, or a DML record format from an in port. (This pane is the Source pane in the SQL

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 154 of 221

Editor: SELECT Statement dialog.)

Use the Use record format pane to select the table currently associated with the component’s port, to select a different table, and to add fields to the Expression
grid for creating comparison and similar subexpressions. This pane lets you:
Select the On port or From table option to toggle between the two types of records.
Browse for and select a different table from the Select Tables dialog.
NOTE: The Browse Tables feature lets you select a table, view, or alias. These options are database-specific. A view has the attributes of a table and acts
like a persistent SQL query; it can provide good performance. An alias is a name stored in the database that can refer to a view or a table. (A different kind of
alias that is not stored in the database can be used in an SQL statement; see “SELECT”) For convenience, the user interface and documentation refer to tables,
views, and aliases by the general term tables.
Drag and drop entire tables or individual fields to the Expression grid to construct your expression. When you drag and drop a table name, the editor
creates a wildcard expression — for example, A_CUSTOMERS.*

Expression grid

Screen capture showing a sample Expression grid with SELECT and WHERE
tabs.

Depending on the SQL statement type, the Expression grid contains one or more tabs for constructing SQL clauses. You can use these grids in several ways to
construct an SQL expression. The grids let you:
Drag and drop table or field names from the Use record format or Source pane to the Expression grid. The SQL Editor automatically creates INSERT,
SELECT, UPDATE, or WHERE expressions or a subexpression
Click Generate SQL to populate the Expression grid with all the table fields, and then manually delete the ones you do not want
Open the SQL Expression Editor, where you can choose fields, built-in functions, and operators to further refine your SQL expression
Resize a row to enter long, multiple-line expressions; you do this by selecting the row’s leftmost gray column to display the resize mouse pointer
Reorder rows by using the Move Grid Row Down and Move Grid Row Up toolbar icons
Add AND clause rows and OR clause columns on the tabs that support them; you do this with the New Grid Row and New Grid Column toolbar icons

SQL statement pane

Use this read-only view to monitor the SQL statement created in the SQL Editor. This pane is automatically refreshed for most actions that involve the
Expression grids. It is also refreshed when you save changes made using the SQL Expression Editor. Click Apply to manually update and save your changes.
Related topics
Creating and editing SQL statements with the SQL Editors
SQL Editor views and navigation
SQL Editor: DELETE Statement dialog
SQL Editor: INSERT Statement dialog
SQL Editor: SELECT Statement dialog
SQL Editor: UPDATE Statement dialog

Pre N
viou

GDE Help > Working with data > Using databases in graphs > Creating and editing SQL statements > When to use the SQL Editors and when to use graph
logic

When to use the SQL Editors and when to use graph logic
SQL SELECT statements can be very powerful and complex. If you are an advanced SQL user you may be inclined to do a lot in your SQL statements —
including performing data transformations and aggregations.
However, in the powerful Ab Initio Environment, it is best to perform simple SQL tasks in the SQL-enabled components and put the more complicated
programming and data transformation logic in other graph components. Following are some guidelines to help you get the most use out of the SQL Editors.

When to use the SQL Editors

Use the SQL Editors to help you generate SQL to:

Select and unload data from one table or a small number of tables
Perform a simple join with other data
Use an SQL WHERE clause to restrict the rows retrieved

When to use graph logic

Use these graph features instead of the SQL Editors when you need to:
Use a transform function instead of a SELECT statement with lots of nested CASE statements. The transform will be easier to code, run faster, and scale

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 155 of 221

more easily.
Use a JOIN component to join several tables — especially if some require inner joins and others outer joins. While SQL supports this application, the
database will only be able to handle two tables at a time. So put this logic in other parts of your graph.
Use a ROLLUP component instead of an SQL SELECT SUM statement to aggregate records.
Use a JOIN WITH DB component when working with hundreds of millions of rows that require thousands of joins for each record.
Use a component or a graph to implement your logic if you encounter syntax that grid view does not support. Encountering unsupported SQL syntax here
usually means that SQL is not the most efficient solution.
Related topics
Creating and editing SQL statements with the SQL Editors

Pre N
viou e

GDE Help > Working with data > Using databases in graphs > Creating and editing SQL statements > Exporting and unexporting table parameters

Exporting and unexporting table parameters

The recommended method for making parameters available throughout a graph or subgraph is to declare parameters at the graph or subgraph level and then
reference them from components in the graph. In some circumstances you can or may be required to export the parameters from table components up to the
graph level. For more information, see “When to export a component parameter”.
For example, for dependency analysis to accurately trace lineage through database tables referenced in a table component, the EME technical repository must
know the names of all the referenced tables and their record formats. In cases where you have a table component with a highly parameterized SQL statement,
it may be more convenient or even necessary to export the EME dataset associated with the table component as a Dataset Mapping parameter. This allows you
to specify each table referenced by the component and the table's record format as a single input parameter to the graph or subgraph. For more information,
see “Exporting dataset mappings”.
You can export a variety of parameters for a table from the following tabs of the Properties dialog:

Properties tab Parameters

Data The database configuration file, dbms type, table name, table specification kind, and EME dataset
NOTE: The EME dataset component parameter cannot be declared at the graph level; it must be exported.
NOTE: If you want to supply a value for the dbms type parameter at run time, the graph must be set to use dynamic script generation.
Parameters The listed parameters
Layout The entire layout
Ports The input or output port metadata parameters
Condition The condition settings
After a parameter has been exported, you can edit it only in the Parameters Editor; it will be read-only in the Properties dialog.
If you export a parameter in a subgraph, the parameter appears in the Parameters Editor for the subgraph that contains it, not in the parent graph.
Unexporting a parameter does not delete it from the graph level. Instead, it disassociates the parameter in the originating component from the graph-level
parameter shown in the Parameters Editor. The graph-level parameter remains, allowing other components to continue to obtain values from it. The
unexported parameter becomes editable again in the originating component’s Properties dialog.

Exporting table parameters

You can export table parameters from the Data, Parameters, Layout, Ports , and Condition tabs where the parameters are declared in the Properties dialog. The
procedure is similar but not identical for each of these tabs.
To export table parameters from the Data tab:
1. In the table’s Properties dialog, click the Data tab, where the Configuration file, DBMS type, Data location, and EME dataset have previously been
defined.
2. Click Export.
The Export Table Parameters dialog opens.
3. Select one or more of the parameters you want to export, and click OK.
The Export as Parameter dialog appears, displaying information about the parameters you selected for export.
4. Accept the defaults or modify the appropriate fields, and click OK.
If you selected multiple parameters in the Export Table Parameters dialog, the Export as Parameter dialog reappears for each of the parameters you selected.
Repeat this step until focus returns to the Table Properties dialog, where the fields for the exported parameters are shown as read only, with notations that they
were exported.
After you have exported all the parameters for the tab, the Export button changes to Unexport.
To export table parameters from the Parameters tab:
1. In the table’s Properties dialog, click the Parameters tab.
2. Follow these steps for each parameter you want to export:
a. Select the parameter, and click Export.
The Export as Parameter dialog displays information about the parameter you selected for export.
b. Accept the defaults or modify the appropriate fields, and click OK.
On the Parameters tab an Up arrow appears before the parameter that was exported.
To export table parameters from the Ports tab:
1. In the table’s Properties dialog, click the Ports tab.
2. Follow these steps for each port whose metadata you want to export:
a. Select the port whose metadata you want to export, and click Export.
The Export as Parameter dialog displays information about the port metadata you selected for export.
b. Accept the defaults or modify the appropriate fields, and click OK.
On the Ports tab, an Up arrow appears before the port that was exported.
To export table parameters from the Layout or Condition tab:
1. In the table’s Properties dialog, click the Layout or Condition tab.
2. Click Export.
The Export as Parameter dialog displays information about the single layout or condition parameter for export.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 156 of 221

3. Accept the defaults or modify the appropriate fields, and click OK.
On the Layout or Condition tab, a notation describes that the parameter was exported.

Unexporting or deleting exported table parameters

You can unexport table parameters from the table’s Properties dialog, or you can delete them from the Parameters Editor.

From the Table Properties dialog

To unexport a parameter from the Table Properties dialog:

1. In the table’s Properties dialog, click the tab from which the parameter was exported.
2. Do one of the following, depending on whether you previously exported one or all parameters:

Tab Action
Data If you exported all parameters, click Unexport, select the appropriate unexport options in the Export Table Parameters dialog, and click
OK.
If you didd not export all parameters listed in the Export Table Parameters dialog, click Export, select the appropriate unexport options in
the Export Table Parameters dialog, and click OK.
Parameters Select an exported parameter and click Unexport. Repeat for each exported parameter.
Layout Click Unexport.
Ports Select an exported port and click Unexport. Repeat for each exported port metadata parameter.
Condition Click Unexport.
NOTE: Unexporting a parameter does not delete it from the graph. Instead, it disassociates the parameter in this component from the graph-level parameter
shown in the Parameters Editor, while allowing other components to continue to obtain values from the graph-level parameter.

From the Parameters Editor

To delete an exported parameter from the Parameters Editor:

1. In the project tree of the Parameters Editor, select the graph or subgraph node.
2. In the parameters pane, select the parameter you want to delete.
3. Choose Edit > Delete or click .
This deletes the parameter from the graph or subgraph in the Parameters Editor and restores the originating component as the source of the parameter’s value.
WARNING! If any component — other than the originating component — relies on the deleted graph-level parameter for its value, the graph may fail or
generate incorrect output.
Related topics
Exporting component parameters to the top level of a graph

Pre N
viou

GDE Help > Working with data > Profiling data

Profiling data
As a graph developer, you may want to profile your data so you can examine the values and distributions in the output, and adjust your record formats
accordingly so that they reflect the data as intended.
A profile tells you the following:
For the profiled dataset, the number of records, invalid records, values, and invalid values
For each field in the profiled dataset:
The number of values, valid values, invalid values, null values, distinct values, and blank values
The average, maximum, and minimum character length
The minimum and maximum value
The most common and the least common values, invalid values, and patterns
You can use the data profiling feature of the GDE to:
Analyze varied data sources and data types
View the original data that goes into a profile statistic
Determine the quality and characteristics of data by looking at detailed profile statistics
Use column and field values and characteristics to help refine record formats
This section of the help describes how to run profile jobs and how to navigate the output. It includes the following topics:
Running profile jobs
Closing and redisplaying profiles
NOTE: Before you can profile data from the GDE, your Ab Initio administrator must complete certain configuration tasks. For more information, see
“Setting up the environment for data profiling”.

Pre N
viou e

GDE Help > Working with data > Profiling data > Running profile jobs

Running profile jobs

You can profile data in any of the following:
An input file or table
An output file or table

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 157 of 221

A watcher file

Running a profile job

To run a profile job:

1. Select the component whose data you want to profile.
2. Do one of the following:
Right-click the component and choose Profile Dataset from the pop-up menu.
From the GDE menu bar, choose View > Profile Dataset.
The Profile Dataset dialog displays a message telling you that the profile job is running.
When a profile job finishes, a browser window displays a profile of all of the data in the profiled component. This profile, called a dataset profile, displays
information about all the fields (or columns) in the dataset.
Screen capture of a dataset profile.

From the dataset profile, you can display field profiles. Each field profile displays statistics about that particular field (or column) in the dataset.
For profile help, including instructions on navigating profiles, getting information about statistics, and interpreting special characters, click the Help button
in the upper-right corner of the profile window. For context-sensitive help on a particular section of a profile, hover over its question mark icon
and then click More.

Canceling a profile job

If you want to stop a profile job before it has finished, you can cancel it.
To cancel a profile job:
1. Select the component for which you are profiling data.
2. Do one of the following:
Click Cancel in the Profile Dataset dialog.
Right-click the component and choose Cancel Profile Job from the pop-up menu.
From the GDE menu bar, choose View > Cancel Profile Job.
The Profile Dataset dialog confirms the cancellation. For more information about the job, click Details.
Related topics
Profiling data
Closing and redisplaying profiles

Pre N
viou

GDE Help > Working with data > Profiling data > Closing and redisplaying profiles

Closing and redisplaying profiles

When you have finished viewing a profile, simply close the browser window. You can view the profile again later during the same GDE session, if you so
choose.
To redisplay a profile:
1. Select the component whose profile you want to view.
2. Do one of the following:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 158 of 221

From the GDE menu bar, choose View > Redisplay Dataset Profile.
Right-click the component and choose Redisplay Dataset Profile from the pop-up menu.
Related topics
Profiling data
Running profile jobs

Pre N
viou e

GDE Help > Viewing data

Viewing data
This section contains these topics:
About viewing data in the GDE
View Data window
Getting information about records in the View Data window
Selecting data in the View Data window
Expanding and collapsing subrecords
Customizing the View Data window
Setting the number of records displayed in the View Data window
Getting more records in the View Data window
Clearing the contents of the View Data window
Sorting records in the View Data window
Searching the View Data window
Copying field names and record numbers to the clipboard
Printing the contents of the View Data window
Exporting data from the View Data window
Viewing data as XML
Viewing unformatted data
Dump window
View Data toolbar

Pre N
viou e

GDE Help > Viewing data > About viewing data in the GDE

About viewing data in the GDE

In the GDE, you can use the View Data window to view dataset records in an input, intermediate, or output file (or table) associated with a component. You
can also view data that has passed through a watcher and other intermediate files. You can also use this window to view compressed data and flows. For more
information, see “Viewing compressed datasets”.
In addition to viewing data, you can use the View Data window to look for invalid or unexpected data, copy and paste data into another program, and print or
export data. See “Invalid UTF-8 data in the View Data Window”.
To view dataset records:
1. Select a dataset component and either choose View > Data from the GDE menu bar or right-click and choose View Data from the pop-up menu. This
displays the View Data Options dialog.
2. In the View Data Options dialog, accept the default settings or change them, and then click OK.
The View Data window displays the dataset records listed horizontally (grid view), vertically (tree view), or formatted (formatted text view), depending on the
display you selected:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 159 of 221

Screen captures of two View Data windows, one in grid view, the other in tree view.

Screen captures of the View Data window in formatted text view.

Pre N
viou e

GDE Help > Viewing data > About viewing data in the GDE > Viewing compressed datasets

Viewing compressed datasets

You can use the View Data window to view compressed datasets and the contents of compressed data flows with a watcher present. In most cases, View Data
automatically uncompresses the data (depending on the component), determines the appropriate DML format, and displays the dataset to you.
In this example, the dataset associated with Output File was compressed before being written to disk by the DEFLATE component:
Screen capture of a graph with an OUTPUT file whose data was compressed by a Deflate
component before it was written to disk.

View Data automatically uncompresses the data before displaying it:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 160 of 221

Screen caputure showing the compressed data from the previous picture when displayed in View Data. It has
been automatically uncompressed and is readable.

Similarly, View Data converts the compressed data on the Replicate.out to Reformat.in flow. where you can view it from a watcher:
Screen capture showing that View Data automatically uncompresses compressed data
associated with a watcher.

Viewing lookup datasets

In limited cases, View Data cannot automatically recognize compressed data or locate its associated DML. Those cases are when:
The dataset is the output of a WRITE BLOCK-COMPRESSED LOOKUP
The dataset is a LOOKUP with the block_compressed parameter set to true
The procedures below describe how you can view these datasets.

WRITE BLOCK-COMPRESSED LOOKUP

To view these datasets:

1. Attach an intermediate file to the out port of the WRITE BLOCK-COMPRESSED LOOKUP component.
2. Attach an INFLATE component to the read port and disable the INFLATE component.
3. Attach a TRASH component to the out port of the INFLATE component, and disable the TRASH component. (The TRASH component should have the
correct DML record format.)
4. Run the graph and use View Data to view the uncompressed data in the intermediate file.
In this example, an intermediate file, a disabled INFLATE component, and a disabled TRASH component have been placed after the WRITE BLOCK-
COMPRESSED LOOKUP component.
A screen capture showing a graph whose INFLATE and TRASH components are disabled and placed
downstream of an intermediate file.

It is now possible to view the compressed data with View Data:

A screen capture showing how the compressed data in the
Intermediate file can be successfully viewed in View Data.

LOOKUP with block compression set

To view these datasets:

1. Attach a disabled component (for example, GENERATE RECORDS) to the write port of the LOOKUP component.
2. Set the disabled component’s Record format source to Propagate from neighbors and set it to the LOOKUP out port.
3. Run the graph and use View Data to view the uncompressed data in the LOOKUP file.
In this example, the lookup file has the Block-compressed parameter set to true.The use of the disabled component makes it possible to view the compressed

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 161 of 221

data:
A screen capture showing how using a disabled component
makes it possible to see data in a lookup file, even when the
Block-compressed parameter is set to true.

Viewing compressed datasets without the GDE

Sometimes it is necessary to view compressed datasets when a GDE is not available. This can happen in a production environment. In this case, you can view
compressed datasets and block-compressed lookup files by using the m_dump utility with the -decompress argument. For more information, see “m_dump”.
Related topics
View Data window
DEFLATE component
INFLATE component
WRITE BLOCK-COMPRESSED LOOKUP component

Pre N
viou

GDE Help > Viewing data > About viewing data in the GDE > Invalid UTF-8 data in the View Data Window

Invalid UTF-8 data in the View Data Window

The View Data window displays invalid UTF-8 data as the hexadecimal value of each invalid byte, preceded by \X. It does not actually change the data.
UTF-8 uses between 1 and 4 bytes to encode each character. Specific values of the first byte signal whether the character is encoded with more than 1 byte.
Values C0, C1, and F5-FF are always invalid. Values C2-F4 are valid only as the first byte of a multibyte sequence. Values 80-BF are valid only as the
second, third, or fourth byte of a multibyte sequence. For more details, see IETF RFC 3629.
You can get an invalid byte sequence if you describe your data with the wrong character encoding. To illustrate: say that you mistakenly describe iso_latin_1
data with the DML type of utf8 string. View Data will display hexadecimal-escaped byte values instead of accented European characters. A capital letter O
with an umlaut has the hexadecimal value d6 in iso_latin_1, so you would see \Xd6 wherever that character appears in your data. For example, the name
Ozgar (with an umlaut) would appear as \Xd6zgar.

Related topics
View Data window
Getting information about records in the View Data window
Selecting data in the View Data window
Expanding and collapsing subrecords
Customizing the View Data window
Setting the number of records displayed in the View Data window
Getting more records in the View Data window
Clearing the contents of the View Data window
Sorting records in the View Data window
Searching the View Data window
Copying field names and record numbers to the clipboard
Printing the contents of the View Data window
Exporting data from the View Data window
Viewing data as XML
View Data Options dialog
Viewing unformatted data
Dump window
View Data toolbar

Pre N
viou e

GDE Help > Viewing data > View Data window

View Data window

How to reach the View Data window
1. Select a dataset component and either choose View > Data from the GDE menu bar or right-click and choose View Data from the pop-up menu. This
displays the View Data Options dialog.
2. In the View Data Options dialog, select the options you want and click OK to display the View Data window.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 162 of 221

In the View Data window, you can look at data using either grid view, tree view, or formatted text view. See also “Invalid UTF-8 data in the View Data
Window”.
To toggle between the different views:
Do one of the following:
Choose View > Grid View, View > Tree View, or View > Formatted Text from the menu bar.
Use the Display Type toggle button on the toolbar.

Grid View

Here is the View Data window in grid view:

Screen capture of the View data dialog in grid view.

Grid view has these characteristics:

Each row shows one record.
The leftmost column displays the physical record numbers.
NOTE: The physical record numbers of the original dataset start at 1.
Each of the other columns corresponds to a field.
When you hover over a column name, a pop-up box displays the field name and DML type, as shown in the following figure:
Screen capture showing the hover information for a column name.

Tree View

Here is the View Data window in tree view:

Screen capture of the View Data dialog in tree view.

Tree view has these characteristics:

The first column displays the record format, field by field.
Each of the other columns displays one record. Subrecords are represented by the word record enclosed in square brackets: [record].
Collapsed subrecords have a plus sign (+) next to them.
When you hover over a field name, a pop-up box displays the field name and DML type.

Formatted Text

Here is the View Data window in formatted text view:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 163 of 221

Screen captures of the View Data window in formatted text view.

Formatted text view has these characteristics:

The view prefaces each record with Record n:, where n is the physical record number of the record that follows.
NOTE: The physical record numbers of the original dataset start at 1.
The output resembles the output from the DML m_eval utility: the field names are on the left followed by a DML record or vector type containing any
additional fields and the actual data.
Left and right square brackets enclose subrecords and vectors and their data. Nested records and vectors are always shown expanded. You cannot change
any of this.
The view ends each record with a dashed line.
The view supports text searches.
For information on viewing unformatted data, see “Viewing unformatted data”.
Related topics
About viewing data in the GDE
Getting information about records in the View Data window
Selecting data in the View Data window
Expanding and collapsing subrecords
Customizing the View Data window
Setting the number of records displayed in the View Data window
Getting more records in the View Data window
Clearing the contents of the View Data window
Sorting records in the View Data window
Exporting data from the View Data window
Searching the View Data window
Printing the contents of the View Data window
Copying field names and record numbers to the clipboard
Viewing data as XML
View Data Options dialog
Viewing unformatted data
Dump window
View Data toolbar

Pre N
viou

GDE Help > Viewing data > Getting information about records in the View Data window

Getting information about records in the View Data window

To get information about the records currently displayed, do one of the following:
In the View Data window, hover over the icon in the lower-right corner.
Screen capture of the pop-up
information for the data being
viewed.

The resulting tooltip displays information about your records.

In the View Data Options dialog, click the Info tab.
You see the same information as above, plus information about the dataset itself.
Related topics

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 164 of 221

About viewing data in the GDE

View Data window
View Data Options dialog

Pre N
viou

GDE Help > Viewing data > Selecting data in the View Data window

Selecting data in the View Data window

In the View Data window, you can select a cell, field, or record; a range of cells, fields, or records; or all the data. You can copy the selection to the clipboard,
print it, or export it to an external file.
The procedures in this topic apply to both the grid and tree views unless otherwise noted. They do not apply to the formatted text view. See also “Keyboard
shortcuts in the View Data window”.

A cell

To select a cell
Click the cell.
A selected cell has a dark blue border.

A field

To select a field, do one of the following:

Grid view. Field names appear as column headers; click the column header of the field.
Tree view. Field names are listed in the leftmost column; click any cell in the row of the field you want to select.
Screen capture of the View Data window showing a selected cell with a thick blue outline
and a selected field with a thick gray outline.

A record

To select a record, do one of the following:

Grid view. Click the physical record number in the leftmost column.
Tree view. Click in a column header.
Screen captures of the View Data window;one shows the
physical record number in the leftmost column;the other shows
the physical record number as a column header.

A range of cells

To select a range of cells, do one of the following:

Click a corner of the starting cell, and Shift-click the cell in the diagonally opposite corner of the range.
Screen capture of the View Data window with arrows showing
how to select a range of cells by clicking a corner cell and then
shift-clicking the cell in the diagonal opposite corner of the
range.

Drag from one corner cell to the cell in the diagonally opposite corner of the range.
Screen capture of the View Data window with arrows showing
how to select a range of cells by clicking a corner cell and
then shift-clicking the cell in the diagonal opposite corner of
the range.

A range of fields

To select a range of fields, do one of the following:

Click a field name at one end of the range, and Shift-click the field name at the other end of the range.
Drag from a field name at one end of the range to the field name at the other end of the range.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 165 of 221

A range of records

To select a range of records, do one of the following:

Click a physical record number at one end of the range, and Shift-click the physical record number at the other end of the range.
Drag from a physical record number at one end of the range to the physical record number at the other end of the range.

All data

To select all data:

Press Ctrl+A.
Related topics
About viewing data in the GDE
View Data window
Getting information about records in the View Data window
Keyboard shortcuts in the View Data window

Pre N
viou e

GDE Help > Viewing data > Expanding and collapsing subrecords

Expanding and collapsing subrecords

In the View Data window, you can examine data records at any level. You can display as much or as little of a nested hierarchy as you like. You can expand
and collapse subrecords (group items) as you see fit.
NOTE: See also “Keyboard shortcuts in the View Data window”.

Expanding and collapsing in grid view

All subrecords

To expand or collapse all subrecords in the dataset:

Right-click the column header of the subrecord to display a pop-up menu with expand and collapse options:
Screen capture of the View Data window showing what
happens when you right-click a column header of a
subrecord: a pop-up menu appears with expand and
collapse options.

To expand or collapse one level of all subrecords, do one of the following:

Shift-click the plus or minus sign next to [record].
Right-click the column header of the subrecord and choose Expand Field or Collapse Field from the pop-up menu.
To expand or collapse all levels of all subrecords, do one of the following:
Ctrl-shift-click the plus or minus sign next to [record].
Right-click the column header of the subrecord and choose Expand Field and Subfields or Collapse Field and Subfields from the pop-up menu.

One subrecord

To expand or collapse one level of a subrecord in a single record:

Click the plus or minus sign next to [record].
To expand or collapse all levels of a subrecord in a single record, do one of the following:
Ctrl-click the plus or minus sign next to [record].
If the subrecord is the selected cell, hold down the Ctrl key and press the left or right arrow key.

Expanding and collapsing in tree view

To expand or collapse one level of a subrecord:

Click the plus or minus sign next to the name of the subrecord.
To expand or collapse all levels of a subrecord:
Shift-click the plus or minus sign next to the name of the subrecord.
Related topics
Expanding and collapsing subrecords
About viewing data in the GDE
View Data window
Customizing the View Data window
Getting more records in the View Data window
Sorting records in the View Data window
Searching the View Data window
Copying field names and record numbers to the clipboard
View Data Options dialog
Viewing unformatted data
Dump window

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 166 of 221

View Data toolbar

Keyboard shortcuts in the View Data window

Pre N
viou e

GDE Help > Viewing data > Customizing the View Data window

Customizing the View Data window

This topic contains these sections:
Resizing columns
Hiding and showing fields
Maximum characters and upper limits per cell
Customizing the display of strings
Splitting the View Data window
Viewing a subset of a dataset
Viewing just one partition
Setting how much memory is used

Pre N
viou

GDE Help > Viewing data > Customizing the View Data window > Resizing columns

Resizing columns
In grid view in the View Data window, the column widths are initially sized to fit the first 100 rows of data shown in the column, not to accommodate the
column header.

One column

To adjust the width of a column to a specific size:

Drag an edge of the column header. (The cursor changes shape when you are able to drag.)
To resize a column to the width of the visible data:
1. Hover over the right edge of the column header.
2. Double-click when the cursor changes to a resizing cursor: . S
To resize a column using a menu:
1. Do one of the following:
Select a column and then choose View > Resize Column from the menu bar.
Right-click a column and select Resize Column from the pop-up menu.
2. From the Resize Column submenu, choose one of the following items:
Fit Visible Data. Resizes the column so that all the data currently visible fits in the column.
Fit Visible Data and Field Name. Resizes the column so that all the data currently visible, as well as the field name, fits in the column.
Fit All Data. Resizes the column so that all the data — including data not currently scrolled into view — fits in the column.
Fit All Data and Field Names. Resizes the column so that the field name and all the data — including data not currently scrolled into view — fits in the
column.
See also the setting Maximum Column Width When Autosizing on the View Data Options: Options tab.

Multiple columns

To resize multiple columns:

1. Choose View > Resize Visible Columns to display the pop-up menu.
2. From the Resize Visible Column submenu, choose one of the following items:
Fit Visible Data. Resizes all visible columns so that all the data currently visible fits in the column.
Fit Visible Data and Field Name. Resizes all visible columns so that all the data currently visible, as well as all the field names, fits in the column.
Fit All Data. Resizes all visible columns so that all the data — including data not currently scrolled into view — fits in the columns.
Fit All Data and Field Names. Resizes all visible columns so that all field names and all the data — including data not currently scrolled into view —
fits in the columns.
See also the setting Maximum Column Width When Autosizing on the View Data Options: Options tab.
Related topics
Hiding and showing fields
Maximum characters and upper limits per cell
Customizing the display of strings
Splitting the View Data window
Viewing a subset of a dataset
Viewing just one partition
Setting how much memory is used
Keyboard shortcuts in the View Data window

Pre N
viou e

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 167 of 221

GDE Help > Viewing data > Customizing the View Data window > Hiding and showing fields

Hiding and showing fields

In the View Data window, you can hide or show individual record fields; and you can customize which fields, subrecords, and subfields to display.

Setting which fields to display

To set which fields, subrecords, and subfields to display:

1. Choose File > Options from the menu bar and click the Fields tab.
2. In the list of all possible fields, subrecord, and subfields, select or deselect the checkbox next to the field you want to show or hide as described in the
procedures below.
You can also expand and collapse group items, as described in “Expanding and collapsing subrecords”.

Hiding fields

To hide a field in the View Data window, do one of the following:

Right-click the field name and choose Hide Field from the pop-up menu.
Choose File > Options from the menu bar, click the Fields tab, and uncheck the fields you want to hide.

Showing hidden fields

To show a hidden field in the View Data window, do one of the following:
Right-click an adjacent visible field name and choose Show Left/Right Sibling Field from the pop-up menu.
Choose File > Options from the menu bar, click the Fields tab, and select the fields you want to show.
Related topics
Resizing columns
Maximum characters and upper limits per cell
Customizing the display of strings
Splitting the View Data window
Viewing a subset of a dataset
Viewing just one partition
Setting how much memory is used
Keyboard shortcuts in the View Data window

Pre N
viou e

GDE Help > Viewing data > Customizing the View Data window > Maximum characters and upper limits per cell

Maximum characters and upper limits per cell

The View Data window requires an upper limit for the number of characters displayed in a cell; this prevents memory problems in the event of a mismatch
between the data and the DML expression describing it. The default upper limit is 10,000, but you can change it up to the absolute upper limit of 20,000. (The
smallest number of characters for the upper limit is 10 — you cannot change this.)
To set the maximum characters displayed in a cell:
1. Choose File > Options from the menu bar and click the Options tab.
2. Set the Maximum Characters Displayed in Cell (between 10 and 20000 inclusive).
The value of Maximum Characters Displayed in Cell also affects:
The number of characters displayed when you hover over a cell whose value does not fit the column width
The number of characters you can enter in the Find what box of the View Data Find dialog
NOTE: This setting has no effect on the width of the columns displayed in the View Data window.
Related topics
Resizing columns
Hiding and showing fields
Customizing the display of strings
Splitting the View Data window
Viewing a subset of a dataset
Viewing just one partition
Setting how much memory is used
Keyboard shortcuts in the View Data window

Pre N
viou e

GDE Help > Viewing data > Customizing the View Data window > Customizing the display of strings

Customizing the display of strings

In the View Data window, you can display strings several ways. This feature is specific to the View Data window: a string display selection does not persist
when you copy records to the clipboard. For more information on the copy feature, see “Copying field names and record numbers to the clipboard”.
To specify how you want strings displayed:
1. Do one of the following:
Choose View > String Display from the menu bar.
Choose File > Options from the menu bar, then click the Display tab and make sure that Interpret As is set to Formatted Fields. For more information,
see “View Data Options: Display tab”.
2. Select the appropriate option from the String Display submenu or the String Display drop-down list:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 168 of 221

Compact Blanks. Collapses a series of spaces to one space.

Screen captures of a value having many spaces is shown in the View Data window: one
shows the default display, the other shows the display if Compact Blanks is selected.

Enclose in Quotes. The default. Displays string, decimal, and date type data in quotes.
Screen capture of a value displayed
in quotes in the View Data window.

Literal. Displays a printable representation of the data exactly as it exists in the dataset record.
Screen capture of a value displayed
as a literal.

Substitute Mid Dot for Blanks. Displays a blank as a centered dot.

Screen capture of a value displayed
with dots representing spaces.

Related topics
Resizing columns
Hiding and showing fields
Maximum characters and upper limits per cell
Splitting the View Data window
Viewing a subset of a dataset
Viewing just one partition
Setting how much memory is used
View Data Options: Display tab
Keyboard shortcuts in the View Data window

Pre N
viou

GDE Help > Viewing data > Customizing the View Data window > Splitting the View Data window

Splitting the View Data window

You can split the View Data window horizontally or vertically in both grid view and tree view. Doing so lets you keep one part of the window stationary while
you scroll another part.
Screen captures of two View Data windows with labels and arrows pointing out the horizontal and vertical splitters.

To split a window:
1. Drag a splitter to where you want it.
Screen capture of lower right corner of the View Data
window showing the horizontal and vertical splitters in
their un-split positions.

2. Place the cursor in either window pane and scroll to the target data.
To clear a split window:
Drag the splitter into the scroll bar you got it from.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 169 of 221

Screen capture of the View Data window with a vertical split. A label and arrows
show how you can drag the vertical splitter to the vertical scroll bar.

Related topics
Resizing columns
Hiding and showing fields
Maximum characters and upper limits per cell
Customizing the display of strings
Viewing a subset of a dataset
Viewing just one partition
Setting how much memory is used
Keyboard shortcuts in the View Data window

Pre N
viou e

GDE Help > Viewing data > Customizing the View Data window > Viewing a subset of a dataset

Viewing a subset of a dataset

NOTE: This topic is only for those who can write DML expressions.
To view a subset of the specified dataset in the View Data window:
1. Choose File > Options from the menu bar in the View Data window to display the View Data Options dialog.
2. Click the Records tab.
3. In the Start Record box, accept the default or enter the physical record number (in the original dataset) at which you want the View Data window to start
displaying records that match the filter expression.
4. In the Record Count box, accept the default or enter the number of records you want to initially display. This value will appear in the More Records box on
the View Data toolbar.
5. Enter a DML expression to limit the records displayed in the View Data window. You can click Edit to open the Expression Editor to help you create your
expression.
NOTE: The GDE does not save the expression when you close the View Data window.
6. Click OK.
7. Optional. On the View Data toolbar, click the Go button to retrieve the next subset (if any) that matches your expression. View Data appends any new
records to your current display in groups set by the value of Record Count.
Related topics
Resizing columns
Hiding and showing fields
Maximum characters and upper limits per cell
Customizing the display of strings
Splitting the View Data window
Viewing just one partition
Setting how much memory is used
Keyboard shortcuts in the View Data window

Pre N
viou

GDE Help > Viewing data > Customizing the View Data window > Viewing just one partition

Viewing just one partition

To view the data from only one partition in the View Data window:
1. Choose File > Options in the View Data window and click the Records tab of the View Data Options dialog.
2. Deselect the All checkbox and enter the number of the partition you want to view in the Multifile Partition box.
NOTE: These fields are only visible for a component with a multifile layout.
Related topics
Resizing columns
Hiding and showing fields
Maximum characters and upper limits per cell
Customizing the display of strings
Splitting the View Data window
Viewing a subset of a dataset
Setting how much memory is used
Keyboard shortcuts in the View Data window

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 170 of 221

Pre N
viou

GDE Help > Viewing data > Customizing the View Data window > Setting how much memory is used

Setting how much memory is used

You can adjust the maximum amount of memory that the View Data window uses to prepare data for display. Doing so can prevent your machine from
running out of memory if you try to retrieve an amount of data that exceeds the capacity of your PC’s memory.
To set how much memory the View Data window uses:
1. Choose File > Options in the View Data window, and then click the Options tab.
2. In the Maximum Memory Used During Data Collection box, accept the default or set a value to best work with your PC’s available memory. For more
information on determining the best value to enter, see “View Data Options: Options tab”.
Related topics
Resizing columns
Hiding and showing fields
Maximum characters and upper limits per cell
Customizing the display of strings
Splitting the View Data window
Viewing a subset of a dataset
Viewing just one partition
Setting how much memory is used
Keyboard shortcuts in the View Data window

Pre N
viou

GDE Help > Viewing data > Setting the number of records displayed in the View Data window

Setting the number of records displayed in the View Data window

The View Data window normally displays either 100 records (the default) or the number of records you specify in the Record Count field on the View Data
Options: Records tab. However, the View Data window displays fewer than the default or specified number of records in any of these situations:
It first reaches the end of the file.
It first reaches the value of the Maximum Memory Used During Collection field on the View Data Options: Options tab.
You entered a DML filter expression in the View Data Options: Records tab.

Related topics
Getting more records in the View Data window
Clearing the contents of the View Data window
About viewing data in the GDE
View Data window
Viewing unformatted data
Dump window
View Data toolbar
Keyboard shortcuts in the View Data window

Pre N
viou e

GDE Help > Viewing data > Getting more records in the View Data window

Getting more records in the View Data window

In the View Data window — if you have not reached either the end of the file or the memory limit specified in the Maximum Memory Used During Data
Collection box — you can append more records to those already displayed. You can also clear the display before getting new records.
To append additional records to the displayed data:
1. Accept the default or set the number of additional records you want to append by editing the number in the More Records box.
Icon for the More
Records box.
2. Make sure Clear Display is not selected.
3. Click Go.

NOTE: The Go button is unavailable if you have reached the end of the file.
The View Data window appends up to the number of records you specified, provided that it does not first reach the end of the file or the maximum memory
limit. The status bar at the bottom of the window shows the number of records scanned and the number of records in the display. For more information, see
“Setting the number of records displayed in the View Data window”.
Related topics
Setting the number of records displayed in the View Data window
Clearing the contents of the View Data window
About viewing data in the GDE
View Data window
Expanding and collapsing subrecords
Customizing the View Data window

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 171 of 221

Sorting records in the View Data window

Viewing unformatted data
Dump window
View Data toolbar
Keyboard shortcuts in the View Data window

Pre N
viou e

GDE Help > Viewing data > Clearing the contents of the View Data window

Clearing the contents of the View Data window

To clear the contents of the View Data window before fetching additional data:
1. Select Clear Display.
Icon

2. Click Go.
S

This clears the memory used for the current display so that the newly fetched records are not appended to the previously visible records.
CAUTION! Clicking the Refresh button on the View Data toolbar when Clear Display is unchecked changes the value of Start Records on the “View Data
Options dialog” to match the value of the currently displayed first record.
Related topics
Setting the number of records displayed in the View Data window
Getting more records in the View Data window
About viewing data in the GDE
View Data window
Viewing unformatted data
Dump window
View Data toolbar
Keyboard shortcuts in the View Data window

Pre N
viou

GDE Help > Viewing data > Sorting records in the View Data window

Sorting records in the View Data window

In the View Data window — in both grid view and tree view — the initial order of the displayed records is the order in which the records occur in the data. If
you re-sort the records on a particular field, the current sort order is indicated by a glyph in the column header (grid view) or field name (tree view).
Screen captures of the View Data dialog in Tree View and Grid View. A label and arrows point out the sort glyphs.

To sort in grid view:

Right-click the name of the column you want to sort on, and choose Sort Ascending or Sort Descending from the pop-up menu.
Double-click a column header to toggle between ascending and descending order.
To sort in tree view:
Right-click the field name and choose Sort Ascending or Sort Descending from the pop-up menu.
To restore the order of records in the window to match the order of the records in the dataset, do one of the following:
From the View Data menu bar, choose View > Reset Sort.
In grid view, right-click any column header and choose Reset Sort from the pop-up menu.
In grid view, double-click the rectangle that is the topmost and leftmost in the window.
Screen capture of the View Data dialog in Grid View with a label and arrow pointing out the topmost and leftmost
rectangle.

In tree view, right-click any field name and choose Reset Sort from the pop-up menu.
Related topics
About viewing data in the GDE
View Data window
Selecting data in the View Data window
Expanding and collapsing subrecords
Customizing the View Data window
Setting the number of records displayed in the View Data window
Getting more records in the View Data window

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 172 of 221

Clearing the contents of the View Data window

Searching the View Data window
Viewing unformatted data
Dump window
View Data toolbar
Keyboard shortcuts in the View Data window

Pre N
viou e

GDE Help > Viewing data > Searching the View Data window

Searching the View Data window

You can search in the View Data window in the following ways:
Match case or pattern
Search only expanded records and subrecords, or search all records whether collapsed or expanded (grid view and tree view)
Search all fields or only a selected field (grid view and tree view)
Search up or down
Locate values that occur more than once
To search in the View Data window:
1. Do one of the following to display the View Data Find dialog:
Choose Edit > Find from the menu bar.
Press Ctrl+F.
On the View Data toolbar, click .
2. Enter a search value and click Find Next. For detailed information about searching, click Help in the dialog or see View Data Find dialog.
Related topics
View Data Find dialog
About viewing data in the GDE
View Data window
Expanding and collapsing subrecords
Customizing the View Data window
Setting the number of records displayed in the View Data window
Getting more records in the View Data window
Clearing the contents of the View Data window
Sorting records in the View Data window
View Data toolbar
Keyboard shortcuts in the View Data window

Pre N
viou e

GDE Help > Viewing data > Copying field names and record numbers to the clipboard

Copying field names and record numbers to the clipboard

All the View Data views let you copy data to the clipboard, from where you can paste it into other applications. In the grid and tree views, you can also
specify whether to include field names and record numbers in the output.

Copying data

To copy data in the View Data window to the clipboard:

1. Select the data you want to copy. For more information, see Selecting data in the View Data window.
2. Do one of the following:
Press Ctrl+C.
On the View Data toolbar, click .
Choose Edit > Copy from the View Data window menu.
NOTE: You can copy and paste cells directly to an Excel spreadsheet from View Data.

Setting copy options

To specify whether to copy field names and record numbers to the clipboard:
1. Choose Edit > Copy Options from the View Data window menu.
2. In the Copy Options dialog, select whether to include the field names or record numbers in the output.
3. Click OK.
The changes take effect when you next copy data.
Related topics
Printing the contents of the View Data window
Exporting data from the View Data window
View Data window
Selecting data in the View Data window
Expanding and collapsing subrecords
Exporting data from the View Data window
Viewing unformatted data
Dump window

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 173 of 221

View Data toolbar

Keyboard shortcuts in the View Data window

Pre N
viou e

GDE Help > Viewing data > Printing the contents of the View Data window

Printing the contents of the View Data window

You can print all the data in the View Data window, only the selected items, or only particular records.
To print the contents of the View Data window:
1. Do one of the following to display the Print Options dialog:
Press Ctrl+P.
From the View Data toolbar, click .
From the View Data window menu bar, choose File > Print.
2. Use the Print Options dialog to enter your print selections, set up your printer, and preview your print job. For more information, see “Print Options
dialog”.
Related topics
Print Options dialog
Copying field names and record numbers to the clipboard
Exporting data from the View Data window
Keyboard shortcuts in the View Data window

Pre N
viou e

GDE Help > Viewing data > Exporting data from the View Data window

Exporting data from the View Data window

You can export all the data in the View Data window, a range of records, or just the data indicated by the current selection to a file.
To export the data in the View Data window to a file:
1. Do one of the following to display the Export Data dialog:
From the View Data window menu bar, choose File > Export.
From the View Data toolbar, click the Export button .
2. Enter the data range, filename, and other information in the Export Data dialog. For more information, see “Export Data dialog”.
Related topics
Export Data dialog
Printing the contents of the View Data window
Exporting data from the View Data window
Keyboard shortcuts in the View Data window

Pre N
viou e

GDE Help > Viewing data > Viewing data as XML

Viewing data as XML

This feature lets you view complicated XML data stored in a field using an external browser or other application. The browser or application formats the text
so that it is easier to read. You can select only one field for viewing at a time.
To view data as XML in the View Data window:
1. Select the field you want to view as XML.
2. Choose View > View Field as XML from the View Data window menu.
Screen capture showing View Data with an XML field. An inset screen capture shows how the field
appears as tagged XML in Internet Explorer after selecting the View Field as XML menu command.

The XML data field is displayed in whatever application is registered to display .xml files on your Windows system. (Typically, this is Internet Explorer.)
Related topics

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 174 of 221

About viewing data in the GDE

View Data window
View Data Options dialog
Viewing unformatted data
Dump window
View Data toolbar
Keyboard shortcuts in the View Data window

Pre N
viou

GDE Help > Viewing data > Viewing unformatted data

Viewing unformatted data

You can view a dataset as raw data, as hexadecimal data, as formatted text with field names and values, or as formatted text with field names and values
displayed in tabular form. Here are the examples of the four options:
Four layered screen captures showing the same dataset’s raw data as it appears in the four different viewing options.

To view unformatted data:

1. Select a dataset component and choose either View Data Unformatted from the pop-up menu or View > Data Unformatted from the GDE menu bar.
2. In the View Data window, accept the defaults or customize the display and other characteristics.
The default display type is Unformatted. (The Formatted Text display type is similar to the Formatted Text view in the View Data window.)
For more information, see “View Data (Unformatted) dialog”.
3. Click OK.
Related topics
Viewing specific unformatted subrecords
View Data (Unformatted) dialog

Pre N
viou

GDE Help > Viewing data > Viewing unformatted data > View Data (Unformatted) dialog

View Data (Unformatted) dialog

How to reach this dialog
Select a dataset component and choose either View Data Unformatted from the pop-up menu or View > Data Unformatted from the GDE menu bar.

Use this dialog to specify how you want to look at records in a file or table component, or at records that have passed through a watcher.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 175 of 221

Screen capture of the View Data dialog

with four sections described in the text
that follows.

To specify the display features you want:

1. In the Records area, enter numbers to specify the range of records you want to view. The default for the first box is 1; reset it as appropriate. Click the
arrow on the right box for choices 1, 10, 100, and End; or enter any number you want.
2. In the Display As list, select one of the following:
Grid Mode — To view records with field names and values presented in tabular form
Formatted Text — To view the records as formatted text with field names and values
Hexadecimal — To view the raw data in hexadecimal format
Unformatted — To view the raw data (default)
3. In the Grid Mode area (available only when Grid Mode is selected), specify whether to display — one record in each row of the grid, or one record in each
column. You can also select the Display strings in quotes checkbox to have string values enclosed in quotation marks
4. In the Expression area (not available when Grid Mode is selected), enter a DML expression to extract certain fields from the data and perform calculations
with them. You can:
Type a DML expression in the Expression box.
For example, type the following to view the full names of the subjects in a file:
string_concat( fname, lname )
Click Edit to open the Expression Editor to locate a field name or to help you create your expression.
Click the Show Expression Only checkbox to display only the expression’s result for each record.
The resulting Dump window displays any matching records.
5. In the Partitions area, if you have multifile partitions and want to view the data for only one partition, select the Partition checkbox and type a number in
the box. Numbers range from 0 to n–1, where n is the total number of partitions. Otherwise, you will view data from All partitions.
6. Click OK.
The Dump window displays the records.
Related topics
Viewing unformatted data
Viewing specific unformatted subrecords

Pre N
viou

GDE Help > Viewing data > Viewing unformatted data > Viewing specific unformatted subrecords

Viewing specific unformatted subrecords

If your data has large records consisting of hundreds of fields, you can view specific subrecords in the Dump window.
To view a specific subrecord:
1. Select a dataset component and choose either View Data Unformatted from the pop-up menu or View > Data Unformatted from the GDE menu bar. This
displays the View Data (Unformatted) dialog.
2. In the Display As list in the View Data window, select Formatted text.
3. Under Expression, select Show Expression Only.
4. Do one of the following:
If you know the name of the subrecord you want to show, enter it in the Expression box.
If you are unsure of the name of the subrecord, click Edit to display the Expression Editor and use it to identify and enter the subrecord name into the
Expression box. This example returns subrecords whose COUNT field value is 3.
Screen capture showing the DML
expression COUNT == 3. The Show
Expression Only checkbox is selected.

5. Click OK. The Dump window displays the records.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 176 of 221

Screen capture showing Record 1’s contents as "Expression values: COUNT == 3 =

1” and Record 2’s contents as “Expression values: COUNT == 3 = 0".

Related topics
Viewing unformatted data
Dump window

Pre N
viou e

GDE Help > Viewing data > Dump window

Dump window
How to reach this window
1. Select a dataset component and choose either View Data Unformatted from the pop-up menu or View > Data Unformatted from the GDE menu bar.
2. Click OK in the View Data (Unformatted) dialog.
The Dump window displays the records you specified.

The Dump window displays unformatted data one of four ways, as described in “View Data (Unformatted) dialog”.

Grid view

In grid view of the Dump window, you can do the following:

Resize a column — Move the cursor over the gray headers until it changes shape , then click and drag to move the column’s edge.
Sort by a column — Double-click a header (double-click again to reverse the sort order).
View the list vertically (portrait) rather than horizontally (landscape) — Click Pivot.
Save the contents of the window as a tab-delimited text file — Click Export.

All views

In all views of the Dump window, you can do the following:

View the latest data — Click Refresh.
Print the contents of the window — Click Print.
Search for strings — Press Ctrl+F.
Save the contents of the window to a text file — Click Save As. (The Save As dialog is restricted to the local computer. The equivalent button for grid
view is Export.)
Related topics
View Data (Unformatted) dialog
View Data window
About viewing data in the GDE

Pre N
viou

GDE Help > Viewing data > View Data toolbar

View Data toolbar

The View Data window has a toolbar containing the following buttons:
Exports the data in the View Data window to a file
Prints the data in the View Data window
Displays the View Data Options dialog
Copies the selection to the clipboard
Displays the View Data Find dialog
Finds the next occurrence of what is specified in the View Data Find dialog
Finds the previous occurrence of what is specified in the View Data Find dialog
Toggles the view between grid view, tree view, and formatted text view
Refreshes the display

Icon for the More Lets you specify how many more records to display
Records text box.
Applies the latest toolbar selections and updates the display with the results

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 177 of 221

Icon Clears the View Data window

Related topics
About viewing data in the GDE
View Data window

Pre N
viou

GDE Help > Parameterizing graphs and plans

Parameterizing graphs and plans

Parameters and their values control the behavior of components, graphs, plans, and sandboxes. Typically, you use the Properties dialog to set the values for
component and plan parameters. You use the Parameters Editor and the Input Values Editor to set the parameter values for graphs and sandboxes. For more
information, see “Parameters overview”.
This section describes how to parameterize graphs and plans using the Parameters Editor and the Input Values Editor. It includes the following topics:
Working with the Parameters Editor
Working with the Input Values Editor
For information on parameterizing plans, see “Using parameters in Conduct>It”.

Pre N
viou

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor

Working with the Parameters Editor

You use the Parameters Editor to view, add, and edit parameters for graphs, their components, their parent private sandboxes, and any included common
sandboxes.
Opening the Parameters Editor
Displaying advanced elements
Viewing parameters
Viewing parameter details
Viewing parameter resolution details
Filtering information
Component parameters in the Parameters Editor
Adding a parameter in the Parameters Editor
Editing parameters
Overriding parameter values
Setting a component’s layout
Editing common parameters for multiple components

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Opening the Parameters Editor

Opening the Parameters Editor

You can open the Parameters Editor from the GDE workspace or from the Sandbox View. The Parameters Editor has basic and advanced elements. You can
optionally choose to show or hide the advanced elements. For more information, see “Displaying advanced elements”.
Regardless of whether advanced elements are displayed in the editor, the information you see and the parameters you can edit depend upon the way the editor
is opened.
When you open the Parameters Editor from the GDE workspace, you can view and edit:
Parameters for the current graph and its components
Parameters for any input value sets used by the graph
Parameters for the private sandbox
Overridable parameters for any common sandboxes that are included
NOTE: You cannot view, edit, or apply any sandbox configuration parameter sets used by the private sandbox. For more information, see “Overriding
parameters for specific phases of the project life cycle”.
When you open the Parameters Editor from the Sandbox View, you can view and edit:
Parameters for the private sandbox
Overridable parameters for any common sandboxes that are included
Configuration parameter sets, which you can create and apply
NOTE: You cannot view and edit any graph, .input.pset, or component parameters.
The following topics describe these two methods in detail:
Opening the Parameters Editor from the GDE workspace
Opening the Parameters Editor from the Sandbox View

Pre N
viou e

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 178 of 221

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Displaying advanced elements

Displaying advanced elements

By default the Parameters Editor opens in a basic view, displaying the Parameters sets tree, the parameter set chain, the Parameters grid, the Description field,
and the Resolved value:
Screen capture of the Parameters Editor displaying basic elements

The following procedures describe how you can display areas that are hidden in the default view:
To display the Project overrides grid:
Do one of the following:
Click the expansion arrow above the Description field.
Drag the split bar above the Description field upwards.
Select the private sandbox or one of the included common sandboxes in the Parameter sets tree, and choose View > Project Overrides from the menu
bar, or press Ctrl+F9.
To display the Attributes grid:
Do one of the following:
Click the expansion arrow to the left of the Resolved value box.
Drag the expansion arrow to the left of the Resolved value box toward the right.
Choose View > Attributes from the menu bar.
Press F9.
To display attribute columns in the Parameters and Project overrides grid:
1. Choose View > Attribute Columns from the menu bar.
2. In the Configure Attribute Columns dialog, select the attributes you want to appear, and click OK.
When all the advanced elements have been selected, the Parameters Editor looks like this:
Screen capture of Parameters Editor with advanced elements displayed - Project overrides, Attributes, and Attribute columns

To resize panes:
Drag the split bars between panes up, down, left and right.
Related topics
Parameters Editor elements
Working with the Parameters Editor

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 179 of 221

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Viewing parameters

Viewing parameters
The Parameters Editor displays the hierarchical Parameters sets tree, the parameter set chain, and the parameters for the selected item in the tree and chain.
The scope of the tree, and the specific information displayed in the right pane of the Parameters Editor, is determined by the way in which the Parameters
Editor was opened. For more information, see “Opening the Parameters Editor”.
The Parameter sets tree contains the following items:
The parent private sandbox folder and associated .sandbox.pset and .project.pset files
NOTE: For Format 2 sandboxes these are named .air.sandbox.overrides and .air. project.overrides.
Any common sandboxes that have been included, and their associated sandbox and project .pset files
The graph, its components, and any input psets — these are visible only if the Parameters Editor was opened from the GDE workspace rather than from
the Sandbox View:
Screen capture showing the Parameters set tree and associated elements

By default, if opened from the Sandbox View, the Parameters Editor opens in the point of view of the private sandbox. If opened from the GDE workspace,
the Parameters Editor opens in the point-of-view of the graph. The Parameters grid on the right side of the window displays the graph level parameters, if any
have been declared.
You can click any of the items in the Parameter sets tree to view and edit their respective parameters in the Parameters and Project overrides grids. You can
add parameters to some, but not all, of the items in the Parameter sets tree. For more information, see “Adding a parameter in the Parameters Editor”.
The following colors are used in the Parameters Editor and on the Parameters tab of the components’ Properties pages to distinguish different kinds of text:
Black — Parameter names and other ordinary text.
This includes text that was entered in place of a parameter default value.
Red — Erroneous text.
NOTE: An erroneous reference to a nonexistent parameter in the Parameters Editor is colored purple, like any other reference. However, if you let the
mouse pointer hover over the reference, the tooltip will tell you that the reference cannot be resolved.
Purple — A reference to a parameter that has yet to be resolved.
This includes references that cannot be resolved (erroneous references).
Tan — A default value that can be overridden.
Related topics
Filtering information
Parameters overview
Parameters Editor
Parameters Editor elements
Working with the Parameters Editor

Pre N
viou

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Viewing parameter details

Viewing parameter details

To get a complete text display of all the information for a particular parameter, simply select the parameter in the Parameters grid, and then choose View >
Parameter Details.
The Parameter Details viewer appears, with a text-only listing of all information about the selected parameter, including:
Name
Value
Resolved value
All attribute values (see “Parameter attributes”)
Related topics
Parameters overview
Working with the Parameters Editor

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 180 of 221

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Viewing parameter resolution details

Viewing parameter resolution details

Parameters are often defined in terms of references to other parameters. Those other parameters may in turn be defined in terms of still other parameters, and
so on. The GDE’s resolution details feature allows you to see these parameter dependencies in an easy-to-understand way. It shows you how the parameter
you have selected gets the value it currently has. You can see resolution details for a parameter in a tooltip or in the Resolution Details dialog.
The following topics are discussed in this section:
Displaying parameter resolution information in a tooltip
Opening the Resolution Details dialog
Using the Resolution Details dialog
Resolution details for transforms and record formats
Related topics
Parameters overview

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Viewing parameter resolution details > Displaying parameter
resolution information in a tooltip

Displaying parameter resolution information in a tooltip

You can display some information about any parameter’s value by letting the mouse pointer hover over the parameter entry in one of the following:
The Parameters grid or the Project overrides grid of the Parameters Editor
The Parameters grid or the Project overrides grid of the Input Values Editor
The grid of the Parameters tab of a component’s Properties dialog
A tooltip appears when you do this, containing the following information:
Name of the parameter
Defined value of the parameter
Resolved value of the parameter
For example:
Screen capture of the parameter resolution display for a graph parameter.

This works with dependent graph parameters too: simply let the mouse pointer hover over the dependent parameter in the editor, and its resolved value will be
displayed in the tooltip.
In the case of parameters that are dependent on AB_PARAMETER_ENV, if you let the mouse pointer hover over the sandbox-dependent version of the
parameter, the tooltip displays the sandbox-dependent value, as resolved in the sandbox context.
If you let the mouse pointer hover over the eme-dependent version of the parameter, the tooltip displays its eme-dependent value as it would be resolved in the
EME technical repository context.

Location of the parameter

The source of the resolved value displayed in the tooltip depends on the parameter’s Location attribute:
If Location is Embedded, the value is taken directly from the Value field of the parameter
If Location is File, the parameter’s Value field is assumed to specify a path to a file whose contents are taken as the parameter’s resolved value
In this case, when you let the mouse pointer hover over the eme-dependent version of such a parameter, the GDE gets the resolved “file contents” from the
current contents of the actual file on disk, not in the EME technical repository. This is because the file may not yet have been checked in, or may have been
modified in the disk copy.
Related topics
Parameters overview
Viewing parameter resolution details

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Viewing parameter resolution details > Opening the Resolution Details
dialog

Opening the Resolution Details dialog

You can open the Resolution Details dialog in any of the following ways:
Choose View > Resolution Details from the Parameters Editor menu bar.
Click the Resolution details button in the Parameters Editor toolbar.
Right-click a parameter name in the Parameters grid or the Project overrides grid of the Parameters Editor, and choose Resolution details from the pop-up

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 181 of 221

menu.
You can leave the Resolution Details dialog open while you are working with the Parameters Editor. This enables you to see the resolution details for each
parameter as you select them in the Parameters Editor.
Parameters overview
Viewing parameter resolution details

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Viewing parameter resolution details > Using the Resolution Details
dialog

Using the Resolution Details dialog

The Resolution Details dialog provides information about the selected parameter in the following sections:
Reference tree pane — Displays the complete tree of other parameter definitions that the currently selected parameter’s definition depends on
“Value comes from” box — Displays the parameter’s value, as defined by the expression here
“Parameter declared in” box — Displays the location where the parameter was declared
“Resolved value” box — Displays the actual value that the parameter’s definition resolves to
Screen capture showing the Resolution Details dialog

Reference tree pane

The Reference tree pane displays a hierarchical tree of the selected parameter and all the other parameter definitions that the current parameter’s definition
depends on. It contains two columns:
The Parameter column shows the name of the parameter
The Value column shows the defined value of the parameter — that is, the unresolved expression for the intended value of the parameter
Screen capture of the reference tree in the resolution details for a graph parameter called TEST_PARAM.

The item at the top of the tree represents the currently selected parameter in the Parameters Editor.
For example, here’s what you might see displayed in the Reference tree pane for a graph parameter called TEST_PARAM, whose value is defined to be
$AI_LOG_FILE (a predefined Ab Initio Environment parameter that depends on many other Ab Initio Environment parameters):
Screen capture of the reference tree in the resolution details for a graph parameter called
TEST_PARAM.

Immediately under TEST_PARAM, you see AI_LOG_FILE. Its indented position indicates that TEST_PARAM’s definition contains a reference to
AI_LOG_FILE.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 182 of 221

AI_LOG_FILE is preceded by a “+” symbol, indicating that AI_LOG_FILE’s definition references and is dependent on other parameters. That means that
TEST_PARAM is also ultimately dependent on them.
If you click the “+” to expand the subtree, you might see something like this:
Screen capture of the reference tree for a parameter TEST_PARM.

The parameters shown under AI_LOG_FILE are also indented, indicating that these parameters are both referenced in AI_LOG_FILE’s immediate definition.
In addition, AI_ADMIN_LOG and AI_LOG_PREFIX are preceded by a “+” symbol, indicating that they contain references to still more parameters. If you
were to expand, you might see something like this:
Screen capture of the reference tree for a parameter
TEST_PARM, with all the other parameters in the tree
expanded.

Now you can see that:

AI_ADMIN_LOG has an immediate dependence on references to AI_ADMIN and AI_TEST_FLAG.
AI_LOG_PREFIX has an immediate dependence on references to AI_GRAPH_NAME and AI_FILE_DATE.
TEST_PARAM itself depends on all the parameters shown below it in the tree.
Screen capture showing the Reference tree for the TEST_PARAM parameter in the Resolution Details dialog

“Value comes from” box

For each parameter selected in the Reference tree pane, the Value comes from box shows where that parameter’s value is defined.
For example, in the following figure the value for the parameter AI_TEST_FLAG is defined in Project_A’s .sandbox.pset file.
Screen capture showing the Value comes from box in Resolution Details dialog,
indicateing where the AI_TEST_FLAG parameter was defined

“Parameter declared in” box

For each parameter selected in the Reference tree pane, the Parameter declared in box shows the location where the parameter was declared.
For example, in the following figure, the value for the parameter AI_TEST_FLAG is declared in the .project.pset file of the Ab Initio Environment’s abenv
directory.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 183 of 221

Screen capture showing the Value comes from box in Resolution Details dialog,
indicateing where the AI_TEST_FLAG parameter was declared

“Resolved value” box

For each parameter selected in the Reference tree pane the Resolved value box shows the actual value that the parameter’s definition resolves to.
For example, in the following figure the resolved value for the parameter AI_TEST_FLAG is asmith.
Screen capture of the Resolutionn Details dialog, showing the Resolved value for the
AI_TEST_FLAG parameter

Related topics
Parameters overview
Viewing parameter resolution details

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Viewing parameter resolution details > Resolution details for
transforms and record formats

Resolution details for transforms and record formats

When using files for transforms and record formats, you set the Interpret option in the Properties dialog or Parameters Editor to apply interpretation of
referenced parameters to the path or to the contents of the specified file. The Resolution Details dialog enables you to examine the details for both the filename
and the file contents, as shown below:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 184 of 221

Screeen capture of the Resolution Details dialog, showing the details for a record
format parameter

Related topics
Parameters overview
Viewing parameter resolution details

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Filtering information

Filtering information
You can restrict the information displayed in the Parameters Editor by specifying display criteria for parameter or component objects.
Filtering is useful when you have a large number of parameters and components in a graph, and you want to restrict the editor's display to only the parameters
or components in which you are interested. By default, the editor displays all parameters.
You can filter the display on the basis of parameter name, value, or type, or by component name or type. You can specify any combination of these criteria.
The criteria you specify affect not only the parameters displayed in the Parameter Editor's main window, but also the components displayed in the editor’s left
pane (the Parameter sets tree).
As soon as you add or modify any criteria, the editor suppresses all parameters or components that do not fulfill the criteria, and displays only the parameters
or components that meet the criteria. When you clear the criteria, the editor reverts to displaying all components and parameters.
To filter the information displayed in the Parameters Editor:
1. Do one of the following:
From the Parameters Editor menu bar, choose Filter > Add/Modify.
Click the Filter button .
This opens the Filter Criteria dialog:
Screen capture showsing the Filter Criteria dialog

2. Select the Match setting from the drop-down list in the dialog.
All — Specifies that all of the following filter criteria must be true of a given parameter or component object for it to be displayed.
Any — Specifies that if any of the specified criteria are true of a given parameter or component object, the object will be displayed in the editor.
In cases where the criteria filter out all the parameters of a component, the component itself is also filtered out of the editor display.
3. In the lower pane, do the following:
a. In the left column, select the criteria type from the drop-down list.
b. In the right column, enter a value or select a value from the drop-down lis.t
4. If you want to filter on an additional criteria click the Add button .
5. When you have finished defining the filter criteria, click OK.
The information now displayed in the Parameters Editor is restricted to the criteria that you selected.
To stop filtering information displayed in the Parameters Editor:
1. Do one of the following:
From the Parameters Editor menu bar, choose Filter > Clear.
Click the Clear Filter button .
The Parameters Editor now displays all the parameter information.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 185 of 221

Component parameters in the Parameters Editor

The Parameters Editor can serve the same purpose as the individual components’ Properties dialogs. It gives you a comprehensive view of all the parameters
in a graph (and its subgraphs), as well as its project and common projects, at once, rather than forcing you to go back and forth among the separate
components. Simply click the desired component in the Parameter sets tree, and you will see the component’s parameters displayed in the Parameters grid.
For example:
Screen capture of the parameter editor, showing how an individual component’s parameters can be viewed.

The easiest way to edit the values is to click the Edit button in the row of the parameter you want to edit, and enter the value in the dialog box that
appears. Alternatively, for many of the parameters, you can add or change values directly in the parameter’s Value field.
You can view component parameters’ attribute values in the Parameters Editor. You can also edit component parameter attributes that are editable (such as
Interpretation, or Export to Environment). For more information, see “Displaying advanced elements”.
Every graph component value is represented in the Parameters Editor, regardless of whether it is called a “parameter” in a component. Anything that you can
do in a component’s Properties dialog — set parameters, edit DML, edit transforms, and so on — you can also do in the Parameters Editor.

Graph component values visible in the Parameters Editor

The editor shows all the specified values for a graph — including some values that do not appear as parameters in the individual components. These include
settings such as the following:
protection — File permission settings that appear on the Access tab of a dataset component’s Properties dialog. In the editor it appears as a protection
parameter. Its value is a permissions string.
condition — Settings that appear on the Condition tab of a component’s Properties dialog. In the Parameters Editor these settings appear as values of
condition parameters and other parameters whose names begin with condition.
config_file — For certain database components (such as Input Table and Output Table), you must set up a database configuration file, which specifies how
to connect to the database you want to use. In a component Properties dialog, this file is specified on the Description tab; in the Parameters Editor, it
appears as the value for a config_file parameter.
table_spec — The source table for an Input Table component is specified on the Description tab of its Properties dialog. In the Parameters Editor it appears
as the value for a parameter called table_spec.
Layout — The Input File and Output File components specify their file locations on the Description tab of their Properties dialog. In the Parameters Editor
these locations appear as values for a Layout parameter.
Port metadata — Record formats for components are specified on a separate Ports tab in the Properties dialog. In the Parameters Editor record formats
appear as values for portname_metadata parameters.
Related topics
Parameters overview
Working with the Parameters Editor

Pre N
viou

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Adding a parameter in the Parameters Editor

Adding a parameter in the Parameters Editor

You can add parameters to the following items in the Parameter sets tree:
The .project.pset file for the private sandbox
If your administrator has given you write permissions, the .project.pset file for included common sandboxes
The graph
NOTE: You cannot add parameters to .sandbox.pset files, .input.pset files, or graph components.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 186 of 221

To add a parameter in the Parameters Editor:

1. Select a graph or sandbox item in the Parameter sets tree.
2. Click in the Parameters or Project overrides grid below the row where you would like the new parameter to appear.
3. Do one of the following:
From the editor’s menu bar, choose Edit > Insert.
On the editor’s toolbar, click the Insert parameter button.
A new row appears with the parameter name newparam_nnn in the Name column:
For a sandbox, the row contains a default local parameter indicated by the icon.
For a graph, the row contains by default an input parameter indicated by the icon.
4. Replace the newparam_nnn string with the name you want for the parameter.
5. Define the new parameter’s Value and attributes as you want.

Related topics
Parameters overview
Component parameters in the Parameters Editor
Graph component values visible in the Parameters Editor
Editing parameters
Viewing parameter details

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Editing parameters

Editing parameters
Each row in the Parameters grid represents a single parameter. Each row has the following columns:
Status:
— A to-do cue indicates that there is something required but missing in the parameter’s definition.
— A spinning wheel indicates that a process is ongoing to resolve the value of the parameter.
Name — Displays the name of each parameter.
Value — Displays the defined value of each parameter, if any.
— Opens an appropriate dialog or editor, where you can specify or edit the parameter’s value.
Attribute columns that you choose to display in the grid.
To add attribute columns, choose View > Attribute Columns from the menu bar, select the attributes you want to display and click OK. These columns are a
subset of the attributes that you can view and edit in the Attributes grid, where you can see all the attributes for the selected parameter. For more information,
see “Attributes grid (Advanced)”.
In addition, you can view all the attributes in the Attributes grid below the Parameters grid. For more information, see “Displaying advanced elements”.
You click in a cell to edit it. To select an entire row, click in the box to the left of the row.
Related topics
Parameters overview
Working with the Parameters Editor

Pre N
viou

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Overriding parameter values

Overriding parameter values

The .project.pset file for a project declares its parameters, providing the parameter interface through which the sandbox customizes the values provided by
the .project.pset file. Graphs may further control some of these values at runtime. When you work with a sandbox, you will typically find it necessary to
override some of the default values in the .project.pset file. When you provide a nondefault value for a parameter, it is called “overriding a parameter.” For
more information, see “Overrides”.
Information about overriding parameter values in a variety of circumstances is described in the following sections:
Overriding local sandbox parameters
Overriding included project parameters
Overriding parameters for specific phases of the project life cycle
Overrides using input values at runtime
Related topics
Parameters
Overriding common sandbox parameters

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Overriding parameter values > Overriding local sandbox parameters

Overriding local sandbox parameters

You can directly override the values of parameters marked overridable in the local sandbox. For example, you might want to override the database username
and password.
To override a local sandbox parameter:
1. In the Parameters Editor, select the project represented in the left pane of the Parameter Sets tree.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 187 of 221

2. Select the .sandbox.pset file in the Parameters Sets tree or in the parameter set chain at the top of the right pane of the editor.
NOTE: For Format 2 sandboxes, select .air-sandbox-overrides.
3. In the Parameters grid, select the parameter you want to override, and make the change you want.
4. From the Parameters Editor menu bar, choose File > Save.
Related topics
Overriding included project parameters
Overriding parameters for specific phases of the project life cycle
Overrides using input values at runtime
Overriding parameter values
Overriding common sandbox parameters
Overrides

Pre N
viou

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Overriding parameter values > Overriding included project parameters

Overriding included project parameters

In addition to overriding values in your local sandbox, you can override overridable input parameter values supplied by any included project. For example,
you might want to override the AI_TEST_FLAG and AI_REL_LOC parameters in the included ABENV project.
CAUTION! When overriding the parameters of an included common project, open the Parameters Editor from the Sandbox View. If you open the
Parameters Editor from the GDE workspace and override parameters, you could inadvertently destroy the relationship between the sandbox and the common
project, resulting in graphs and plans being unable to be executed.
To override an included project parameter:
1. In the Parameters Editor, select the project, represented in the left pane at the top of the Parameter Sets tree.
2. Select the .sandbox.pset file or the .project.pset file in the Parameter Sets tree or in the parameter set chain at the top of the right pane of the editor.
NOTE: For Format 2 sandboxes, select .air-sandbox-overrides or .air-project-parameters.
3. Do one of the following:
Choose Edit > Create project override from the Parameters Editor menu bar.
Click in the Project overrides grid, and then click the Insert button on the Parameters Editor toolbar.
This opens the Create Project Override dialog:
Screen capture of the Create Project Override dialog

4. From the Parameter to override list, select the parameter you want to override.
5. Select the project that contains the named parameter you want to override, either by selecting First Match or by choosing a project from the Choose project
drop-down list. For more information, see “Project to override”.
6. Click OK. The override parameter you created is displayed in a new row in the Project overrides grid of the Parameters Editor.
7. In the Project overrides grid, type the new override value in the parameter’s Value cell, and press Enter.
8. From the Parameters Editor menu bar, choose File > Save.
For more information, see “Overriding common sandbox parameters”.
Related topics
Overriding non-dependent parameters in Format 3 sandboxes
Overriding dependent parameters in Format 3 sandboxes
Overriding non-dependent parameters in Format 2 sandboxes
Overriding dependent parameters in Format 2 sandboxes
Overriding local sandbox parameters
Overriding parameters for specific phases of the project life cycle
Overrides using input values at runtime
Overriding parameter values
Overrides

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Overriding parameter values > Overriding parameters for specific
phases of the project life cycle

Overriding parameters for specific phases of the project life cycle

As your project goes through the phases of its life cycle, you may find it helpful to create configuration parameter sets that provide customized values for each
phase of the life cycle, overriding the values for parameters declared in the .project.pset file, and serving as the base for the .sandbox.pset file. These
customized parameter sets can be checked in to the EME technical repository for future use by others working on this project, ensuring the application of
consistent environment settings throughout your organization. For more information, see “Configuration psets”.
NOTE: Configuration parameter sets can be used with Format 3 sandboxes only.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 188 of 221

To use configuration parameter sets, you must complete the following tasks:
Creating a configuration parameter set
Defining override values in a configuration parameter set
Applying a configuration parameter set
Related topics
Overriding local sandbox parameters
Overriding included project parameters
Overrides using input values at runtime
Overriding common sandbox parameters
Overriding parameter values
Overrides

Pre N
viou

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Overriding parameter values > Overriding parameters for specific
phases of the project life cycle > Creating a configuration parameter set

Creating a configuration parameter set

You create configuration parameter sets based on the parameters declared in the .project.pset file. Initially the configuration parameter set contains a single
line referencing the .project.pset file. You will later define override values for specified parameters.
To create a configuration parameter set:
1. Open the sandbox. If the sandbox is attached to an EME technical repository, check it out to ensure that you have the most up-to-date version.
2. In the Sandbox View, right-click and choose Edit Parameters from the pop-up menu to open the Parameters Editor.
CAUTION! Open the Parameters Editor from the Sandbox View. If you choose Edit > Parameters from the GDE menu bar to open the Parameters Editor
for a graph and create a configuration parameter set to override the parameters of an included common project, you could inadvertently break the
dependencies of the graph being edited.
3. In the Parameter sets tree, select the .project.pset file.
NOTE: It is not necessary to lock the project.
4. Choose Project > Create configuration with Base ‘.project.pset’.
5. In the Save As dialog, provide a descriptive name for the configuration parameter set with a .pset extension; for example, dev_env.pset, test_env.pset, or
prod_env.pset.
NOTE: The file will be saved to the project directory. The dialog does not allow you to save the .pset file to an alternative location.
6. Click Save.
A message tells you that the configuration parameter set file has been saved.
7. Click OK.
The configuration.pset file appears at the bottom of the tree in the Sandbox View. Typically, you will create two or more configuration.pset files to define the
parameter values for specific phases of your development cycle.
Next, you will define the values in the configuration.pset files to override its default parameter values.
Related topics
Defining override values in a configuration parameter set
Applying a configuration parameter set
Editing a configuration parameter set
Overriding parameter values
Overriding common sandbox parameters
Overrides

Pre N
viou

Defining override values in a configuration parameter set

After you create an empty configuration parameter set, you are ready to define the override values for specified parameters.
Repeat the following steps for each configuration parameter set you have created.
To define override values in a configuration parameter set:
1. In the Parameter sets tree of the Parameters Editor or in the parameter set chain, select the .sandbox.pset item.
2. Choose Project > Change Base Configuration.
3. In the resulting Open dialog, select the name of the configuration.pset file you want to define, and click Open.
The configuration.pset file you opened appears between the .sandbox.pset item and the .project.pset item, both in the Parameter sets tree and in the parameter
sets chain in the Parameters Editor.
4. Select the configuration.pset item.
5. In the Parameters grid, define new values for the listed project parameters.
6. Define override values for included common projects:
a. Choose Edit > Create Project Override.
b. From the Parameter to override list, select the parameter you want to override.
c. Select the project that contains the named parameter you want to override, either by selecting First Match or by choosing a project from the Choose
project drop-down list. For more information, see “Project to override”.
d. Click OK. The override parameter you created is displayed in a new row in the Project overrides grid of the Parameters Editor.
e. In the Project overrides grid, type the new override value in the parameter’s Value cell, and press Enter.
For more information, see “Overriding common sandbox parameters”.
7. Choose File > Save.
8. Check the sandbox, together with the configuration parameter sets, in to the EME technical repository.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 189 of 221

The configuration.pset files are now complete and ready to be applied to the sandbox.
Related topics
Creating a configuration parameter set
Applying a configuration parameter set
Editing a configuration parameter set
Overriding parameter values
Overriding common sandbox parameters
Overrides

Pre N
viou

Applying a configuration parameter set

You can use configuration parameter sets to easily supply override values for development, test, and production phases of the project life cycle. You can apply
either the .project.pset file or a configuration parameter set as the base for further overrides in the .sandbox.pset file, either when you check the sandbox out of
the EME technical repository, or after the sandbox is open.

Applying through the Checkout Wizard

To apply a configuration parameter through the Checkout Wizard:

1. Open the sandbox and check it out of the EME technical repository.
2. On the Sandbox Configuration page of the Checkout Wizard, select the configuration.pset file you want, click Next, and complete the checkout operation.
3. In the Sandbox View, right-click the sandbox project object at the top of the tree, and choose Edit Parameters from the pop-up menu.
The Parameters Editor opens. The selected configuration.pset item appears between the .sandbox.pset item and the .project.pset item, both in the Parameter
sets tree and in the parameter sets chain.
4. Close the Parameters Editor.
5. Run the graph. It uses the parameter values defined in the current configuration.pset file.

Applying through the Parameters Editor

To apply a configuration parameter through the Parameters Editor:

1. Check the sandbox out of the EME technical repository.
2. In the Sandbox View, right-click the sandbox.pset file and choose Edit from the pop-up menu.
3. In the Parameters Editor, choose Project > Change Base Configuration.
4. In the resulting Open dialog, select the configuration.pset file you want to apply, and click Open.
The selected configuration.pset item appears between the .sandbox.pset item and the .project.pset item, both in the Parameter sets tree and in the parameter
sets chain.
5. Choose File > Save and close the Parameters Editor.
6. Run the graph. It uses the parameter values defined in the current configuration.pset file.
Related topics
Creating a configuration parameter set
Defining override values in a configuration parameter set
Editing a configuration parameter set
Overriding parameter values
Overriding common sandbox parameters
Overrides

Pre N
viou

Editing a configuration parameter set

You can edit the override values of an existing, applied configuration parameter set.
To edit an existing configuration parameter set:
1. Open the sandbox. If the sandbox is attached to an EME technical repository, check it out to ensure that you have the most up-to-date version.
2. In the Sandbox View, right-click the project folder and choose Edit Parameters from the pop-up menu to open the Parameters Editor.
CAUTION! Note the following:
If you edit a configuration parameter set directly from the Sandbox View of the GDE, the override values you define will not be set in the context of
the .sandbox.pset file to which they are applied.
If you choose Edit > Parameters from the GDE menu bar to open the Parameters Editor for a graph and create a configuration parameter set to override
the parameters of an included common project, you could inadvertently break the dependencies of the graph being edited.
3. In the Parameter sets tree in the Parameters Editor, select the configuration.pset item you want to edit.
4. In the Parameters and Project overrides grids, make the changes you want.
5. In the menu bar, choose File > Save.
6. Check the sandbox in to the EME technical repository.
Related topics
Creating a configuration parameter set
Defining override values in a configuration parameter set
Applying a configuration parameter set

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 190 of 221

Overriding parameter values

Overriding common sandbox parameters
Overrides

Pre N
viou

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Overriding parameter values > Overrides using input values at runtime

Overrides using input values at runtime

You can create input value parameter sets to override both project and graph input parameters at runtime. You might want to do this for reasons such as the
following:
At the graph level, depending on circumstances, you might want to be able to select a specific input file at runtime, such as by a run date or by machine-
specific values.
At the project level, when doing performance testing, you might want to override the value of AI_MFS_DEPTH to easily compare a two-way with an
eight-way multifile system.
For an input value to override a project parameter, the parameter must carry the attributes of Input and Overridable. A graph parameter must carry the Input
attribute.
For more information, see “Overview of the Input Values Editor”.
Related topics
Overriding local sandbox parameters
Overriding included project parameters
Overriding parameters for specific phases of the project life cycle
Overriding parameter values
Overriding common sandbox parameters
Overrides

Pre N
viou

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Setting a component's layout

Setting a component’s layout

The Parameters Editor enables you to specify a component’s layout by specifying that its Layout parameter’s value should be taken from the Layout parameter
value of some other component.
This functionality in the Parameters Editor duplicates the following functionality on the separate tab of the Properties dialog:
The Layout tab functionality in components that allows you to select Component for Layout source, and (when you choose this option) lets you select,
from a list, the component whose layout you want to use for the current component.
For example, to set the Data Location URL for one dataset in a graph to be the same as the data location for another dataset in the same graph, you would do
the following in the Parameters Editor:
1. Select the row of the parameter you want to change.
2. From the Parameters Editor menu bar, choose Edit > Set SameAs.
The Select a parameter dialog appears, displaying an expandable tree of all the components in the current graph.
Expanding a component’s subtree reveals its Layout parameter. (Components without a Layout parameter are shown in color, and unexpandable.)
3. Select (by clicking on) the Layout of the component you want the parameter you selected in Step 1 to be the same as.
4. Click OK.

Pre N
viou

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Setting a port's record format

Setting a port’s record format

The Parameters Editor enables you to specify a port’s record format by specifying that its new record format value should be taken from the record format
value of some other port in the graph.
This functionality in the Parameters Editor duplicates the following functionality on the separate tabs of the Properties dialog:
The Ports tab functionality in components that allows you to select Use another port in graph for a given port’s record format, and (when you choose this
option) displays a list of the components and ports in the current graph, from which you can choose the port whose record format you want to use for the
currently selected port.
For example, to set the record format for the port on one component to be the same as the record format for the port on another component, you would do the
following in the Parameters Editor:
1. In the Parameter sets tree of the Parameters Editor, select a component.
2. In the Parameters grid, select the read_metadata or write_metadata parameter.
3. From the Parameters Editor menu bar, choose Edit > Set SameAs.
The Select a Parameter dialog appears, displaying an expandable tree of all the components in the current graph.
4. Select the record format you want the parameter you selected in Step 1 above to be the same as.
5. Click OK.

Pre N
viou

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 191 of 221

GDE Help > Parameterizing graphs and plans > Working with the Parameters Editor > Editing common parameters for multiple components

Editing common parameters for multiple components

When components in a graph share common parameters, you can edit those parameters simultaneously.
To edit a common parameter for multiple components:
1. In the graph, select the components that share parameters.
2. Right-click one of them and choose Parameters from the pop-up menu.
A list of parameters common to those components appears in the cascading menu.
3. Select the one you want to edit.
The appropriate editor or dialog opens.
4. Make your change and click OK.
The change applies to all the selected components containing this parameter.
Related topics
Working with the Parameters Editor

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Input Values Editor

Working with the Input Values Editor

This section contains the following topics:
Overview of the Input Values Editor
Opening the Input Values Editor
Features of the Input Values Editor
What the Input Values Editor shows
Entering values in the Input Values Editor
Running graphs from the Input Values Editor
Viewing resolution details for input parameters
Exiting the Input Values Editor
Input values and required values
Saving input values in a file
Loading saved input values files
Removing orphaned input values
Input values context
Related topics
Parameters overview

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Input Values Editor > Overview of the Input Values Editor

Overview of the Input Values Editor

Input parameters require that values be given to them from “outside” the object in which they’re declared. An input parameter that you declare in a graph can
receive a value when the graph is run. If the parameter is marked Required, it must have a value. If a value is not supplied, the GDE won’t execute the graph.
The editor displays a yellow cue next to a required parameter that has no value. In the GDE, you give values to input parameters through the Input Values
Editor.
When you run the graph in the GDE, the editor is automatically invoked. All of the graph’s input parameters are displayed, and you must give them values or
accept the default values, if they exist.
If an input parameter is not required, the editor will still appear when you run the graph, but you can close the editor without giving a value to the parameter,
and the GDE will go on to execute the graph.
The Input Values Editor lets you do the following:
Give sets of values to the current graph’s input parameters, when you run the graph
Save sets of input values in files so that you can reload them for use by the graph later
Run the graph that uses the current input parameter set
See the resolution details for the currently selected parameter
You can also edit certain attributes on an input value:
Location — The default for this attribute is Embedded, which means that the input value is found directly in the input entry’s Value column. If this
attribute is File, the entry’s value column gives the pathname of a file that contains the parameter’s value.
Interpretation — Allows you to specify how the expression in the input entry’s Value column is to be interpreted (analogous to the Interpretation attribute
of a parameter itself).
Overridable — Allows you to specify whether the input value can be overridden by an input value in another input values set.
The editor is an interface to a graph’s input parameter values only. To edit the input parameters’ attributes, add new input parameters, or delete existing
parameters, you must use the Parameters Editor. For more information, see “Working with the Parameters Editor”.
Related topics
Parameters overview
Working with the Input Values Editor

Pre N
viou e

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 192 of 221

GDE Help > Parameterizing graphs and plans > Working with the Input Values Editor > Opening the Input Values Editor

Opening the Input Values Editor

When you run a graph that requires input parameters, the Input Values Editor opens automatically. When you are developing a graph, you can open the Input
Values Editor manually to create .pset files that can be supplied to the graph at runtime.
The method you use to manually open the Input Values Editor depends on whether you want to display the current input values parameter set or display a
specific input values parameter set.
To open the Input Values Editor to display the current input values parameter set:
Do one of the following:
From the GDE menu bar, choose Run > Input Values.
In the GDE status bar, left-click Input Values and choose Edit Input Values from the pop-up menu.
Press Shift+F11.
To open the Input Values Editor to display a specific input values parameter set:
1. Right-click one of the .pset files in the mp directory of the sandbox.
2. Select Edit or press Enter.
3. When prompted, click Yes or No to specify whether this input values set should be used as the current input values set.
Related topics
Working with the Input Values Editor
Features of the Input Values Editor

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Input Values Editor > Features of the Input Values Editor

Features of the Input Values Editor

The features of the Input Values Editor are similar to those of the Parameters Editor. The graph’s input parameters are displayed in the Parameters grid — one
parameter per row. Parameters providing input override values for included common projects are displayed in the Project overrides grid. Each parameter’s
name and (optionally) its attributes are shown:
Screen capture of the main display of the input values editor.

Unlike the Parameters Editor, the Input Values Editor allows you to edit only values (and a few attributes) — it’s a value editor, not a parameters editor.
In each parameter entry’s Value field, you enter the value you want the parameter to have in this input values set. When this set is used as the graph’s input
values context, the graph’s input parameters will receive the values specified here.
If you entered a value for the parameter when you declared it in the Parameters Editor, that value is shown as the default in the Input Values Editor. You can
either leave the value as is, or type a new one over it.
Related topics
Parameters overview
Working with the Input Values Editor

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Input Values Editor > What the Input Values Editor shows

What the Input Values Editor shows

The Input Values Editor always shows the input parameter values in effect for the graph you are currently editing. This set of values is called the graph’s input
values context. You can change these values by typing new ones in the editor.
The new values you enter become the graph’s new context as soon as you click OK or choose File > Save or File > Save As and save the values.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 193 of 221

Changing input values and saving them

You can save one or more sets of input values for a graph. By default, when you initially create a set of input values, the GDE saves them in an .input.pset.
1. You do one of the following:
Execute a graph with input parameters, thus automatically invoking the Input Values Editor with the graph’s current input values context.
Invoke the Input Values Editor directly with the current context by choosing Run > Input Values.
The Input Values Editor opens, displaying the current context values.
2. Make changes to the input parameters’ values, and then choose File > Save As.
3. From the Save As dialog, you navigate to the location where you want to save the values, enter a name for the file, and click Save.
You can create as many input values files as you like.

Changing values in input values files

Once a set of input values has been saved in a file, you can reload the values for use by a graph by choosing File > Open in the Input Values Editor, or by
choosing Run > Select Input Values from the GDE menu bar.
If you make changes to the input values you have loaded from a file, the changes are preserved in the GDE’s in-memory context, but the file is not changed
unless you explicitly change it by choosing File > Save (or File > Save As) from the editor menu. The GDE’s Input Values box in the status bar continues to
display the name of the file.
Related topics
Parameters overview
Working with the Input Values Editor

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Input Values Editor > Entering values in the Input Values Editor

Entering values in the Input Values Editor

When you run a graph that requires input parameters, the Input Values Editor opens automatically. All of the graph’s input parameters are displayed, and you
must give them values or accept the default values if they exist.
To enter a value for an input parameter:
Type a value in its Value column, or click its Edit button ( ) to open a dialog in which you can supply a value or edit an existing value.
Related topics
Parameters overview
Working with the Input Values Editor

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Input Values Editor > Running graphs from the Input Values Editor

Running graphs from the Input Values Editor

If you have opened an input value set directly from the Sandbox View, you can run its containing graph directly from the Input Values Editor without having
to first open the graph.
To run a graph directly from the Input Values Editor:
Choose File > Run or click the Run toolbar button .

Pre N
viou

GDE Help > Parameterizing graphs and plans > Working with the Input Values Editor > Viewing resolution details for input parameters

Viewing resolution details for input parameters

You can view the resolution details for an input parameter selected in either the Parameters grid or the Project overrides grid in the Input Values Editor. The
resolution details include the parameter set where the parameter is declared and the parameter set from which its value comes.
To view resolution details:
1. Select a parameter in either the Parameters grid or the Project overrides grid.
2. Choose View > Resolution Details.

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Input Values Editor > Saving input values in a file

Saving input values in a file

To save a set of input values to a file:
1. In the Input Values Editor, choose File > Save As.
The Save As dialog appears.
2. Navigate to the location within the current project where you want to save the input values, and type the file name you want in the File name box.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 194 of 221

NOTE: Remember that input values sets with the name graph-name.input.pset are ignored by default when a project is checked in to an EME technical
repository. Name your input values set something like graph-name.pset.
3. Click Save to save the values.
The GDE saves the file with a .pset extension.
When you save a set of input values in a file, that set of values becomes the context for the current graph.
Related topics
Parameters overview
Working with the Input Values Editor

Pre N
viou

GDE Help > Parameterizing graphs and plans > Working with the Input Values Editor > Loading saved input values files

Loading saved input values files

You can associate saved input parameter sets with a graph that includes parameters that match those defined in the input value set.
To load a set of saved input values, making them the context for the current graph:
1. Choose Run > Select Input Values from the GDE menu bar.
The Open dialog appears.
2. Navigate to the location of the input values file you want to load, select it, and click Open.
The GDE loads the file and establishes the values it contains as the current graph’s context context. The file’s name is displayed in the status bar in the GDE’s
Input Values box in the lower-right corner of the GDE.
NOTE: If you attempt to load an input values file that was created for a graph other than the one currently being edited, the GDE will not load the file:
Screen capture of the GDE dialog displayed when you try to load the wrong input values file.

The GDE always checks to make sure that the input values you are attempting to set as the context match the graph you are trying to apply them to. If the
input values and the graph don’t belong together, the GDE will not load the values.
Alternatively, to load new input value files directly into the Input Values Editor:
1. Choose Run > Input Values from the GDE menu bar.
The Input Values Editor opens, with values loaded according to the current context (which is shown in the status bar in the GDE’s Input Values box in the
status bar at the lower-right corner of the GDE).
2. Choose File > Open from the editor menu.
The Open dialog appears. You can now navigate to the input values .pset file you want to load, select its name in the dialog, and click Open to load the file.
You can use this method to load a different input values file when you are executing a graph (and the Input Values Editor has been invoked automatically by
the GDE).
Related topics
Parameters overview
Working with the Input Values Editor

Pre N
viou

GDE Help > Parameterizing graphs and plans > Working with the Input Values Editor > Removing orphaned input values

Removing orphaned input values

If you create one or more input values files for a graph with input parameters and then, in the Parameters Editor, delete one or more of those parameters from
the graph, the entries for those parameters in the existing files will be “orphaned” — there will no longer be parameters in the graph corresponding to the
parameter entries in the input values files.
In the Input Values Editor, orphaned entries are marked with a yellow cue. If you let the mouse pointer hover over an orphaned entry, the resolution tooltip
tells you that the parameter reference cannot be resolved.
To remove an orphaned entry in an input value set:
1. Select the entry in the Input Values Editor.
2. Choose Edit > Delete Parameter from the menu bar.
Related topics
Parameters overview
Working with the Input Values Editor

Pre N
viou e

GDE Help > Parameterizing graphs and plans > Working with the Input Values Editor > Exiting the Input Values Editor

Exiting the Input Values Editor

When you have finished entering input parameter values, you can do any of the following:
Click OK to run the graph with the values shown in the editor.
If the input values displayed in the editor were loaded from a file, clicking OK will cause any changes you made in the editor to be saved to the file.
This also establishes the set of values in the editor as the current context of the graph. The set of input values you chose for running the graph will remain in
effect after the graph is run.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 195 of 221

This feature is important when you want to do things such as view data in datasets whose URLs are specified by the values of input parameters in the graph.
In the Input Values Editor do one of the following:
Click Cancel to exit the editor (and discard any changes you made) without running the graph.
Click the exit button in the top right corner of the editor window to exit the editor (and discard any changes you made) without running the graph.
Choose File > Close to exit the editor (and discard any changes you made) without running the graph.
Related topics
Parameters overview
Working with the Input Values Editor

Pre N
viou

GDE Help > Parameterizing graphs and plans > Working with the Input Values Editor > Input values and required values

Input values and required values

If a graph has an input parameter, the Input Values Editor is invoked automatically when the graph is run in the GDE. This will happen even if the parameter
is already defined with a default value, and regardless of whether the parameter is required or not. You can accept the default value (if there is one) by simply
clicking OK and leaving the editor without making any changes, or you can type in a different value.
If the input parameter is required (in other words, if the parameter’s Required attribute is selected), it must have a value in order for the graph to run. The
editor will indicate this by displaying a yellow cue next to the parameter.
Related topics
Parameters overview
Working with the Input Values Editor

Pre N
viou

GDE Help > Parameterizing graphs and plans > Working with the Input Values Editor > Input values context

Input values context

When you select a set of input values for running a graph by clicking OK in the Input Values Editor, two things happen with the specified values:
They are used for running the graph.
They continue to be effective after the graph is run, until you specify other values.
Preserving their effectiveness is important when you want to do things (such as viewing data) that may depend on input parameters having values, even
though the graph is not running.

Selecting a new context

You can establish a context of input values by choosing Run > Select Input Values from the GDE menu bar. The Open dialog appears, and you can browse to
and select an input values file to be used as the effective context.
Note that this only sets the context; it does not open the input values set for editing. To do this, choose Run > Input Values from the GDE menu bar.

Identifying the input values context

The current input values context is identified by the GDE in its Input Values box, on the right side of the status bar at the bottom of the GDE window:
Screen capture of the GDE status bar, showing the Input Values box.

If a set of values was read in from an input values .pset file, the name of that file is shown in the box. If no values have yet been saved, the GDE displays
[none].

Identifying the sandbox

The active sandbox (the sandbox the current graph is in) is identified in the Sandbox box, to the left of the Input Values box in the status bar at the bottom of
the GDE window:
Screen capture of the status bar showing the active sandbox for the current graph

NOTE: The active sandbox containing the current graph can be different from the sandbox selected in the Sandbox View.
When you create a new graph, you can use the Sandbox box in the status bar to associate it with any currently open sandbox.
Screen
Simply click the caret at the right of the Sandbox box — . A list of the currently open sandboxes and their associated host connections is
displayed:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 196 of 221

Screen capture of the open sandbox list

NOTE: The ability to change the sandbox is indicated by a caret to the right of the sandbox name. If the caret is not present, it indicates that the graph is
already associated with a sandbox.
Clicking any of the listed sandboxes associates the new graph with it. For example, if you were to choose Project_A above, and then File > Save As from the
GDE menu bar, you would see that the GDE was set up to save the new graph to the mp subdirectory of the Project_A sandbox.
Clicking [No Sandbox] leaves undefined where the GDE will save the graph. When you save the graph, it is up to you to navigate (in the Save As dialog) to
the location you want.

Clearing the current input values context

To clear the currently established context and restore the input values to their defaults, do one of the following:
Choose Run > Reset Input Values from the GDE menu bar.
Right-click the Input Values box and choose the Reset Input Values from the pop-up menu.
This changes that status of the Input Values box to [none]. If a .pset file is selected, the GDE disassociates it from the current graph or plan and uses the input
values specified in the Input Values Editor. If temporary input values (.input.pset specified in the Input Values box) are being used, the GDE returns them to
their default values.
Related topics
Parameters overview
Working with the Input Values Editor

Pre N
viou e

GDE Help > GDE administration tasks

GDE administration tasks

There are certain aspects of your GDE environment that you may want change after getting started with the GDE. The following topics describe these
administrative tasks:
Getting a software activation key
Getting key status
Configuring the host connection
Managing host connections
Specifying language settings

Pre N
viou e

GDE Help > GDE administration tasks > Getting a software activation key

Getting a software activation key

You need a software activation key to use the GDE.

About software activation keys

The GDE supports two types of software activation keys: user keys and computer keys. Whereas computer keys enable an Ab Initio product on a specific
computer, user keys enable specific users to run the GDE or other Ab Initio product on any computer.
The GDE uses the Application Hub to obtain user keys from an Ab Initio key server. Before you can obtain and install a user key, your administrator must
have configured the Application Hub for the key server as described in the Key Server Installation and Administration Guide.
NOTE: When using user keys, if you choose to work simultaneously with two instances of the GDE that are displayed on different Windows desktops, you
must minimize one of them to have it relinquish its key. In general, the key server supports only one fully enabled instance of the GDE at a time.

Requesting and installing a key

If the GDE status bar displays an icon indicating that you do not have a valid key , the Key Wizard opens and takes you through the steps to do one of the
following:
Request a key
Install a key that has been sent to you
Alternatively, you can request and install a key as described below.

Requesting a key

To request a key:
1. From the GDE menu bar, choose File > Key Management > Request Key.
2. In the Request Key dialog, supply all the requested information.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 197 of 221

3. Click Copy to Clipboard.

The dialog closes and the information entered in it is stored on the clipboard.
4. Open your email program and paste the clipboard contents into a mail message.
5. Mail the message and information to the designated Ab Initio key contact within your company.
Your administrator should send you a key file.

Installing a key

To install a key:
1. From the GDE menu bar, choose File > Key Management > Install Key File.
2. In the Install Key File dialog, browse to the key file supplied by Ab Initio and click OK.
The GDE status bar displays a green checkmark icon indicating that your key is valid.
Related topics
Starting the GDE
Getting key status

Pre N
viou

GDE Help > GDE administration tasks > Getting key status

Getting key status

If you or your administrator suspects that there is an issue with your software activation keys, you may want to check the status of both your keys and your
key servers.
To check the status of your keys and key servers:
1. From the GDE menu bar, choose File > Key Management > Key Status.
2. (Optional) To see if there are keys available that aren’t listed in the Key information list, click Refresh Keys.
For more information, contact your administrator.
Related topics
Getting a software activation key

Pre N
viou e

GDE Help > GDE administration tasks > Configuring the host connection

Configuring the host connection

Before using the GDE to run a graph or plan, you must establish a connection between your GDE and the installation of the Ab Initio server software that
starts and controls the execution of your graph. The computer that hosts this installation is called the run host. Typically, the GDE is on one computer and the
run host is a different computer. But even if the GDE is local to the run host, you must still establish the connection.
Illustration showing the role of the run host and Application Hub in establishing connections.

To establish the connection, you use the Host Connection Settings dialog to specify the information the GDE needs to connect to the Application Hub on the
run host. The Application Hub is software that centralizes connections between client applications like the GDE, one or more Co>Operating System
installations, and one or more EME Technical Repository servers (see “About the Application Hub”).

Before you begin

In preparation for configuring the connection between the GDE and the Co>Operating System you will use, collect the following information from your Ab
Initio administrator:
The machine name and operating system of the run host where the Co>Operating System is installed
The path to the Co>Operating System on the run host
The connection method to use (for example, DCOM for Windows or rexec for Linux)

Making the connection

To make a connection:
1. From the GDE menu bar, choose Settings > Manage Connections. The Connections dialog opens.
2. Click Edit to open the Host Connection Settings dialog.
3. In the Host name box, enter the name of the run host.
4. From the Host type and the Connection method lists, make selections for the run host that your administrator suggested.
5. In the Login and Password boxes, enter your username and password.
6. Leave the Default directory box blank, or enter a path to a directory used as a starting point for browsing files.
7. From the Test dropdown list, select Connection.
After a few seconds, you should see a message telling you that the connection to the Co>Operating System is working.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 198 of 221

If the connection fails, an error message that explains the problem appears. Correct the problem before proceeding.
For more information, see “Testing the connection”.
8. Close the dialogs and save your changes.
Related topics
Starting the GDE
Getting a software activation key

Pre N
viou e

GDE Help > GDE administration tasks > Managing host connections

Managing host connections

After establishing the initial connection, you may want to change your connections or define multiple host connection settings. This section describes these
and other connection tasks.
This section includes the following topics:
Using host connection settings
Using host setup and cleanup scripts
Setting up the connection between the GDE and the run host
Related topics
Configuring the host connection

Pre N
viou

GDE Help > GDE administration tasks > Managing host connections > Using host connection settings

Using host connection settings

To run your graph or plan, the GDE requires host connection settings that specify how to communicate with the Application Hub on a run host.
The host connection settings, stored in an .aic file, include the login and password for your account on the run host, the path of the Application Hub to connect
to, the communications protocol, and which Co>Operating System to use.
Illustration showing a single host connection containing various host connection
settings.

You can define any number of host connections. For one run host you might want to define multiple host connections that specify different Co>Operating
Systems or connection protocols. For example in the illustration below, there is a host connection to Co>Operating System Version 2.16 on Run host A, and
separate host connections to Co>Operating System Version 2.16 and Version 2.15 on Run host B.
Illustration showing the role of the host settings in establishing
connections.

The GDE stores host connections in a predefined location that you can change (see “Saving host connections in a new location”). You can browse for the host
connection you want to use from a list shown in the Connections dialog.
An Import button on that dialog also enables you to convert 2.15 host connection settings files into 3.0-compatible connection information.
This section describes tasks involved in using host connection settings. It includes the following topics:
Creating or modifying host connections
Testing the connection
Saving host connections in a new location
Related topics
Managing host connections
Using host setup and cleanup scripts
Setting up the connection between the GDE and the run host

Pre N
viou e

GDE Help > GDE administration tasks > Managing host connections > Using host connection settings > Creating or modifying host connections

Creating or modifying host connections

For the GDE to connect on your behalf to the Application Hub on a run host, you must have an account on the run host. If necessary, see your system
administrator to obtain an account.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 199 of 221

To create or modify host connections:

1. From the GDE menu bar, choose Settings > Manage Connections.
The Connections dialog opens.
2. Choose one of the following:
Edit — Modifies the selected host connection.
New — Creates a new host connection.
Duplicate — Creates a new host connection based on the settings of the selected one.
The Host Connection Settings dialog opens, with the current settings for the fields filled in.
3. If this is a new host connection, enter a name and description.
4. Make the necessary changes to the values.
For further information about the various settings, click the Help button in the dialog.
For detailed information on setting the connection method, see “Setting up the connection between the GDE and the run host”.
5. Click Test and chose either Connection or Application Hub configuration.
The GDE uses the values you specify to connect to the run host. For more information, see “Testing the connection”. The host connection is saved to the
location defined in the General category of the Preferences dialog.
NOTE: To save host connections in a different location, see “Saving host connections in a new location”.
6. Click OK to save the new or modified host connection in the current host connections location and close the Host Connection Settings dialog.
7. Click Close to close the Connections dialog.
Related topics
Using host connection settings
Testing the connection
Saving host connections in a new location
Setting up the connection between the GDE and the run host

Pre N
viou

GDE Help > GDE administration tasks > Managing host connections > Using host connection settings > Testing the connection

Testing the connection

You can test whether the information specified in the Host Connection Settings dialog works correctly. The GDE enables you to test the validity of the
Application Hub configuration, and validate the AB_HOME paths to all instances of the Co>Operating System, and validate AB_AIR_ROOT for published
EME technical repositories, as these configuration variables are defined in the system configuration (abinitiorc) file and the user configuration (.abinitiorc)
file.
To test the connection to the Application Hub and specified Co>Operating System:
1. Do one of the following:
In the Connections dialog, click Test Connection.
In the Host Connection Settings dialog, click Test and choose Connection.
To test the connection to the Application Hub, and all published Co>Operating Systems and EME technical repositories:
1. Do one of the following:
In the Host Connection Settings dialog, click Test and choose Application Hub configuration.
In the Connections dialog, right-click in the Host connections list and choose Test > Application Hub configuration from the pop-up menu.
2. In the resulting dialog, click Show Details to see the list of tested Co>Operating Systems and of published EME technical repositories.
If there are no published EME technical repositories, a message to that effect appears in the output dialog.
If there is an error, the GDE displays a dialog reporting that the test failed. Click Show Details to display information about why the GDE could not connect.
Make any necessary adjustments, and retest the connection until you receive the message “Connection test was successful.” If necessary, contact your
Ab Initio administrator for help to modify the abinitiorc file.
Related topics
Using host connection settings
Creating or modifying host connections
Saving host connections in a new location
Setting up the connection between the GDE and the run host

Pre N
viou

GDE Help > GDE administration tasks > Managing host connections > Using host connection settings > Saving host connections in a new location

Saving host connections in a new location

The GDE saves new host connections to a predetermined location. You can alter that location as follows.
To change the location where host connections are stored:
1. From the GDE menu bar, choose Settings > Preferences.
2. Click the General category.
3. From the Host connections location drop-down list, select Specify host connections location (below).
4. Enter the path to the new location.
5. Click OK to save your change and close the Preferences dialog.
Related topics
Using host connection settings
Creating or modifying host connections
Testing the connection
Setting up the connection between the GDE and the run host

Pre N
viou e

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 200 of 221

GDE Help > GDE administration tasks > Managing host connections > Using host setup and cleanup scripts

Using host setup and cleanup scripts

When you specify host connection settings, you can write shell commands to be used as host setup and host cleanup scripts. The run host executes the host
setup script when the Application Hub starts up, and it executes the host cleanup script when the Application Hub shuts down.
For example, the run host executes the host setup script before it runs your graph or plan, and executes the host cleanup script after it executes your graph or
plan. If you define a host setup script or a host cleanup script, the GDE embeds it in the host connection settings.
CAUTION! The use of host setup and cleanup scripts is strongly discouraged. See “The problem with host setup and cleanup scripts” for details.
Related topics
Configuring the host connection
Graph scripts
Comparing graph start and host setup scripts
The problem with host setup and cleanup scripts
Graphs launched from the GDE

Pre N
viou e

GDE Help > GDE administration tasks > Managing host connections > Using host setup and cleanup scripts > Graph scripts

Graph scripts
In addition to host setup and cleanup scripts, there are start and end scripts associated with graphs. To define graph start and end scripts, from the GDE menu
bar choose Edit > Script > Start or Edit > Script > End.
If you define both host and graph scripts, the run host executes them in the following order when it executes a graph:
1. Host setup script
2. Graph start script
3. Graph execution
4. Graph end script
5. Host cleanup script
Related topics
Using host setup and cleanup scripts
Comparing graph start and host setup scripts
The problem with host setup and cleanup scripts
Graphs launched from the GDE

Pre N
viou

GDE Help > GDE administration tasks > Managing host connections > Using host setup and cleanup scripts > Comparing graph start and host setup scripts

Comparing graph start and host setup scripts

A graph start script (as well as its counterpart, the graph end script) is specific to an individual graph: it cannot be shared between graphs. You can use a graph
start script to specify conditions in your environment that must be true in order for the graph to run. For example, a graph start script might check that a
required file exists before running, and create the file if it does not yet exist.
A host setup script (as well as its counterpart, the host cleanup script), on the other hand, is shared by all graphs executed or deployed using the same host
connection. When you deploy a graph, a copy of the host setup script from the current host connection is embedded in the script. If you change the host setup
script, you must redeploy the graph so the deployed script contains the most recent changes. If another user deploys your graph, the host setup script from that
user's current host connection gets embedded in the script.
Related topics
Using host setup and cleanup scripts
Graph scripts
The problem with host setup and cleanup scripts
Graphs launched from the GDE

Pre N
viou

GDE Help > GDE administration tasks > Managing host connections > Using host setup and cleanup scripts > The problem with host setup and cleanup
scripts

The problem with host setup and cleanup scripts

Different users can have different host connections with different host setup and cleanup scripts. This means the same graph will in general produce different
results depending on what host connection settings are used to run them. Since the host setup and cleanup scripts are embedded in the deployed graph script,
the deployed graph script always contains the setup and cleanup scripts of the last user who saved the graph.
Especially in a collaborative environment, where different users may be editing and saving the same graphs with different host connection settings, the graph’s
behavior may change with each subsequent deployment. The inconsistent behavior can be confusing, and hard to troubleshoot.
For these reasons, you should avoid using host setup and cleanup scripts unless it is absolutely necessary. But if you must use host scripts, make sure that all
users have the same host scripts in their host connection settings.
For best practice, if you must use a host setup script, restrict it to a single line that dots in a shared setup script, for example:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 201 of 221

. setup.ksh
If you find a need for more elaborate host setup and cleanup scripts, contact Ab Initio Support before proceeding.
Related topics
Using host setup and cleanup scripts
Graph scripts
Comparing graph start and host setup scripts
Graphs launched from the GDE

Pre N
viou

GDE Help > GDE administration tasks > Managing host connections > Using host setup and cleanup scripts > Graphs launched from the GDE

Graphs launched from the GDE

The GDE_EXECUTION environment variable indicates whether a graph, script, parameter evaluation, or command line instruction is running on the host
server from the GDE. The GDE sets GDE_EXECUTION to 1 (true) in the host’s environment when it runs any of the above. In a production environment,
GDE_EXECUTION is not set. Never set GDE_EXECUTION yourself.
You can test the value of the GDE_EXECUTION environment variable in host connection setup scripts, graph start scripts, and shell-interpreted parameter
expressions to make your graphs behave one way in development and another way in production. For example, you might want to have different
AB_REPORT settings for development and production.
Related topics
Using host setup and cleanup scripts
Graph scripts
Comparing graph start and host setup scripts
The problem with host setup and cleanup scripts

Pre N
viou e

GDE Help > GDE administration tasks > Managing host connections > Setting up the connection between the GDE and the run host

Setting up the connection between the GDE and the run host
You use the Host Connection Settings dialog to specify the information the GDE needs to log in to the Application Hub on a run host. The Connection method
box of the dialog specifies which remote protocol the GDE should use. The protocols might require you to specify information such as the host name, login
name, and password for the run host.
This section describes the protocol-specific information you must provide for each of the supported connection methods:

Run host platform

Supported methods
Unix Windows
Rexec X X
Telnet X
SSH X
DCOM X
Related topics
Using host connection settings

Pre N
viou

GDE Help > GDE administration tasks > Managing host connections > Setting up the connection between the GDE and the run host > Rexec

Rexec
The REXEC connection method uses the Unix Rexec protocol.
If you are connecting to a Unix-based server, you must specify the username in the Login box of the Host Connection Settings dialog; for a Windows-based
server, specify domainname/username. If your account is on a domain and you do not include the domain name when connecting to Windows, the login will
fail.
Related topics
Setting up an Rexec connection
Creating or modifying host connections
Testing the connection

Pre N
viou

GDE Help > GDE administration tasks > Managing host connections > Setting up the connection between the GDE and the run host > Telnet

Telnet
The Telnet connection method uses the Telnet protocol.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 202 of 221

To define a Telnet connection:

1. In the Connection method box of the Host Connection Settings dialog, select Telnet, then click Settings. The Telnet Connection Settings dialog opens.
2. Fill in the Prompt and Response fields as follows:

Field Description
Prompt fields In most cases you do not need to edit the Prompt fields because the defaults are the most commonly used prompts: login, Username, Login,
or Name, and Password or password.
Response Type your username and password for the run host. The defaults — $USERNAME and $PASSWORD — pick up the values from the
fields Login and Password fields of the Host Connection Settings dialog.
NOTE: Prompts are case sensitive. The prompt Login:|username: matches Login: and username:, and Password:|password: matches Password: and
password:. If you need help, see your system administrator for Telnet prompts and responses.
3. To encrypt a response, select the checkbox next to that response in the Encrypt column.
4. Accept the default number of seconds to wait for a prompt (30), or enter another value in the Response timeout box.
5. Accept the default Telnet port (23, which is represented by 0 in this dialog) or enter a different port number:
If the Telnet daemon is running on a nonstandard port, set the number of the port in the Telnet port box.
If the run host is MVS, see your system administrator.
6. Accept the default (DUMB) or enter the terminal type you are using — such as VT100.
7. Click OK to save your changes and close the Telnet Connection Settings dialog. You return to the Host Connection Settings dialog.
8. Test your settings, as described in “Testing the connection”.
Related topics
Setting up a Telnet connection
Creating or modifying host connections
Testing the connection

Pre N
viou

GDE Help > GDE administration tasks > Managing host connections > Setting up the connection between the GDE and the run host > SSH

SSH
The SSH connection method uses secure shell protocol (SSH) access.
SSH uses public key authorization, in which public/private key pairs allow you connect to remote Internet sites without sending your password or requiring
you always to use the same IP address to connect. You generate and store the private key on your local computer and protect it with a password. You or an
administrator can set up the public key in an authorization file on the SSH server. To authorize the Internet connection, the keys must match. The name of the
authorization file varies depending on the specified SSH server and protocol.
To use the SSH connection method:
1. Set up the SSH server (described in “Setting up the Cygwin OpenSSH Service”).
2. Define an SSH connection.
3. Load an existing SSH key file or generate a new one.
Related topics
Defining the SSH connection in the GDE
Generating an SSH key file using the GDE
Loading or importing an existing SSH key file
Setting up an SSH connection
Importing private SSH2 keys with PuTTY
SSH configuration scenarios

Pre N
viou e

GDE Help > GDE administration tasks > Managing host connections > Setting up the connection between the GDE and the run host > SSH > Defining the
SSH connection in the GDE

Defining the SSH connection in the GDE

To define an SSH connection in the GDE:
1. Select Settings > Manage Connections to display the Connections dialog.
2. Select the host connection for which you want to define an SSH connection, and then click Edit to display the Host Connection Settings dialog
3. In the Connection Method box, select SSH, then click the Settings button to display the SSH Connection Settings dialog.
4. If you already have a private SSH key file, enter its name in the Private key file box, or browse to its location. If you leave this box blank, the server
encrypts the password specified in the Password box in the Host Connection Settings dialog.
NOTE: For encrypted files, you must specify a filename in the Private key file box and enter the SSH passphrase in the Password box in the Host
Connection Settings dialog.
5. Specify either SSH 1 or SSH 2 for the SSH Protocol.
NOTE: SSH-2 became a proposed standard Internet protocol (RFC 4251) in 2006. It addresses some inherent vulnerabilities in the SSH-1 protocol. Security
concerns dictate using SSH-2 in preference to SSH-1 wherever this is possible. SSH-1 support is provided for backward compatibility.
6. In the Response Timeout box, accept the default (30 seconds) or specify another number after which the SSH connection will terminate if it is unable to
connect to the SSH server.
7. Accept the default SSH Port (22, represented as 0 in the dialog) or enter the port that the SSH protocol can use to connect to the SSH server.
8. (Optional) Select Use compression and Allow empty password.
9. If you do not already have a private SSH key file, click Generate Key to create one.
NOTE: PuTTY and OpenSSH use different file formats for SSH2 RSA and DSA private keys. You cannot simply copy the files. However, you can import
an OpenSSH private key into PuTTY (for details, see “Making the initial SSH connection”).
10. Click OK to close the SSH Connection Settings dialog and return to the Host Connection Settings dialog.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 203 of 221

11. Test your settings, as described in “Testing the connection”.

Related topics
Creating or modifying host connections
Testing the connection
Generating an SSH key file using the GDE
Loading or importing an existing SSH key file

Pre N
viou e

GDE Help > GDE administration tasks > Managing host connections > Setting up the connection between the GDE and the run host > SSH > Opening the
PuTTy Key Generator

Opening the PuTTy Key Generator

To use the PuTTY Key Generator alone (not while creating a host connection):
1. Select Settings > Manage Connections to display the Connections dialog.
2. Click New to display the Host Connection Settings dialog.
3. Select SSH as the Connection method, and then click Settings to display the SSH Connection Settings dialog.
4. Click Generate Key to display the PuTTy Key Generator. Then see one of these topics:
“Generating an SSH key file using the GDE”
“Loading or importing an existing SSH key file”

Pre N
viou

GDE Help > GDE administration tasks > Managing host connections > Setting up the connection between the GDE and the run host > SSH > Generating an
SSH key file using the GDE

Generating an SSH key file using the GDE

To generate a key using PuTTy Key Generator dialog:
1. If the PuTTy Key Generator dialog is not open, see “Opening the PuTTy Key Generator”.
2. In the Parameters area of the PuTTy Key Generator dialog, select the type of key to generate based on the protocol you are using: SSH1 (RSA), SSH2
RSA, or SSH2 DSA.
3. Accept the default Number of bits in a generated key (1024) or enter a different integer.
4. Click Generate and then move your mouse across the blank area of the dialog. The generator uses the motion of the mouse to ensure that the generated is
random.
5. After the key has been generated, the Key area contains the following fields:
Public key for pasting into OpenSSH authorized_keys file — Copy this text and paste it into a file (or you can save it using the Save public key button
as described in Step 6 below). Give the file to your system administrator to place on the host to which you will connect.
Key fingerprint — Specifies the fingerprint or host key for the computer running the SSH daemon or service. You cannot edit this.
Key comment — Specifies the comment generated for the key. PuTTY enters a default comment, but you can edit it if you need to.
Key passphrase — (Optional) Enter a passphrase. A passphrase is similar to a password: you must enter it each time you use the key pair for connection
authorization.
If you specify a passphrase, you must also enter it in the Password box of the Host Connection Settings dialog.
If you do not specify a passphrase, you must select Allow Empty Password in the SSH Connections Settings dialog.
Confirm passphrase — Re-enter the passphrase specified in Key passphrase.
6. Click Save private key to display the Save private key as dialog. (If you left Key passphrase blank, the GDE prompts you for confirmation. Click Yes to
save the file without a passphrase.)
7. Enter a name for the private key file, an appropriate location (we recommend the My Documents folder), and click Save.
8. If you did not copy the key text and save it to a file (as described in Step 5 above), click Save public key to save the key to a file. Give the public SSH key
file to your system administrator to place on the host to which you will connect.
9. Close the PuTTY Key Generator dialog to return to the Set Advanced Connection Options dialog.
10. Do one of the following:
If you were only creating a private key and not creating a host connection, follow the next procedure to associate the generated private key with an
existing host connection
If you were creating a private key as part of creating a host connection, enter the name of the generated private SSH key file in the Private key file box
and then continue specifying settings for the host connection. Click Help if you need assistance.
Related topics
Creating or modifying host connections
Testing the connection
Defining the SSH connection in the GDE
Loading or importing an existing SSH key file

Pre N
viou e

GDE Help > GDE administration tasks > Managing host connections > Setting up the connection between the GDE and the run host > SSH > Loading or
importing an existing SSH key file

Loading or importing an existing SSH key file

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 204 of 221

Assuming that the public SSH key exists and is located in the appropriate authorized_keys file on the run host (see “Locations for SSH key files”), you can
load or import an existing SSH key file as follows:
NOTE: The following procedure assumes that the private key file to import is in a location your computer can access.
To import a private key file using PuTTY:
1. If the PuTTy Key Generator dialog is not open, see “Opening the PuTTy Key Generator”.
2. Select Conversions > Import key from the PuTTY Key Generator dialog menu bar.
3. Navigate to the private key file, select it, and click Open.
If prompted for a passphrase, enter it. Once the key is imported, you can optionally edit or delete the passphrase before saving.
4. Click Save private key to display the Save private key as dialog, and save the key to an appropriate location.
This file can be located anywhere, but we recommend the My Documents folder.
5. Close the PuTTY Key Generator dialog to return to the Set Advanced Connection Options dialog.
6. Do one of the following:
If you were only importing a private key and not creating a host connection, follow the next procedure to associate the imported private key with an
existing host connection
If you were importing a private key as part of creating a host connection, enter the name of the imported private SSH key file in the Private key file box
and then continue specifying settings for the host connection. Click Help if you need assistance.
Related topics
Creating or modifying host connections
Testing the connection
Defining the SSH connection in the GDE
Generating an SSH key file using the GDE

Pre N
viou e

GDE Help > GDE administration tasks > Managing host connections > Setting up the connection between the GDE and the run host > DCOM

DCOM
The DCOM (distributed component object model) connection method uses the Windows DCOM facility to authenticate users on the remote machine. If you
choose this connection method, the Login and Password boxes of the Host Connection Settings dialog are grayed out.
Because DCOM is simpler to manage, it is the preferred connection method when you are connecting to a Windows server. If the connection fails (due to
permissions or system policies), use Rexec instead.
Related topics
Setting up a DCOM connection
Creating or modifying host connections
Testing the connection

Pre N
viou

GDE Help > GDE administration tasks > Managing host connections > Setting up the connection between the GDE and the run host > Connection
implementation

Connection implementation
The implementation of the connection differs depending on which connection method you select, but the process of running a graph always includes the
following:
1. The GDE transfers any necessary files to the run host.
2. The GDE executes processes on the run host.
3. The run host reports tracking information, environment information, and so on to the GDE.

Rexec and SSH implementation

When the GDE uses Rexec or SSH as the connection method, the implementation includes these basic steps:
1. The GDE connects to the Rexec daemon (rexecd) or SSH daemon (sshd) through a communication port on the run host.
Illustration showing the GDE establishing a run host connection via Rexec
or SSH.

2. The daemon starts the Application Hub process (see “About the Application Hub”).
Illustration showing the Rexec or SSH daemon starting the Application
Hub.

3. The GDE then communicates directly with the Application Hub.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 205 of 221

Illustration showing the GDE communicating with the Application Hub

through Rexec or SSH.

4. The GDE transfers the graph script to the Application Hub, which writes it to disk in the run directory.
Illustration showing the Application Hub writing the graph script to the run directory.

5. The GDE runs the script (via the Application Hub), and the script starts the launcher process.
Illustration showing the initial execution of the graph script through an Rexec or SSH
connection.

6. As the script executes, the launcher process returns tracking information and standard output to the GDE through the same connection to the Rexec or SSH
daemon.
Illustration showing two way communication through an Rexec or SSH connection during
graph execution.

Telnet implementation

When the GDE connects to the run host using Telnet, it follows these basic steps:
1. The GDE connects to the Telnet daemon (telnetd) on the run host.
Illustration showing the GDE establishing a run host connection via Telnet.

2. The daemon starts the Application Hub process (see “About the Application Hub”).
Illustration showing the Telnet daemon starting the Application Hub.

3. The Application Hub creates a listener port and communicates information about that port to the GDE.
Illustration showing the Application Hub opening a listener port and
notifying the GDE.

4. The GDE drops the connection to the Telnet daemon and connects to the Application Hub through the listener port.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 206 of 221

Illustration showing the GDE communicating with the Application Hub

through the listener port.

5. The GDE transfers the graph script to the Application Hub, which writes it to disk in the run directory.
Illustration showing the transfer of the graph script through the Application Hub.

6. The GDE runs the script (via the Application Hub), and the script starts the launcher process.
Illustration showing the initial execution of the graph script through the listener port.

7. As the script executes, the launcher process returns tracking information and standard output to the GDE.
Illustration showing two way communication through the listener port during graph
execution.

Related topics
Setting up the connection between the GDE and the run host
Connecting the run host to processing computers

Pre N
viou e

GDE Help > GDE administration tasks > Specifying language settings

Specifying language settings

If you are running the GDE in a language other than English, you may want to change the display language.
You can control the following language settings:
The language in which menus, menu options, and tooltips are displayed
The character set used to display metadata

Changing the language setting

The Language command on the GDE Settings menu determines the display language for menus, menu options, and tooltips.
To change the GDE display language:
Choose Settings > Language > language from the GDE menu bar.

Changing the character set for metadata

The AB_CHARSET configuration variable determines the enterprise-wide character set for Ab Initio software metadata, such as DML comments, field names
in record formats, and names of graphs, parameters, variables, graphs, components, and files. Your Ab Initio administrator sets the value of AB_CHARSET
for the enterprise Ab Initio installation in the Co>Operating System’s system configuration file, as described in “Specifying the enterprise-wide character set

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 207 of 221

for metadata”.
The metadata character set for the GDE must match that of the Co>Operating System to which it is connected. By default, the GDE automatically uses the
encoding format that corresponds to the system locale of the Windows operating system on which it is installed. For Windows-1252 — the default locale for
English and West European languages — the GDE uses ISO-8859-1. For all other locales, the GDE uses UTF-8.
You can set AB_CHARSET to override the default values for the GDE’s metadata character set in one of the following ways:
On the GDE client system
From the command line
NOTE: Do not set AB_CHARSET in the .abinitorc file on the GDE host machine — if set, this value overrides that set in the Co>Operating System’s
system configuration file. For more information on configuration variables, see “How configuration variables are evaluated” and “Editing configuration files”.

On the GDE client system

To set AB_CHARSET on the Windows machine where the GDE is installed:

1. Open the Windows Control Panel and click System.
2. In the System Properties dialog, select the Advanced tab.
3. Click Environment Variables.
4. In the Environment Variables dialog, create a new environment variable AB_CHARSET.
5. Set AB_CHARSET to the same value as that specified for the Co>Operating System to which your GDE is connected.
To get the value of AB_CHARSET for your Co>Operating System, run the m_env command as follows:
m_env -h AB_CHARSET

From the command line

To start GDE with the correct encoding format from the command line, run one of the following commands from a Windows command prompt:
gde.exe -utf-8
gde.exe -iso-8859-1
For more information, see “Starting the GDE from the command line”.
To save the command for launching the GDE with the correct encoding format in a Windows shortcut for future use:
1. Right-click your desktop background.
2. Choose New > Shortcut.
3. When prompted for the location of the target item, enter the path to the GDE executable followed by the encoding format to use. For example, to save the
command gde.exe -utf-8 to your desktop, specify the following:
"C:\Program Files\Ab Initio\Ab Initio GDE 1.16.0.6\Program Files\gde.exe" -utf-8
4. Click Next.
5. Supply a name for the shortcut — such as UTF-8 GDE — and click Finish.
Related topics
AB_CHARSET
Specifying the enterprise-wide character set for metadata
Administering character sets

Pre N
viou e

GDE Help > Troubleshooting tasks

Troubleshooting tasks
The following topics tell you how to use GDE-based troubleshooting tools in the GDE and how to debug graphs.
Using troubleshooting tools
Debugging graphs
NOTE: For Co>Operating System troubleshooting information, see “Common troubleshooting techniques” and “Heterogeneous environment
troubleshooting”.
Related topics
Fundamentals of troubleshooting
Error message reference

Pre N
viou

GDE Help > Troubleshooting tasks > Using troubleshooting tools

Using troubleshooting tools

There are several tools provided with the GDE that you can use to help troubleshoot different aspects of GDE performance and behavior.
Using Package for Support
Tracing operations and communications
GDE Task Manager
Network Performance Test utility
Related topics
Fundamentals of troubleshooting
Debugging graphs
Error message reference

Pre N
viou e

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 208 of 221

GDE Help > Troubleshooting tasks > Using troubleshooting tools > Using Package for Support

Using Package for Support

Package for Support is a feature that automatically packages up a graph or a plan and all its supporting files into a compressed tar file so you can send it to
Ab Initio Support.
Package for Support packages the last-saved version of the currently open graph or plan, together with any externally defined record formats, transforms,
database configuration files, and configuration information. For instructions on creating a Package for Support, see the next topic, “Creating a Package for
Support”.
The packaged files include:
The graph itself (the .mp file)
The plan itself (the .plan file)
The sandbox in which the graph or plan resides and any common sandboxes that are included
All external plans and graphs and their dependencies
The deployed script (if present)
Any record formats in external .dml files
Any transforms in external .xfr files
Record format and transform DML in include files referenced by .dml or .xfr files, or by the AB_INCLUDE_FILES configuration variable
Database configuration files (.dbc, .cfg) from database components
The host connection settings (.aic) and EME Technical Repository profile (.aip) files with protected passwords
Snapshots of these items:
The server environment for both the Application Hub and the Co>Operating System
The Ab Initio Environment on the server for the Application Hub and the Co>Operating System
The GDE client-server environment
The Database Package environment on the server
The key files for the Application Hub, the Co>Operating System, and the GDE
The most recently created report files (.dmp, .rpt)
Note the following:
The Package for Support files do not include:
Any of your data files
Anything from your Technical Repository other than the setup and log information for this particular job
Any passwords — such as the one entered in the Host Connection Settings dialog, or those associated with the configuration variables
AB_PASSWORD, AB_PASSPHRASE, and AB_IDB_PASSWORD
When the packager cannot find a part of the package, it displays a warning and asks whether you want to continue. Ignore these warnings and continue
packaging the file, because even an incomplete package is useful to Ab Initio Support. For more information on the possible error messages, see “Error
messages from Package for Support”.
Related topics
unpackage command
Using Ab Initio Help
Ab Initio documentation
Additional help sources
Ab Initio Online Discussion Browser
Contacting Ab Initio Support

Pre N
viou

GDE Help > Troubleshooting tasks > Using troubleshooting tools > Using Package for Support > Creating a Package for Support

Creating a Package for Support

This topic describes how to create, locate, and send a Package for Support.
Use Package for Support to package the graph and its supporting files into a compressed tar file that you can send to Ab Initio Support. Package for Support
includes the last saved version of the currently open graph, together with any externally defined record formats, transforms, database configuration files, and
configuration information. For details, see “Using Package for Support”.
To create a Package for Support:
1. In the GDE, open the graph you want to send for analysis.
2. From the GDE menu bar, choose Help > Support > Create Package for Support.
The Package Status tab in the Application Output window displays the name and contents of the package file, as well as any errors. For more information, see
“Error messages from Package for Support”.
To locate a Package for Support file, do one of the following:
From the GDE. From the GDE menu bar, choose Help > Support > Find Packaged Graph. A new window opens, highlighting the package file so you can
easily send it.
For a Citrix installation. To locate the package on Citrix and copy it to a different host:
NOTE: The GDE copies the package to the Citrix server machine. Because you may not have the privileges to use Windows Explorer on the server, you
must use the Copy Package for Support to Remote Host menu command to locate the file and copy it to a machine where you do have the necessary access.
From there you can send the package to Support.
a. From the GDE menu bar, choose Help > Support > Copy Package for Support to Remote Host.
b. In the Select Path dialog, enter the path for the remote machine, and click Select. For example, //hostname/path. Do not enter the filename; the dialog
adds it automatically.
The GDE displays a message confirming the location of the copied file.
From Windows Explorer. To locate the package:
Unhide the Local Settings directory.
On Windows XP machines, the package directory is typically C:\Documents and Settings\username\Local Settings\Temp, which by default is hidden from
Windows Explorer.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 209 of 221

To copy the package to the default directory of the current run host or to another host:
1. From the GDE menu bar, choose Help > Support > Copy Package for Support to Remote Host.
2. In the Select Path dialog, accept the default directory or choose a different one, and click Select. Do not enter the filename; the dialog adds it
automatically.
The GDE displays a message confirming the location of the copied file.
To send the Package for Support:
1. Once packaging is complete, you can click Print on the Package Status tab to print out the messages in the window.
The window contains information about all of the files, any errors encountered or missing files, and the location of the compressed package file.
2. Send the package file to support@abinitio.com.
Related topics
Using Package for Support
Contacting Ab Initio Support
Error messages from Package for Support

Pre N
viou

GDE Help > Troubleshooting tasks > Using troubleshooting tools > Using Package for Support > Error messages from Package for Support

Error messages from Package for Support

The Package Status tab in the Application Output window displays any warning or error messages encountered during the creation of a Package for Support.
The following topics describe packaging errors:
Cannot create local file filename
Cannot create packaging directory directoryname
Cannot package graph name
Cannot remove packaging directory name
Error creating archive name
Problem with connecting to host
WARNING: could not retrieve file filename. Package will be incomplete
WARNING: could not retrieve the deployed script, name. You may cancel the packaging
Related topics
Using Package for Support
Creating a Package for Support
Contacting Ab Initio Support

Pre N
viou e

GDE Help > Troubleshooting tasks > Using troubleshooting tools > Tracing operations and communications

Tracing operations and communications

When you have difficulty opening and closing documents or connecting to the remote host, tracing options are available that may help Ab Initio Support
identify the cause of the problem.
The Trace for Support feature automatically logs client-side operations and server-side communications while a graph or a plan is running, making it more
convenient to collect client and/or server execution traces for Ab Initio Support. Once tracing is enabled, the Trace for Support feature generates useful
information as GDE operations run. This information is recorded in various files and packaged as a tar file. The packaged files include:
client.run — Trace of operations in the GDE.
mt_trace.txt — Trace of all middle-tier communications between the GDE and the Application Hub.
server.run — Trace of server-side operations. This trace is propagated to all Ab Initio processes, even on remote nodes. This makes it possible to trace all
of the components in a graph or plan.
Tracing is global in the GDE; you can start it without first opening a document. This is useful because it allows you to turn on client-side tracing only, for
example, to track operations such as the opening and closing of documents.
To start tracing:
1. From the Help menu, choose Support > Start Tracing.
2. In the Tracing Options dialog, select the appropriate options. Both Client-side tracing and Server-side tracing are selected by default.
3. Click OK.
NOTE: For the GDE to access the server-side trace file on a remote host, the active graph or plan must be associated with a host connection file pointing to
that host. If the active graph or plan is already connected to its remote host, you must reconnect by choosing Settings > Manage Connections and clicking Test
Connection in the Connections dialog. This supplies the necessary information to the tracing function.
To stop tracing:
From the Help menu, choose Support > Stop Tracing.
This stops tracing and generates a package of the logging output, which you can send to Ab Initio Support.
To send the trace file to Ab Initio Support:
1. Stop tracing.
2. From the Help menu, choose Support > Find Trace for Support.
This opens a temporary Windows Explorer window and displays the directory that contains the trace file package, so you can conveniently attach it to an
email to support@abinitio.com.
Related topics
Using troubleshooting tools
GDE Task Manager
Network Performance Test utility

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 210 of 221

Pre N
viou e

GDE Help > Troubleshooting tasks > Using troubleshooting tools > GDE Task Manager

GDE Task Manager

For troubleshooting purposes, the GDE provides a Task Manager utility. The GDE Task Manager is a separate application that lets you force any GDE process
running on your local system to stop and generate .dmp and .rpt files that Ab Initio Support can use to debug the GDE. This utility works with GDE Version
1.14.29 or higher.
The GDE Task Manager, GdeTaskManager.exe, is located in your system’s GDE installation directory. By default, this is:
C:\Program Files\Ab Initio\Ab Initio GDE 3.0.n\Program Files
Related topics
Using troubleshooting tools
Tracing operations and communications
Network Performance Test utility

Pre N
viou e

GDE Help > Troubleshooting tasks > Using troubleshooting tools > Network Performance Test utility

Network Performance Test utility

For troubleshooting purposes the GDE includes the Ab Initio Network Performance Test utility. This utility is a separate application that performs the tests to
determine network performance.
For each host connection you select, the utility tests:
Network latency using Winsock 2
Network throughput using a small packet test and Winsock 2
Network latency using the Application Hub
Network throughput using a small packet test and the Application Hub
Network throughput using a large packet test and the Application Hub
The Ab Initio Network Performance Test utility, netperf.exe, is located in your system’s GDE installation directory. By default, this is:
C:\Program Files\Ab Initio\Ab Initio GDE version number\Program Files

When to use netperf

Use this utility to:

Identify network bottlenecks and to determine the fastest servers up-front, before setting up or moving an installation
Compare latency versus throughput (throughput combines the network hardware’s response with the server’s response)
Compare the relative performance of multiple servers (for example, compare a local server versus remote servers to see whether redistribution makes
sense)
Identify communication problems causing slow graphs
Copy and paste the resulting data to send to Ab Initio Support or a Network Administrator

Notes about netperf

This utility requires GDE-based DLL files; it cannot be run independently of a GDE installation. In addition, this utility requires a GDE version later than
1.15.7; if you want to run the utility and are using GDE Version 1.15.7 or lower, you must also install a later version of the GDE.
Related topics
Using troubleshooting tools
Tracing operations and communications
GDE Task Manager

Pre N
viou e

GDE Help > Troubleshooting tasks > Debugging graphs

Debugging graphs
As you develop graphs, you can use the GDE debugger to uncover and solve problems that may be present. Using breakpoints, you can evaluate expressions
in the Transform Editor and examine the values and metadata of input records, output records, and variables. Using watchers, you can monitor and debug data
flows. Using isolation, you can debug a subset of a graph. In the Application Output window, you can view context-specific error messages.
The GDE debugger includes the following features:
Debugger toolbars
Debugger pane
Breakpoints
Watchers
Isolation mode
Context-specific error reporting
Related topics
Working with debugging options

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 211 of 221

Debugging transforms
Debugging data flows
Using isolation mode

Pre N
viou

GDE Help > Troubleshooting tasks > Debugging graphs > Working with debugging options

Working with debugging options

The GDE provides three options for debugging graphs. You can limit debugging to work with watchers on data flows, work with breakpoints in transforms, or
work with both simultaneously. When working solely with watchers, you can take advantage of inline expansion. When working solely with breakpoints, you
can avoid the overhead of watcher processing.
NOTE: To work with breakpoints and watchers separately, you must use Co>Operating System Version 2.15.4 or later as the host connection.
Before you can use any of the features of the debugger, you must:
Designate the debugging options
Enable debugging

Debugger toolbars

Toolbars for the debugging features are located in the toolbar area at the top of the GDE window. The display is dependent on the selection or deselection of
the checkbox Enable breakpoints and watchers separately in the Debug category of the Preferences dialog.
The Debug toolbar provides controls for both watchers and breakpoints.
Screen capture of the

The Watchers toolbar controls watchers on data flows in the graph.

Screen

The Breakpoints toolbar controls breakpoints on rules or statements that you want to examine in the Transform Editor.
Screen

The Transform Editor toolbar is located in the toolbar area at the top of the Transform Editor.
Screen capture of the Transform Editor’s Debugging
toolbar.

Designating debugging options

To designate the debugging option:

1. From the GDE menu bar, choose Settings > Preferences.
2. In the Preferences dialog, select the Debug category.
3. Do one of the following, depending on whether you want to use breakpoints and watchers separately or simultaneously:
To use these functions separately, select Enable breakpoints and watchers separately to display a separate toolbar for each.
To use these functions simultaneously, deselect Enable breakpoints and watchers separately to display the single full Debug toolbar.
4. Select the Show Breakpoints Reached window checkbox to automatically open the Breakpoints Reached window when a graph with breakpoints is run in
multiple partitions.
5. Click OK.

Enabling the debugger

NOTE: Enabling the breakpoints debugger turns off Inline expansion. For more information, see “The debugger and inline expansion”.
To enable debugging from the GDE menu bar:
1. Choose one of the following:
Debug > Debugger — Enables both watchers and breakpoints
Debug > Watchers — Enables watchers only
Debug > Breakpoints — Enables breakpoints only
2. If the Debug toolbar is already visible and the toolbar is not enabled (most of the buttons are grayed out), click the appropriate icon:
For full debugging, click .
S
For watchers, click .
For breakpoints, click on the toolbar of either the GDE window or the Transform Editor.
To enable breakpoint debugging from the Transform Editor:
Do one of the following:
From the menu bar, choose Debug > Enable Breakpoints.

On the toolbar, click .

Related topics
Debugging graphs
Debugging transforms
Debugging data flows
Using isolation mode

Pre N
viou

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 212 of 221

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging transforms

Debugging transforms
You debug transforms by using breakpoints, as described in the following topics:
Breakpoints
Debugger pane
Using breakpoints
Setting breakpoints
Editing breakpoints
Removing breakpoints
Monitoring breakpoints
Viewing expression values

Pre N
viou e

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging transforms > Breakpoints

Breakpoints
A breakpoint is a marker that you can set on an executable rule or statement in a transform function. When the execution of the graph reaches a breakpoint, it
stops so you can evaluate expressions and can examine the values and metadata of input records, output records, and variables.
In a transform function, you set breakpoints on the rules or statements that you want to examine while the graph runs. You can specify conditions for a
breakpoint by editing it. When the rule or statement with a breakpoint on it is executed and all conditions on the breakpoint are met, the breakpoint is triggered
and stops execution of the graph.
When the graph stops at a breakpoint, the Transform Editor opens with the Debugger pane visible at the bottom.
Related topics
Debugging transforms
Debugger pane
Using breakpoints

Pre N
viou

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging transforms > Debugger pane

Debugger pane
If you enable the debugger and run a graph that has breakpoints set, when the graph stops at the first encountered breakpoint, the Transform Editor opens with
the Debugger pane visible. If the preference has been set in the Debug category of the Preferences dialog, the Breakpoints Reached window opens as well. The
selection in the Breakpoints Reached window determines which partition is evaluated in the Debugger pane. The editor, the Debugger pane, and the
Breakpoints Reached window remain open as long as you continue debugging the graph.
The Debugger pane displays the values and metadata for the current statement or rule at the breakpoint on its four tabs:
Inputs — Displays the names, values, and data types of the fields in all the inputs to the transform.
Variables — Displays the names, values, and data types of any local variables defined in the transform function.
Outputs — Displays the names, values, and data types of the output fields that have been populated at this point in the execution of the function.
Eval — Lets you write expressions and then evaluate them in terms of the state of execution of the graph at the current breakpoint.
You can, for example, see the effect of concatenating two fields, perform a computation that is not included in the transform function, call a DML function,
and so on.
To automatically evaluate expressions on the Eval tab:
a. Click in the uppermost empty cell in the Expression column on the Eval tab.
b. Populate the Expression cell either by typing an expression directly in the cell or by dragging any text from any field in the transform into the cell.
c. Complete the edit operation. For example:
- Press Enter
- Press Tab
- Press the up or down arrow key
- Click elsewhere in the editor window
- Step through the transform rules
d. To update the evaluations of all expressions, click Refresh.
The status bar below the Debugger pane indicates the breakpoint line on which the execution of the graph has stopped, the partition number, and number of
the invocation (or the number of the record) being processed. The information displayed here depends on the rule or statement you selected for a particular
partition in the Breakpoints Reached window.
Related topics
Debugging transforms
Breakpoints
Using breakpoints

Pre N
viou e

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging transforms > Using breakpoints

Using breakpoints
To use breakpoints in a graph:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 213 of 221

1. Enable the debugger.

2. Set breakpoints.
3. (Optional) Edit the breakpoints.
4. Run the graph.
When the first breakpoint is triggered, execution of the graph stops, the Breakpoints Reached window opens, and the Transform Editor opens with the
Debugger pane visible in the lower part of the editor window.
If several breakpoints have been triggered — for example, in a parallel graph in which a breakpoint occurs in each partition — use the Breakpoints Reached
window to choose the rule or statement in a partition’s call stack to display its values in the Debugger pane.
The Debugger pane displays information for each breakpoint for each record being processed through the Transform Editor. After you have examined the
contents of the Debugger pane for one breakpoint, continue debugging by choosing one of the following from the Transform Editor menu bar, or by clicking
the corresponding button on the toolbar:
Enable Breakpoints — Turns breakpoint debugging on and off.
Debug > Continue (F5) — Causes the graph to resume execution in the current partition until the next breakpoint is triggered.
Debug > Continue All Partitions (Alt+F5) — Causes the graph to resume execution in all partitions until the next breakpoint is triggered.
Debug > Stop Debugging (Shift+F5) — Stops execution of the graph.
Show Next Statement — Moves focus to the rule, variable, or statement to be processed next. This is useful with large transforms, where the row is
scrolled out of sight.
Debug > Single Step (F10) — Causes the graph to resume execution until it reaches the next executable rule or statement.
Debug > Step In (F11) — Causes the graph to resume execution until it reaches the next executable rule or statement, including any rule or statement in a
user-defined function invoked by the current transform function.
Edit > Set Breakpoint (F9) — Adds a breakpoint at the selected row.
Edit > Remove Breakpoint (F9) — Removes a breakpoint from the selected row.
Remove All Transform Breakpoints — Removes all the breakpoints in the transform.
Edit Breakpoint — Opens the Edit Breakpoint window for the selected rule.
Show Breakpoints Reached — Opens the Breakpoints Reached window, where you can select a function in the call stack of any partition to display the
corresponding code for the record currently being processed in the Debugger pane of the Transform Editor.
When you have finished debugging, click the Stop Execution button or choose Debug > Stop Debugging from the Transform Editor menu to stop
execution of the graph.
Related topics
Debugging transforms
Breakpoints
Setting breakpoints
Editing breakpoints
Removing breakpoints
Monitoring breakpoints
Viewing expression values

Pre N
viou

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging transforms > Setting breakpoints

Setting breakpoints
To set a breakpoint:
1. In the Transform Editor, select the rule or statement on which you want to set a breakpoint.
NOTE: To set a breakpoint within a transform that contains a parameter reference, choose View > Resolved View from the Transform Editor menu bar. In
the secondary read-only view of the Transform Editor, continue with Step 2 below. For more information, see “Viewing resolved transforms”.
2. Do one of the following:
From the Transform Editor menu, choose Debug > Set Breakpoint.
On the Transform Editor toolbar, click .
Press F9.
In the editor grid, double-click to the left of the rule.
In the editor grid, right-click the rule and choose Set Breakpoint from the pop-up menu.
Breakpoints remain set until you remove them, even if you deactivate the debugger. Closing the graph removes all breakpoints.
Related topics
Debugging transforms
Breakpoints
Using breakpoints
Editing breakpoints
Removing breakpoints
Monitoring breakpoints
Viewing expression values

Pre N
viou

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging transforms > Editing breakpoints

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 214 of 221

Editing breakpoints
Edit a breakpoint if you want to stop execution of the graph under one of the following circumstances:
In a specific partition.
At a specific numbered record.
When an expression you specify evaluates to true (non-zero). For details, see “DML expressions”.
To edit a breakpoint:
1. In the Transform Editor, select the rule that has the breakpoint you want to edit.
NOTE: To edit a breakpoint within a transform that contains a parameter reference, choose View > Resolved View from the Transform Editor menu bar. In
the secondary read-only view of the Transform Editor, continue with Step 2 below. For more information, see “Viewing resolved transforms”.
2. Do one of the following:
From the Transform Editor menu, choose Debug > Edit Breakpoint.
In the editor grid, right-click the rule and choose Edit Breakpoint from the pop-up menu.
The Edit Breakpoint dialog opens.
3. In the dialog, specify your requirements for the breakpoint.
To access all breakpoints in a graph for editing:
1. From the GDE menu bar, choose Debug > Edit All Breakpoints.
2. Follow these steps for each breakpoint you want to modify:
a. In the Breakpoints Editor, select the row representing the breakpoint you want to edit.
b. Click Edit to open the Edit Breakpoint dialog.
c. In the dialog, specify your requirements for the breakpoint and click OK.
3. Click OK to close the Breakpoints Editor.
Related topics
Debugging transforms
Breakpoints
Using breakpoints
Setting breakpoints
Removing breakpoints
Monitoring breakpoints
Viewing expression values

Pre N
viou

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging transforms > Removing breakpoints

Removing breakpoints
You can remove breakpoints for a transform in an individual component or you can remove breakpoints for all components in the entire graph.
To remove a single breakpoint from a transform:
1. In the Transform Editor, select a rule that has a breakpoint set on it.
NOTE: To remove a breakpoint within a transform that contains a parameter reference, choose View > Resolved View from the Transform Editor menu
bar. In the secondary read-only view of the Transform Editor, continue with Step 2 below. For more information, see “Viewing resolved transforms”.
2. Do one of the following:
From the Transform Editor menu, choose Debug > Remove Breakpoint.
S
On the Transform Editor toolbar, click the Remove Breakpoints button .
Press F9.
In the editor grid, double-click to the left of the rule.
In the editor grid, right-click the rule and choose Remove Breakpoint from the pop-up menu.
In the Breakpoints Editor, select the breakpoint and click Remove.
To remove a all breakpoints from a transform:
1. Do one of the following:
From the Transform Editor menu, choose Debug > Remove All Transform Breakpoints.
On the Transform Editor toolbar, click the Remove All Transform Breakpoints button .
To remove all breakpoints from a graph:
1. Do one of the following:
From the GDE menu bar, choose Debug > Remove All Breakpoints.
On the Debug toolbar or Breakpoints toolbar, click the Remove All Breakpoints button .
2. Close the graph.
Related topics
Debugging transforms
Breakpoints
Using breakpoints
Setting breakpoints
Editing breakpoints
Monitoring breakpoints
Viewing expression values

Pre N
viou e

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging transforms > Monitoring breakpoints

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 215 of 221

Monitoring breakpoints
To monitor breakpoints:
1. On the GDE toolbar, click the Run Graph button to run a graph in which breakpoints have been set.
A read-only instance of the Transform Editor with a debugging pane opens. When the first breakpoint is reached, the Breakpoints Reached window displays
the rules and statements in the call stack of the partition where the breakpoint was reached, as shown in the following figure
NOTE: Data for only one partition at a time is shown in the Transform Editor. The inputs, variables, and so forth are for the selected partition. Use the
Breakpoints Reached window to select another partition.
Transform Editor with yellow arrow indicating active breakpoint, debugging pane with Input data
displayed and Status bar showing breakpoint data. Together with an image of the Active Breakpoints
window showing partitions stopped at the breakpoint.

NOTE: Data for only one partition at a time is shown in the Transform Editor. The inputs, variables, and so forth are for the selected partition. Use the
Breakpoints Reached window to select another partition.
2. In the Breakpoints Reached window, double-click a rule or statement — preceded by an arrow indicator — to display the values at the corresponding
breakpoint in the Debugger pane of the Transform Editor.
3. In the Transform Editor, click one of the following buttons:
To continue processing data for the next partition at the current or next active breakpoint, click the Continue This Partition button .
S
To continue processing data for all partitions at the current next active breakpoint, click the Continue All Partitions button .
Related topics
Debugging transforms
Breakpoints
Using breakpoints
Setting breakpoints
Editing breakpoints
Removing breakpoints
Viewing expression values

Pre N
viou

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging transforms > Viewing expression values

Viewing expression values

When you are debugging transforms, you can hover the mouse pointer over an expression in text view of the Transform Editor to view its value in a tooltip
window. There are two options for viewing expression values:
For a highlighted expression — This displays the value for the whole expression. For example, positioning the mouse pointer over the highlighted
expression in.id + a where a = 3, might result in a value of in.id + a = 1003
For an expression that is not highlighted — This displays the value for a fragment of the expression. For example, positioning the mouse pointer over in.id
in the expression in.id + a would result in a value for in.id alone — for example, in.id = 1000.
Related topics
Debugging transforms
Breakpoints
Using breakpoints
Setting breakpoints
Editing breakpoints
Removing breakpoints
Monitoring breakpoints

Pre N
viou e

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging data flows

Debugging data flows

You debug data flows by using watchers, as described in the following topics:

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 216 of 221

Watchers
Using a watcher
Adding watchers on flows
Specifying phased or nonphased watchers
Viewing data in a watcher
Removing watcher files

Pre N
viou e

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging data flows > Watchers

Watchers
A watcher automatically adds intermediate files to flows so you can view the data that passes through the flows when you run a graph in the GDE. The
debugger places watcher files in the layout of the component downstream of the watcher. Watchers are a simpler alternative to the debugging technique of
manually creating intermediate files and inserting them into a graph.
There are two types of watchers:
Nonphased (default) — Does not add a phase break to the graph.
Phased — Adds a phase break to the graph, but does not change the phase numbers in the GDE.
The GDE automatically uses phased watchers when you do any of the following:
Locate a watcher on a flow that crosses a phase boundary.
Locate a watcher on a flow that is an input to an isolated graph section.
Select Default to phased watchers in the Preferences dialog, and then add a watcher.
You can also create a phased watcher. See “Specifying phased or nonphased watchers”.
Watchers appear as follows in the GDE:

Nonphased watcher

Nonphased watcher with data

Phased watcher with no data

Phased watcher on a phase break

Related topics
Debugging data flows
Using a watcher
Adding watchers on flows
Specifying phased or nonphased watchers
Viewing data in a watcher
Removing watcher files

Pre N
viou

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging data flows > Using a watcher

Using a watcher
To use a watcher:
1. Turn on debugging.
2. Add a watcher on a flow.
3. Run the graph.
4. View the data.
Related topics
Debugging data flows
Watchers
Adding watchers on flows
Specifying phased or nonphased watchers
Viewing data in a watcher
Removing watcher files

Pre N
viou e

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging data flows > Adding watchers on flows

Adding watchers on flows

To add watchers on flows:
1. Turn on debugging, if it is not already on.
2. Select the flows on which you want to place watchers.
3. Do one of the following:
From the GDE menu bar, choose Debug > Add Watcher on Flow.
In the graph, right-click the flow and choose Add Watcher on Flow from the pop-up menu.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 217 of 221

When you run the graph, the watchers turn blue, and you can view the data that has passed through the flows.
NOTE: To change the default color of a watcher, use the Watcher field in the Colors category of the Preferences dialog.
Related topics
Debugging data flows
Watchers
Using a watcher
Specifying phased or nonphased watchers
Viewing data in a watcher
Removing watcher files

Pre N
viou e

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging data flows > Specifying phased or nonphased watchers

Specifying phased or nonphased watchers

You can explicitly specify whether or not watchers will add phase breaks at runtime.
To set the watcher type:
1. In a graph, right-click the flow.
2. From the pop-up menu, select or deselect the Watcher is Phased option to, respectively, add or remove phase breaks.
Note the following:
When a watcher crosses a phase boundary, the watcher is always phased.
Although phase breaks in watchers are recognized by the GDE at runtime, they do not change the phase numbers displayed on the flows in the GDE.
Nonphased watchers fill as data moves through the graph. If there is an error in a component to the right of the nonphased watcher, its dataset may be
incomplete.
For information about setting the default watcher type, see the Default to phased watchers option in the Debug category of the Preferences dialog.
Related topics
Debugging data flows
Watchers
Using a watcher
Adding watchers on flows
Viewing data in a watcher
Removing watcher files

Pre N
viou e

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging data flows > Viewing data in a watcher

Viewing data in a watcher

After running the graph:
1. Right-click the watcher in which you want to view the data.
2. Choose View Data from the pop-up menu.
The View Data window enables you to examine the data that has passed through that flow.
Related topics
Debugging data flows
Watchers
Using a watcher
Adding watchers on flows
Specifying phased or nonphased watchers
Removing watcher files

Pre N
viou e

GDE Help > Troubleshooting tasks > Debugging graphs > Debugging data flows > Removing watcher files

Removing watcher files

The GDE cleans up watcher files automatically unless the cleanup process terminates abnormally — for example, if you exit a graph by clicking the Stop
Execution button .
To delete all watcher datasets in the default directory (for all graphs):
Do one of the following:
From the GDE menu bar, choose Debug > Delete Watcher Datasets.
At a Korn shell prompt, issue the following command:
m_rm -f -rmdata GDE-WATCHER-xxx
where GDE-WATCHER-xxx is the name of the watcher data file.
NOTE: Do not remove GDE-WATCHER-xxx files manually — this will result in other files being left on their host systems.
Related topics
Debugging data flows
Watchers
Using a watcher

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 218 of 221

Adding watchers on flows

Specifying phased or nonphased watchers
Viewing data in a watcher

Pre N
viou

GDE Help > Troubleshooting tasks > Debugging graphs > Using isolation mode

Using isolation mode

Isolation mode identifies a subset of a graph in the GDE and lets you execute debugging only on that subset. This makes debugging faster, because it allows
you to run a subset of a graph over and over without having to rerun the entire graph. Isolation mode mimics the debugging technique of copying and pasting a
subset of the graph to a separate graph during development.
NOTE: Isolation mode works with versions of the Co>Operating System earlier than Version 2.10, but the earlier versions support only file or multifile
layouts. If you try to use isolation mode with an unsupported layout, the Co>Operating System generates an error message when it compiles and runs the
graph.
To isolate a section of a graph:
1. Select all components in the section you want to isolate, or select a component at the input and the output of the section.
2. Do one of the following:
From the GDE menu bar, choose Debug > Isolate Selected Components.
On the GDE toolbar, click the Isolate Components button . S
The GDE isolates all selected components and any components between them. All other components are grayed out. In addition, the GDE automatically adds
watchers to the inputs and outputs of the isolated section.
When you run a graph in isolation mode, lookup files used by components in the isolated section are loaded, and then the isolated section runs.
The first time you run a graph after turning on isolation mode, components upstream of the isolated components may run in order to fill the upstream watchers
with data.
Related topics
Debugging graphs

Pre N
viou e

GDE Help > GDE FAQs

GDE FAQs
This section contains answer to the questions most often asked of the Ab Initio Internal Support team about the GDE. It contains the following topics:
Conditional components
Specifying conditions across phases
Checking the status of a graph in the end script and performing an appropriate action
Removing watcher files
GDE closes unexpectedly
Help versus Component Help buttons
Layout of watcher files

Pre N
viou

GDE Help > GDE FAQs > Conditional components

Conditional components

Question

Can I make my graph conditional so that certain components do not run?

Short answer

You can enter a condition expression on the Condition tab for a graph component. You can either type an expression in the box or insert a variable that
references an expression.
The expression must evaluate to a string for true or false or the integers 0 or 1. True values cause the component to remain active, while false values cause the
component to be disabled.
The following is the set of valid false values:
“0” (the string) or 0 (the integer)
“false” or “False”
“F” or “f”
Any other string or integer value is considered to be true.
The correct syntax for if statements in PDL is as follows:
$[condition]
The correct syntax for if statements in the Korn shell is as follows:
$(if [[ condition ]]; then_statement; else_statement; fi)

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 219 of 221

Condition expressions do not have access to the data on the flow. For example, you cannot selectively disable a component for input records whose
total_purchases field is greater than 100. For this type of problem, you must use a component. (In this case, FILTER BY EXPRESSION will do what you
need.)
For more information, see “About conditional components”, “Writing conditional expressions” and “Examples of conditional expressions”.

Details

To add a condition to a component:

1. If the Condition tab of the component Properties dialog is not visible, turn it on:
a. From the GDE menus, choose Settings > Preferences.
b. In the Advanced category, select Display Condition tab and click OK.
2. Double-click the component or subgraph to display its Properties dialog. Click the Condition tab.
3. Specify a conditional expression for the sandbox context, the EME context, or both. (For more information about the EME context, see “Dependency
analysis with conditional components”.)
NOTE: The expression must evaluate to a string for true or false or the integers 0 or 1. True values cause the component to remain active, while false values
cause the component to be disabled.
4. Choose the interpretation method for each conditional expression. The interpretation method for the sandbox context may be different than for the EME
context.
5. Specify how the graph should behave when the component is disabled:
Remove completely — The Co>Operating System removes the component and any flows connected to its ports. If a disabled flow is attached to a
required port of another component, the graph also removes that component and its flows, continuing the process until it reaches an optional port.
Replace with flow — The Co>Operating System replaces the component with a flow connecting an input port to an output port.
6. If you selected Replace with flow, accept the defaults in the From and To boxes, or select different ports to redirect the flow.
Note the following when writing conditional components:
Be careful not to have a record format or layout propagate from a component that might not exist at runtime. This could cause your graph to fail.
Disabled components display a gray tracking LED in the GDE when you run the graph.

See also

Conditional components, Writing conditional expressions, Examples of conditional expressions

Pre N
viou e

GDE Help > GDE FAQs > Specifying conditions across phases

Specifying conditions across phases

Question

Can I run a component in a second phase, based on a condition created in the first phase?

Short answer

Because the decision whether to execute a conditional component is made before a graph actually runs, you cannot assign the value used in a condition during
execution of the graph; the value must be set at the beginning. However, there are alternative design strategies that will give the result you want.

Details

One way to set conditions is to use a JOIN component with a NULL key ({}). Pass all your data into the first input flow, in0. For the second input flow, in1,
pass in either one record or no records, based on how your condition evaluates. If you specify an inner join, the output will be either all your records (if one
record is passed to in1) or no records (if no record is passed to in1).
Alternatively, you could use a FILTER BY EXPRESSION component. For this technique, your conditional expression would write a value to a lookup file.
The select expression of the Filter by Expression component accesses the lookup file and evaluates the value you placed there. Based on that value, the records
are either output via the out port or output elsewhere (those records that are not selected are output to the deselect log).

See also

conditional components, FILTER BY EXPRESSION, JOIN, LOOKUP FILE

Pre N
viou e

GDE Help > GDE FAQs > Checking the status of a graph in the end script and performing an appropriate action

Checking the status of a graph in the end script and performing an appropriate action

Question

How do I check the status of a graph in the end script and perform an appropriate action based on that status (such as doing cleanup or sending an e-mail)?

Short answer

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 220 of 221

You can verify the status of the graph in the end script using the variable $mpjret. If the graph succeeded, the value of the variable is 0; otherwise, it is non-
zero.

Details

For example, include the following code in your end script to check if the job ran successfully and report the results:
# Check to see if graph succeeded

if [ $mpjret -eq 0 ]
then
echo "Graph Succeeded"
else
echo "Graph Failed"
script_to_execute_when_graph_failed.ksh
fi

See also

Using host setup and cleanup scripts

Pre N
viou e

GDE Help > GDE FAQs > Removing watcher files

Removing watcher files

Question

How do I remove watcher files?

Short answer

To delete all watcher datasets in the default directory (for all graphs), use the GDE menu option Delete Watcher Datasets.

Details

The GDE removes watcher files automatically unless the removal process terminates abnormally — for example, if you exit a graph by clicking the Stop
Execution button.
To delete all watcher datasets in the default directory (for all graphs), do one of the following:
In the GDE, choose Debug > Delete Watcher Datasets from the menu bar.
To delete specific watcher datasets:
At a Korn shell prompt, issue the following command:
m_rm -f -rmdata GDE-WATCHER-xxx
where GDE-WATCHER-xxx is the name of the watcher data file. The m_rm command accepts wildcards, so you can use it to remove all watcher datasets.
You should not remove GDE-WATCHER-xxx files by using the Unix rm command, as this will result in other files being left on their host systems.

See also

debugger, watcher

Pre N
viou e

GDE Help > GDE FAQs > GDE closes unexpectedly

GDE closes unexpectedly

Question

My GDE closed unexpectedly — what should I do?

Short answer

Report any process failures to Ab Initio Support. Send in your graph and all relevant information.

Details

To help Ab Initio Support diagnose the problem as quickly as possible, include the following information:
The version of the GDE you are using.
The graph you were using when the failure occurred. Use Package for Support to send it.
Any gde-*.dmp and gde.RPT.xxxx files. You can find these in the Program Files folder of your GDE install.
The exact steps to reproduce the problem, if you know what they are.

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020
Getting started with Ab Initio Page 221 of 221

Any information you have about when the process failure started and what changes took place before the failure began.
For example, if the GDE closed unexpectedly when you were editing a transform, had you recently changed that transform? Had you recently installed new
software on your computer? Had you just installed a new GDE?

See also

failure, Ab Initio Support

Pre N
viou

GDE Help > GDE FAQs > Help versus Component Help buttons

Help versus Component Help buttons

Question

What is the difference between the Help and Component Help buttons?

Short answer

The Help button provides general information about the Properties tab from which you clicked it — for example, general information about the Parameters
tab.
The Component Help button provides specific information about the particular component you are working with.
NOTE: For help about a specific parameter in the Parameters list of the Parameters tab, right-click the name of the parameter, then click the Help button that
appears.

Details

The Properties dialog for graph components contains two help buttons:
Help — Provides access to general information about the tab of the Properties dialog where you invoked it.
For example, if you are on the Parameters tab and click the Help button, help about the Properties: Parameters tab is displayed. This is the same topic you see
if you click Help in the Properties dialog for any component; it explains how to use the buttons and other controls that are on this tab for all components.
Component Help — Provides information specific to the component where you opened the Properties dialog.
For example, if you click Component Help from the Properties dialog for a JOIN component, information about the Join component is displayed. From this
topic you can access links to information about the Join component’s parameters, a description of join types, and so on.
Related topics
Using Ab Initio Help

Pre N
viou e

GDE Help > GDE FAQs > Layout of watcher files

Layout of watcher files

Question

What is the layout of watcher files?

Answer

The debugger places watcher files in the layout of the component downstream of the watcher.

See also

debugger, layout, watchers

Pre N
viou

file:///C:/Users/venka/AppData/Local/Temp/~hhB3C8.htm 07-02-2020

Ab Initio Best Practices and Useful Tips PDF
No ratings yet
Ab Initio Best Practices and Useful Tips PDF
3 pages
CAT - C15 (Prefix MBN, 6NZ, 9NZ, or EGH) .Prefix MBN
75% (4)
CAT - C15 (Prefix MBN, 6NZ, 9NZ, or EGH) .Prefix MBN
8 pages
Abinitio Transform Components
No ratings yet
Abinitio Transform Components
14 pages
Abinitio Vectors: Created and Presented by Avishek Gupta Roy
100% (1)
Abinitio Vectors: Created and Presented by Avishek Gupta Roy
18 pages
Abinitio Ace: (A I Application Configuration Environment)
100% (1)
Abinitio Ace: (A I Application Configuration Environment)
16 pages
Abinitio Gde 3 0
50% (2)
Abinitio Gde 3 0
60 pages
Ab Initio 1
100% (4)
Ab Initio 1
115 pages
01 Ab Initio Basics
No ratings yet
01 Ab Initio Basics
139 pages
Ab Initio Interview Questions
100% (1)
Ab Initio Interview Questions
2 pages
Abinitio Questions
0% (1)
Abinitio Questions
33 pages
Abinitio Newtopics
No ratings yet
Abinitio Newtopics
5 pages
Abinitio Latest Questions
100% (1)
Abinitio Latest Questions
13 pages
02 Building Simple Ab Initio Graphs
No ratings yet
02 Building Simple Ab Initio Graphs
31 pages
AbInitio Online Training Course Content
No ratings yet
AbInitio Online Training Course Content
4 pages
Abinitio Tutorial - Trapezium Technologies
No ratings yet
Abinitio Tutorial - Trapezium Technologies
140 pages
Introduction To EME - AB INITIO
50% (2)
Introduction To EME - AB INITIO
32 pages
Change and Configuration Management Plan Template 1.2
No ratings yet
Change and Configuration Management Plan Template 1.2
5 pages
Report Hydro
80% (10)
Report Hydro
63 pages
01 - IBM Abinitio
No ratings yet
01 - IBM Abinitio
92 pages
Ab Initio Interview Questions and Answers
No ratings yet
Ab Initio Interview Questions and Answers
6 pages
01 Ab I E0
100% (1)
01 Ab I E0
129 pages
Ab Initio Session1
100% (1)
Ab Initio Session1
21 pages
Final
100% (1)
Final
40 pages
ABInitio FAQ
No ratings yet
ABInitio FAQ
21 pages
Top 19 Ab Initio Interview Questions & Answers: 1) Mention What Is Abinitio?
100% (1)
Top 19 Ab Initio Interview Questions & Answers: 1) Mention What Is Abinitio?
5 pages
Abinitio Faq's
No ratings yet
Abinitio Faq's
19 pages
Abinitio-Faqs
100% (1)
Abinitio-Faqs
14 pages
Interview Questions Abinitio
No ratings yet
Interview Questions Abinitio
7 pages
71 Ab Initio Etl Best Practices
0% (1)
71 Ab Initio Etl Best Practices
3 pages
Welcome To Ab Initio
No ratings yet
Welcome To Ab Initio
24 pages
Abinitio Frequently Asked Interview Questions
No ratings yet
Abinitio Frequently Asked Interview Questions
3 pages
Adhoc Multifile in Abinitio
No ratings yet
Adhoc Multifile in Abinitio
1 page
Questions
No ratings yet
Questions
83 pages
02 Building Simple Ab Initio Graphs
100% (2)
02 Building Simple Ab Initio Graphs
31 pages
Ab Initio - Passing Null Key
100% (1)
Ab Initio - Passing Null Key
2 pages
M - Dump Ab Initio
No ratings yet
M - Dump Ab Initio
4 pages
M - Shell Commands: Options
No ratings yet
M - Shell Commands: Options
4 pages
Components
No ratings yet
Components
11 pages
Kiran Abinitio
No ratings yet
Kiran Abinitio
66 pages
Ab Initio AIR Commands
100% (1)
Ab Initio AIR Commands
3 pages
135+ (FREQUENTLY ASKED) - Ab Initio Interview Questions & Answers
No ratings yet
135+ (FREQUENTLY ASKED) - Ab Initio Interview Questions & Answers
19 pages
Ab Initio EME Technical Repository
No ratings yet
Ab Initio EME Technical Repository
7 pages
AbInitio String Functions PDF
No ratings yet
AbInitio String Functions PDF
13 pages
Ab Initio - Intro
100% (1)
Ab Initio - Intro
43 pages
Abinitio MNC QA
No ratings yet
Abinitio MNC QA
10 pages
Ab Initio Transform Components: We Have An Total of 13 Transformation Components
No ratings yet
Ab Initio Transform Components: We Have An Total of 13 Transformation Components
11 pages
Runtime Behaviour of Abinitio Transform Components
No ratings yet
Runtime Behaviour of Abinitio Transform Components
8 pages
Abinitio Question
67% (3)
Abinitio Question
3 pages
Abinitio Assessment 1
No ratings yet
Abinitio Assessment 1
4 pages
Ab Initio Questions
No ratings yet
Ab Initio Questions
14 pages
Abnitio Interview Question
No ratings yet
Abnitio Interview Question
9 pages
Abinitio Interview Ques
No ratings yet
Abinitio Interview Ques
30 pages
Abintio Documents
No ratings yet
Abintio Documents
15 pages
Abinitio Training: Medium Complex Components
No ratings yet
Abinitio Training: Medium Complex Components
29 pages
P4 Ab Initio - Lookup File and Reusability Features
No ratings yet
P4 Ab Initio - Lookup File and Reusability Features
29 pages
Ab Initio Job Interview Questions and Answers
No ratings yet
Ab Initio Job Interview Questions and Answers
8 pages
Abinitio Vijay - 8553385664
No ratings yet
Abinitio Vijay - 8553385664
28 pages
Ab Initio Scenario Based Interview Questions and Answers
No ratings yet
Ab Initio Scenario Based Interview Questions and Answers
9 pages
Ab Initio (Company)
No ratings yet
Ab Initio (Company)
4 pages
Ab Initio Training
No ratings yet
Ab Initio Training
100 pages
Ab Initio Training
No ratings yet
Ab Initio Training
100 pages
Ab Initio
No ratings yet
Ab Initio
2 pages
Ab Initio Introduction
No ratings yet
Ab Initio Introduction
7 pages
Distributed Operating Systems
No ratings yet
Distributed Operating Systems
17 pages
Juniper Router CLI Configuration
No ratings yet
Juniper Router CLI Configuration
332 pages
A36 Annunciator Light Diagram
No ratings yet
A36 Annunciator Light Diagram
3 pages
Audit Quality Manual - Aqmm
No ratings yet
Audit Quality Manual - Aqmm
30 pages
Augmented Reality Marketing A Systematic Literature Review and An Agenda For Future Inquiry
No ratings yet
Augmented Reality Marketing A Systematic Literature Review and An Agenda For Future Inquiry
18 pages
Braille Glove
No ratings yet
Braille Glove
8 pages
Data Analyst SQL Tableau in San Francisco Bay CA Resume Rod Cyrus
No ratings yet
Data Analyst SQL Tableau in San Francisco Bay CA Resume Rod Cyrus
2 pages
Incorrect Naming-22.04.24
No ratings yet
Incorrect Naming-22.04.24
12 pages
Essbase Beginner's Guide
No ratings yet
Essbase Beginner's Guide
124 pages
Condition Assessment Manual: Automation System Checklist and Inspection Form
No ratings yet
Condition Assessment Manual: Automation System Checklist and Inspection Form
27 pages
3BSE040587-601 - en Compact HMI 6.0.1 Getting Started
100% (1)
3BSE040587-601 - en Compact HMI 6.0.1 Getting Started
246 pages
Exp-No5 Subtract 8 Bit and 16-Bit Numbers
100% (1)
Exp-No5 Subtract 8 Bit and 16-Bit Numbers
3 pages
SDF Lab
No ratings yet
SDF Lab
28 pages
Burkert
No ratings yet
Burkert
46 pages
QE Rotoguard PDF
No ratings yet
QE Rotoguard PDF
2 pages
Ciencia e Ingeniería de Materiales. 7a Ed. Donald R. Askeland y Wendelin J. Wright by Cengage - Issuu
No ratings yet
Ciencia e Ingeniería de Materiales. 7a Ed. Donald R. Askeland y Wendelin J. Wright by Cengage - Issuu
5 pages
FT8 - VRC For DISA - Day3 - 21072021
No ratings yet
FT8 - VRC For DISA - Day3 - 21072021
62 pages
A Seminar Report On "Broadband-Over-Power: Lines"
No ratings yet
A Seminar Report On "Broadband-Over-Power: Lines"
20 pages
Lesson 2 Notes and Vocabulary
No ratings yet
Lesson 2 Notes and Vocabulary
6 pages
National ICT Masterplan 2017 - February 2013 Edition
No ratings yet
National ICT Masterplan 2017 - February 2013 Edition
66 pages
Post Installation To First Emergency Access
No ratings yet
Post Installation To First Emergency Access
19 pages
Mongoose Pro GM II Add Keys, Program DDM Confirmed!
No ratings yet
Mongoose Pro GM II Add Keys, Program DDM Confirmed!
4 pages
2023.08 Welcome in Finance Department
No ratings yet
2023.08 Welcome in Finance Department
9 pages
Two-Member QFX Series Virtual Chassis Upgrade Procedure: Network Configuration Example
No ratings yet
Two-Member QFX Series Virtual Chassis Upgrade Procedure: Network Configuration Example
23 pages
1.number System
No ratings yet
1.number System
25 pages
Capstone Finalpaper. Aaa
No ratings yet
Capstone Finalpaper. Aaa
9 pages
Dodge Caravan Not Picking Up Speed Between 0 and 30 KM
No ratings yet
Dodge Caravan Not Picking Up Speed Between 0 and 30 KM
13 pages

Note: This service is not intended for secure transactions such as banking, social media, email, or purchasing. Use at your own risk. We assume no liability whatsoever for broken pages.