Introduction
Intended Audience
About This User Guide
About Actian DataConnect
Actian DataConnect Architecture
Actian DataConnect Key Features
Integration Design Maintenance Flow
Videos
Actian Support
Importing Prior Version Projects and Artifacts
Importing Version 9 Workspace
Importing Version 10 Artifacts from an Exported v10 Zip
Importing Projects Directly from Actian DataConnect 10
Importing Integrations and Packages from v10 Integration Manager
Importing Artifacts from Folder
Setting Preferences
Overview
Setting Appearance Preferences
Setting Color and Font Preferences
Setting Color Preferences for EZscript Editor
Setting Grid Preferences
Setting Data Profile Preferences
Setting Data Profile Metric Defaults
Setting EZscript Preferences
Setting General Preferences for EZscript Editor
Setting Execution Preferences
Setting Logging Preferences
Setting Error Handling Preferences
Setting Classpath Preferences
Setting General Preferences
Setting Macro Preferences
Setting Map Designer Preferences
Setting Field Columns Preferences
Setting Package and Deploy Preferences
Setting Integration Manager Preferences
Setting Process Preferences
Setting Canvas Preference for Process Designer
Setting Palette Preference for Process Designer
Setting Steps Preference for Process Designer
Setting Templates Preference for Process Designer
Setting Schema Preferences
Setting Browser Preferences
Managing Workspaces, Projects, and Integration Artifacts
Managing Workspaces
Create Workspace
Delete Workspace
Switch Workspace
Project Explorer
Repository Explorer
Integration Manager Explorer
Creating Projects
Integration Artifacts and Editors
Adding Integration Artifacts
Creating a Map
Creating a Process File
Creating EZscript Library
Creating General EZscript Libraries
Creating EZscript Library Using the Lookup Wizard
Creating a Structured Schema
Creating a Folder
Viewing and Editing Properties for a Project or Artifact
Viewing and Editing Project Properties
Viewing and Editing Artifact Properties
Opening an Artifact
Importing Projects and Artifacts
Importing an Archive File
Importing Existing Projects into Workspace
Importing from File System
Importing Preferences
Importing Projects from a Folder or Archive
Importing Templates
Importing From File Folder
Importing From Package or djar File
Importing From Package in Integration Manager
Importing Projects or Artifacts from Prior Versions
Exporting Projects or Artifacts
Exporting Projects or Artifacts Using File System
Exporting Preferences
Exporting Projects and Artifacts as an Archive File
Copying and Moving Artifacts Between Projects
Copying Artifacts Within Projects
Deleting Projects and Artifacts
Searching and Replacing Text in Artifacts
Searching Artifacts Using Open Resource Dialog
Searching Artifacts Using Search Dialog
Search Results View
Replacing Text Matches
Managing Macro Sets and Macros
Macro Definition Files
Creating Macro Definition Files
Switching Macro Definition Files
Macro Sets
Creating Macro Sets using Preferences Dialog
Creating Macro Sets using Create Macro Menu Option
Duplicating Macro Sets
Deleting Macro Sets
Viewing all Macro Sets
Adding Project-level Macro Sets
Missing Macro Sets for a Project
Missing Macro Sets for a Map or Process
Reordering Macro Sets for Project, Map, or Process
Macros
Creating Workspace-level Macros
Creating Macro using Create Macro Menu Option
Duplicating Workspace-level Macros
Copying Workspace-level Macros
Moving Workspace-level Macros
Deleting Workspace-level Macros
Configuring Local Macros
Execution Service Macros
Testing Execution Service Macros During Design
Editing Macros
Editing Macros using Preferences Dialog
Editing Macros by Typing a Name
Editing Macros by Selecting a Name
Using Macros
Pasting Macro in Map or Process
Finding Macros using Auto-Complete
Creating a Macro by Selecting a Value
Creating Macros by Typing a Name
Logging Macro Values
Designing and Executing Processes
Exploring Process Editor
Step Builder Canvas Tab
Process Toolbar
Tool Box and Palette
Step Navigator
Thumbnail
Process File Properties
Building Processes
Creating a Process Using Process Wizard
Creating a Process Without Using Process Wizard
Setting Execution and Logging Options
Adding Macro sets and Macros
Specifying EZscript Library, Global Variables, or Engine Profile
Adding Steps
Adding Annotations
Copying and Pasting Steps
Deleting Steps
Enabling and Disabling Steps
Adding Message Component Instances or SQL Sessions
Adding Message Component Instances
Manually Deploying Message Components
Adding SQL Sessions
Associating Instances or Sessions with Steps
Adding DJMessage Variable
Adding DJMessage Variable on Step Properties tab
Adding DJMessage Variable on the Configuration tab
Linking Steps
Testing Steps
Saving a Process
Saving a Process RTC File Only
Reusing Steps
Saving Step(s) as Template
Inserting Step(s) From Template
Configuring Processes
Configuring Macros
Managing EZscript Library Files
Adding EZscript Library Files
Deleting EZscript Library Files
Managing Global Variables
Managing Message Components
Adding Message Components
Editing Message Components
Deleting Message Component Instance
Configuring SQL Sessions
Adding SQL Sessions
Editing SQL Sessions
Duplicating SQL Sessions
Importing SQL Sessions
Deleting SQL Sessions
Configuring Execution Options for a Process
Configuring Logging Options for a Process
Configuring Engine Profiler
Health Care Components and Schemas
HL7 Batch Aggregator
HL7 Batch Aggregator Properties
Supported Actions
Supported Action Parameters
Supported Action Properties
Override Properties
Errors
HL7 Batch File Aggregator
HL7 Batch File Aggregator Properties
Supported Actions
Supported Action Parameters
Supported Action Properties
Override Properties
Errors
HL7 Batch Iterator
HL7 Batch Iterator Properties
Supported Actions
Supported Action Parameters
Supported Action Properties
Error Conditions
HL7 to XML Transformer
Using Linux
Supported Actions
Supported Action Parameters
Supported Action Properties
Error Conditions
XML to HL7 Transformer
Using Linux
Supported Actions
Supported Action Parameters
Supported Action Properties
Error Conditions
EDI 999 Validator
EDI 999 Validator Properties
Supported Actions
Supported Action Parameters
Supported Action Properties
Errors
Target Message
Sample EZScript
HL7 Message Structure Validator
Step Actions
Instance Properties
Step Action Parameters
Error Conditions
TA1 Validator
TA1 Validator Properties
TA1 Note Codes
Supported Actions
Supported Action Parameters
Supported Action Properties
Errors
HL7 Integration Schemas
HL7 Message Definition
HL7 Segment Library
HL7 Field Library
Composite
Subcomposite
HL7 Message and Library Relationship
Using Scripts in Processes
Using EZscript Libraries in Processes
Building Decision Step Expressions
Managing Queue Message Objects
Creating and Using Message Variables
Creating New DJMessage Variable
Assigning Result of DJComponent GetMessage Function to Message Variable
Using FindMessage Function
Validating Processes
Validating a Process Step
Validating a Complete Process
Running Processes
Debugging a Process
Troubleshooting Process Execution
Process Steps and Components
List of Process Steps
List of Process Step Components
Deprecated Components
Aggregator Step
EDI X12 Functional Group Aggregator
File Transfer Aggregator
Zip Aggregator 1.0
Zip Aggregator 2.0
HL7 Batch Aggregator
HL7 Batch File Aggregator
Application Step
Decision Step
Invoker Step
Data Profiler Invoker
DataFlow Invoker
IS API Invoker
JDBC Stored Procedure Invoker
Orchestration Invoker
REST API Invoker 1.x
REST API Invoker 2.x
REST API Invoker 3.x
SMTP Email Invoker
Salesforce Bulk Loader
Salesforce Changed Data Query Invoker
Salesforce Login Invoker
Unzip Invoker
XQuery Invoker
Zip Invoker
Iterator Step
EDI X12 Batch Transaction Iterator
EDI X12 Functional Group Iterator
EDI X12 Transaction Set Iterator
File Transfer Iterator
HL7 Batch Iterator
JSONPath Iterator
XPath Iterator
Zip Iterator
Process Step
Queue Step
AWS S3 Queue
Azure Storage Queue
FTP Queue
File Folder Queue
Google Cloud Storage Queue
Google Drive Queue
IBM MQ Queue
IMAP Email Queue
JMS Queue
Kafka Micro-batch Queue
Kafka Queue
MSMQ Queue
POP3 Email Queue
RabbitMQ Queue
Websphere MQ Queue
Script Step
SQL Step
Start Step
Stop Step
Alt-Transformation Step
Transformation Step
Transformer Step
Automatic Mapping Transformer
File to Message Transformer
HL7 to XML Transformer
Message to File Transformer
XML to HL7 Transformer
Validator Step
EDI 999 Validator
HL7 Message Structure Validator
TA1 Validator
XML Schema Validator
XSLT Step
Integrating Health Care Data
Supported Health Care Standards
Health Care Components and Schemas
HL7 Batch Aggregator
HL7 Batch Aggregator Properties
Supported Actions
Supported Action Parameters
Supported Action Properties
Override Properties
Errors
HL7 Batch File Aggregator
HL7 Batch File Aggregator Properties
Supported Actions
Supported Action Parameters
Supported Action Properties
Override Properties
Errors
HL7 Batch Iterator
HL7 Batch Iterator Properties
Supported Actions
Supported Action Parameters
Supported Action Properties
Error Conditions
HL7 to XML Transformer
Using Linux
Supported Actions
Supported Action Parameters
Supported Action Properties
Error Conditions
XML to HL7 Transformer
Using Linux
Supported Actions
Supported Action Parameters
Supported Action Properties
Error Conditions
EDI 999 Validator
EDI 999 Validator Properties
Supported Actions
Supported Action Parameters
Supported Action Properties
Errors
Target Message
Sample EZScript
HL7 Message Structure Validator
Step Actions
Instance Properties
Step Action Parameters
Error Conditions
TA1 Validator
TA1 Validator Properties
TA1 Note Codes
Supported Actions
Supported Action Parameters
Supported Action Properties
Errors
HL7 Integration Schemas
HL7 Message Definition
HL7 Segment Library
HL7 Field Library
Composite
Subcomposite
HL7 Message and Library Relationship
Using Data Profiler Engine
Command Line Syntax and Usage
Designing and Executing Data Profile
Exploring Data Profile Editor
Creating a Profile Using Data Profile Wizard
Creating a Profile Without Using Wizard
Specifying Source Connection for Data Profile
Adding Rules from Profile Tab
Generating Rules using AutoGen Wizard
Creating AutoGen rules file
Editing AutoGen rules file
Viewing AutoGen Results
Using Function rule in Combination with Other rule
Managing Rules
Add Rule
Edit Rule
Invert Rule Test
Delete Rule
Disable and Enable Rules
Clear Rules
Viewing Summary Report
Browsing Profile Data
Specifying Target Connection for Data Profile
Configuring Data Profile
Validating and Running Profile
Validating the Profile Results
Running Profile
Viewing Pass, Fail, and Drill Down Output
Rule and Their Resulting Outputs
Troubleshooting Profile Execution
Setting Rule Parameter Defaults
Rule and Parameter Reference
Summary Rule
Distinct Values
Duplicate Values
Duplicate Clusters (Fuzzy Matching)
Statistics
Equal Range Binning
Maximum
Minimum
Median
Mode
Most Frequent Values
Standard Deviation
Sum
Variance
Test Rule
Compare to Constant
Compare to Field
Is Blank
Is Duplicate
Is Null
Is Not Blank
Is Not Duplicate
Is Not Null
In Range
Matches Regex
Conversion Rule
String to Date
String to Double
String to Float
String to Integer
String to Long
String to Numeric
String to Time
String to TimeStamp
Function Rule
String Length
String LowerCase
String Trim
String UpperCase
String Encode Caverphone
String Encode Metaphone
String Encode Double-Metaphone
String Encode Soundex
String Encode RefinedSoundex
Designing and Executing Map
Exploring Map Editor
Creating a Map Using New Map Wizard
Creating a Map Without Joins Using Map Wizard
Creating a Map With Joins Using Map Wizard
Creating a Map Within Process Designer
Creating a Map Without Using Map Wizard
Setting Up Source Data
Specifying Source Connector, Parts, and Properties
Confirming Source Schema
Defining and Applying Filters to Source Data
Defining Sort Options
Defining Sample
Browsing Source Data
Clearing Source Connection
Saving and Reusing Source Configuration
Setting Up Join Sources
Specifying New Schema for Join
Deleting Join
Setting Up Target Data
Specifying Target Connector, Parts, and Properties
Target Output Modes
Confirming Target Schema
Defining and Applying Filters to Target Data
Defining Sample
Browsing Target Data
Find Dialog
Clearing Target Connection
Saving and Reusing Target Configuration
Managing Multiple Targets
Adding Multiple Targets
Editing Target
Deleting Target
Viewing Map File Properties
Saving a Map as RTC File
Saving and Reusing a Connection
Refreshing Map Connection Schema
Reconnecting Target Connector
Setting Up Multimode Target Connectors
Setting Up Multimode Target Connectors
Setting Up Multimode Target Connector Using Multimode Wizard
Setting Up Multimode Target Connector Without Using Multimode Wizard
Managing Constants
Adding Constants
Searching Constant
Deleting Constant
Example
Managing Intermediate Targets
Managing Lookups
Lookup Types
Adding Lookups
Deleting Lookups
Managing Temporary Targets
Adding Temporary Targets
Specifying New Schema for Temporary Target
Deleting Temporary Targets
Setting Up Reject Data
Confirming Reject Schema
Using Reject Data Browser
Clearing Reject Connection
Saving Reject Configuration
Using Map Navigator
Configuring Map
Configuring Macros
Using Script Library Files
Adding EZscript Library File
Removing EZscript Library File
Defining Global Variables
Configuring Map Events
Adding Map Event
Modifying Map Event
Deleting Map Event
Configuring Logging Options for a Map
Configuring Engine Profiler
Configuring Execution Options for a Map
Mapping Target from Source Data
Mapping Methods
Common Options
Mapping Fields Using Simple View
Mapping Fields Using Advanced View
JSON Map Advanced View - Nodes and Actions
Common Tasks in Simple View and Advanced View
Dragging and Dropping Fields From Source to Target
Using Map Recommend
Mapping Fields Using Recommend Option
Mapping Fields By Name
Mapping Fields by Position
Applying Default Values for Target Field Expressions
Other Ways to Map Target Fields
Target File Mapping Scenarios
Custom Search Navigator
Managing Record Types in Advanced View
Adding Record Type
Deleting Record Type
Duplicating Record Type
Managing All Record Instances in Advanced View
Specifying Record Instance Properties
Deleting Root Record Reference
Managing Groups in Advanced View
Adding a Group
Deleting a Group
Managing Field Records in Advanced View
Adding Field Record
Managing Events and Actions
ECA Rules
Rules for Events added Using Map Wizard
Events and Actions
Managing Events and Actions in Advanced View
Managing Record Rules in Advanced View
Managing Recognition Rule sets and Rules
Adding Target Record Write Condition Rules in Advanced View
Validating Maps
Validating a Map
Running Maps
Troubleshooting Map Execution
Migrating Connectors in an Existing Map
Map Connectors
Types of Connections
File Connections
Physical Data Connections
Intermediate Import and Export Format Connections
XML Support
XML Schema (W3C XSDL)
eDoc Connections
Data File Formats
HDFS Connectivity
Database Connections
ODBC and Other Middleware Connections
SQL Connections
Cursors
Installing an ODBC Driver
ODBC Connectivity Tips
Oracle Connectivity Guidelines
Application Connections
Native API Connections
Batch Response File
Legacy Systems
Unknown Application or File Format Connections
Intermediate Methods to Connect to Data Formats
URI Connections
URI Support In Actian DataConnect
Internet URL Format
URI Parameters
Escape Characters
Non-routable Addresses
Limitations
Source and Target Map Connectors
Actian Warehouse
Actian Warehouse Multimode
Actian Extract
Actian Ingres (ODBC 3.x)
Actian Vector
Actian Vector (Delimited)
Actian Vector Multimode
Actian X
Actian X Multimode
Actian Zen
Actian Zen Multimode
ACUCOBOL-GT Version 7
Apache Common Logfile Format
ASCII (Delimited)
ASCII (Fixed)
Binary
Binary (International)
Binary Line Sequential
Btrieve 10
COBOL Flat File
Common Logfile Format Webserver
Data Junction Log File
dBASE IV
DIF
EDI X12 (eDoc)
EDIFACT (eDoc)
Excel 97 and Excel 2000
Excel 2007, Excel 2010, and Excel (xlsx)
Excel 365
Excel 365 Multimode
Folio Flat File
FoxPro
HCL Informix 14.10 Server
HCL Informix Dynamic Server 14.10 Multimode
HCL OneDB
HCL OneDB Multimode
HIPAA (eDoc)
HL7 (eDoc)
HTML
IBM DB2 9.7
IBM DB2 9.7 Multimode
IBM DB2 10
IBM DB2 10 Multimode
IBM DB2 11.5 Universal Database
IBM DB2 11.5 Universal Database Multimode
IBM DB2 Loader
IBM DB2 Universal Database 9.5
IBM DB2 Universal Database 9.5 Multimode
Integration Log File
JDBC
JDBC Multimode
JSON
JSON Multimode
LDIF
Lotus 123
Micro Focus Cobol
Microsoft IIS Extended Logfile Format
Microsoft SQL Azure
Microsoft SQL Azure Multimode
MUMPS (ODBC)
MySQL (ODBC 3.5)
Netezza
NetSuite
NetSuite Multimode
Null
OData
ODBC 3.5
ODBC 3.5 Mass Insert
ODBC 3.5 Multimode
ODBC 3.x
ODBC 3.x Mass Insert
ODBC 3.x Multimode
Oracle 10g, 11g, 12c, and 19c
Oracle 10g, 11g, 12c and 19c Multimode
Oracle 10g, 11g, 12c and 19c Direct Path
Oracle CRM On Demand
Oracle SQL Loader
PayChex (DJF) Import
PostgreSQL
PostgreSQL Multimode
PostgreSQL (ODBC 3.x)
Process and Transformation LogFile Parser
Rich Text Format
Salesforce
SAP IDoc (eDoc)
SAS Transport Format
Sequential Binary
ServiceNow
ServiceNow Multimode
SGML
SQL Script
SQL Server 7 (OLEDB)
SQL Server 7 Mass Insert (OLEDB)
SQL Server 7 Multimode (OLEDB)
SQL Server 2000
SQL Server 2000 Mass Insert
SQL Server 2000 Multimode
SQL Server 2005
SQL Server 2005 Mass Insert
SQL Server 2005 Multimode
SQL Server 2008
SQL Server 2008 Mass Insert
SQL Server 2008 Multimode
SQL Server 2012
SQL Server 2012 Mass Insert
SQL Server 2012 Multimode
SQL Server 2016
SQL Server 2016 Mass Insert
SQL Server 2016 Multimode
SQL Server 2019
SQL Server 2019 Mass Insert
SQL Server 2019 Multimode
SQL Server BCP
SWIFT (eDoc)
Sybase Adaptive Server 12.x and 15.x
Sybase Adaptive Server 12.x and 15.x Multimode
Teradata (Fastload)
Text (Delimited - EDI)
Text (Delimited - EDIFACT)
Unicode (Delimited)
Unicode (Fixed)
Variable Sequential (MVS)
Variable Sequential (Record-V UniKix)
Variable Sequential (SyncSort)
Variable Sequential (User Defined)
Visual dBASE 5.5
Visual FoxPro
XDB (ODBC 3.x)
XML-DMS
XML-DMS Multimode
Deprecated Connectors
Encoding Reference
Constant Values for Encoding Parameters in EZscript
Determining Which Connector to Use
Flat File Connectors
Unicode or ASCII
Character Encoding
Unicode Source Data
Unicode Target Data
Troubleshooting the Replacement Character Issue
XML Connector
Database Connectors
Components
Encoding and Oracle Databases
Example Use Case
Encoding EZscript Functions and Objects
Encoding Functions
File Functions
EZscript DJMessage Objects
Understanding Unicode and Other Encoding Types
UTF Format Encoding in Applications
Non-Unicode Connectivity
Unicode and Encoding Checklist
Installing Language Sets
Installing Character Sets
Encoding Tips
Troubleshooting Encoding Issues
Unicode Limitations
Data Browser
Script Editor
Data Parser
Unicode Character Encodings
Byte Order Marks
Determining Field Width in Characters or Bytes
Field Width in Characters
Field Width in Bytes
Hex Values
Managing Schemas
Creating Schemas
Creating Schema Manually
Creating Schema Using Metadata Connector
Types of Metadata Connectors
Creating Schema Using External Connection
Creating Schema From Another Schema
Creating Schema Using Data Parser
Using Data Parser
Data Parser Display Mode Options
Hex Values Reference Chart
Creating Subset Schema From Master Schema
Exploring Schema Editor
Nodes in Schema Design Editor
Nodes in v9 Compatible XML Schema
Viewing Schema File Properties
Managing Records
Adding Records in JSON Schema
Duplicating Records in JSON Schema
Deleting Records in JSON Schema
Adding Records in XML Schema
Duplicating Records in XML Schema
Reordering Records in XML Schema
Deleting Records in XML Schema
Managing Fields in Records
Adding Fields to a Record in JSON Schema
Deleting Fields in a Record in JSON Schema
Reordering Fields in a Record in JSON Schema
Adding Fields to a Record in XML Schema
Deleting Fields in a Record in XML Schema
Reordering Fields in a Record in XML Schema
Managing Rules for a Record
Adding Recognition Rule in JSON Schema
Deleting Recognition Rule in JSON Schema
Reordering Recognition Rule in JSON Schema
Adding Recognition Rule in XML Schema
Deleting Recognition Rule in XML Schema
Reordering Recognition Rule in XML Schema
Adding Validation Rule in XML Schema
Updating Schemas
Scripting
EZscript Script Editor
Exploring EZscript File in Tab View
Exploring EZscript Expressions Window
Using Content Assist
Adding or Removing Bookmarks
EZscript Libraries
Using DJImport/DJExport Object Connection Wizard
Creating New DJImport or DJExport Object
Using Existing DJImport or DJExport Object
Writing Expressions
Basic Elements of an Expression
Operands
Operators
Parentheses
Functions
Statements
Scripting Keywords
Precedence in Evaluating Expressions
Commenting Out Code
Quotation Marks in Expressions
Specifying Field Names in Expressions
Continuing Lines in Expressions
Regular Expressions
Special Characters
Literal Values of Special Characters
Functions and Operators
Escaping Hex Values
Literal Values in Expressions
Using Scripts to Perform Specific Tasks
Parsing a Name Field Into Separate Fields
Example of Rearranging Order of a Name
Parsing a Source Field by Character
Specifying Ranges in Expressions
Converting Dates
Using Masks to Convert Two-Digit Dates
Mask Type for Two-Digit Dates, "YYdddd"
Filtering by Date
Setting Up Picture Masks
Formatting Boolean Data
Formatting Date/Time Data
Validating Data Types in Expressions
Calling External DLLs
Calling DLLs using a Declare statement
Examples of Calling External DLLs
Capturing Transformation Metadata
Handling Invalid Data
Retrieving Source and Target Metadata
Using DJRecord and DJField Objects to Access Metadata
Retrieving and Setting LogFile and LogMask Properties
Example
Setting the Scope of Functions
Script Functions
Script Functions A-F
Abs Function
Add1Fmt Function
Add1Part Function
Add2Part Function
Asc Function
B64Decode Function
B64Encode Function
Bin Function
CBool Function
CByte Function
CDate Function
CDbl Function
CDec Function
ChangeDirectory Function
ChangeFromUnicode Function
ChangeTimeZone Function
ChangeToUnicode Function
CharCount Function
Choose Function
Chr Function
CInt Function
Clean Function
ClearMacro Function
CLng Function
Compare Function
CSng Function
CStr Function
CurDir Function
Date Function
DateAdd Function
DateConvert Function
DateDiff Function
DatePart Function
DateSerial Function
DateValMask Function
DateValue Function
Day Function
DefineMacro Function
DeleteMessage Function
Discard Function
Environ Function
Eval Function
Exp Function
Extract Function
FieldAt Function
FileAppend Function
FileCopy Function
FileDateTime Function
FileDelete Function
FileExists Function
FileLen Function
FileList Function
FileRead Function
FileReadLine Function
FileRename Function
FileWrite Function
Filter Function
FindMessage Function
Fix Function
FlushLog Function
Format Function
Script Functions G-M
GetDirectory Function
GetThreadID Function
GetTimeZone Function
GSub Function
Hex Function
Hour Function
IIf Function
ILAddrow Function
ILBuild Function
ILClear Function
ILFirstKey Function
ILNextKey Function
ILookup Function
ILRemoveRow Function
Increment Function
InitCaps Function
InputBox Function
InStr Function
InStrRev Function
Int Function
IsArray Function
IsDate Function
IsDirectory Function
IsFile Function
IsMacroDefined Function
IsNull Function
IsNumeric Function
Join Function
LBound Function
LCase Function
Left Function
LeftB Function
Len Function
LenB Function
Log10 Function
Log Function
LogMessage Function
Lookup Function
LTrim Function
MacroExpand Function
MacroValue Function
MakeDirectory Function
Mid Function
MidB Function
Minute Function
Month Function
MsgBox Function
Script Functions N-Z
NamePart Function
Now Function
Null Function
Oct Function
Parse Function
ParseXMLFile Function
ParseXML Function
Print Function
RecordAt Function
Reject Function
RemoveDirectory Function
Replace Function
ReplaceAll Function
ResetLookup Function
Right Function
RightB Function
Rnd Function
Round Function
RTrim Function
Search Function
Second Function
Serial Function
SetTimeZone Function
Sgn Function
Shell Function
SignFlip Function
Sleep Function
SortArray Function
Space Function
Split Function
Stop Function
Str Function
StrComp Function
String Function
StrReplace Function
StrReverse Function
Sub Function
SubString Function
Switch Function
Terminate Function
TestMask Function
Time Function
TimeSerial Function
TimeStamp Function
TimeValue Function
TLookup Function
Transliterate Function
Trim Function
UBound Function
UCase Function
UnString Function
UTF8Decode Function
UTF8Encode Function
UUIDGenerate Function
Val Function
ValMask Function
Weekday Function
Xlate Function
XmlCData Function
Year Function
Script Operators
Arithmetic Operators
Multiply (*) Operator
Add (+) Operator
Difference (-) Operator
Integer Division (\) Operator
Numeric Division (/) Operator
Exponent (^) Operator
Mod Operator
Assignment (=) Operator
Assign (=) Operator
Comparison Operators
Less Than (<) Operator
Greater Than (>) Operator
Less Than or Equal To (<=) Operator
Greater Than or Equal To (>=) Operator
Contains (~) Operator
Does Not Contain (!~) Operator
Equals (==) Operator
Does Not Equal (<>) Operator
Concatenation (&) Operator
Concatenate (&) Operator
Logical Operators
And Operator
Or Operator
Not Operator
Like Operator
Important Pattern Matching Rules
Recognition Rule Operators
Any Value Operator
Between Operator
Like Operator
Regular Expression Operator
Script Statements
Using DJX to Create SQL Statements
Dynamic SQL Statements
DJXBegin and DJXEnd
Source Query Statement
Flow Control Statements
ElseIf Statement
For...Next Statement
GoTo Statement
For Each...Next Statement
If...Then...Else Statement
Select Case...End Case Statement
While...Wend Statement
Option Runtime Statements
Option Evaluate Automatic Statement
Option Evaluate Manual Statement
Option Explicit Statement
Option FieldExplicit Statement
Option FieldImplicit Statement
Option Implicit Statement
Option Math Fast Statement
Option Math Precise Statement
Option Math Strict Statement
Run-Time Error Trapping Statements
On Error GoTo Statement
On Error Resume Next Statement
Resume Label Statement
Resume Next Statement
Resume Statement
Declare Statement
Dim Statement
Function Statement
Global Statement
Include Statement
Option Base Statement
ReDim Statement
Return Statement
Variables
Scoping Variables
Scope Levels
Local Scope Notes
Public Scope Notes
Guidelines for Naming Variables
Variant Data Type
Array Variables
Referencing Elements in Arrays
Declaring Arrays
Storing Data in Arrays
Retrieving Data from Arrays
Clearing Variables and Array Elements
Managing Variables
Adding Global Variables
Editing Global Variables
Importing Global Variables
Deleting Global Variables
Script Objects
Object Properties
Read Write Abilities of Object Properties
Object Operators
Object Variables
Declaring Object Variables
Internal Object Variables for Mapping
Err Object Variable
DJRecord Object Type
Properties
Methods
Operators
DJField Object Type
Properties
DJImport and DJExport Object Types
Properties
Methods
Operators
Examples of DJImport Object Usage
DJExport Object Type Notes
Example of DJExport Object Type Usage
DJRowSet Object Type
Properties
Methods
Operators
DOMDocument Object Type
Properties
Methods
Operators
DOMNode Object Type
Properties
Methods
Operators
DJComponent Object Type
Messaging Support
Properties
Methods
Operators
DJMessage Object Type
Methods
Properties
Operators
Using a DJMessage Object with a Map
Creating Map File
Creating DJMessage Object Global Variable
Intializing a DJMessage Object
Adding a Transformation Step to a Process
Linking Steps in a Process
Creating a Configuration and Running a Process
Using DJMessage and DJComponent Objects in Expressions
Examples
RFH Header Support: Websphere MQ
RFH Header Guidelines and Properties
RFH2 Header Guidelines and Properties
Specifying RFH and RFH2 Headers
Websphere MQ Header Support
Supported Header Types
Examples
Java Objects in Scripts
Class Objects
Transformation Object
Project Object
Properties
Errors
Examples
Script Troubleshooting
Novice Troubleshooting Suggestions
Use the most efficient function for your task
Understand the difference between syntax errors and errors in logic
Use comments to document your expressions
Intermediate to Advanced Suggestions
Assign a variable in the code to speed up your transformations
Use the Option Explicit statement
Use functions that signal errors in processing
Use Resume and Resume Next appropriately
Use the correct operator for the job
Learn about flow control for faster processing
Stack Overflow
Example 1 (Incorrect)
Example 2 (Correct)
64-Parameter Limitation in Function Arguments
Expression Tester Utility
Using the Expression Tester
Using Flags
Debugger Commands
Script Debugging
Debugging Prerequisites
Debug Toolbar and Menu Options
Debug Tab
Accessing EZscript Debugger
Adding and Removing Breakpoints
Using Extract Editor
Data Extraction Process
Creating Extract Editor File
Extract Editor
Extract Editor Toolbar Options
Viewing Extract File Properties
Configuring Extract Editor Options
Defining Line Styles
Recognition Rules
Recognition Rules
Finding Logical Record Breaks
Adding Line Styles
Line Style Icons
Editing Line Style
Deleting Line Style
Reordering Line Styles
Defining Fields
Adding Field Definition
Editing Field Definition
Deleting Field Definition
Assigning Fields to Accept Records
Managing Accept Record’s Field Layout
Browsing Data
Parsing Data Automatically
Generating Extract Script
Using Extract Script in Map Editor
Other Features
Undo/Redo Operation
Finding Content
Viewing Line Style Matches
Status Bar Information
Meta Characters supported in Regular Expression
Using Content Extraction Language
Supported Text Files
Supported Operations
Use of Content Extraction in the Integration Platform
Script Examples
CXL Scripts
Basic Syntax
Script Structure
Script Execution
Script Licensing
A Simple Script Example
Language Elements
CXL Character Set
Keywords
Numeric and String Constants
Variables and Fields
User-Defined Variables
Built-in Variables
Field Variables
Variable Typing and Conversion
Operators
Arrays
One-Dimensional Arrays
Associative Arrays
Multidimensional Arrays
Array Iteration
Functions
Built-in Functionality
User-Defined Functions
Rules and Limitations for Variables in a User Defined Function
Variables Definitions
Return
Pattern Matching and Action Statements
CXL Patterns
BEGIN { statements }
END { statements }
CATCHUP { statements }
Expressions in Patterns
Regular Expression
/regular expression/ { statements }
Metacharacters
Comparison Expressions
CXL Comparison Operators used in Comparison Expression Patterns
Actions and Statements
Expressions in Statements
Comment Statements
Reinitialize Statement
Assignment Statements
Catchup Statements
Control Statements
Output Statements
Integrating with Map Designer
Map Designer Setup
Source Type
Source Data File
CXL Script
Map Designer Results
Connect
Process Script
Refresh Script
Source Data Browser and Source Schema
DJXLPACK - Script Compressing and Encoding
Script Errors and Debugging Tips
Syntax Errors
Logic Errors
Debugging Techniques
Trace
Comments
Logmessage
Source Data Browser
Language Syntax and Examples
!=
!~
# comment
$
$n
&&
*
+
+=
-
.
/
/ regular expression /
<
<=
=
= =
>
>=
?
{ and }
[ and ]
\
^
||
~
in
|
r1r2
stop;
accept explist;
asc (string);
BEGIN { statements }
break;
catchup on;
catchup off;
CATCHUP { statements }
Chr (n)
cleararray ( array );
clearvars;
EBCDIC
ENCODING
END { statements }
Fix (number)
for ( index in array ) { statements }
gsub ( reg, sub, var );
if ( condition ) { statements } else { statements }
IFS
ILS
InitCaps (string)
Int (number)
IsNumeric (value)
LCase (strexpr)
Left (strexpr, n)
length ( var );
logmessage ( warningtype, format, parm1, parm2 );
ltrim ( var );
NamePart ("[h] [f] [m] [mi] [l] [t]", "string")
Part Description
NF
NR
readahead ( num );
REGPOS
REGLEN
reject;
Right (strexpr,n)
rtrim ( var );
Sgn (number)
shift;
skip ( num );
Space (number)
split ( var, array, fs );
String (number, string)
sub ( reg, sub, var );
substr ( var, pos, len );
TABS
TRACE ON
TRACE OFF
Transliterate (source_char_set, target_char_set, string)
trim ( var );
UCase (strexpr)
Val (string)
var [ num ]
var ( j k )
while ( condition ) { statements }
Script Examples
Example Script 1: Fixed-Format Report
Example Script 2: Multicolumn Record Reports
Example Script 3: Tagged Reports
Example Script 4: One-To-Many Item Reports
Example Script 5: Multirecord Type Hierarchical Reports
Example Script 6: User Defined Functions, Arrays, and Loops
CXL Quick Reference
Basics
Variables and Fields
Built-in Variables
Field Variables
Built-in Functions
Operations
CXL Patterns
Regular Expression Summary
Statements in Actions
Using Engine Profiler
Enabling Engine Profiling
Viewing Profile Output File
Statistics Tab
Iteration and Time Histogram Tabs
Call Graph Tab
File Format of the Profile Output File
Packaging and Deploying Integration Artifacts
Specifying Package File Location
Creating a Package
Package Inventory File
Package (djar) File
Package Inventory Changes Pop-up Message
Viewing Integration Manager Configurations
Adding an Integration Manager Connection
Importing Configurations into a Workspace
Editing Configurations
Deploying to Integration Manager
Redeploying to Integration Manager
Using Runtime Engine
Invoking Runtime Engine Using CLI
Running Multiple Actian DataConnect Versions
Runtime Engine Command Line Interface
Runtime Engine Command Line Syntax and Usage
Running a Map
Running a Process
Running Multiple Maps or Processes
Running a Map or Process in djar
Running a Map or Process (XML)
Running Multiple Maps and Processes (XML)
Specification Files
Additional Information
Quotes and Escape Characters
Single Quotes
Double Quotes
Control Characters in Double Quotes
Override Strings Enclosed in Double Quotes
Command Line Options
Global Options
Transformation Options
Process Options
Command Line Options (XML Files)
Global Options (XML Files)
Djar Utility
Error Codes and Messages
Using Design Templates
Template Location
Getting Started with Templates
Importing Templates Automatically
Importing Templates Manually
Modifying Macro Definition File
Non-template Resources
Error Codes and Messages
Engine Error Codes
Scripting Language Error Codes
Run-time Error Values
Integration Language Run-time Errors
Untrappable Error Codes
Message Component Framework Engine Error Codes
Frequently Asked Questions (FAQs)
What SDKs are available?
Has the scripting language changed?
Does the engine still support version 9 djengine commands?
Are 32-bit operating systems still supported?
What version of Java is supported?
Is multi-threading supported?
Does the Expression Results control panel still work?
Is the engine execution profiler still available?
What are the deployment options for runtime?
Does Change Source and Change Target still work?
Can the metadata be accessed and edited directly?
Are the e-Document connectors like EDI, HIPAA, HL7, and SWIFT still supported?
Is there a Developer Community?
Are third party source control systems supported?
What different types of life cycle management or versioning features are available?
Is Integration Hub (iHub) still supported?
Does Content Extractor Editor (earlier called as Extract Schema Designer work in version 12?
Introduction
Frequently Asked Questions (FAQs)