You are on page 1of 456

OpenText ContentBridge

User Guide

This text should outline the purpose and contents of your


document in a few words. It will appear on the title page, in the
PI Root document lists (on the KC and in downloaded
documentation packages) and maybe will also at other location
to introduce the document in a documentation overview.

EDCCM210200-UGD-EN-1
OpenText ContentBridge
User Guide
EDCCM210200-UGD-EN-1
Rev.: 2021-May-31
This documentation has been created for OpenText ContentBridge CE 21.2.
It is also valid for subsequent software releases unless OpenText has made newer documentation available with the product,
on an OpenText website, or by any other means.

Open Text Corporation

275 Frank Tompa Drive, Waterloo, Ontario, Canada, N2L 0A1

Tel: +1-519-888-7111
Toll Free Canada/USA: 1-800-499-6544 International: +800-4996-5440
Fax: +1-519-888-0677
Support: https://support.opentext.com
For more information, visit https://www.opentext.com

Copyright © 2021 Open Text. All Rights Reserved.


Trademarks owned by Open Text.

One or more patents may cover this product. For more information, please visit https://www.opentext.com/patents.

Disclaimer

No Warranties and Limitation of Liability

Every effort has been made to ensure the accuracy of the features and techniques presented in this publication. However,
Open Text Corporation and its affiliates accept no responsibility and offer no warranty whether expressed or implied, for the
accuracy of this publication.
Table of Contents
1 Introduction to ContentBridge ............................................... 13

2 Sample applications of ContentBridge ................................. 17


2.1 Cleaning your data .......................................................................... 17
2.2 Import data from a purchased list ..................................................... 17
2.3 Sending data to your customers ....................................................... 18

3 The ContentBridge Tutorial .................................................... 19


3.1 Run ContentBridge .......................................................................... 20
3.2 Reading a file .................................................................................. 21
3.2.1 Read Text File Wizard - File Definition .............................................. 21
3.2.2 Read Text File Wizard - File Format ................................................. 23
3.2.3 Read Text File Wizard - Schema ...................................................... 24
3.3 Review the data .............................................................................. 24
3.4 Validate the data ............................................................................. 25
3.5 Transform the data .......................................................................... 28
3.5.1 Add a new field ............................................................................... 29
3.5.2 Split a field ...................................................................................... 30
3.6 Write the data to a file ...................................................................... 33
3.6.1 Write Text File Wizard - File Location ............................................... 33
3.6.2 Write Wizard - File Format ............................................................... 34
3.6.3 Execute Write Text File Function ...................................................... 35
3.7 Write to MS Access ......................................................................... 36
3.7.1 Write to MS Access - more .............................................................. 37
3.8 A Final Tidy Up ............................................................................... 38

4 Using ContentBridge ............................................................... 41


4.1 ContentBridge Map ......................................................................... 42
4.2 ContentBridge Map - Manipulating objects ........................................ 44
4.3 ContentBridge Map - Data Toolbar ................................................... 44
4.4 ContentBridge context menus .......................................................... 45
4.5 ContentBridge Map - Functions Toolbar ............................................ 46
4.6 ContentBridge Map - Functions Toolbar (General) ............................. 47
4.7 ContentBridge Map - Functions Toolbar (Import) ............................... 49
4.8 ContentBridge Map - Functions Toolbar (Export) ............................... 51
4.9 ContentBridge Map - Output Toolbar ................................................ 54
4.10 ContentBridge Map - Data Toolbar ................................................... 54
4.11 The Menu ....................................................................................... 55
4.12 Options .......................................................................................... 58
4.13 ContentBridge Themes .................................................................... 62
4.14 Map Properties ............................................................................... 65

EDCCM210200-UGD-EN-1 User Guide iii


Table of Contents

5 Basic Functions ....................................................................... 67


5.1 Read a text file ................................................................................ 67
5.1.1 Select File ...................................................................................... 68
5.1.2 Define Format ................................................................................. 70
5.1.3 Review Schema .............................................................................. 71
5.2 Read MS Excel ............................................................................... 72
5.2.1 Select Spreadsheet ......................................................................... 73
5.2.2 Select Range of Cells ...................................................................... 73
5.2.3 Preview Data .................................................................................. 75
5.3 Read MS Excel Advanced ............................................................... 76
5.3.1 Select Spreadsheet ......................................................................... 77
5.3.2 Select Range of Cells ...................................................................... 78
5.3.3 Preview Data .................................................................................. 78
5.4 Read MS Access ............................................................................ 80
5.4.1 Select Database ............................................................................. 81
5.4.2 Select Table ................................................................................... 81
5.4.3 Preview Database ........................................................................... 82
5.5 Read MySQL .................................................................................. 83
5.5.1 Select the Server ............................................................................ 85
5.5.2 Select the Database ........................................................................ 86
5.5.3 Select the Table .............................................................................. 86
5.5.4 Preview the Data ............................................................................. 87
5.6 Read Microsoft SQL Server Database .............................................. 88
5.6.1 Select the Server ............................................................................ 90
5.6.2 Select the Database ........................................................................ 90
5.6.3 Select the Table or View .................................................................. 91
5.6.4 Preview the Data ............................................................................. 92
5.7 Read a SQL Compact database ....................................................... 93
5.7.1 Select the Database ........................................................................ 94
5.7.2 Select the Table .............................................................................. 95
5.7.3 Preview the Data ............................................................................. 95
5.8 Read an Oracle database ................................................................ 96
5.8.1 Select the Server ............................................................................ 97
5.8.2 Select the Table or View .................................................................. 98
5.8.3 Preview the Data ............................................................................. 99
5.9 Read an ODBC data source .......................................................... 100
5.9.1 Select the ODBC Database ........................................................... 101
5.9.2 Select the Table or View ................................................................ 103
5.9.3 Preview the Data ........................................................................... 104
5.10 Read an OLE DB Provider ............................................................. 105
5.10.1 Select the OLE DB Provider ........................................................... 106

iv OpenText ContentBridge EDCCM210200-UGD-EN-1


Table of Contents

5.10.2 Select the Table or View ................................................................ 109


5.10.3 Preview the Data ........................................................................... 110
5.11 Read an XML file .......................................................................... 111
5.11.1 Select the XML file ........................................................................ 112
5.11.2 Preview the Data ........................................................................... 113
5.12 Validate Data ................................................................................ 114
5.12.1 Validate data - using OR, AND and NOT ........................................ 116
5.12.2 Validate data - Dispositions ............................................................ 118
5.12.3 Validate Inputs Toolbar .................................................................. 118
5.12.4 Validate Functions Toolbar ............................................................ 119
5.12.5 Validate Functions Toolbar (Date & Time) ....................................... 120
5.12.6 Validate Functions Toolbar (String) ................................................ 121
5.12.7 Validate Functions Toolbar (General) ............................................. 123
5.13 Transform data ............................................................................. 124
5.13.1 Transform Toolbar (Inputs) ............................................................ 126
5.13.2 Transform Toolbar (Outputs) .......................................................... 126
5.13.3 Transform Toolbar (Functions) ....................................................... 127
5.13.4 Transform Toolbar (String Functions) ............................................. 129
5.13.5 Transform Toolbar (General Functions) .......................................... 130
5.13.6 Auto-Map ..................................................................................... 131
5.13.7 Transform - Output Schema ........................................................... 132
5.14 De-Duplicate data ......................................................................... 133
5.14.1 Define Columns ............................................................................ 134
5.14.2 Define Matching Rules .................................................................. 135
5.14.3 Results of a De-Duplication ............................................................ 136
5.15 Merge data ................................................................................... 137
5.16 Sort data ...................................................................................... 138
5.17 Custom Table ............................................................................... 139
5.18 Write to a text file .......................................................................... 141
5.18.1 Select File .................................................................................... 143
5.18.1.1 Parameterized File Name .............................................................. 144
5.18.2 Define Format ............................................................................... 144
5.18.3 Define Schema ............................................................................. 146
5.19 Write MS Access ........................................................................... 146
5.19.1 Select Database ........................................................................... 148
5.19.2 Select Table ................................................................................. 149
5.20 Write MySQL ................................................................................ 149
5.20.1 Select the Server .......................................................................... 150
5.20.2 Select the Database ...................................................................... 151
5.20.3 Select the Table ............................................................................ 152
5.21 Write Microsoft SQL Server ........................................................... 154
5.21.1 Select the Server .......................................................................... 155

EDCCM210200-UGD-EN-1 User Guide v


Table of Contents

5.21.2 Select the Database ...................................................................... 156


5.21.3 Select the Table ............................................................................ 156
5.22 Write to a SQL Compact database ................................................. 158
5.22.1 Select the Database ...................................................................... 159
5.22.2 Select the Table ............................................................................ 159
5.23 Write to an Oracle database .......................................................... 160
5.23.1 Select the Server .......................................................................... 162
5.23.2 Select the Table ............................................................................ 162
5.24 Write to an ODBC database ........................................................... 163
5.24.1 Select the ODBC Database ........................................................... 165
5.24.2 Select the Table ............................................................................ 166
5.25 Write to an OLE DB Provider ......................................................... 167
5.25.1 Select OLE DB Provider ................................................................ 169
5.25.2 Select Table ................................................................................. 172
5.26 Write to an XML file ....................................................................... 173
5.26.1 Write XML file properties ............................................................... 176
5.26.2 Object Importer ............................................................................. 176
5.27 Executing a Map ........................................................................... 177
5.27.1 Execute mode ............................................................................... 178
5.28 Trial Mode .................................................................................... 178
5.29 Batch Processing .......................................................................... 179
5.30 Database and File Reads .............................................................. 181
5.31 Sample Maps installed with ContentBridge ..................................... 182
5.31.1 Sample Map - Flat File .................................................................. 183
5.31.2 Sample Map - Reference Table ...................................................... 184
5.31.3 Sample Map - Normalize Data ....................................................... 186
5.31.4 Sample Map - Read Emails from Outlook ....................................... 187
5.31.5 Sample Map - Contact Name Split .................................................. 188
5.31.5.1 Sample Map - Contact Name Split (Input) ....................................... 191
5.31.5.2 Sample Map - Contact Name Split (Output) .................................... 192
5.31.6 Sample Map - Validate Field Length ............................................... 192
5.31.7 Sample Map - Object Importer ....................................................... 193
5.31.8 Sample Map - InfoArchive Load and Ingest Mode ........................... 193
5.31.9 Sample Map - InfoArchive Ingest Only Mode ................................... 194
5.31.10 Sample Map - Update & Insert Data ............................................... 195

6 Advanced Functions ............................................................. 197


6.1 DCTM QC Validation ..................................................................... 197
6.1.1 Using Session Manager in DCTM_QC_Validation ........................... 198
6.2 Add To Documentum Queue .......................................................... 201
6.2.1 Required Attributes for Successful Load ......................................... 202
6.3 Cloud Configuration ...................................................................... 203

vi OpenText ContentBridge EDCCM210200-UGD-EN-1


Table of Contents

6.4 DeDupAndCombine ...................................................................... 204


6.5 Read From DCTM ......................................................................... 206
6.5.1 Integrated Config .......................................................................... 207
6.5.1.1 DataDictionary Configurations ........................................................ 208
6.5.2 Export .......................................................................................... 209
6.5.3 Export to Cloud Storage ................................................................ 214
6.6 Read Zip Archival .......................................................................... 215
6.7 Read from OTCS .......................................................................... 218
6.7.1 Integrated Config .......................................................................... 218
6.7.1.1 DataDictionary Configurations ........................................................ 219
6.7.2 Export .......................................................................................... 219
6.8 Read From DocumentumDB .......................................................... 223
6.8.1 Prerequisites ................................................................................ 223
6.8.2 Data Dictionary Configurations ....................................................... 223
6.8.3 Configurations for Oracle ............................................................... 224
6.8.4 Configurations for MS SQL Server ................................................. 228
6.9 Update Documentum DB ............................................................... 233
6.9.1 Prerequisites ................................................................................ 233
6.9.2 Configurations for Oracle ............................................................... 234
6.9.3 Configurations for MS SQL Server ................................................. 235
6.10 Load Into DCTM ........................................................................... 238
6.10.1 Prerequisites ................................................................................ 238
6.10.2 Integrated Config .......................................................................... 238
6.10.3 Using Session Manager in Load Into Documentum ......................... 242
6.10.4 Required Attributes for Successful Load ......................................... 244
6.10.5 Data Dictionary Configurations ....................................................... 248
6.10.6 Loading data into Documentum ...................................................... 256
6.10.7 Import from Cloud Storage ............................................................. 260
6.11 Create Objects in DCTM ................................................................ 261
6.11.1 Integrated Config .......................................................................... 265
6.11.2 Using Session Manager in Create Objects in DCTM ........................ 266
6.12 Read From SharePoint .................................................................. 269
6.12.1 SharePoint Export (Using CSOM) .................................................. 269
6.13 Write To SharePoint ...................................................................... 273
6.13.1 Prerequisites ................................................................................ 274
6.13.2 DataDictionary Configurations ........................................................ 274
6.14 EmailTable ................................................................................... 275
6.15 Write To File Share ....................................................................... 277
6.15.1 PreRequisites ............................................................................... 278
6.16 eRoom Exporter ............................................................................ 278
6.17 Read File Folders .......................................................................... 281
6.18 Session Manager .......................................................................... 283

EDCCM210200-UGD-EN-1 User Guide vii


Table of Contents

6.18.1 Save Credentials using Session Manager ....................................... 284


6.19 DCTM Compare ............................................................................ 285
6.19.1 Compare Definitions ...................................................................... 286
6.19.2 Compare Options .......................................................................... 287
6.20 Attribute Validations ...................................................................... 288
6.20.1 Validation Modes .......................................................................... 289
6.20.1.1 Default Validation: ......................................................................... 289
6.20.1.2 DQL Validation: ............................................................................. 289
6.20.1.3 D2 Validation ................................................................................ 289
6.20.2 Logging Levels .............................................................................. 290
6.21 Read From eRoom ........................................................................ 290
6.22 Email Exporter .............................................................................. 292
6.22.1 Data Dictionary Configurations ....................................................... 298
6.23 Load Into InfoArchive .................................................................... 299
6.23.1 InfoArchive Basics ......................................................................... 299
6.23.2 Creating SIP Package ................................................................... 300
6.23.3 Submission ................................................................................... 301
6.23.3.1 Data Submission Session (DSS) .................................................... 301
6.23.3.2 Operational Modes ........................................................................ 301
6.23.4 Using InfoArchive Addin ................................................................ 302
6.23.4.1 Prerequisite .................................................................................. 302
6.23.4.2 Sample Map ................................................................................. 302
6.23.4.3 Configurations .............................................................................. 303
6.24 XSD to DBS Converter .................................................................. 311
6.25 Load Into OpenText ...................................................................... 312
6.25.1 Prerequisites ................................................................................ 313
6.25.2 Required Attributes for Successful Load ......................................... 314
6.25.3 Configure a Category in OpenText Content Server .......................... 316
6.25.4 Configured Data Dictionary ............................................................ 316
6.25.5 Loading Data into OpenText .......................................................... 318
6.26 Write to Excel ............................................................................... 320
6.26.1 Select a File .................................................................................. 320
6.26.1.1 Parameterized File Name .............................................................. 321
6.26.2 Define the Format ......................................................................... 321
6.26.3 Define the Schema ........................................................................ 321

7 Reference ............................................................................... 323


7.1 Function Properties ....................................................................... 323
7.2 Reference to the Validate Functions ............................................... 324
7.2.1 .NET Script ................................................................................... 325
7.2.2 1st - 4th, Last, Current, Next Quarter .............................................. 327
7.2.3 Alpha ........................................................................................... 328

viii OpenText ContentBridge EDCCM210200-UGD-EN-1


Table of Contents

7.2.4 Alpha Numeric .............................................................................. 329


7.2.5 AM, PM ........................................................................................ 329
7.2.6 AND ............................................................................................. 330
7.2.7 Argentine Post Code ..................................................................... 331
7.2.8 Australian Post Code ..................................................................... 331
7.2.9 Australian Telephone Number ........................................................ 332
7.2.10 Belgian Post Code ........................................................................ 332
7.2.11 BinaryLookup ................................................................................ 333
7.2.12 Brazilian Post Code ....................................................................... 334
7.2.13 Compare ...................................................................................... 335
7.2.14 Contains ....................................................................................... 337
7.2.15 Credit Card Number ...................................................................... 339
7.2.16 Dutch Post Code ........................................................................... 339
7.2.17 Email Address .............................................................................. 340
7.2.18 Ends With ..................................................................................... 340
7.2.19 European Post Code ..................................................................... 341
7.2.20 Forename/s Last Name ................................................................. 343
7.2.21 French Post Code ......................................................................... 343
7.2.22 Fuzzy Compare ............................................................................ 344
7.2.23 German Post Code ....................................................................... 345
7.2.24 IP Address .................................................................................... 345
7.2.25 ISBN Number ............................................................................... 346
7.2.26 Italian Post Code ........................................................................... 346
7.2.27 January - December, Last, Current, Next Month .............................. 347
7.2.28 Last, Current, Next Financial Year .................................................. 347
7.2.29 Last, Current, Next Hour ................................................................ 348
7.2.30 Last, Current, Next Year ................................................................ 348
7.2.31 Length .......................................................................................... 349
7.2.32 Lookup ......................................................................................... 350
7.2.33 Lookup - a tutorial ......................................................................... 351
7.2.34 Monday - Sunday, Yesterday, Today, Tomorrow ............................. 353
7.2.35 Not ............................................................................................... 354
7.2.36 Not Empty .................................................................................... 355
7.2.37 Not Null ........................................................................................ 355
7.2.38 Null .............................................................................................. 356
7.2.39 Numeric ........................................................................................ 356
7.2.40 OR ............................................................................................... 357
7.2.41 Range .......................................................................................... 357
7.2.42 Regular Expression ....................................................................... 358
7.2.43 South African Cellular Number ....................................................... 360
7.2.44 Spanish Post Code ....................................................................... 361
7.2.45 Starts With .................................................................................... 361

EDCCM210200-UGD-EN-1 User Guide ix


Table of Contents

7.2.46 Last Name (detailed) ..................................................................... 363


7.2.47 Swedish Post Code ....................................................................... 363
7.2.48 Swedish Telephone Number .......................................................... 364
7.2.49 UK Bank Sort Code ....................................................................... 364
7.2.50 UK Car Registration ...................................................................... 365
7.2.51 UK National Insurance Number ...................................................... 366
7.2.52 UK Post Code ............................................................................... 366
7.2.53 UK Telephone Number .................................................................. 367
7.2.54 URL ............................................................................................. 367
7.2.55 US or Canadian Zip Code .............................................................. 368
7.2.56 US Social Security Number ............................................................ 368
7.2.57 US State Abbreviation ................................................................... 369
7.2.58 US Telephone Number .................................................................. 369
7.2.59 US Zip Code ................................................................................. 370
7.2.60 US, Canadian or UK Zip Code ....................................................... 370
7.2.61 Valid Date ..................................................................................... 371
7.3 Reference to the Transform Functions ............................................ 372
7.3.1 .NET Script ................................................................................... 372
7.3.2 Abbreviate .................................................................................... 374
7.3.3 Append ........................................................................................ 376
7.3.4 BinaryLookup ................................................................................ 377
7.3.5 Concatenate ................................................................................. 378
7.3.6 Doc ID Lookup .............................................................................. 379
7.3.7 Delete .......................................................................................... 385
7.3.8 First Non Null ................................................................................ 387
7.3.9 If .................................................................................................. 388
7.3.10 Left .............................................................................................. 390
7.3.11 Left Delete .................................................................................... 391
7.3.12 Left Trim ....................................................................................... 393
7.3.13 Length .......................................................................................... 394
7.3.14 Literal Value ................................................................................. 394
7.3.15 Lookup ......................................................................................... 395
7.3.16 Lower Case .................................................................................. 396
7.3.17 Middle .......................................................................................... 397
7.3.18 Name Split .................................................................................... 398
7.3.19 Pad .............................................................................................. 401
7.3.20 Prefix ........................................................................................... 402
7.3.21 Proper Case ................................................................................. 402
7.3.22 Remove ........................................................................................ 403
7.3.23 Repeating Lookup ......................................................................... 404
7.3.24 Replace ........................................................................................ 407
7.3.25 Right ............................................................................................ 408

x OpenText ContentBridge EDCCM210200-UGD-EN-1


Table of Contents

7.3.26 Right Delete .................................................................................. 409


7.3.27 Right Trim ..................................................................................... 411
7.3.28 Sentence Case ............................................................................. 412
7.3.29 Sequence ..................................................................................... 412
7.3.30 Split ............................................................................................. 413
7.3.31 ToBoolean,ToDataTime...... ........................................................... 415
7.3.32 Trim ............................................................................................. 418
7.3.33 Upper Case .................................................................................. 418

8 Notes on Databases .............................................................. 419

9 Maintaining Abbreviations .................................................... 423

10 Importing Maps From Previous Versions ........................... 425

11 Names Definition Editor ........................................................ 427

12 Building the Map and the Data Schema .............................. 429

13 Writing .NET Script ................................................................ 431


13.1 Compilation Settings ..................................................................... 432
13.2 Source Code ................................................................................ 434
13.3 Compilation Result ........................................................................ 434
13.4 Execution ..................................................................................... 435

14 Substituting settings when a map executes ....................... 437

15 Content Bridge InfoArchive (IA) App Creator ..................... 439


15.1 Introduction ................................................................................... 439
15.2 Prerequisites ................................................................................ 439
15.3 Run the IA App Creator ................................................................. 439
15.4 Configuring IA URL’s and REST Endpoints ..................................... 439
15.5 Creating the IA Application ............................................................ 440

16 Troubleshooting .................................................................... 443


16.1 Microsoft Office 32 Bit Support ....................................................... 446
16.2 Obtaining Technical Support .......................................................... 447

17 Dashboard Integration .......................................................... 449


17.1 Executing Entire Map .................................................................... 450
17.2 Executing Single Step/Function at a time ........................................ 451
17.3 Executing Single Step/Function with Cascading Option ................... 451

18 Uninstalling ContentBridge .................................................. 453

19 Appendix A-Supported Databases ...................................... 455

EDCCM210200-UGD-EN-1 User Guide xi


Chapter 1

Introduction to ContentBridge

Thank you for selecting ContentBridge.

Go straight to the Tutorial

See the Release Notes for ContentBridge 21.2 for the list of new features in this release.

ContentBridge allows data to be moved from one database or data file to another
database. On route data can be:

• Checked for errors and inconsistency

• Checked for duplicate entries

• Modified using a powerful set of functions


• Filtered so that only the rows or records you want are retained

• Moved from one technology to another

EDCCM210200-UGD-EN-1 User Guide 13


Chapter 1 Introduction to ContentBridge

Installing the software is fully automated and you can be validating and moving
data after following a few simple steps. ContentBridge is built using Microsoft's
latest .NET framework. If this is not installed on your machine it will be
downloaded and installed from the Microsoft web site.

At all times the actions of ContentBridge are clearly visible and all errors and
warnings are quickly displayed to the user.

ContentBridge will move data in or out of a wide range of databases and data files.
This includes:

• Comma Delimited Files (Comma Separated Values - CSV), Tab Separated Files
(TXT) and similar text files
• Fixed format files
• XML files
• Microsoft Excel spreadsheets
• Microsoft Access
• SQL Server and SQL Server Compact
• Oracle
• MySQL
• OLE DB data sources
• ODBC data sources

Make sure you take a backup copy of your database or files before you start.

Where to go next

14 OpenText ContentBridge EDCCM210200-UGD-EN-1


Run the simple tutorial to see howContentBridge works

Register your copy of ContentBridge

Run the demo of ContentBridge in use by selecting this from the Help menu

Converting maps created in version 1.x

EDCCM210200-UGD-EN-1 User Guide 15


Chapter 2
Sample applications of ContentBridge

2.1 Cleaning your data


Before undertaking a marketing campaign you may want to check the addresses are
valid and perhaps clean up the data ensuring the formatting is acceptable.

ContentBridge will allow you to quickly import your data onto a map and run some
simple checks:

• Check the postal codes or zip codes are in the correct format
• Check the surnames are valid and NOT FOR EXAMPLE ALL IN CAPITALS
• Check the telephone numbers look okay
• Check thousands of rows in minutes
• Split the data into groups to mail for each of the next few weeks
• Identify contacts in target regions
• Prepare the data for mail merge

2.2 Import data from a purchased list


If you buy data you need to check it and make sure the quality is acceptable. You
then need to import that data into your contact management system. Tasks you need
to undertake include:

• Validate the data as described above


• Adjust the format to match you requirements. You may need a salutation field as
well as the individual name fields
• Sort the data into regions
• Remove unwanted rows
• Find duplicate rows

EDCCM210200-UGD-EN-1 User Guide 17


Chapter 2 Sample applications of ContentBridge

2.3 Sending data to your customers


You may need to send data to your customers. They may want that data in a certain
format. ContentBridge can make this task simple:

• Validate the data before you send it


• Correct typing errors such as UPPER CASE NAMES
• Filter the data to send only the records the customer requires or has paid for
• Mark the records you have sent
• Transfer the data into an Access database, Excel spreadsheet or a comma
delimited file for delivery

If you have an application for ContentBridge and you are unsure if it can help or
how to proceed please contact ContentBridgeInfo@OpenText.com.

18 OpenText ContentBridge EDCCM210200-UGD-EN-1


Chapter 3
The ContentBridge Tutorial

This tutorial will take you through a simple tutorial to get you quickly up and
running.

Sample data is provided as part of the ContentBridge installation and the tutorial
covered in this section uses this data. You will be shown how to run ContentBridge
connect to this data file, validate the data, transform and finally write the resulting
data to a new text file.

At all stages we can preview the data and if we want make adjustments.

Contents of the Tutorial

Run ContentBridge

Read a text file

Review the data

Validate the data

Transform the data

Add individual FirstName and LastName fields

Split the Contactname field into First and Last name

Write the results to a text file

Write the results to MS Access

If you are planning to write data to an important database or file, please make
sure you take a backup copy first.Even though ContentBridge allows you to see the
data and to review before proceeding with the write you should always make sure
you have saved a copy.

Next >

EDCCM210200-UGD-EN-1 User Guide 19


Chapter 3 The ContentBridge Tutorial

3.1 Run ContentBridge


Start ContentBridge if it is not already running. ContentBridge can be started from
the Start menu:

Start \ All Programs \ OpenText Corporation\ Content Bridge\ OpenText


ContentBridge

The following window is displayed. ContentBridge provides a blank map. Functions


are placed on this map to import data, validate and transform that data and finally
write it out to a file or database.

< Prev| Next >

20 OpenText ContentBridge EDCCM210200-UGD-EN-1


3.2. Reading a file

3.2 Reading a file


Click Read Text File from the Functions toolbar on the left, hold the left mouse
button down and drag and drop it on the grid (map). You may need to scroll the
toolbar to see the Read Object which is found at the bottom. To scroll press the small
down arrow at the bottom of the toolbar. The following object will appear on the
map:

Save the map by pressing the save icon in the toolbar. We have chosen to save the
map at this early stage as ContentBridge will use relative addressing for data files.

Click the top left icon to display the properties wizard. You can also highlight an
object on the map and press the F4 key.

The three stages of the wizard are described in the next three pages of this tutorial.
The wizard stages are:

• Selection of the text file. Select customers.txt in the sample folder installed with
your copy of ContentBridge.
• Specifying the file format. ContentBridge will attempt to resolve what the format
is. The customer.txt file is a comma-delimited file. The data can be reviewed.
Check the box to indicate that the first row contains the field names.
• Make any changes required to the schema. Press finish to complete the wizard.

< Prev| Next >

3.2.1 Read Text File Wizard - File Definition


This stage of the wizard allows you to select the file to read into ContentBridge.

EDCCM210200-UGD-EN-1 User Guide 21


Chapter 3 The ContentBridge Tutorial

Select the text file to be read into ContentBridge. This should be the Customers.txt
file in the Samples folder:

• Under Windows XP - in My Documents\OpenText\Content Bridge\Samples


• Under Windows 7/Vista - in Documents\OpenText\Content Bridge\Samples

Click the button to the right of the text file box and select the Customers.txt file
which is found in the Samples folder:

Please note that ContentBridge will accept a path relative to the map or an absolute
path. In the screenshot above the map and the text file are in the same folder.

< Prev| Next >

22 OpenText ContentBridge EDCCM210200-UGD-EN-1


3.2. Reading a file

3.2.2 Read Text File Wizard - File Format


This stage of the wizard allows you to tell ContentBridge the type of file you will be
reading in,

Select the Delimited file type. Please note that ContentBridge will look at the first 50
rows and attempt to work out the file type and delimiters, so this will be selected
automatically.

Check the box to indicate that for this file the first row contains the column names.

ContentBridge shows the data so you can check how your selection will work.

< Prev| Next >

EDCCM210200-UGD-EN-1 User Guide 23


Chapter 3 The ContentBridge Tutorial

3.2.3 Read Text File Wizard - Schema


This stage of the wizard previews the data and allows adjustments to be made to the
data types is required.

Press the Finish button.

< Prev| Next >

3.3 Review the data


The Output panel at the bottom shows the action of ContentBridge. The 91 rows of
Customers.txt file has been read into ContentBridge. Select the Data tab at the
bottom and you can see the data displayed for review.

The Output panel at the bottom is always used to display the progress of an
execution. If at any time to wish to review the data, highlight the map element and
ensure the data tab is selected at the bottom. The display will now look like:

24 OpenText ContentBridge EDCCM210200-UGD-EN-1


3.4. Validate the data

All 91 rows can be reviewed. You can search for data, browse through the rows and
go directly to a row by typing in the row number and pressing Enter. If required the
data can be edited. The changes will not be applied to the original data source, but
will be reflected in the output from ContentBridge. One of ContentBridge's greatest
features is the complete visibility of data. The data can be sorted by any row by
clicking on a column heading. The sort will alternate from ascending to descending
and back again with each click. The sort is indicated by an arrow in the column
heading. Columns may be resized using the mouse to drag the column separator.

< Prev| Next >

3.4 Validate the data


Next we will validate the data to check for errors and problems.

Select the General tab on the toolbar on the left. It will be near at the bottom. Left
click the ValidateFunction in the Functions toolbar, hold the mouse button down
and drag & drop it onto the map.

EDCCM210200-UGD-EN-1 User Guide 25


Chapter 3 The ContentBridge Tutorial

Join the output of the Read Text Fileto the input of the Validate . To do this place
the mouse pointer over the Read Text File map element.

Advanced topic: The map objects can be pinned open or made to open and contract
as the mouse pointer passes over them.

Left click on the output of the Read (bottom left icon), hold the mouse button down
and drag it over the input of the Validate (bottom left icon).

You will now see the data moved from the Readto the Validate . Highlight the
Validate object in the map and press F5. The Data panel will show the Source,
Passed and Failed data.

All rows will pass the validate by default.

We will now add some data checking or validation:

Click the left icon of theValidate object to display the properties dialog box. Press
the Reset toolbar button, answer yes and you will see that all rows of the data are
shown on the left and also in the map area. Validation rules appear on the right and
can be dragged onto the map and linked to rows by the same drag and drop
technique used for the main map.

On the Functions toolbar on the right select the General section. Drag the Not NULL
function onto the map and connect the Region data field to this test. The validate
will then look as shown below. This will test if the Region is present for all rows.

26 OpenText ContentBridge EDCCM210200-UGD-EN-1


3.4. Validate the data

Save the Validate properties by pressing the OK button. The validate will
automatically execute and 35 rows will now have passed and 56 failed. Select the
Data tab to review the passed and failed rows.

< Prev| Next >

EDCCM210200-UGD-EN-1 User Guide 27


Chapter 3 The ContentBridge Tutorial

3.5 Transform the data


ContentBridge allows you to transform the data before writing to an output file or
database.

Drag and drop the Transform function to the map.

Connect the Passed data (indicated by the icon with a green tick) from the Validate
to the Input of the Transform.

Click the left icon of theTransform to display the properties:

28 OpenText ContentBridge EDCCM210200-UGD-EN-1


3.5. Transform the data

Press the Reset button on the outputs toolbar and press Yes. This will copy the input
columns to the output.

Press the Auto-Map button in the toolbar and press OK. Each field is mapped to an
output field of the same name.

The data can be previewed from the Transform properties dialog box by pressing
the Preview button on the toolbar. You will see that the ContactName holds the first
and last name of the contact. We will now split this into individual fields.

< Prev| Next >

3.5.1 Add a new field


Click the Transform object to display the properties if not already showing.

Press the Edit button in the right Outputs toolbar.

The following dialog box is displayed. Add a new field for the FirstName and
LastName.

• Click the left toolbar icon to add a new field


• Double click the name and change to FirstName
• Set the size to 50 characters

EDCCM210200-UGD-EN-1 User Guide 29


Chapter 3 The ContentBridge Tutorial

• Repeat for LastName

Remove the ContactName field as we will not be using it. To do this highlight this
row and press the red X button in the toolbar.

< Prev| Next >

3.5.2 Split a field


Drag and drop the new FirstName and LastName fields onto the schema. If the
Preview mode is on switch this off by pressing the Preview button again. You can
rubber band to select other items on the map and move them with the cursor keys or
mouse to make room.

Select the Functions tab of the Functions toolbar on the left.

Drag and drop the Split function onto the map.

Connect the ContactName to the input and the outputs to the FirstName and
LastName fields.

30 OpenText ContentBridge EDCCM210200-UGD-EN-1


3.5. Transform the data

Click the left icon of the Split. Define the delimiter character as space by clicking on
the underlined text in the function description and entering space. Press the OK
button

EDCCM210200-UGD-EN-1 User Guide 31


Chapter 3 The ContentBridge Tutorial

Save the Transform properties by pressing OK and review the Transform Output
data. You will now see the two new fields containing the first and last names.

Close the Transform properties by pressing OK. The Transform will execute. You
can check the output data by selecting the Data tab at the bottom and comparing the
Input and Output

Advanced topic:

The properties of all functions are similar in style. A natural English sentence
describes the action of the function. The blue underlined text can be clicked on. This
will then either:

• Cycle through the allowed values


• Bring up a dialog box to allow entry of a value. You may type in a value or pick
from this list. Characters such as a period are displayed as {period} as the period
character would be difficult to see

The action of the function can be tested. You can run this test with the data
presented from the data in your map or by typing in data. The type is set to the data

32 OpenText ContentBridge EDCCM210200-UGD-EN-1


3.6. Write the data to a file

type by default but can be modified as required (see the Glossary for more
information on Data Types).

< Prev| Next >

3.6 Write the data to a file


Having validated and transformed the data we will now write the results to a text
file.

Select the Export tab in the toolbar on the left. Drag and drop the Write File function
to the map:

Connect the Output of the Transform to the Input of the Write Text File .

Click the left icon of theWrite Text Fileobject to display the properties. The two
stages of the wizard are described in the next two pages of the Tutorial and allow:

• The definition of the output file and if the data should be appended or replace
the data in that file
• The definition of the format of the output data

< Prev| Next >

3.6.1 Write Text File Wizard - File Location


This stage of the wizard is used to define the output text file.

EDCCM210200-UGD-EN-1 User Guide 33


Chapter 3 The ContentBridge Tutorial

Enter the file to which the data should be written. Press the button to the right and
type in Output.txt.

Please note that ContentBridge will accept a path relative to the map or an absolute
path.

< Prev| Next >

3.6.2 Write Wizard - File Format


This stage of the wizard is used to define the file type to be written to.

34 OpenText ContentBridge EDCCM210200-UGD-EN-1


3.6. Write the data to a file

Select Delimited. Normally you are better advised to select a delimited file with the
Field Delimiter as a comma and the Text Qualifier as double quotes. These are the
default settings.

You can also choose to include column headings as the first row by checking the
box.

Press Finish to complete the wizard.

< Prev| Next >

3.6.3 Execute Write Text File Function


By default all export functions on the map are set to execute when prompted. This
can be seen by the gear with two blue rectangles showing as the icon on the right of
the Write Text Fileobject. This is the default to protect the user from unwittingly
overwriting data. If you click on this icon it will cycle through three possible states:

Manual execution only. This function will


not execute as part of a cascade all or
Cascade execution.
Prompt before continuing execution

EDCCM210200-UGD-EN-1 User Guide 35


Chapter 3 The ContentBridge Tutorial

Continue execution without a prompt

Press F5 and answer yes to execute. The data will be written to the file.

Please note that the evaluation copy of ContentBridge is restricted to only write
out 50 rows of data. All execute functions are set into Trial mode. While in this
mode they will only process 50 rows. The Import and other functions are unlimited
allowing you access to a free data validation tool.

You have now completed the Tutorial.

If you wish click the right arrow above and go on to write the data to a Microsoft
Access database instead of to a text file.

< Prev| Next >

3.7 Write to MS Access


We will now write to an Access database.

Save the map by pressing the floppy disk icon on the main toolbar at the top.

Remove the transform and the Write Text File from the map.

Open the Read Text File properties and go to the third stage of the wizard. Highlight
the CustomerID row and double click the Data Type. Change the data type to Int32.
Now press the Primary Key button on the toolbar.

Finish the wizard.

Now drag a Write MS Access object onto the map. set the properties as follows:

Click to enlarge

36 OpenText ContentBridge EDCCM210200-UGD-EN-1


3.7. Write to MS Access

Click to enlarge

< Prev| Next >

3.7.1 Write to MS Access - more


Now drag a Transform object onto the form and build the map to place the
Transform in between the Validate and the Write MS Access .

Click on the left icon on the Transform object to display the properties. Press the
Auto-Map button, select the Reset Outputs checkbox and press OK. You will see that
ContentBridge has suggested how to link the input data to the Contacts database.
You only need to add the split of the ContactName into the FirstName and
LastName fields and the job is done.

EDCCM210200-UGD-EN-1 User Guide 37


Chapter 3 The ContentBridge Tutorial

Press the OK button and review the data. To write the data to the Contacts database
change the red stop icon to green arrow or blue pause and execute all.

If you wish, load the sample maps provided with ContentBridge. These are
UG.dbm, a map built as the tutorial describes and UG1.dbm, a more complicated
example where a reference table or list is used to manage the permitted countries.

< Prev| Next >

3.8 A Final Tidy Up


You can tidy up your completed map by renaming the objects on the map.

Double click on the name of each object and give it an appropriate name such as:

• Read Text File to “Customers”


• Validate to “Check Region”
• Transform to “Split Name”
• Write MS Access to “Contact”

If you wish you can pin the map objects expanded. This is done by clicking on the
magnifier glass icon on the right hand corner of each object. The icon will turn green
and the object remain expanded.

38 OpenText ContentBridge EDCCM210200-UGD-EN-1


3.8. A Final Tidy Up

Finally save the map for future use.

< Prev

EDCCM210200-UGD-EN-1 User Guide 39


Chapter 4

Using ContentBridge

This section describes the features and functions of ContentBridge in greater depth:

• The ContentBridge screen • Write to an XML File


• The toolbar • Execute
• The functions toolbars • Supported data files and
databases

• The Menu • DCTM QC Validation


• Options • Create D2 queue
• ContentBridge Themes • DeDupAndCombine
• Map Properties • Read From DCTM
• Batch processing • Read From
DocumentumDB

• Reading a text file • Load Into Dctm


• Reading a Microsoft • Load Into InfoArchive
Access database

• Reading a MySQL • Create Objects in DCTM


database

• Reading a SQL Server • Read From SharePoint


database

• Reading an Oracle • Write to SharePoint


database

• Reading an ODBC • Email Table


database

• Reading an OLE DB data • Write to File Share


source

• Reading a Microsoft Excel • eRoom Exporter


spreadsheet

• Reading from an XML • Read File Folders


File

• Validating data • Session Manager


• Transforming data • DCTM Compare
• De-Duplication of data • Attribute Validations
• Merging data • Read from eRoom

EDCCM210200-UGD-EN-1 User Guide 41


Chapter 4 Using ContentBridge

• Sort data • Email Exporter


• Custom table • Load Into OpenText CS
• Map-level .NET Scripts
• Writing to a text file
• Writing to
aMicrosoftAccess
database

• Writing to a MySQL
database

• Writing to aSQL
Serverdatabase

• Writing to an Oracle
database

• Writing to
anODBCdatabase

• Writing to an OLE
DBdata source

4.1 ContentBridge Map


ContentBridge presents a map. Onto this map objects are placed to carry out
functions such as reading a text file, validating that text file, making transformations
to the data and writing to for example a MS Access database.

42 OpenText ContentBridge EDCCM210200-UGD-EN-1


4.1. ContentBridge Map

Take a look at how context menus can help you work quickly and conveniently

In addition to the map there are a number of toolbars and display panels. Each is
described in the following pages of this user guide:

• Main toolbar
• Functions
• Output
• Data

The latter three toolbars can be manipulated as the user wishes.

If space is a premium the pin icon on each toolbar can be used to cause the toolbars
to minimize when not in use. A toolbar can be hidden using the X icon and restored
from the View menu.

EDCCM210200-UGD-EN-1 User Guide 43


Chapter 4 Using ContentBridge

4.2 ContentBridge Map - Manipulating objects


Objects are dragged from the toolbar on the left onto the main grid area to build a
ContentBridge map. Double-clicking an object in the toolbar will also add that object
to the map.

Objects on the map can be manipulated in a number of ways:

• Place the mouse over the boarder and drag the object to move it
• Highlight one or more objects and use the cursor keys to move them. The Shift
key will make the objects move more quickly in larger steps
• Click the icon on the left to display the object properties
• Double click the title to edit
• Click the pin icon on the top right hand corner to pin open or closed. If set closed
the object will expand when the mouse is over the object.
• Click the gear icon to toggle the execution mode. More...

4.3 ContentBridge Map - Data Toolbar


ContentBridge includes a simple main toolbar. This is shown below:

44 OpenText ContentBridge EDCCM210200-UGD-EN-1


4.4. ContentBridge context menus

Cut, Copy and Paste will work on multiple items and between two maps loaded in
two copies of ContentBridge.

4.4 ContentBridge context menus


ContentBridge provides context menus on all the map elements. These can help you
work quickly and efficiently. Just use the right button to bring up a menu with a
series of options. Two examples are shown below:

EDCCM210200-UGD-EN-1 User Guide 45


Chapter 4 Using ContentBridge

4.5 ContentBridge Map - Functions Toolbar

46 OpenText ContentBridge EDCCM210200-UGD-EN-1


4.6. ContentBridge Map - Functions Toolbar (General)

The functions toolbar is split into three


sections;
1. Import
2. Export
3. General

Objects are dragged from the toolbar onto


the map.

Toolbars can be pined open or allowed to


open when the mouse passes over them.

The toolbar can also be re-sized and docked


in other locations. When docking in other
locations a graphic appears to show the
options.

If you have hidden a toolbar it can be


unhidden from the View menu.

4.6 ContentBridge Map - Functions Toolbar


(General)
The Main Functions Toolbar is split into three sections. The General section contains
the following objects. These objects are dragged onto the main map area to build a
ContentBridge map.

.NET Script A function to allow entry of c# or VB.NET


script to carry out a wide range of
operations.

Please see elsewhere in this user guide for


more details

EDCCM210200-UGD-EN-1 User Guide 47


Chapter 4 Using ContentBridge

De-Duplication A function to search for and remove


duplicate data

Please see elsewhere in this user guide for


more details
Merge A function to merge two or more streams of
data into a single file or table

Please see elsewhere in this user guide for


more details
Sort Sort data by one or more columns

Please see elsewhere in this user guide for


more details
Transform A set of functions to transform data.

Please see elsewhere in this user guide for


more details
Validate A set of validation tests used to check the
quality and content of the data

Please see elsewhere in this user guide for


more details
Attribute Validation It is used to validate selected attributes from
D2.

Please see elsewhere in this user guide for


more details
DeDupAndCombine DeDupAndCombineAddin will remove the
deduplicate the records from the incoming
table and then combines the records.

Please see elsewhere in this user guide for


more details
FuzzyCompare Used to perform a relational operation using
Fuzzy logic. It comparesthe input
valueagainst a comparison value and
provides a boolean output(True or False).

Please see elsewhere in this user guide for


more details
XSD to DBS Converter This function reads the XSD schema and
exports the output as DBS schema file.

Please see elsewhere in this user guide for


more details

48 OpenText ContentBridge EDCCM210200-UGD-EN-1


4.7. ContentBridge Map - Functions Toolbar (Import)

4.7 ContentBridge Map - Functions Toolbar (Import)


The Main Functions Toolbar is split into three sections. The Import section contains
the following objects. These objects are dragged onto the main map area to build a
ContentBridge map.

Custom Table A table of values that are manually entered.


They are then used to check data against
using the Lookup functions. An example
might be a list of allowed titles such as Mr,
Mrs, Ms, Miss, Master, Sir, Rev, Lord...

Please see elsewhere in this user guide for


more details
Read MS Access A map object used to read data from an
Access database.

Please see elsewhere in this user guide for


more details
Read MS Excel A map object used to read data from a
spreadsheet

Please see elsewhere in this user guide for


more details
Read MS SQL A map object used to read to a Microsoft SQL
Server database.

Please see elsewhere in this user guide for


more details
Read MySQL A map object used to read to a MySQL
Server database.

Please see elsewhere in this user guide for


more details
Read ODBC A map object used to read to an ODBC data
source. This gives connectivity to a wide
range of databases and sources including,
SQL Server, Oracle, dBase and many more.
Please note that ODBC support is only
available with ContentBridge.

Please see elsewhere in this user guide for


more details

EDCCM210200-UGD-EN-1 User Guide 49


Chapter 4 Using ContentBridge

Read OLE DB A map object used to read to an OLE DB


provider. This gives connectivity to a wide
range of databases and sources including,
SQL Server, Oracle, Access (Jet 4.0), ISAM,
FoxPro and many more. Please note that
OLE DB support is only available with
ContentBridge.

Please see elsewhere in this user guide for


more details
Read Text File A map object used to read data from a file.

Please see elsewhere in this user guide for


more details
Read XML A map object used to read to an XML file.

Please see elsewhere in this user guide for


more details
Read Oracle A map object used to read to a Oracle
database. This object will only appear if the
Oracle client software is installed on your
PC.

Please see elsewhere in this user guide for


more details
eRoom Exporter The import function eRoom Exporter
imports an exported erm file into
ContentBridge.

Please see elsewhere in this user guide for


more details
Read Documentum The function Read from DCTM retrieves
content from a Documentum Repository to
be loaded into ContentBridge.

Please see elsewhere in this user guide for


more details
Read from DocumentumDB The Read From DocumentumDB can be used
to read data directly from the Documentum
database.

Please see elsewhere in this user guide for


more details
Read eRoom The read from eRoom add-in can be used to
read and export artifacts and documents
from an existing eRoom to a destination on
your machine.

Please see elsewhere in this user guide for


more details

50 OpenText ContentBridge EDCCM210200-UGD-EN-1


4.8. ContentBridge Map - Functions Toolbar (Export)

Read File Folders The function Read File Folders retrieves


content from any local directory, or server
FileShare to be loaded into ContentBridge.

Please see elsewhere in this user guide for


more details
Read MS SQL Compact 3.5 A map object used to read to a Microsoft SQL
Server Compact 3.5 database.

Please see elsewhere in this user guide for


more details
Read Sharepoint This add-in exports content from a
SharePoint site (2003, 2007 or 2010), or
library and loads the data into ContentBridge

Please see elsewhere in this user guide for


more details
DCTM Session Management This add-in allows you to connect to multiple
(up to four) repositories and manages your
sessions between them.

Please see elsewhere in this user guide for


more details
Email Exporter Email Exporter will connect to the exchange
sever and extracts and exports the email
from the configured public folders

Please see elsewhere in this user guide for


more details

Other output objects will be added in future releases. Please check the OpenText
web site to check the availability of other database connectors.

4.8 ContentBridge Map - Functions Toolbar (Export)


The Main Functions Toolbar is split into three sections. The Export section contains
the following objects. These objects are dragged onto the main map area to build a
ContentBridgemap.

Write MS Access A map object used to write data out to an


Access database.

Please see elsewhere in this user guide for


more details
Write MS SQL A map object used to write to a Microsoft
SQL Server database.

Please see elsewhere in this user guide for


more details

EDCCM210200-UGD-EN-1 User Guide 51


Chapter 4 Using ContentBridge

Write MySQL A map object used to write to a MySQL


Server database.

Please see elsewhere in this user guide for


more details
Write ODBC A map object used to write to an ODBC
provider. This gives connectivity to a wide
range of databases and sources including,
SQL Server, Oracle, dBase and many more.
Please note that ODBC support is only
available with ContentBridge.

Please see elsewhere in this user guide for


more details
Write OLE DB A map object used to write to an OLE DB
provider. This gives connectivity to a wide
range of databases and sources including,
SQL Server, Oracle, Access (Jet 4.0), ISAM,
FoxPro and many more. Please note that
OLE DB support is only available with
ContentBridge.

Please see elsewhere in this user guide for


more details
Write Text File A map object used to write data out to a file.

Please see elsewhere in this user guide for


more details
Write an XML File A map object used to write data out to an
XML file.

Please see elsewhere in this user guide for


more details
Write Oracle A map object used to write to an Oracle
database.This will only appear in the toolbar
if the Oracle client is installed on your PC.

Please see elsewhere in this user guide for


more details
Create D2 queue Create D2 queue Addin will create a Queue
request in documentum.

Please see elsewhere in this user guide for


more details
Create Objects in DCTM The CreateObjects addin can be found under
the Export Tab and allows you to create non-
document type objects in Documentum.

Please see elsewhere in this user guide for


more details

52 OpenText ContentBridge EDCCM210200-UGD-EN-1


4.8. ContentBridge Map - Functions Toolbar (Export)

DCTM QC Validation DCTM QC Validation function can be used


to validate the values assigned to the
attributes of the documents/objects loaded
into documentum repository in the earlier
step in the ContentBridge map earlier.

Please see elsewhere in this user guide for


more details
DCTM Compare The DCTM Compare add-in works in
conjunction with the Session Manager add-in
which can be found under the Import tab of
ContentBridge.

Please see elsewhere in this user guide for


more details
Email Table EmailTable is an export function that allows
ContentBridge to send an email to a specified
account.

Please see elsewhere in this user guide for


more details
Load Into DCTM Loads content to any Documentum
Repository from ContentBridge.

Please see elsewhere in this user guide for


more details
Load Into InfoArchive This Addin creates the SIP packages for
InfoArchive and exports it into a folder.

Please see elsewhere in this user guide for


more details
Write MS SQL Compact 3.5 A map object used to write to a Microsoft
SQL Server Compact 3.5 database.

Please see elsewhere in this user guide for


more details
Write to FileShare The function Write to FileShare exports
content to local FileShare server

Please see elsewhere in this user guide for


more details
Write to Sharepoint The Write to SharePoint function exports
content to a SharePoint site, or library to be
loaded into ContentBridge and processed.

Please see elsewhere in this user guide for


more details

Other output objects will be added in future releases. Please check the OpenText
web site to check the availability of other database connectors.

EDCCM210200-UGD-EN-1 User Guide 53


Chapter 4 Using ContentBridge

4.9 ContentBridge Map - Output Toolbar


The Output toolbar has two tabs at the bottom; Output and Data.

The Output tab shows the progress of the execution of ContentBridge. In the
example below 91 records have been read from an object, Customers, and then
validated using an object named Check Region. 31 rows passed and 60 failed.

This toolbar can be pinned as expanded or allowed to contract when not in use. The
toolbar can also be re-sized and docked in other locations.

4.10 ContentBridge Map - Data Toolbar


The Output toolbar has two tabs at the bottom; Output and Data.

The Data tab shows the data in the map object highlighted. Depending on the type
of the the object there can be more many sub-tabs. In this case (a validation object)
there are three: Source; Passed and Failed.

The data can be sorted in ascending or descending order. To do this click on a


column title. The sort order and column width is remembered while the map
remains loaded. Columns and Rows can be resized using the mouse. Press the Auto-
Size button to re-size all columns and rows. If you would like the Data panel to
always Auto-Size you can change a setting in the ContentBridge Options, though
you should bear in mind that this can take some time for large data sets.

This toolbar can be hidden, pinned as expanded or allowed to contract when not in
use. The toolbar can also be re-sized and docked in other locations.

54 OpenText ContentBridge EDCCM210200-UGD-EN-1


4.11. The Menu

The find function can be used to search for data. Enter the text to search for in the
white box and press the find button. Each time the find button is pushed
ContentBridge will show the next match. The browse buttons can also be used to
scroll through the data or you may move directly to a row.

4.11 The Menu


File

Create New Map Creates a new map. You may be prompted to


save the current map
Open Map Opens a saved map
Close Map Close the current map
Save Map Saves the current map
Save Map As Allows a map to be saved under a different
name
Recent Maps Displays the last 4 maps used
Exit Quits ContentBridge

Edit

Undo Undo the last action. ContentBridge will


remember the last 5 objects added or deleted
Redo Redo up to the last 5 actions that have been
undone
Cut Delete one or more objects placing them in
the clipboard
Copy Copy the selected objects into the clipboard

EDCCM210200-UGD-EN-1 User Guide 55


Chapter 4 Using ContentBridge

Paste Paste the objects held in the clipboard onto


the map
Delete Delete all selected items
Select All Select all items on the map

View

Functions Displays the Functions toolbar (if it has been


hidden)
Output Displays the output panel (if it has been
hidden)
Data Displays the data panel (if it has been
hidden)

Map

Execute Cascading Executes the highlighted function and all


that follow
Execute All Executes all functions
Stop Execute Stops execution
Properties Sets the properties for the map. More...

Note: If data is modified manually then care must be taken not to execute functions
that will overwrite this change. As an example a text file can be read and then
following validation problem rows modified by hand. If you save the map the
changes to the data are stored and are reloaded when the map is reloaded. If you
execute the text file read again these changes will be lost. You can protect a function
from executing by clicking on the icon on the bottom write of the title bar / The icon
will change from green (auto-execute) to blue (Prompt) to Red (manual execute)

Function

Execute Function Executes the highlighted function


Rename Allows the highlighted function displayed
on the map to be renamed
Properties Displays the properties of the highlighted
function. Clicking on the left icon of a
function will also display the properties
dialog
Auto Execute A function set to auto execute will execute as
part of a cascade
Prompt Execute A function set to prompt execute will only
execute as part of a cascade after prompting
the user

56 OpenText ContentBridge EDCCM210200-UGD-EN-1


4.11. The Menu

Manual Execute A function set to manual execute will not


execute as part of a cascade
Pinned A function set as pinned is always shown on
the map as expanded
Save Data Sets a function so that the data is saved with
the map. This can be helpful for small
functions handling small numbers of rows
Trial Mode Limits a function to only handle 50 rows. If
you are working with large numbers of rows
this allows the set-up and testing of the map
to be carried out with just 50 rows. When the
map is complete switch off the trial mode
Batch mode Places the highlighted function into batch
mode. Only one function can be in batch
mode.

Tools

MS Access Launches MS Access if present on your PC. If


MS Access is not installed this menu item
will not appear
MS Excel Launches MS Excel if present on your PC. If
MS Access is not installed this menu item
will not appear
Names Definitions Editor Launches a tool to maintain the names used
by the Name SplitTransform function.
More...
Abbreviation Editor Launches a tool to maintain the
abbreviations. More...
Options A number of settings that control the
ContentBridge. More....

Please note that ContentBridge Add-Ins can add items to the tools menus. If you use
the SDK to create your own Add-Ins these can also provide additional entries in this
menu.

Help

Contents Displays the help file for ContentBridge


Watch Demonstration Watch a multi-media demonstration of
ContentBridge in use
Tutorial Follow a tutorial on ContentBridge. This is a
great place to start exploring ContentBridge
Register New Serial Number
De-activate License De-activate to move to another machine

EDCCM210200-UGD-EN-1 User Guide 57


Chapter 4 Using ContentBridge

OpenText ContentBridgeon the web Loads a web browser with the ContentBridge
page of the OpenText web site showing
Check Web for updates Check the OpenText web site for a new
version of ContentBridge
About Displays the version of ContentBridge

4.12 Options
The options dialog box displays a small number of options that may be set by the
user.

This includes the default propertiesfor new maps and the Auto-Size behavior:

The behavior on loading:

58 OpenText ContentBridge EDCCM210200-UGD-EN-1


4.12. Options

The behavior of Functions added to the map and when the properties are closed:

If a log file may be written as the map executes. By default the text that is written to
the log file also appears in the Output panel.

You can disable this feature by de-selecting the “Log execution output to Output
Window” check-box.

EDCCM210200-UGD-EN-1 User Guide 59


Chapter 4 Using ContentBridge

You can also configure ContentBridge options to create a log file using the same
name as the running map. and also append time-stamp to the end of log file name.

Setting these options to dynamically change the log file name is extremely useful in
terms of maintaining separate log file per execution cycle.

ContentBridge allows execution data to be posted to a designated Dashboard server

Configure the Dashboard host and port name as well as the frequency to post
dashboard updates during map execution using the dashboard tab:

The dashboard URL must contain the <host>:<port> where, <host> is the server
where the dashboard WEB-API are installed and <port> is the port number
monitored by the dashboard WEB-API for incoming requests. Specify port number
only if Dashboard web-api is configured to monitor any port other than the default
http port 80.

Post Update Frequency indicates the number of rows. ContentBridge application


will attempt to post the status of running map to the dashboard after these many
number of rows have been processed since the last update. in the following example,
data will be posted to the dashboard after each function has completed processing
500, 1000,1500, 2000 rows/documents.

60 OpenText ContentBridge EDCCM210200-UGD-EN-1


4.12. Options

For further details refer to Dashboard Integration.

The location for reference files such as the list of abbreviations or name prefixes. This
can be set to a network location so that you can share these settings between many
ContentBridgeusers. The default locations is within a ..\OpenText Content Bridge\
folder in My Documents for Windows XP and Documentsfor Windows Vista, 7, 8
and higher

EDCCM210200-UGD-EN-1 User Guide 61


Chapter 4 Using ContentBridge

The ContentBridge themeyou wish to work with:

4.13 ContentBridge Themes


ContentBridge offers the user a choice of themes. These are selected from the Tools,
Options dialog:

62 OpenText ContentBridge EDCCM210200-UGD-EN-1


4.13. ContentBridge Themes

Some examples of themes are shown below:

MS Office 2003

EDCCM210200-UGD-EN-1 User Guide 63


Chapter 4 Using ContentBridge

IDE 2005

MS Office 2007 - Blue

MS Office 2007 - Silver

64 OpenText ContentBridge EDCCM210200-UGD-EN-1


4.14. Map Properties

4.14 Map Properties

The Author, Company and Comments are free text areas and you can add any data
as appropriate. When a new map is created these properties are set to default values
as specified in the Identity tab of the Options settingsfor ContentBridge .

The map version can be set manually or allowed to auto increment.

EDCCM210200-UGD-EN-1 User Guide 65


Chapter 4 Using ContentBridge

Please see another topic on Batch processing in ContentBridge.

The records in a batch are set for the map and can be found in the Batch Mode Tab

Dashboard tab allows users to enable or disable posting of execution data to the
dashboard.

Users can also choose to select posting data against a specific project configured in
the Dashboard application.

This is very useful when there are multiple migration projects underway at the same
time. In this scenario, all ContentBridge maps developed for a specific migration
project can be configured to post data against specific dashboard project so that it is
easy to monitor execution status of maps used by different migration teams

The projects must be configured using the Dashboard portal so that the project is
available for selection on this screen.

ContentBridge downloads the list of available projects from Dashboard at the


application startup. So if you have configured any new projects while ContentBridge
application is running, you must close and reopen all the ContentBridge application
instances so the newlyconfigured Dashboard projects are available for selection.

For further details refer to Dashboard Integration.

66 OpenText ContentBridge EDCCM210200-UGD-EN-1


Chapter 5
Basic Functions

5.1 Read a text file


Highlight Read Text File from the Functions toolbar and drag and drop it on the
grid. The following object will appear:

Click the left icon to display the properties wizard. The three stages of the wizard
allow:

• Selection of the text file. As an example select customers.txt in the sample folder
installed with your copy of ContentBridge .
• Specifying the file format.ContentBridge will attempt to resolve what the format
is. The customer.txt file is a comma-delimited file. The data can be reviewed.
Check the box to indicate that the first row contains the field names.
• Make any changes required to the schema. Press finish to complete the wizard.

Click to enlarge Click to enlarge Click to enlarge

If you re-enter the properties and change the file to be read ContentBridge will ask if
you wish to reset the data schema. If the file has the same format as the original file
you may not want to make a change.

EDCCM210200-UGD-EN-1 User Guide 67


Chapter 5 Basic Functions

5.1.1 Select File

Select the text file to be read into ContentBridge. Both delimited files such as a csv
file or a fixed format file can be read. If you want to read a Microsoft Access
database or a Microsoft Excel spreadsheet you need to place the appropriate
function on the map.

Please note that the file name can be given as absolute or relative to the location of
the map.

Encoding:

68 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.1. Read a text file

The encoding settings allows ContentBridge


to support a number of text formats. You will
normally be fine with the default, UTF-8, but
try others if you see some characters missing.

Read all similar files within folder and append as one operation:

ContentBridge can read from a single file (the default) or read all files of a similar
format from within a single directory. When this second option is selected the files
can be of a format by which each file holds a single record with a row containing a
field. This type of file may be something like the following:

“AccountID”,“PRK0024S” “Name”,“John Smith” “Telephone”,“0207123456”


“Email”,“john.smith@company.com”

Include filename in the output as a new column:

You can choose to include the filename as a column in the data. This can be useful if
you want the data source to be shown in the destination data. The Transform
function allows other data to be included such as the date, machine name and the
username.

Archive files after they have been read:

You can set the object to archive the file after processing. This can be useful if you
are using ContentBridge Loader to schedule execution of maps and want to move
processed files so that they will not be run again. While developing the map use
Trial mode and the file will not be archived.

Return to the overview of Read Text File.

EDCCM210200-UGD-EN-1 User Guide 69


Chapter 5 Basic Functions

5.1.2 Define Format

Select either Delimited of Fixed Width as the file type. ContentBridge will look at the
first 50 rows and attempt to work out the file type and delimiters. Indicate if the first
row contains the column names.

For a fixed width file you would need to specify the width of each field.

If the Record Separator is not CR + LF as is the default for Windows files you can
also select LF only as is used for UNIX files or CR only as is used for Mac files.

Return to the overview of Read Text File.

70 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.1. Read a text file

5.1.3 Review Schema

The data is displayed for review. Each field type can be reviewed and modified if
required.

Names of the columns can be changed as can the length of some data types such as a
String. If possible identify the primary key for the data. This will be for example the
userID, account code or a similarly named column.

If your data does not have a suitable primary key you can add a sequence number
using the Transform Sequence Function.

For more information on databases, data types and schemas please follow this link

You can save the schema for use in another map or at a later time. You can also Load
an existing schema. If you open the properties of an existing Read Text object and
change the

source filename, ContentBridge will prompt you before changing the schema. If the
new file is of an identical format you can avoid the need to re-define the schema.

When you are happy complete the wizard by pressing the finish button.

EDCCM210200-UGD-EN-1 User Guide 71


Chapter 5 Basic Functions

Return to the overview of Read Text File.

5.2 Read MS Excel


Highlight Read MS Excel from the Functions toolbar and drag and drop it on the
grid. The following object will appear:

Click the title bar to display the properties wizard. The three stages of the wizard
allow:

• Selection of a spreadsheet.
• Select a worksheet, a range from a worksheet, a named range or a SQL query.
• Preview the data.

Click to enlarge Click to enlarge Click to enlarge

72 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.2. Read MS Excel

5.2.1 Select Spreadsheet

Select the Excel spreadsheet to read.

Please note that ContentBridge will accept a path relative to the map or an absolute
path.

Return to the overview of Read MS Excel.

5.2.2 Select Range of Cells

EDCCM210200-UGD-EN-1 User Guide 73


Chapter 5 Basic Functions

Select the Worksheet or a Named Range to be read. A range within a worksheet can
be specified using the Excel format in the form of the following example: A1:C3.

It is also possible to enter a SQL statement, for example:

SELECT * FROM [Sheet1$]; SELECT CountryID, CountryName FROM [Countries$]

This example assumes the first row contains column titles and you check the box,
“First Row contains Column Headers”.

Because the Excel access uses the Microsoft JET Engine you can use MS Access
functions, for example:

SELECT CountryID, UCASE(CountryName) FROM [Countries$]

You can also define named ranges of cells and select from them:

SELECT CountryID, CountryName FROM [CountryNames]

Return to the overview of Read MS Excel.

74 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.2. Read MS Excel

5.2.3 Preview Data

The first 50 rows of the data are displayed to confirm that the correct data will be
imported into ContentBridge.

ContentBridge will look at the column format to try and work out the data type. If
you do need to change the data type this can be done as part of a Transform function
by editing the schema.

Return to the overview of Read MS Excel.

EDCCM210200-UGD-EN-1 User Guide 75


Chapter 5 Basic Functions

5.3 Read MS Excel Advanced


Highlight Read MS Excel Advanced from the Functions toolbar and drag and drop
it on the grid. The following object will appear:

Note: The Read Excel Advanced add-in doesn't have any dependency unlike
the Read Excel add-in.

Click the title bar to display the properties wizard. The three stages of the wizard
allow:

• Selection of a spreadsheet.
• Select a worksheet, a range from a worksheet, a named range or a SQL query.
• Preview the data.

Click to enlarge Click to enlarge Click to enlarge

76 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.3. Read MS Excel Advanced

5.3.1 Select Spreadsheet

Select the Excel spreadsheet to read.

Please note that ContentBridge will accept a path relative to the map or an absolute
path.

Return to the overview of Read MS Excel.Advanced

EDCCM210200-UGD-EN-1 User Guide 77


Chapter 5 Basic Functions

5.3.2 Select Range of Cells

Select the Worksheet or a Named Range to be read. A range within a worksheet can
be specified using the Excel format in the form of the following example: A1:C3.

Return to the overview of Read MS Excel.Advanced

5.3.3 Preview Data

78 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.3. Read MS Excel Advanced

The first 50 rows of the data are displayed to confirm that the correct data will be
imported into ContentBridge.

ContentBridge will look at the column format to try and work out the data type. If
you do need to change the data type this can be done as part of a Transform function
by editing the schema.

Return to the overview of Read MS Excel.Advanced

EDCCM210200-UGD-EN-1 User Guide 79


Chapter 5 Basic Functions

5.4 Read MS Access


Highlight Read MS Access from the Functions toolbar and drag and drop it on the
grid. The following object will appear:

Click the left icon to display the properties wizard. The three stages of the wizard
allow:

• Selection of the MS Access database.


• Select a table or query from within the Access database. You can also enter a SQL
statement.
• Preview the data.

Click to enlarge Click to enlarge Click to enlarge

80 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.4. Read MS Access

5.4.1 Select Database

Select the Access database to read. If the access database has users and passwords
then these will also need to be entered here.

Please note that ContentBridge will accept a path relative to the map or an absolute
path.

Return to the overview of Read MS Access.

5.4.2 Select Table

EDCCM210200-UGD-EN-1 User Guide 81


Chapter 5 Basic Functions

Select the Table or Query to be read. It is also possible to enter a SQL statement.

Return to the overview of Read MS Access.

5.4.3 Preview Database

82 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.5. Read MySQL

The first 50 rows of the data are displayed to confirm that the correct data will be
imported into ContentBridge.

Return to the overview of Read MS Access.

5.5 Read MySQL


Highlight Read MySQL from the Functions toolbar and drag and drop it on the
grid. The following object will appear:

Click the title bar to display the properties wizard. The four stages of the wizard
allow:

• Selection of the MySQL Server.


• Select the database on the server.
• Select a table from within the MySQL database. You can also enter a SQL
statement.

EDCCM210200-UGD-EN-1 User Guide 83


Chapter 5 Basic Functions

• Preview the data.

Click to enlarge
Click to enlarge

Click to enlarge Click to enlarge

84 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.5. Read MySQL

5.5.1 Select the Server

Select the MySQL Server to access. Enter the Port used to make the connection, a
username and the password.

MySQL allows a zero date of the format 00-00-0000. Microsoft DOT NET, the tool
used to build ContentBridge, does not. Either Null or 1 Jan 1900 is used instead.

If your data has zero dates then you will need to check the Allow Zero Dates
checkbox. You will then need to translate the date fields into a String using the
Transform ToDate function and then test for any zero dates using an If function and
set them to either 1 Jan 1900 or Null.

Return to the overview of Read MySQL.

EDCCM210200-UGD-EN-1 User Guide 85


Chapter 5 Basic Functions

5.5.2 Select the Database

Select the database to be used from the list displayed.

Return to the overview of Read MySQL.

5.5.3 Select the Table

86 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.5. Read MySQL

Select the Table to be read. It is also possible to enter a SQL statement.

Return to the overview of Read MySQL.

5.5.4 Preview the Data

EDCCM210200-UGD-EN-1 User Guide 87


Chapter 5 Basic Functions

The first 50 rows of the data are displayed to confirm that the correct data will be
imported into ContentBridge.

Return to the overview of Read MySQL.

5.6 Read Microsoft SQL Server Database


Highlight Read MS SQL from the Functions toolbar and drag and drop it on the
grid. The following object will appear:

Click the title bar to display the properties wizard. The four stages of the wizard
allow:

• Selection of the SQL Server.


• Select the database on the server.
• Select a table or view from within the SQL Server database. You can also enter a
SQL statement.
• Preview the data.

88 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.6. Read Microsoft SQL Server Database

Click to enlarge Click to enlarge

Click to enlarge Click to enlarge

EDCCM210200-UGD-EN-1 User Guide 89


Chapter 5 Basic Functions

5.6.1 Select the Server

Select the MS SQL Server to access. Use Windows integrated security or enter the
username and password.

Return to the overview of Read MS SQL.

5.6.2 Select the Database

90 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.6. Read Microsoft SQL Server Database

Select the database to be used from the list displayed.

Return to the overview of Read MS SQL.

5.6.3 Select the Table or View

EDCCM210200-UGD-EN-1 User Guide 91


Chapter 5 Basic Functions

Select the Table or View to be read. It is also possible to enter a SQL statement.

Return to the overview of Read MS SQL.

5.6.4 Preview the Data

92 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.7. Read a SQL Compact database

The first 50 rows of the data are displayed to confirm that the correct data will be
imported into ContentBridge.

Return to the overview of Read MS SQL.

5.7 Read a SQL Compact database


Highlight Read MS SQL Server Compact 3.5from the Functions toolbar and drag
and drop it on the grid. The following object will appear:

Click the left icon to display the properties wizard. The three stages of the wizard
allow:

• Selection of the SQL Compact database. Click on the image to see more details.
• Select a table from within the database. You can also enter a SQL statement.

EDCCM210200-UGD-EN-1 User Guide 93


Chapter 5 Basic Functions

• Preview the data.

Click to enlarge Click to enlarge Click to enlarge

5.7.1 Select the Database

94 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.7. Read a SQL Compact database

Enter the name of the SQL Compact database followed by the password, if used.

Return to the overview of Read SQL Compact.

5.7.2 Select the Table

Select the Table to be read. It is also possible to enter a SQL statement.

Return to the overview of Read SQL Compact.

5.7.3 Preview the Data

EDCCM210200-UGD-EN-1 User Guide 95


Chapter 5 Basic Functions

The first 50 rows of the data are displayed to confirm that the correct data will be
imported into ContentBridge.

Return to the overview of Read SQL Compact.

5.8 Read an Oracle database


The Oracle objects will only appear in the toolbars if the Oracle client software,
ODAC, is loaded on your machine.

Highlight Read Oracle from the Functions toolbar and drag and drop it on the grid.
The following object will appear:

Click the left icon to display the properties wizard. The three stages of the wizard
allow:

• Selection of the Oracle database. This involves a few steps. Click on the image to
see more details.

96 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.8. Read an Oracle database

• Select a table or view (query) from within the database. You can also enter a SQL
statement.
• Preview the data.

Click to enlarge Click to enlarge Click to enlarge

5.8.1 Select the Server

EDCCM210200-UGD-EN-1 User Guide 97


Chapter 5 Basic Functions

Enter the name of the server followed by the user and password.

Return to the overview of Read Oracle.

5.8.2 Select the Table or View

98 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.8. Read an Oracle database

Select the Table or View (Query) to be read. It is also possible to enter a SQL
statement.

Return to the overview of Read Oracle.

5.8.3 Preview the Data

EDCCM210200-UGD-EN-1 User Guide 99


Chapter 5 Basic Functions

The first 50 rows of the data are displayed to confirm that the correct data will be
imported into ContentBridge.

Return to the overview of Read Oracle.

5.9 Read an ODBC data source


Highlight Read ODBC from the Functions toolbar and drag and drop it on the grid.
The following object will appear:

Click the left icon to display the properties wizard. The three stages of the wizard
allow:

• Selection of the ODBC data source. This involves a few steps. Click on the image
to see more details.
• Select a table or view (query) from within the database. You can also enter a SQL
statement.
• Preview the data.

100 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.9. Read an ODBC data source

Click to enlarge Click to enlarge Click to enlarge

ODBC provides very broad connectivity to databases. It, or OLE DB, can be used to
access a wide range of data sources. If OpenText has published a specific data
connector, for example for Access, SQL Server or ACT! 6 you are best advised to use
that rather than ODBC or OLE DB. Given the choice of OLE DB or ODBC you
should normally use OLE DB.

Please note that ODBC and OLE DB are standards for connecting to databases and
are supported by most database technology used today. ODBC is an older standard
and has been largely replaced by OLE DB.

5.9.1 Select the ODBC Database

EDCCM210200-UGD-EN-1 User Guide 101


Chapter 5 Basic Functions

To access an ODBC data source you will need a DSN configured. ContentBridge
supports System, User and File DSNs. If you have not set-up one you can do this by
pressing the Manage Data Sources button.

102 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.9. Read an ODBC data source

Add a System DSN following the instructions on screen. Press the Refresh Data
Sources after you have added the DSN. Select the DSN and press the Next button.

Return to the overview of Read ODBC.

5.9.2 Select the Table or View

EDCCM210200-UGD-EN-1 User Guide 103


Chapter 5 Basic Functions

Select the Table or View (Query) to be read. It is also possible to enter a SQL
statement.

Return to the overview of Read ODBC.

5.9.3 Preview the Data

104 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.10. Read an OLE DB Provider

The first 50 rows of the data are displayed to confirm that the correct data will be
imported into ContentBridge.

Return to the overview of Read ODBC.

5.10 Read an OLE DB Provider


Highlight Read OLEDB from the Functions toolbar and drag and drop it on the
grid. The following object will appear:

Click the left icon to display the properties wizard. The three stages of the wizard
allow:

• Selection of the OLE DB provider. This involves a few steps. Click on the image
to see more details.
• Select a table or view (query) from within the database. You can also enter a SQL
statement.
• Preview the data.

EDCCM210200-UGD-EN-1 User Guide 105


Chapter 5 Basic Functions

Click to enlarge Click to enlarge Click to enlarge

OLE DB provides very broad connectivity to databases. It, or ODBC, can be used to
access a wide range of data sources. IfOpenText has published a specific data
connector, for example for Access, SQL Server or ACT! 6 you are best advised to use
that rather than ODBC or OLE DB. Given the choice of OLE DB or ODBC you
should normally use OLE DB.

Please note that ODBC and OLE DB are standards for connecting to databases and
are supported by most database technology used today. ODBC is an older standard
and has been largely replaced by OLE DB.

5.10.1 Select the OLE DB Provider

106 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.10. Read an OLE DB Provider

Press the button to the right. The standard OLE DB provider dialog box is displayed:

EDCCM210200-UGD-EN-1 User Guide 107


Chapter 5 Basic Functions

Select the provider you wish to use: in this case the Jet 4.0 to connect to the Microsoft
Office 12.0 Access database. Please note that the OLE DB provider for ODBC will not
work. Microsoft do not support ODBC from a .NET application. You should use the
specific ODBC support in ContentBridge. Press the Next button.

For MS Access you are then required to specify the location of the database. For the
SQL Server or Oracle providers this dialog box will be different. You can test the
connection and then press OK.

108 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.10. Read an OLE DB Provider

Return to the overview of Read OLE DB.

5.10.2 Select the Table or View

EDCCM210200-UGD-EN-1 User Guide 109


Chapter 5 Basic Functions

Select the Table or View (Query) to be read. It is also possible to enter a SQL
statement.

Return to the overview of Read OLE DB.

5.10.3 Preview the Data

110 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.11. Read an XML file

The first 50 rows of the data are displayed to confirm that the correct data will be
imported into ContentBridge.

Return to the overview of Read OLE DB.

5.11 Read an XML file


Highlight Read XML File from the Functions toolbar and drag and drop it on the
grid. The following object will appear:

Click the left icon to display the properties wizard. The two stages of the wizard
allow:

EDCCM210200-UGD-EN-1 User Guide 111


Chapter 5 Basic Functions

• Selection of the XML file. Please note the path can be relative to the map.
• Preview the first 50 rows of data

Click to enlarge Click to enlarge

5.11.1 Select the XML file

112 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.11. Read an XML file

Select the XML file to read. Please note that the path can be relative to the location of
the map.

Return to the overview of Read XML

5.11.2 Preview the Data

EDCCM210200-UGD-EN-1 User Guide 113


Chapter 5 Basic Functions

The first 50 rows are shown.

Return to the overview of Read XML

5.12 Validate Data


ContentBridge offers a number of tools to validate data, checking the content or
format of each row of the data.

Highlight Validate from the Functions toolbar and drag and drop it on the grid. The
following object will appear:

Connect the data from, for example, the output of Text File Read to the input of the
Validatefunction.

Click the left icon to display the properties. Validation can be added as required.
This is done by dragging functions from the right hand toolbar onto the map and
joining a column to that function. Functions are divided into three groups:

114 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.12. Validate Data

• Date and Time


• String
• General

Each column of the data is placed on the map for validation. They can be removed if
required, but validation will only occur for those rows connected to a validate
function on the map. Any number of validation tests can be added and more than
one can be run against a single column.

The data can be previewed from this properties dialog box. Simply push the Preview
button on the top toolbar and browse through the rows of data. For each row
displayed the icon on the validate function will be set to a red cross or a green tick to
indicate if the row displayed will pass each test.

A row must pass all tests to be included in the rows that have passed unless the
OR function is used. This is explained in more detail in the following page.

You can place more than one validate object on the map using this approach to pass
records that pass one test into one output file and another set into a second file. This
approach can be used for example to split a file into New York, Los Angeles and
Boston addresses.

EDCCM210200-UGD-EN-1 User Guide 115


Chapter 5 Basic Functions

5.12.1 Validate data - using OR, AND and NOT


Each validate function has an output. This will be True or False and will indicate if
the validate test is passed. A row will pass validation if all the unconnected outputs
are True. In the example below the validate is shown in preview mode and shows a
simple test to check the Country is equal to “Germany”. The function has been
pinned open to best illustrate the test.

As all the unconnected validate function outputs are True the whole rows passes or
is valid as shown in the bottom left. If we wanted to also pass rows with country
equal to “UK” and “France” we can build the validate as follows. Again the
functions are pinned and the preview mode selected.

116 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.12. Validate Data

The problem is the row fails as at least one of the unconnected outputs is false. This
problem is resolved using the OR function. The outputs of all tests are connected to
the OR which then in turn produces a True as the output. The row passes as the
Country is indeed “Germany” or “France” or “UK”.

The AND and NOT functions can be used to build more complex combinations of
tests. Adding a NOT on the end will only pass rows where the country is not
Germany, France or UK. The combinations are endless and ContentBridge can be
used to carry out all manner of tests on the data.

EDCCM210200-UGD-EN-1 User Guide 117


Chapter 5 Basic Functions

5.12.2 Validate data - Dispositions


Having run a validate of the data you may wish to force a row to pass even though it
has failed the validation tests placed on your map. To do this expand the
Dispositions toolbar as show below.

Any row can be forced to Pass or Fail. The third option, Default, follows the results
of the validation tests included in the map. The icon shows the state of each row.

To change the Disposition:

• Highlight one or more rows


• Press the appropriate button on the Dispositions toolbar
• When you have finished execute the validate object

The dispositions are saved with the map.

5.12.3 Validate Inputs Toolbar

118 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.12. Validate Data

The Inputs toolbar lists all the columns in the


source data for the validate object. By default
all columns appear on the validate map, but
they can be removed and if needed replaced
by dragging from the Input toolbar.

If space is at a premium the toolbar can be


unpinned so that it contracts when not in
use.

5.12.4 Validate Functions Toolbar

EDCCM210200-UGD-EN-1 User Guide 119


Chapter 5 Basic Functions

The Functions Toolbar contains the set of


functions that can be used to validate data.
The toolbar is arranged into three sections as
listed below and described in more details
elsewhere in this user guide.
• General
• String
• Date and Time

If space is at a premium the toolbar can be


unpinned so that it contracts when not in
use.

Each function is described in the reference section.

5.12.5 Validate Functions Toolbar (Date & Time)


ContentBridge provides a series of data and time validation checks. These are
collected into a group within the Functions toolbar and are dragged onto the
validate map when required.

The functions are listed below:

Valid Date Confirms the data is a valid date


AM & PM Confirms the time falls before or after midday
Last, Current, Next Confirms the time falls within the appropriate hour
Hour
Monday - Sunday, Confirms the day is on the appropriate day of the week
Yesterday, Today,
Tomorrow

120 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.12. Validate Data

January - December, last Confirms the date falls in the appropriate month
Month, Current Month,
Next month
Last, Current, Next, 1st, Confirms the date falls in the appropriate quarter
2nd, 3rd, 4th Quarter
Last, Current, Next Year Confirms the date falls in the appropriate year
Last, Current, Next Confirms the date falls in the appropriate financial year
Financial Year

Full descriptions are provided in the reference section.

If you would like to see additional validation functions then please contact
ContentBridgeInfo@opentext.com?subject=Content%20Bridge%20Info.

Please note that these tests are not warranted in any way and while we endeavor to
QC all validation functions data can vary widely and results are not always
predictable. Please email us with any details of any false negatives (good data
classified as bad) or incorrect data passed as valid.

5.12.6 Validate Functions Toolbar (String)


ContentBridge provides a series of string validation checks. These are collected into
a group within the Functions toolbar and are dragged onto the validate map when
required.

In general the string tests do not confirm valid data such as a valid email only a
valid format such as fred@company.com. Fred may not be a valid email recipient at
company.com.

The functions are listed below:

Format Checks the data matches a test provided by a


regular expression.

Please note that this function is only


available with ContentBridge.
Ends With, Starts With, Contains Test the the string includes data
Argentine Post Code Test the format of the data for a match
Alpha Test the format of the data for a match
Alpha Numeric Test the format of the data for a match
Australian Telephone Number Test the format of the data for a match
Australian Post Code Test the format of the data for a match

EDCCM210200-UGD-EN-1 User Guide 121


Chapter 5 Basic Functions

Belgian Post Code Test the format of the data for a match
Brazilian Post Code Test the format of the data for a match
Credit Card Number Test the format of the data for a match
Dutch Post Code Test the format of the data for a match
Email Address Test the format of the data for a match.
European style Postcode Test the format of the data for a match
French Post Code Test the format of the data for a match
Forename/s Surname Test the format of the data for a match. This
test is not as thorough as the Surname test
below
German Post Code Test the format of the data for a match
Italian Post Code Test the format of the data for a match
ISBN Test the format of the data for a match
IP Address Test the format of the data for a match
Length Tests the length of a string
Numeric Test the format of the data for a match
Swedish Phone Number Test the format of the data for a match
Swedish Post Code Test the format of the data for a match
South African Cellular Number Test the format of the data for a match
Spanish Post Code Test the format of the data for a match
Surname, Forename/s Test the format of the data for a match
Surname(detailed) Test the format of the data for a match
UK Bank Sort Code Test the format of the data for a match
UK Car Registration Test the format of the data for a match
UK National Insurance Number Test the format of the data for a match
UK Post Code Test the format of the data for a match
UK Telephone Number Test the format of the data for a match
US Social Security Number Test the format of the data for a match
URL Test the format of the data for a match
US State Abbreviation Test the format of the data for a match
US Telephone Number Test the format of the data for a match
US Zip Code Test the format of the data for a match
US or Canadian Zip Code Test the format of the data for a match
US, Canadian or UK Zip Code Test the format of the data for a match

122 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.12. Validate Data

Full descriptions are provided in the reference section.

If you would like to see additional validation functions then please contact
ContentBridgeInfo@opentext.com?subject=Content%20Bridge%20Info.

Please note that these tests are not warranted in any way and while we endeavor to
QC all validation functions data can vary widely and results are not always
predictable. Please email us with any details of any false negatives (good data
classified as bad) or incorrect data passed as valid.

5.12.7 Validate Functions Toolbar (General)


ContentBridge provides a series of general validation checks. These are collected
into a group within the Functions toolbar and are dragged onto the validate map
when required.

The functions are listed below:

AND Used to combine validation tests


NOT Used to combine validation tests
OR Used to combine validation tests
Compare Checks the data against a value. This
function is used for all data types including
numeric, date, time and string
Lookup Checks the data falls with a reference table of
allowed values. These

can be from an imported database or file or


manually entered.
Not Empty Confirms the string is not a Null, an empty
string or whitespace chars
Not NULL Confirms the data is not a NULL
Null Confirms the data is NULL
Range Checks the data falls within a range. This
function is used for all data types including
numeric, date, time and string
Script Allows a test to be written in VBScript.

Full descriptions are provided in the reference section.

If you would like to see additional validation functions then please contact
ContentBridgeInfo@opentext.com?subject=Content%20Bridge%20Info.

EDCCM210200-UGD-EN-1 User Guide 123


Chapter 5 Basic Functions

Please note that these tests are not warranted in any way and while we endeavor to
QC all validation functions data can vary widely and results are not always
predictable. Please email us with any details of any false negatives (good data
classified as bad) or incorrect data passed as valid.

5.13 Transform data


ContentBridge allows you to transform the data before writing to an output file or
database.

Drag and drop the Transform function to the map.

For example connect the output data from a Validateto the input of a Transform.

Click the left icon of theTransform to display the properties:

The columns of the input and output (if defined) appear on the map. ContentBridge
will make an attempt to match input data to output data by the column name. This

124 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.13. Transform data

mapping can then be adjusted as required. Not all data has to map to fields and data
can be moved to more than one field in the destination file or database.

The columns displayed on the left show the data entering the Transformation. The
columns on the right show the output. The reset button will do one of the following:

• Where an object with a data schema (a database) is connected to the


transformation output the columns defined in that schema will appear in the
Columns toolbar
• Where no object is connected the transformation output or one with no schema (a
write to a text file) the input columns are copied to the output

New columns can be defined as required by pressing the edit button.

The Auto-Map button will attempt to match the input columns to the output
columns.

Functions can be applied to the data to carry out a transformation. The Functions
toolbars on the left show the available transformation functions.

Tasks carried out include:

• Append: allowing data to be added to the end of the data in a field


• Abbreviation: Transforming data to and from the Abbreviation to the full term
• Prefix: adding data in front of the data in a field
• Concatenate: combining two or more fields together. A delimiter can be added
between the fields to for example add Ian and Smith with a space in between
• Lookup: pointing to a reference list or table. This is discussed in greater details
elsewhere
• Lower-case: changing the case of data
• Upper-case: changing the case of data
• Split: used for example to split a full name into Forename/s and Surname
• Name Split: A split function specifically designed to handle contact details
• Trim: removing unwanted characters from the data
• Left and Right: selecting the first n characters or all those up to a certain
character such as a space

To use a function drag in onto the map and join it into the flow for the appropriate
field.

At any time the data can be previewed by pressing the Preview button on the top
toolbar. You can then browse through the data to see how the transformation will
affect the actual data.

EDCCM210200-UGD-EN-1 User Guide 125


Chapter 5 Basic Functions

5.13.1 Transform Toolbar (Inputs)


The Inputs toolbar lists all the columns in the
destination data for the Transform object. By
default all columns appear on the transform
map, but they can be removed and if needed
replaced by dragging from the Inputs
toolbar.

If space is at a premium the toolbar can be


unpinned so that it contracts when not in
use.

5.13.2 Transform Toolbar (Outputs)

126 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.13. Transform data

The Outputs toolbar lists all the columns in


the destination data for the Transform object.
If you use the Auto-Map function by default
all columns will appear on the transform
map, but they can be removed and if needed
replaced by dragging from the Outputs
toolbar.

Any new columns or fields created will


appear in this list.

If space is at a premium the toolbar can be


unpinned so that it contracts when not in
use.

The Edit button allows adjustments to the


schema of the output. This is described in
more details elsewhere in this help
document.

The Reset button resets the columns to match


the output of the ContentBridge map. This is
described in more details elsewhere in this
help document.

5.13.3 Transform Toolbar (Functions)

EDCCM210200-UGD-EN-1 User Guide 127


Chapter 5 Basic Functions

The Functions toolbar lists all transform


functions available within ContentBridge. To
use a function drag it onto the transform
map and connect as appropriate.

The functions are described in full in the


Reference section of this manual, but are
listed in a page on each group:
• String
• General

If space is at a premium the toolbar can be


unpinned so that it contracts when not in
use.

If you would like to see additional validation functions then please contact
ContentBridgeInfo@opentext.com?subject=Content%20Bridge%20Info.

Please note that these tests are not warranted in any way and while we endeavor to
QC all validation functions data can vary widely and results are not always

128 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.13. Transform data

predictable. Please email us with any details of any false negatives (good data
classified as bad) or incorrect data passed as valid.

5.13.4 Transform Toolbar (String Functions)


The following String transformation functions are provided:

Append Appends text to the end of a string


Concatenate Joins two or more text fields into a single
field. A separator can

be specified. For example the First and last


name might be

concatenated with a space in between


Length Determines the length of a string
Lower, Upper case Adjusts the case of a string
Proper Case Adjusts the case to a capital at the first
character of each word
Sentence Case Places a capital at the start of each sentence
Pad Adds characters to the left or right of the
data to pad the result to a fixed length or one
set by an input
Prefix Places a string in front of the data
Remove Removes one or more characters from a
string
Replace Replaces one or more characters from a
string with one or more

characters
Right, Left, Middle Extracts characters from the right, left or
middle of a string. Can

also be used to, for example, extract all


characters up to the 2nd occurrence of a test
character
Split Splits a string into one or more separate
fields. The separator is

specified. For example “Mr John Bull” is split


into three fields
Trim, Left trim, Right trim Removes Spaces, Tabs, Carriage Returns and
Linefeeds from

both, the left or the right end of a string

Full descriptions are provided in the reference section.

EDCCM210200-UGD-EN-1 User Guide 129


Chapter 5 Basic Functions

If you would like to see additional validation functions then please contact
ContentBridgeInfo@opentext.com?subject=Content%20Bridge%20Info.

Please note that these tests are not warranted in any way and while we endeavor to
QC all validation functions data can vary widely and results are not always
predictable. Please email us with any details of any false negatives (good data
classified as bad) or incorrect data passed as valid.

5.13.5 Transform Toolbar (General Functions)


The following General transformation functions are provided:

First Non Null Returns the first value from a number of


inputs that is not null. This function is used if
a number of different transformations are
made on the data and where only one is
expected to produce a result.
If Allows a test to be made on the field data
and the output to be set according to the
results of this test

Supports up to 4 inputs and supports literal


values as well as row data
Lookup Matching a field against an allowed value in
a reference table or list
Script Allowing VBScript to be used to create a
transformation function.
ToBoolean, ToDateTime... ContentBridge makes a best bet at the data
typeto use, but this series of functions allow
a data type to be forced.

Full descriptions are provided in the reference section.

If you would like to see additional validation functions then please contact
ContentBridgeInfo@opentext.com?subject=Content%20Bridge%20Info.

Please note that these tests are not warranted in any way and while we endeavor to
QC all validation functions data can vary widely and results are not always
predictable. Please email us with any details of any false negatives (good data
classified as bad) or incorrect data passed as valid.

130 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.13. Transform data

5.13.6 Auto-Map
Please ensure you have saved the Transformation before proceeding with the
Auto-Map function.

The Auto-Map function is available from the Transform object properties dialog box.
It automatically maps the input columns to output columns. A number of options
are presented before proceeding.

Columns are matched using the column title. This match can be made based on one
or more of the following:

• An exact map of names


• Mapping a name against an alias. ContentBridge holds a list of common aliases
for common data names. This alias list is found in a file, AliasLists.xml, can be
edited. If you do change this file, please make a backup copy before proceeding
• A map based on part of the input name matching the output column name

You can also choose to reset the outputs before running the Auto-Map and restrict
the map to the first found.

The mapping process will proceed after pressing OK. If you wish to reverse the
process cancel the transformation properties dialog box.

EDCCM210200-UGD-EN-1 User Guide 131


Chapter 5 Basic Functions

5.13.7 Transform - Output Schema


Adjustments to the Schema can be made by pressing the Edit button at the bottom

Fields can be added or removed and the data type can be adjusted. Columns may be
renamed, the order adjusted and a column may be set as the primary key.

Defining the Primary Key can be important. When data is written to a database
ContentBridge will use the primary key to look for a matching row in the target
database. If one is found an Update is used rather than an Insert and only the
changes written to the database.

Please note: The column defined as a primary key in ContentBridge does not need
to match those columns set as indexes in the database. It needs to be a single unique
column used by ContentBridge to find if a row already exists in the target database.
It will help with performance if the column is also an index in the database.

132 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.14. De-Duplicate data

You can explore this by reading from a database table, passing it through a
transform and then writing out to the same table. Then try setting and unsetting the
primary key.

Please see further notes on Databases, data types and schemas.

5.14 De-Duplicate data


ContentBridge allows you to look for duplicate data before writing to an output file
or database. You can use this for example to check for duplicate records in the data
you are about to add to your marketing database.

There are two input data feeds. The source data or the data to be checked for
duplicates and the reference data. If you feed the same data into both inputs
ContentBridge will check for duplicates in the single data source you need to check
the Retain First Match. The De-duplication ignores case and ignores any spaces in
the data.

Drag and drop the De-Duplication function to the map.

Click the left icon to display the properties wizard. The two stages of the wizard
allow:

• Selection of the columns to use for the de-duplication.


• Set the matching properties, for example specify the score to classify a row as a
duplicate.

EDCCM210200-UGD-EN-1 User Guide 133


Chapter 5 Basic Functions

Click to enlarge
Click to enlarge Click to enlarge

5.14.1 Define Columns

134 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.14. De-Duplicate data

Select the columns to be used for the De-Duplication. You should select the columns
carefully listing the smallest number possible and placing them in an order that will
produce the highest rejection of duplicates with the first column in the list.

You may be best advised to create a new column with the fields that must be used to
check for duplicates. Where two separate columns are selected ContentBridge may
conclude that two rows are or are not duplicates based on the first column. This
approach is taken to optimize the processing required.

Return to the overview of De-Duplication object.

5.14.2 Define Matching Rules

Set the level at which the data is regarded as duplicate. A higher figure sets a more
stringent test of records being duplicates

When you are de-duplicating a file against itself you will need to check the box to
allow the first row to be passed.

If the amount of data is large you can optimize by rejecting data initially on only the
first character. Selecting this option could treat as unique records that are actually a
duplicate, but with a typing error on the first character. Smith and Dmith will be
considered non-duplicate.

EDCCM210200-UGD-EN-1 User Guide 135


Chapter 5 Basic Functions

If the Match Nulls checkbox is left unchecked ContentBridge will not make a
comparison if data is missing. For example this can be used if the Social Security
Number is used to compare but may not always be present.

You can enter data and make test comparisons. The test score is shown and the color
changes as the test goes from Different (green) to Identical (red). You can try the
effect of the match Nulls checkbox using this Test Score facility.

Return to the overview of De-Duplication object.

5.14.3 Results of a De-Duplication


The De-duplication function has two inputs and two outputs. These are are shown
in the data panel

The Source data is compared with the Reference data looking for any duplicates.
The unique rows are shown in the Unique tab and the candidates for duplicates in
the Duplicate panel.

The duplicates are shown with the data from the reference row that matches. The
score is also given. In the example above “Anne Devon” is considered a match with
“Ann Devon”.

The Dispositions toolbar can be used to force a duplicate to be considered unique


and a unique row to be considered a duplicate. This works in the same way as
dispositions for the Validatefunction. Please remember that you may also want to
bring up the properties of the De-Duplication function and change the de-duplicate
score or add more columns to the comparison.

Return to the overview of De-Duplication object.

136 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.15. Merge data

5.15 Merge data


The Merge function allows you to combine two or more data streams. This function
will merge both rows and columns using the title to distinguish new columns and
the primary key to find new rows.

There are two or more input data feeds. Connect your source data into the inputs on
the left. A single output on the right is the merged data.

Drag and drop the Merge function to the map.

Connect the input data. This function has no properties. After execution the data
panel will show each input data and the resulting merged data.

Where the column titles do not match the Mergewill add a new column to the
output.

Avoiding creating duplicates

How does ContentBridge handle rows that appear in more than one input? Will it
create duplicate records? No this can be avoided.

If the input data has a unique ID you can prevent the Merge function creating
duplicates. Define the column that is the primary key in each of the input streams.
This can be done for example when the data file is read in using a Text Reador by
editing the data schema in a Transform.

The Merge function will use the primary key to identify rows in both data streams
that are the same record. The merge then applies “last edit wins” or give precedence
to the row from the last data input.

To read further about schemasand how ContentBridge handles the structure of the
data please follow this link.

EDCCM210200-UGD-EN-1 User Guide 137


Chapter 5 Basic Functions

5.16 Sort data


The Sort function allows you to sort data by one or more columns.

It has a single input and a single output.

Drag and drop the Sort function to the map.

Connect the input data and the output data.

Click the left icon of theSort to display the properties:

Add as many columns as you need to sort by. The sort order is the order the
columns appear in the properties dialog box. The icons on the toolbar allow you to
add, remove and change the order of the columns. Highlight an entry to change
columns or change the sort order from ascending to descending or back again.

When you have finished press the finish button. The function will execute on saving.

138 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.17. Custom Table

Please note that this function will not work when combined with the
Batchfunction.

5.17 Custom Table


ContentBridge allows you to manually enter data for use as validation lists. One
example might be a list of allowed titles such as Mr, Mrs, Ms, Miss, Master, Rev etc..

Drag and drop the Custom Tablefunction to the map.

Click the left icon of theCustomTable to


display the properties:

EDCCM210200-UGD-EN-1 User Guide 139


Chapter 5 Basic Functions

Add New fields as required and set the data


type. You can set one column as the primary
key.

Click Finish the complete the wizard.

140 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.18. Write to a text file

Display the Data panel and type in the


values you need.

This table is then used with the lookup function to validate data.

5.18 Write to a text file


Drag and drop the Write File function to the map:

Connect the output of a previous stage to the input of aWrite Text File .

Click the left icon of the Write Text Fileobject to display the properties. The two or
three stages of the wizard allow:

EDCCM210200-UGD-EN-1 User Guide 141


Chapter 5 Basic Functions

• The definition of the output file and if the data should be appended or to replace
the data in that file
• The format of the output data
• If a Fixed-Width file a third stage to define the widths of each column

Click to enlarge Click to enlarge Click to enlarge

By default all export functions on the map are in the mode of Prompt . This can be
seen by the gear with double blue lines showing as the icon on the right of the Write
Text File object. This is the default to protect the user from unwittingly overwriting
data. If you click on this icon it will cycle through three possible states:

Manual execution only. This function will


not execute as part of a cascade all or
Cascade execution.
Prompt before continuing execution

Continue execution without a prompt

You are advised to backup any output files before executing writes using
ContentBridge.

142 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.18. Write to a text file

5.18.1 Select File

Enter the file to which the data should be written. This can be an existing file or a
new one. If it is an existing file you can choose to append new records or to replace
them.

Please note that ContentBridge will accept a path relative to the map or an absolute
path.

The encoding settings allows ContentBridge to support a number of text formats.


Use the default, UTF-7.

EDCCM210200-UGD-EN-1 User Guide 143


Chapter 5 Basic Functions

5.18.1.1 Parameterized File Name


Write to a Text File addin will now allow parameterized Values for log file name.
The allowed parameters that filename can select are listed below.

For eg, The filename can be like ‒

testfilename -$value(batch_id)-$value(datetime)- $value(DDName!ColumnName)'


or �testfilename-$value(batch_id)' etc..

The format should always match the below.

• $value (batch_id): current batch number.


• $value(date) : current date in the format ‒ dd-MM-yyyy
• $value(datetime) : current dateTime in the format ‒ yyyy-MM-dd hh.mm.ss
• $value (DDName!ColumnName): looks up for a column from the
Datadictionary. DDName' in the key mentioned can be any custom table addin in
the map followed by an ! (exclamation symbol) and column name can be any
column present in that particular Custom table. The custom table name and
column name are case sensitive and to be entered exactly as defined in the map.

Make sure that you have saved the old file before you undertake this task.

Return to the overview of Write Text File.

5.18.2 Define Format

144 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.18. Write to a text file

The stage defines the format of the file to be written.

Select Delimited or Fixed With. Normally you are better advised to select a
delimited file with the Field Delimiter as a comma and the Text Qualifier as double
quotes. These are the default settings.

You can also choose to include column headings as the first row by checking the
box.

The default Record Separator is CR + LF, the default for Windows files, but you can
also select LF only as is used for UNIX files or CR only as is used for Mac files.
Lastly you can specify the format of date fields.

These both apply to both Delimited and Fixed Width files.

Return to the overview of Write Text File.

EDCCM210200-UGD-EN-1 User Guide 145


Chapter 5 Basic Functions

5.18.3 Define Schema

The stage defines the widths of the fields.

For each field define the data type and the maximum width. The data will be
truncated or padded to fit.

Return to the overview of Write Text File.

5.19 Write MS Access


Highlight Write MS Access from the Functions toolbar and drag and drop it on the
grid. The following object will appear:

Click the title bar to display the properties wizard. The two stages of the wizard
allow:

146 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.19. Write MS Access

• Selection of the MS Access database.


• Select a table. You are able to create a table at this time. If the table does not have
a primary key a warning is given. ContentBridge can handle updates (changes)
to data in the place of an append where the primary key allows the row to be
identified.

Click to enlarge Click to enlarge

By default all export functions on the map are in the mode of Prompt . This can be
seen by the gear with double blue lines showing as the icon on the right of the Write
MS Access object. This is the default to protect the user from unwittingly
overwriting data. If you click on this icon it will cycle through three possible states:

Manual execution only. This function will


not execute as part of a cascade all or
Cascade execution.
Prompt before continuing execution

Continue execution without a prompt

You are advised to backup your database before executing writes using
ContentBridge.

EDCCM210200-UGD-EN-1 User Guide 147


Chapter 5 Basic Functions

5.19.1 Select Database

Enter the Access database to which the data should be written. If the access database
has users and passwords then these will also need to be entered here.

Please note that ContentBridge will accept a path relative to the map or an absolute
path. In the screenshot above the map and the text file are in the same folder.

You can create a database from ContentBridge.

Make sure that you have saved the Access database before you undertake this
task.

Return to the overview of Write MS Access.

148 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.20. Write MySQL

5.19.2 Select Table

Select the destination table as the Customers table

Please note ContentBridge can also create a new table that matches your data.

You can select the option to empty the table before importing the new data.

Return to the overview of Write MS Access.

5.20 Write MySQL


Please ensure that you have spoken to your system administrator before attempting
to connect to or write to a SQL Server database.

Highlight Write MySQL from the Functions toolbar and drag and drop it on the
grid. The following object will appear:

Click the left icon to display the properties wizard. The three stages of the wizard
allow:

• Selection of the MySQL Server.

EDCCM210200-UGD-EN-1 User Guide 149


Chapter 5 Basic Functions

• Selection of the Database.


• Selection of the Table.

Click to enlarge Click to enlarge Click to enlarg

By default all export functions on the map are in the mode of Prompt . This can be
seen by the gear with double blue lines showing as the icon on the right of the Write
MySQLobject. This is the default to protect the user from unwittingly overwriting
data. If you click on this icon it will cycle through three possible states:

Manual execution only. This function will


not execute as part of a cascade all or
Cascade execution.
Prompt before continuing execution

Continue execution without a prompt

You are advised to backup your database before executing writes using
ContentBridge.

5.20.1 Select the Server

150 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.20. Write MySQL

Select the MySQL Server to write data to. Enter the port to use for the connection, a
username and password.

Return to the overview of Write MySQL.

5.20.2 Select the Database

EDCCM210200-UGD-EN-1 User Guide 151


Chapter 5 Basic Functions

Select a database from the list displayed. A new database can be created from within
ContentBridge, but this is normally best done using MySQL tools.

Return to the overview of Write MySQL.

5.20.3 Select the Table

152 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.20. Write MySQL

Select the destination table from the list. The schema is displayed and all the
potential mismatches and problems are highlighted in red.

ContentBridge can empty the table prior to the data import and you are
recommended to use rollback.

A new table can be created from within ContentBridge. Care is needed in handling
the Primary keys and normally you can leave the database engine to create the
unique IDs rather than attempting to import data into this field. Please see below:

• The Identity insert is used when you are moving a number of tables and want to
preserve the relationships. Normally you should avoid writing to the identity
column, but in some circumstances you may want this option.

Return to the overview of Write MySQL.

EDCCM210200-UGD-EN-1 User Guide 153


Chapter 5 Basic Functions

5.21 Write Microsoft SQL Server


Please ensure that you have spoken to your system administrator before attempting
to connect to or write to a SQL Server database.

Highlight Write MS SQL from the Functions toolbar and drag and drop it on the
grid. The following object will appear:

Click the left icon to display the properties wizard. The three stages of the wizard
allow:

• Selection of the SQL Server.


• Selection of the Database.
• Selection of the Table.

Click to enlarge Click to enlarge Click to enlarge

By default all export functions on the map are in the mode of Prompt . This can be
seen by the gear with double blue lines showing as the icon on the right of the Write
MS SQL object. This is the default to protect the user from unwittingly overwriting
data. If you click on this icon it will cycle through three possible states:

Manual execution only. This function will


not execute as part of a cascade all or
Cascade execution.
Prompt before continuing execution

154 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.21. Write Microsoft SQL Server

Continue execution without a prompt

You are advised to backup your database before executing writes using
ContentBridge.

5.21.1 Select the Server

Select the SQL Server to write data to. Where you are not using Windows security
enter a username and password.

Return to the overview of Write MS SQL.

EDCCM210200-UGD-EN-1 User Guide 155


Chapter 5 Basic Functions

5.21.2 Select the Database

Select a database from the list displayed. A new database can be created from within
ContentBridge, but this is normally best done using SQL Server's Enterprise
Manager.

Return to the overview of Write MS SQL.

5.21.3 Select the Table

156 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.21. Write Microsoft SQL Server

Select the destination table from the list. The schema is displayed and all the
potential mismatches and problems are highlighted in red. In this case shown here
there are a number of columns that fail to match.

ContentBridge can empty the table prior to the data import and you are
recommended to use rollback. The Identity Inserts is an option to allow the inserts
(generally to an empty table) to include inserting the value of the primary key into
the target table. This should be used with caution as you need to avoid creating non-
unique indexes for a identity column.

A new table can be created from within ContentBridge. Care is needed in handling
the Primary keys and normally you can leave the database engine to create the
unique IDs rather than attempting to import data into this field.

Return to the overview of Write MS SQL.

EDCCM210200-UGD-EN-1 User Guide 157


Chapter 5 Basic Functions

5.22 Write to a SQL Compact database


Highlight Write MS SQL Server Compact 3.5from the Functions toolbar and drag
and drop it on the grid. The following object will appear:

Click the left icon to display the properties wizard. The two stages of the wizard
allow:

• Selection of the SQL Compact database. Click on the image to see more details.
• Select a table from within the database.

Click to enlarge Click to enlarge

By default all export functions on the map are in the mode of Prompt . This can be
seen by the gear with double blue lines showing as the icon on the right of the Write
Text File object. This is the default to protect the user from unwittingly overwriting
data. If you click on this icon it will cycle through three possible states:

Manual execution only. This function will


not execute as part of a cascade all or
Cascade execution.
Prompt before continuing execution

Continue execution without a prompt

You are advised to backup your database before executing writes using
ContentBridge.

158 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.22. Write to a SQL Compact database

5.22.1 Select the Database

Select the SQL Compact database to write the data to. Next enter the password, if
used.

Return to the overview of Write SQL Compact.

5.22.2 Select the Table

EDCCM210200-UGD-EN-1 User Guide 159


Chapter 5 Basic Functions

Select the destination table from the list. The schema is displayed and all the
potential mismatches and problems are highlighted in red. In this case shown here
there are a number of columns that fail to match. Care is needed in handling the
Primary keys and normally you can leave the database engine to create the unique
IDs rather than attempting to import data into this field.

ContentBridge can empty the table prior to the data import and supports rollback

Return to the overview of Write SQL Compact.

5.23 Write to an Oracle database


The Oracle objects will only appear in the toolbars if the Oracle client software,
ODAC, is loaded on your machine.

Highlight Write Oracle from the Functions toolbar and drag and drop it on the grid.
The following object will appear:

160 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.23. Write to an Oracle database

Click the left icon to display the properties wizard. The two stages of the wizard
allow:

• Selection of the Oracle database. This involves a few steps. Click on the image to
see more details.
• Select a table from within the database.

Click to enlarge Click to enlarge

By default all export functions on the map are in the mode of Prompt . This can be
seen by the gear with double blue lines showing as the icon on the right of the Write
Text File object. This is the default to protect the user from unwittingly overwriting
data. If you click on this icon it will cycle through three possible states:

Manual execution only. This function will


not execute as part of a cascade all or
Cascade execution.
Prompt before continuing execution

Continue execution without a prompt

You are advised to backup your database before executing writes using
ContentBridge.

EDCCM210200-UGD-EN-1 User Guide 161


Chapter 5 Basic Functions

5.23.1 Select the Server

Select the Oracle database to write the data to. Next enter the username and
password.

Return to the overview of Write Oracle.

5.23.2 Select the Table

162 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.24. Write to an ODBC database

Select the destination table from the list. The schema is displayed and all the
potential mismatches and problems are highlighted in red. In this case shown here
there are a number of columns that fail to match. Care is needed in handling the
Primary keys and normally you can leave the database engine to create the unique
IDs rather than attempting to import data into this field.

ContentBridge can empty the table prior to the data import and supports rollback

Return to the overview of Write Oracle.

5.24 Write to an ODBC database


Highlight Write ODBC from the Functions toolbar and drag and drop it on the grid.
The following object will appear:

Click the left icon to display the properties wizard. The two stages of the wizard
allow:

EDCCM210200-UGD-EN-1 User Guide 163


Chapter 5 Basic Functions

• Selection of the ODBC database. This involves a few steps. Click on the image to
see more details.
• Select a table from within the database.

Click to enlarge Click to enlarge

ODBC provides very broad connectivity to databases. It, or OLE DB, can be used to
access a wide range of data sources. If OpenText has published a specific data
connector, for example for Access, SQL Server or ACT! 6 you are best advised to use
that rather than ODBC or OLE DB. Given the choice of OLE DB or ODBC you
should normally use OLE DB.

By default all export functions on the map are in the mode of Prompt . This can be
seen by the gear with double blue lines showing as the icon on the right of the Write
Text File object. This is the default to protect the user from unwittingly overwriting
data. If you click on this icon it will cycle through three possible states:

Manual execution only. This function will


not execute as part of a cascade all or
Cascade execution.
Prompt before continuing execution

Continue execution without a prompt

You are advised to backup your database before executing writes using
ContentBridge.

164 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.24. Write to an ODBC database

5.24.1 Select the ODBC Database

Select the ODBC database to write the data to. Selection is made through a System,
User or File DSN. Enter the username and password if required.

If you have not set-up one you can do this by pressing the Manage Data Sources
button.

EDCCM210200-UGD-EN-1 User Guide 165


Chapter 5 Basic Functions

Add a System DSN following the instructions on screen. Press the Refresh Data
Sources after you have added the DSN. Select the DSN and press the Next button.

Return to the overview of Write ODBC.

5.24.2 Select the Table

166 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.25. Write to an OLE DB Provider

Select the destination table from the list. The schema is displayed and all the
potential mismatches and problems are highlighted in red. In this case shown here
there are a number of columns that fail to match. Care is needed in handling the
Primary keys and normally you can leave the database engine to create the unique
IDs rather than attempting to import data into this field.

ContentBridge can empty the table prior to the data import.

Return to the overview of Write ODBC.

5.25 Write to an OLE DB Provider


Highlight Write OLEDB from the Functions toolbar and drag and drop it on the
grid. The following object will appear:

Click the left icon to display the properties wizard. The two stages of the wizard
allow:

EDCCM210200-UGD-EN-1 User Guide 167


Chapter 5 Basic Functions

• Selection of the OLE DB provider. This involves a few steps. Click on the image
to see more details.
• Select a table or view (query) from within the database. You can also enter a SQL
statement.

Click to enlarge Click to enlarge

OLE DB provides very broad connectivity to databases. It or ODBC can be used to


access a wide range of data sources. IfOpenText haspublished a specific data
connector, for example for Access, SQL Server or ACT! 6 you are best advised to use
that rather than ODBC or OLE DB. Given the choice of OLE DB or ODBC you
should normally use OLE DB.

By default all export functions on the map are in the mode of Prompt . This can be
seen by the gear with double blue lines showing as the icon on the right of the Write
Text File object. This is the default to protect the user from unwittingly overwriting
data. If you click on this icon it will cycle through three possible states:

Manual execution only. This function will


not execute as part of a cascade all or
Cascade execution.
Prompt before continuing execution

Continue execution without a prompt

You are advised to backup your database before executing writes using
ContentBridge.

168 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.25. Write to an OLE DB Provider

5.25.1 Select OLE DB Provider

Press the button to the right. The standard OLE DB provider dialog box is displayed:

EDCCM210200-UGD-EN-1 User Guide 169


Chapter 5 Basic Functions

Select the provider you wish to use. In this case the Jet 4.0 to connect to an Access
database. Please note that the OLE DB provider for ODBC will not work. Microsoft
do not support ODBC from a .NET application. You should use the specific ODBC
support in ContentBridge. Press the Next button.

170 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.25. Write to an OLE DB Provider

For MS Access you are then required to specify the location of the database. For the
SQL Server or Oracle providers this dialog box will be different. You can test the
connection and then press OK.

EDCCM210200-UGD-EN-1 User Guide 171


Chapter 5 Basic Functions

Return to the overview of Write OLE DB.

5.25.2 Select Table

172 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.26. Write to an XML file

Select the destination table from the list. The schema is displayed and all the
potential mismatches and problems are highlighted in red. In this case shown here
there are a number of columns that fail to match. Care is needed in handling the
Primary keys and normally you can leave the database engine to create the unique
IDs rather than attempting to import data into this field.

ContentBridge can empty the table prior to the data import.

Return to the overview of Write OLE DB.

5.26 Write to an XML file


Drag and drop the Write XML File object to the map:

Connect the output of a previous stage to the input of aWrite XML File .

EDCCM210200-UGD-EN-1 User Guide 173


Chapter 5 Basic Functions

Click the left icon of the Write XML File object to display the properties. There is
only one stage to the wizard:

• The definition of the output file and if the data should be appended, or to replace
the data in that file and some details of the format.

Click to enlarge

By default all export functions on the map are in the mode of Prompt . This can be
seen by the gear with double blue lines showing as the icon on the right of the Write
XML File object. This is the default to protect the user from unwittingly overwriting
data. If you click on this icon it will cycle through three possible states:

Manual execution only. This function will


not execute as part of a cascade all or
Cascade execution.
Prompt before continuing execution

174 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.26. Write to an XML file

Continue execution without a prompt

You are advised to backup any output files before executing writes using
ContentBridge.

EDCCM210200-UGD-EN-1 User Guide 175


Chapter 5 Basic Functions

5.26.1 Write XML file properties

Select the XML file to write to. if the records should be appended and the format of
the output. The format is set as for the ToDatefunction

Please note that the path can be relative to the location of the map.

Return to the overview of Write XML

5.26.2 Object Importer


The Object Importer checkbox when checked will write the desired XML file to the
location specified. It requires the user to change the values in the fields as follows:

• Document Element Name: Change this to ‘Import’.

• Element Name: Change this to ‘Node’.

The input table for the Node field requires the user to specify the values in the
following columns:

176 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.27. Executing a Map

• Action: Specify the type and action separated by commas. For example: The
action ‘document, create’ generates a new document. In this command, the type
is ‘document’, and the action is ‘create’.
• Category name_attribute name: Specify if the input table has a specific category
which is defined by an attribute.For example: Content Server_Vdatabook. In this
example, ‘Content Server’ is the category and the attribute is ‘Vdatabook’. Ensure
that there is an underscore (_) separating the category name and the attribute.

For more information on using the Object Importer feature, see the sample map
“Sample Map - Object Importer” on page 193 included with your version of
ContentBridge.

5.27 Executing a Map


ContentBridge offers number of ways to execute the reading, validation,
transformation and writing of data. ContentBridge is designed to handle large
amounts of data efficiently, but the sophisticated control of execution can help
prevent unnecessary processing.

Three Levels of execution are offered:

Execute Function or Shift F5, executes only the highlighted function


Execute Cascading or F5, executes the highlighted function and all that follow
Execute All or Control F5, executes all functions

The main toolbar provides a buttons for Execute, Execute Cascading and Stop
Executing

Note: If data is modified manually then care must be taken not to execute functions
that will overwrite this change. As an example a text file can be read and then
following validation problem rows modified by hand. If you save the map the
changes to the data are stored and are reloaded when the map is reloaded. If you
execute the text file read again these changes will be lost. To protect the data you
have modified you can set any function so that it will not execute automatically.

EDCCM210200-UGD-EN-1 User Guide 177


Chapter 5 Basic Functions

5.27.1 Execute mode


By default all export functions on the map are set to execute when prompted. This
can be seen by the gear with two blue rectangles showing as the icon on the right of
for example the Write Text File object. This is the default to protect the user from
unwittingly overwriting data. If you click on this icon it will cycle through three
possible states:

Manual Execute Manual execution only. This


function will not execute as
part of a cascade all or
Cascade execution.
Prompt Execute Prompt before continuing
execution
Auto Execute Continue execution without a
prompt

All other objects are set to Auto execution by default.

5.28 Trial Mode


ContentBridge provides a Trial Mode for working with large files. Place your
primary read into trial mode and you restrict the execution of that object to just 50
rows. This will allow you to quickly test changes to the map as you work without
needing to wait for perhaps tens or even hundreds of thousands of rows to execute.

178 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.29. Batch Processing

Just right click on an object and select the


Trial mode menu item. You can also use the
Functions menu.

As soon as you are happy with the map just


switch off trial mode and execute the entire
data.

The evaluation copy of ContentBridge is


restricted by forcing all export functions into
the trial mode.

Please also remember that you can use Batch


Modefor very large files.

5.29 Batch Processing


ContentBridge provides a batch mode for handling large files. If very large files are
imported and worked on using ContentBridge the memory required on your
machine can become excessive and can adversely effect the responsiveness of
Windows. ContentBridge provides a batch processing mode that allows very large
files to be handled without any noticeable effect.

Depending on your machine, file sizes in excess of 10,000 - 100,000 rows may present
problems and you are advise to make use of this facility. In Batch Mode
ContentBridge will process a batch of data from start to end before moving on to the
next batch.

EDCCM210200-UGD-EN-1 User Guide 179


Chapter 5 Basic Functions

Please remember that you can use Trial Modewhile building your map. This will
restrict processing to just 50 rows and allow you to quickly test changes made to the
map.

All you need to is switch a read object into


Batch Mode.
• Set the Batch size in the Map, Properties
menu. A setting of perhaps 5,000-20,000
would be a good starting position. This is
set in Map Properties
• Right click on your primary data read
and click on the Batch item in the context
menu. You can also set this by
highlighting a function and setting batch
mode on from the Functions menu.
• When you “execute all” the processing
will proceed in batches

The Output panel shows the operations of batches, in this case for a batch size of
10,000 rows and handling 22,979 rows.

180 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.30. Database and File Reads

Please note that the batch mode reduces the data held in memory to a single batch. A
necessary effect of this is that the data panel will only show the data for the last
batch executed.

5.30 Database and File Reads


ContentBridge provides a facility to connect to a growing range of databases and
data files. In general all the supported types can be used as for either a read or a
write. This can allow you, for example, to import from a CSV file to an Access
database. You can equally well use ContentBridge to extract data from an another
Access database or a spreadsheet.

The data files and databases supported by ContentBridge are given in Appendix A.

If you would like to see additional data connector functions then please contact
ContentBridgeInfo@opentext.com?subject=Content%20Bridge%20Info.

EDCCM210200-UGD-EN-1 User Guide 181


Chapter 5 Basic Functions

5.31 Sample Maps installed with ContentBridge


A small number of sample maps are installed into the samples folder. These will
show some techniques for handling some common data problems.

The tutorial provides a good place to start. The tutorial will take you through
building a simple ContentBridge map importing some contact data, validating this
data and making some small changes to the format. As you go through the tutorial
you will build a map. A completed tutorial map is also provided with the
ContentBridge install. This is not covered in this section as it is covered by the
tutorial.

Map Description
Flat.dbm Demonstrates how to handle a data file that
has relational data presented in a flat file. In
this sample there are many child records in
each line.
Normalise.dbm This sample demonstrates how to handle a
data file that has relational data presented in
a flat file. In this sample there is only one
child record in each line. There is also a
second map, Normalise2.dbm, showing an
alternative approach to solve the same
problem.
Length.dbm Demonstrates how to validate data on the
length of a combination of two columns.
Outlook_Registration.dbm Demonstrates how to read emails from the
Outlook Inbox, looking for emails presented
by a web form.
Employee.dbm This example demonstrates how to handle
pointers to reference data when moving data
from one database to another.
Contact_Name_Split.dbm Demonstrates how to use the Name Split
Transform function to split a single contact
filed into individual fields.
DataFlex_Sample.dbm Demonstrates how to read in a DataFlex
table, make a change to the data and the
write back using an Update.
Update_Sample.dbm Demonstrates how to manage INSERT and
UPDATES so as to avoid adding duplicate
rows to the target database as the map is
executed more than once or the data is
amended later.
Objectimporter.dbm Demonstrates how to use the Object
Importer feature in the Write to XML add-in.

182 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.31. Sample Maps installed with ContentBridge

IA_LoadAndIngestMode.dbm Demonstrates ingesting SIP Packages to Info


Archive with Load and Ingest mode.
IA_IngestOnlyMode.dbm Demonstrates ingesting SIP Packages that
were created early using ContentBridge with
ingest only mode.

5.31.1 Sample Map - Flat File


Map name: Flat.dbm
Outline: This example demonstrates how to handle a
data file that has relational data presented in
a flat file.
Data: Flat.txt:

OrderID,Date,CustumerID,Item1,Item2,Item
3,Item4,Quantity1,Quantity2,Quantity3,Qua
ntity4 213,12/1/05,T2567,Blue T Shirt,Blue
Jeans,White Hat,Black Scarf,2,1,1,1
435,14/1/05,T5647,Black Jeans,Red Hat,Blue
Strap Top,Black Scarf,1,2,1,3“98250”,“5648”,
“Carrot”,“7”,“0.15”

Each row contains more than one Item. To be


normalized the data should have only a
single Item in each row and look like:

Order_Details.txt:

“OrderID”,“Item”,“Quantity” 213,“Blue T
Shirt”,2 435,“Black Jeans”,1 213,“Blue Jeans”,
1 435,“Red Hat”,2 213,“White Hat”,1 435,
“Blue Strap Top”,1 213,“Black Scarf”,1 435,
“Black Scarf”,3

There should then be an Order Header file


looking like:

Order_Header.txtOrderID,Date,CustumerID
213,12/1/05,“T2567” 435,14/1/05,“T5647”
Description: This sample map shows how to read in the
data and place it in a single output file. The
Transform is used to collect each of the item
details. A final Transform extracts the header
records.
Running: All files can be found in the samples
directory.

Load ContentBridge and open the


ContentBridge map, Flat.dbm. Run the map
and use ContentBridge Data panel to review
the data and see how the map works.

EDCCM210200-UGD-EN-1 User Guide 183


Chapter 5 Basic Functions

5.31.2 Sample Map - Reference Table


Map name: Employee.dbm
Outline: This sample demonstrates how to handle
pointers to reference data when moving data
from one database to another.
Data: The sample data is presented in two files as
shown below:

Employees.txt:

EmployeeName,EmployeeLastName,DeptN
umber “Ian”,“Manning”,“A22” “John”,
“Smith”,“B72” “Jane”,“Robinson”,“W23”
“Nelson”,“Mandella”,“B72” “George”,
“Bush”,“A22” “Nigel”,“Bull”,“B72”

Each row contains details of an employee


and a pointer (foreign key) the department
they are a member of. In real case with real
data there would be many more columns
and rows.

Departments.txt:

DeptNumber,Description “A22”,
“Purchasing” “B72”,“Sales” “W23”,
“Accounts”

184 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.31. Sample Maps installed with ContentBridge

Description: In this simple example we have a list of


departments and a list of employees. There is
a pointer already in the Employee's data that
points to the Department. However, as the
data is moved into a new database the
unique IDs change and the pointer needs
changing.

If this referential pointer did not exist in the


data a similar approach can be used based on
a match by other data: This is discussed later.

This sample shows how to read in the data


and place it into an Access database.

A Transform Lookup function is used to


restore the new foreign key pointing to the
new ID for the Department and to write the
ID of the Department to the Employee data.
A match is found on the old department
number, but the new ID written.

Open the properties of the Transform and


then the properties of the Lookup to see how
this is configured.

If the link on the old Department number


was not present the match could be made on
the Department name.
Running: All files can be found in the samples
directory.

Load ContentBridge and open the


ContentBridge map, Employee.dbm.

Run the map and use ContentBridge Data


panel to review the data and see how the
map works.

The department data is handled first placing


it into a table, Departments, in the Access
database. Access is allowed to add the new
unique ID, an autonumber column in the
database.

This table is then read back in now including


the new ID.

Now the Employee's data is read in.

EDCCM210200-UGD-EN-1 User Guide 185


Chapter 5 Basic Functions

5.31.3 Sample Map - Normalize Data


Map name: Normalize.dbm and Normalize2.dbm
Outline: This example demonstrates how to handle a
data file that has relational data presented in
a flat file.

This is similar to the Flat sample where there


are many order items in a single line.
Data: The sample data has a file as shown below:

Flat.txt:

OrderID,Date,Item,Quantity,Price
1234,12/5/06,G345,45,2.34
1234,12/5/06,G678,23,5.67
2345,13/4/06,H456,12,12.34
2345,13/4/06,G345,45,2.34

Each row contains the order header and a


line item. To be normalized the data should
have only a single Item in each row and look
like:

Order_Items.txt:

OrderID,Item,Quantity,Price
1234,G345,45,2.34 1234,G678,23,5.67
2345,H456,12,12.34 2345,G345,45,2.34

There should then be an Order Header file


looking like:

Order_Header.txt:

OrderID,Date 1234,12/5/06 2345,13/4/06


Description: This sample shows how to read in the data
and place the line items in one file and the
headers in a second. A temporary Access
table is used to de-duplicate the header
records.

In Normalize2.dbm the De-Duplicate


function is used rather than a temporary
Access table.

186 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.31. Sample Maps installed with ContentBridge

Running: All files can be found in the samples


directory.

Load ContentBridge and open the


ContentBridge map, Normalize.dbm.

Run the map using ContentBridge Data


panel to review the data and see how the
map works.

5.31.4 Sample Map - Read Emails from Outlook


Map name: Outlook_Registration.dbm
Outline: This sample demonstrates how to read
emails from the Outlook Inbox, looking for
emails presented by a web form.
Description: When prospective customers register using a
web form the data entered is emailed from
the site. This map finds these emails and
writes the data to an Access database.

Emails are read from Outlook using OLE DB.


The emails of interest found by searching on
the subject field. The data in the message is
split into the individual fields and after a test
for a valid email address written to an Access
database.

The Access write is in the Prompt mode so


that you can choose to check the data before
proceeding with the write.

In this example the email is of a format


created by a FrontPage form. If the format is
different you will need to modify the
Transform function. If you need help or have
questions please email us at OpenText
Running: All files can be found in the samples
directory. Copy the sample registration email
to your inbox.

Load ContentBridge and open the


ContentBridge map,
Outlook_Registration.dbm.

Run the map and use ContentBridge Data


panel to review the data and see how the
map works.

EDCCM210200-UGD-EN-1 User Guide 187


Chapter 5 Basic Functions

5.31.5 Sample Map - Contact Name Split


Map name: Contact_Name_Split.dbm
Outline: This sample demonstrates how to use the
Name Split Transform function to split a
single contact filed into individual fields.
Data: The sample data is presented in a file as
shown below:

Name_Split_Data.txt:

Dr Ian Lawrence Manning PhD Miss Jane


Manning Dr De La Clusa John Smith Ms
Rosie Parks PhD Ms Jane Rosie Johnson Miss
Van Smith MD Dr Rosie Molly Van Percie
Prof John Smith FRSC Smith Dr Paulo Rev
Van Smith Doctor John O'Hare Baron Smith-
Johnson Dr Ian Lawrence Tom Smith DPhil

Each row contains details of a contact name.


There are potentially many fields. These are
split into the constituent fields using the
Name Split function.

188 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.31. Sample Maps installed with ContentBridge

Description: First the Title is found by looking for a string


that is recognized as a Title. Examples are Dr,
Miss, Ms, Mr and so on. The allowed values
are managed using the Names Definition
Editor

The Post Nominal letters are separated by


again comparing with allowed vales (PhD,
MD..) managed with the Names Definition
Editor.

Then the names are split into First, Last and


Middle. Starting characters to a surname are
checked against an allowed list (Van, De La,
Fitz...). The remaining names are separated
according to the order you specify.

Open the Transformproperties and then the


properties of the Name Splitto see how this
is configured.

EDCCM210200-UGD-EN-1 User Guide 189


Chapter 5 Basic Functions

Lastly a Validate object is used to run some


simple checks on the data.

190 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.31. Sample Maps installed with ContentBridge

Running: All files can be found in the samples


directory.

Load ContentBridge and open the


ContentBridge map,
Contact_Name_Split.dbm.

Run the map and use ContentBridge Data


panel to review the data and see how the
map works.

The Inputand Outputdata is shown in these


linked pages.

5.31.5.1 Sample Map - Contact Name Split (Input)


Input data to the name split sample:

See Also

Output data.

EDCCM210200-UGD-EN-1 User Guide 191


Chapter 5 Basic Functions

5.31.5.2 Sample Map - Contact Name Split (Output)


Output data from the name split sample:

See Also

Input Data.

5.31.6 Sample Map - Validate Field Length


Map name: Length.dbm
Outline: This example demonstrates how to validate
data on the length of a combination of two
columns.
Description: The map uses a Transform object to
concatenate two fields, CompanyName and
Contactname into a new column,
CompanyContactLength. The Validate object
then tests this field for length.

192 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.31. Sample Maps installed with ContentBridge

Running: All files can be found in the samples


directory.

Load ContentBridge and open the


ContentBridge map, Length.dbm.

Run the map and use ContentBridge Data


panel to review the data and see how the
map works.

5.31.7 Sample Map - Object Importer


Map name: Objectimporter.dbm
Outline: This example demonstrates how to use the
Object Importer feature in the Write to XML
add-in.
Description: The Object Importer checkbox when checked
will write the desired XML file to the location
specified.
Running: All files can be found in the samples
directory.

Load ContentBridge and open the


ContentBridge map, Objectimporter.dbm.

Run the map and use ContentBridge Data


panel to review the data and see how the
map works.

5.31.8 Sample Map - InfoArchive Load and Ingest Mode


Map name: IA_LoadAndIngestMode.dbm
Outline: This map demonstrates ingesting SIP
Packages to Info Archive with Load and
Ingest mode.

EDCCM210200-UGD-EN-1 User Guide 193


Chapter 5 Basic Functions

Description: Two add-ins XSD to DBS converter are


required to use the add-in. They are SIP_XSD
and PDI_XSD. Two inputs are required for
successful load. The first flow reads the
Ingest information from the custom table and
transforms the data based on the rules
configured in the transform [Transform SIP
( dbs file, the output of the SIP_XSD, should
be imported in the Transform function which
will load the xml elements)] and will be the
first input.

The second flow reads the PDI information


from the text file and transforms the data
based on the rules configured in the
transform [Transform PDI ( dbs file, the
output of the PDI_XSD, should be imported
in the Transform function which will load
the xml elements)] and it will be the second
input.

The details of the successful and failed


records are exported as a .csv file.
Running: All files can be found in the samples
directory.

Load ContentBridge and open the


ContentBridge map,
IA_LoadAndIngestMode.dbm

Run the map and use ContentBridge Data


panel to review the data and see how the
map works.

5.31.9 Sample Map - InfoArchive Ingest Only Mode


Map name: IA_IngestOnlyMode.dbm
Outline: This map demonstrates ingesting SIP
Packages that were created early using
ContentBridge with ingest only mode.
Description: This mode runs as standalone mode without
any inputs.

194 OpenText ContentBridge EDCCM210200-UGD-EN-1


5.31. Sample Maps installed with ContentBridge

Running: All files can be found in the samples


directory.

Load ContentBridge and open the


ContentBridge map,
IA_IngestOnlyMode.dbm

Run the map and use ContentBridge Data


panel to review the data and see how the
map works.

5.31.10 Sample Map - Update & Insert Data


Map name: Update_Sample.dbm
Outline: This example demonstrates how
ContentBridge selects an UPDATE rather
than an INSERT if the row already exists.
Data: Customers.txt
Description: This sample map requires you to create a
target table in a SQL Server database. A
script, Customer.sql, is provided. You will
also need to adjust the map with your SQL
Server details.

The Customers.txt file is read in, passed


through a Transform object and written out
to the SQL table. The Transform maps the
columns straight through, but is also used to
define the primary key in the data. This is
not the identity column in the target table,
but a column in the source data that is
unique. Please also note that ContentBridge
does not write to the SQL Identity column.
This has been removed from the schema so
that the database engine is allowed to create
the appropriate value.

ContentBridge uses this primary key to look


for each row as they are processed. If found
ContentBridge will update the data rather
than adding a new column.

You can amend the map to use for example


MS Access or MySQL as the target database.

EDCCM210200-UGD-EN-1 User Guide 195


Chapter 5 Basic Functions

Running: All files can be found in the samples


directory.

Load ContentBridge and open the


ContentBridge map, Update_Sample.dbm.
Run the map for the first time and 91 rows
are inserted. If you have an evaluation copy
of ContentBridge this is restricted to 50 rows.
Run the map a second time and this time the
91 rows are updated.

Try editing the schema in the Transform


object to remove the definition of the
primary key. After you have done this each
processing of the map will insert new rows.

196 OpenText ContentBridge EDCCM210200-UGD-EN-1


Chapter 6

Advanced Functions

6.1 DCTM QC Validation


DCTM QC Validation function can be used to validate the values assigned to the
attributes of the documents/objects loaded into documentum repository in the
earlier step in the ContentBridge map earlier.

The values contained in the input table columns are compared with corresponding
attributes of documents/objects loaded in Documentum repository.

The following options can be configured:

EDCCM210200-UGD-EN-1 User Guide 197


Chapter 6 Advanced Functions

• Username: The username to connect to the repository


• Password: The password for the username in the repository
• Docbase: Initial default docbase
• Use Session from Session Mgr: Select the docbase from the drop down
menu.Click herefor more information regarding this.
• Average sampling rate can be selected. For example, an average sampling rate of
1 in 10 records means that 1 random record out of every 10 records should be
validated
• Selecting the Show Progress Dialog will show the validation progress:

6.1.1 Using Session Manager in DCTM_QC_Validation


Using session Manager Session function is an optional feature supported by all
documentum related functions of ContentBridge.

Session Managerfunction can be used to establish and manage session(s) with one or
more documentum repositories within the same map.

Once a session manager is executed, it makes connection to the documentum


repositories as configured in function properties. The sessions stay active until the
map is closed and can be reused by any documentum facing addins/functions on the
map.

198 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.1. DCTM QC Validation

EDCCM210200-UGD-EN-1 User Guide 199


Chapter 6 Advanced Functions

In the revised Addin, there are two options available to establish a connection with
the docbase:

• Enter the username , password and docbase manually like before.


• Select the Use Session from SessionMgr checkbox to select the docbase. Then,
the drop down menu for “Available sessions from Session Mgr” will become
enabled and the username, password and docbase input fields will become
disabled.

When you deselect the checkbox, The input fields for username, password and
docbase become enabled and the option to select a docbase from the drop down
menu becomes disabled .

Note: The session manager add-in should be successfully executed prior to being
able to select docbase from the drop down menu in Use Session Mgr in
DCTM_QC_Validation. If you try to “check” the checkbox before executing the
Session Mgr, ContentBridge will throw an error.

200 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.2. Add To Documentum Queue

6.2 Add To Documentum Queue


Add To Documentum queue Addin will create a Queue request in documentum.
The input should be coming from Queue items table consisting of "Queue_Name" .
The add-in processes the input and creates a Documentum object in the required
docbase. Click on the Function under the Export functions section of ContentBridge.
The Add To Documentum queue function will get added in the map.

Click the top left icon to display the properties wizard. You can also highlight an
object on the map and press the F4 key.

Repository Details page has the following fields:

Add a group box with checkbox for “Use Session from Session Manager” and add
Available Sessions from Session manager combo box control.

EDCCM210200-UGD-EN-1 User Guide 201


Chapter 6 Advanced Functions

Add the following textboxes for handling the login.

• Repository – Documentum Repository name

• User Name – name of the user

• Password – password for corresponding user

• Domain – name of the domain.

Repository, user name and password controls are enabled and Available Sessions
from Session manager combo box will be disabled when “Use Session from Session
Manager” is unchecked.

When “Use Session from Session Manager” is checked, Available Sessions from
Session manager combo box will be enabled and Repository, user name and
password controls will be disabled.

Add a “Use Data Dictionary” group box with checkbox. Add Log level combo and
“Repeating attribute delimiter” text box.

When “Use Data Dictionary” checkbox is enabled, use the data dictionary custom
table values otherwise enable the controls and let the user enter or select.

No login button in this page, enable finish button when there is all the required info.

6.2.1 Required Attributes for Successful Load


There are four (4) required attributes that need to be set before documents can be
loaded into Documentum Queue. You could set these attributes in a Transformation
activity.

The following inputs are required for this addin.

• r_object_id (required): Object to be queued

• queue_username(required): User Name to whom queue is assigned

• queue_eventname(required): Provides information to be interpreted by the


application about the specified object.

• queue_message(required): Queue message

• queue_priority(Optional): get from the input table, if not provided set it as 0.


• queue_sendmail(Optional): Get from the input table, if not provided set it as
false.

• queue_duedate(Optional): Get from the input table, if not provided set it as


empty IDFTime object.

202 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.3. Cloud Configuration

6.3 Cloud Configuration


This add-in allows you to connect to multiple (up to four) Cloud Storages and
manages your connections between them.

Set your AWS Secret Key Id and Secret Key in the ContentBridge.MapEditor.exe.
config file listed in the installation path.

Place the following code under the <configurations> tag in the ContentBridge.
MapEditor.exe.config file.
1 <appSettings>
2 <add key="AWSProfileName" value="Profile Name”/>
3 <add key="AWSAccessKey" value="Your Secret Key ID"/>
4 <add key="AWSSecretKey" value="Your Secret Key"/>
5 </appSettings>

EDCCM210200-UGD-EN-1 User Guide 203


Chapter 6 Advanced Functions

• You will be required to type in the Custom Tab Name only if you wish to change
the connection tab name. By default it is Connection 1, Connection2 through to
Connection4.
• Select your Storage type.Currently only Amazon S3 bucket storage is supported.
• Select your Amazon S3 Bucket Name from the drop-down list, you will be
required to select the Bucket Region.
• Confirm your set up by sclicking the Test Connection button.
• Repeat the above steps for the other cloud storages which are configured on the
additional tabs and click Finish.

6.4 DeDupAndCombine
DeDupAndCombineAddin will remove the deduplicate the records from the
incoming table and then combines the records with the configured column with the
delimiter character as mentioned in the Properties wizard. Click on the Function in
the under theGeneral functions section of
ContentBridge.TheDeDupAndCombinefunction willget added in the map.

Click the top left icon to display the properties wizard. You can also highlight an
object on the map and press the F4 key.

204 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.4. DeDupAndCombine

The stages of the wizard are described in the steps below. The wizard stages are:

• select a column under Key fields for which the records would be deduplicated.
• select the column under Combine Fields for which the records would be
combined for the Key Field selected.
• enter a value for Delimiter which will be used as the delimiter character to
combine the fields

EDCCM210200-UGD-EN-1 User Guide 205


Chapter 6 Advanced Functions

6.5 Read From DCTM


The function Read from DCTM retrieves content from a Documentum Repository to
be loaded into ContentBridge. All metadata, content and versions can be exported
from Documentum.

This activity utilizes the Documentum Foundation Classes and Primary Interop
Assembly. This allows ContentBridge to be installed on an independent machine
from the Content Server.

The progress of the export can be monitored in theOutput field below the map. Any
files that failed will be listed in the Output field and in the log file.

The following must be in place before attempting to Export from Documentum .

• Documentum Foundation Classes (configured appropriately)


• Documentum Primary Interop Assembly (PIA) is required only for older
versions of ContentBridge (formerly known as TrinityBridge)

Begin by dragging the Read From DCTM activity onto the map.The properties
screen of the Read From DCTM function allows you configure different options of
the export process, as well as the docbase selection and authentication information
for the target repository.

Before you begin the export you have the option to configure how the content will
be exported.These are similar to the DataDictionary values of the Load Into DCTM.

Begin by creating a new Custom Table called ReadFromDCTM Config.The Custom


table function is located in the Input functions toolbar. Drag the custom table onto
the map editor.

Custom Table1 one will be created. Rename the table to ReadFromDCTM Config.

Add two values to the Table Schema by clicking the custom table properties tab. At
the top of the Table Schema click the icon twice to add values to the table.
Rename one to “Name” and other “Value” and leave them as a Data Type of String.
ClickFinish.

See below for an example of how to set up the ReadFromDCTM table.

206 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.5. Read From DCTM

6.5.1 Integrated Config


Read From Dctm module now allows an option to specify the attribute values
directly in the property page rather than using the DataDictionary . However,
ContentBridge will continue to support older maps where DataDictionary is used to
specify the attribute values.

EDCCM210200-UGD-EN-1 User Guide 207


Chapter 6 Advanced Functions

By default, the Use DataDictionary checkbox is checked. If you would like to specify
the attribute values here on the property page, you would have to uncheck the
checkbox and specify the corresponding attribute values.

Note: If the Use DataDictionary checkbox is unchecked and attribute values are
specified, then CreateObjects module would use the values specified on the property
page for processing and not those in the DataDictionary and vice versa.

6.5.1.1 DataDictionary Configurations


There are five different configurations that you can add:

• EXPORT_CONTENT_TO_ALL_LINKED_FOLDERS:This will export/recreate


all the linked content in the same location as they are currently exist in
Documentum. This only works when performing an export using the Query and
not Folder Selection.

• log_level: Set this to 1 to get additional logging. NOTE: This setting has been
depricated in release 16.5. Please use debug_mode setting in DataDictionary
table instead
• RENDITION_PATH_SEPERATOR: If you are exporting multiple renditions
you can set what character is used to separator out each rendition type.
• ADD_VDOC_CHILD_ROW: If you are exporting virtual documents and want
each child to have their own row in the datatable, then set this value to true.

208 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.5. Read From DCTM

• ALWAYS_ADD_VERSION_LABEL_TO_FILENAME:Set this to true if you


always what the version label appended to the filename as it is created on the file
system.
• IDENTIFY_VDOC_COMPONENT: Set this to true if you want ContentBridge
to flag the object as a virtual document component.
• REPEATING_ATTRIBUTE_DELIMETER: Character used to separate repeating
attribute values.
• REPEATING_ATTRIBUTE_DELIMETER_ESCAPE:Charcter or string to be
used as replacement for the delimiter if exists in the individual value of a
repeating attribute
• ALWAYS_ADD_VERSION_LABEL_TO_FILENAME:Always append the
version label to the filename during export.
• IDENTIFY_VDOC_COMPONENT: A value of true, while exporting will add a
column flagging the row as containing a virtual document component.
• FLAT_EXPORT: Set this to true if you want ContentBridge to export the all the
content to one folder in the staging directory.

6.5.2 Export
Next begin configuring the export by accessing the Repository Details Screen.You
can access this screen by clicking the icon in the top-left corner of the Read From
DCTM.

EDCCM210200-UGD-EN-1 User Guide 209


Chapter 6 Advanced Functions

The first window prompts you for the Repository Details.Select a Repository from
the drop down list.This list is dependent on how you configured the dfc.properties
or dmcl.ini file.

Enter a username and password.Make sure this account has high enough
permissions in the source Repository to perform an export.

Once completed, select Login to verify the connection. A Login Success message will
be displayed and the Next button will become activated if you have successfully
logged in.

If you were unsuccessful in logging in, a message box will appear displaying the
error message.

For example, this error message is letting me know that there was a problem with
the Authentication. This is more than likely a bad username or password.

Once you have successfully logged in, select Nextto proceed to the Documents to
Export selection screen.

You have three ways of exporting documents with this function.You can use a DQL
query, Object IDs, or the folder selection option, which allows you to manually
select cabinets and/or folders.

Object Ids support CSV file as input and should contain a list of r_object_id. Each
Object ID should be listed in a new line in the input CSV file.

In the screen capture below, we are using Object IDs to select Documents to Export.

210 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.5. Read From DCTM

After making a selection, click Next .

By selecting the Folder Selection option, the cabinet structure of the Repository we
logged into will be displayed.

Select the checkbox next to the Cabinet you wish to export. If you wish to export the
sub-folders, click on the Cabinet name to expand the sub-folders (if any).

After making your selection, the following options can be configured:

• Object Type: You can use the drop down list to select which object type you
want to export. By default, dm_document is selected.
• Export All Versions: Select this option to export all versions of each document.
• Recurse Sub-folders: Select this option if you want to export all the content in
the sub-folders.

Once you have made your selections, select Nextto proceed. The next window
presents us with the Export options.

There are five options for us to select:

EDCCM210200-UGD-EN-1 User Guide 211


Chapter 6 Advanced Functions

• Use ObjectID's for Filenames:This option will set the ObjectID as the filename.
This is most helpful when exporting all versions, as a window's FileShare cannot
have documents with the same name in the same directory.
• Export Primary Content: This option will enable the content to be exported.
When you select this checkbox you will be prompted to select an Export
Destination to store the content.

Click the Select button and navigate to an appropriate storage location either locally
or on the network.

• Export Rendition: This option allows you to choose what renditions to export.
You can either manually select renditions of your choosing or export all
renditions

212 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.5. Read From DCTM

• Process Virtual Documents:This option will enable ContentBridge to process


and export virtual documents as folders with the children exported to inside the
folders.

• Compress Virtual Documents:This option is only available if Process Virtual


Documents is selected. If selected this will export virtual documents as a zip file.

ClickNext and Configure the properties shown below as explained here : Integrated
Config

EDCCM210200-UGD-EN-1 User Guide 213


Chapter 6 Advanced Functions

Once you have finished making your selections, click Finish to run the activity.

6.5.3 Export to Cloud Storage


This plugin now supports exporting content to Cloud Storage. Amazon S3 Bucket
Storage is currently supported.

This feature works in conjunction with the Cloud Configure add-in which can be
found under the Import tab of ContentBridge. It requires the Cloud Configuration
activity to have executed to utilize that connection when attempting to export to the
cloud.

You can either export content to the Amazon S3 bucket or a local folder. You can
export primary content, all versions, and renditions to the cloud storage.

Note: Exporting virtual documents to S3 Bucket is not supported.

214 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.6. Read Zip Archival

• On checking the Export to Cloud check box, you can connect to the Amazon S3
bucket that you configured in the Cloud Configuration add-in.You can normally
export the content to local folder by unchecking it.

6.6 Read Zip Archival


The function Read Zip Archival extracts contents from a Zip Archival File from the
local directory, or server File Share to be loaded into ContentBridge.

You can either select a .zip file by selecting Zip radio button or a folder that contains
a .zip file by selecting the Folder radio button. All metadata content can be extracted
from the Zip Archive file.

An AES encrypted or password-protected zip can be unzipped by providing the


correct password. It supports only a single zip file and does not support folder
selection.

Note: There is no limitations on the size for files within a .zip file, or the total
size of the zip file. Also, there are no limitations on the number of files that
may be contained within a single .zip file.

EDCCM210200-UGD-EN-1 User Guide 215


Chapter 6 Advanced Functions

Contents are extracted to a temporary system location by default. You can change
this location by clicking the Select button and navigating to an appropriate storage
location either locally or on the network. The add-in cleans up the temporarily
extracted files after you close the map or the application.

216 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.6. Read Zip Archival

The following options are configurable in this add-in:

• Extract from All Subfolders: This extracts content from a Zip Archival File from
all the subfolders of the main folder selected.
• Include Folder Metadata: This captures the folder's metadata in addition to the
file's metadata.
• Recursive Zip Archival: This extracts contents of a zip file that is inside another
zip recursively.
• Pattern: Unzips files matching a specific filename pattern.
For example:
*.pdf – Extracts only PDF files
*.txt – Extracts only text files

EDCCM210200-UGD-EN-1 User Guide 217


Chapter 6 Advanced Functions

a* – Extracts filenames starting with the alphabet ‘a’

6.7 Read from OTCS


The function Read from OTCS retrieves content from an OpenText Content Server to
be loaded into ContentBridge.You can export all metadata, content and versions
from an OpenText Content Server.

This activity utilizes the REST services hosted on the OTCS server. This allows
ContentBridge to be installed independently from the Content Server.

The progress of an export can be monitored in the “Output” field below the
map.Any files that fail are listed in the “Output” field and the log file.

You can configure options that determine how content is exported before you begin
this activity. See the list of supported Data Dictionary values for more information.

The properties screen of the Read From OTCS function allows you to configure
different options of the export process and authentication information for the target
server.

Start by dragging the “Read From OTCS” activity onto the map .

To create a new Custom table, drag the custom table function onto the map
editor.The Custom table function is located in the Input functions toolbar. A Custom
table with a default name Custom Table1 is created. Rename this to ReadFromOTCS
Config.

Add two values to the Table Schema by clicking the custom table properties tab.
Click twice above the Table Schema to add values to the table. Rename one of the
values to “Name” and other to “Value” and retain their Data Type as String.
ClickFinish .

6.7.1 Integrated Config


Read From OTCS module now allows an option to specify the attribute values
directly in the property page rather than using the DataDictionary . However,
ContentBridge will continue to support older maps where DataDictionary is used to
specify the attribute values.

The properties page allows you to select the Data Dictionary or specify your own
attribute values. The Use DataDictionary checkbox is checked by default. To specify
custom attribute values, uncheck it and specify the corresponding attribute values.

Note: If Use DataDictionary checkbox is unchecked and attribute values are


specified, the ReadOTCS module uses the values specified on the property page for
processing and not those in the DataDictionary.

218 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.7. Read from OTCS

6.7.1.1 DataDictionary Configurations


You can select any of the following configurations:

• log_level: Set this to 1 to get additional logging. The supported logging levels are
Error, Warning, Info, and Debug.

NOTE: This setting has been depricated in release 16.5. Please use debug_mode
setting in DataDictionary table instead

• RENDITION_PATH_SEPERATOR: If you are exporting multiple renditions


you can set what character is used to separator out each rendition type.
• REPEATING_ATTRIBUTE_DELIMETER: Character used to separate repeating
attribute values.
• REPEATING_ATTRIBUTE_DELIMETER_ESCAPE:Charcter or string to be
used as replacement for the delimiter if exists in the individual value of a
repeating attribute.
• ALWAYS_ADD_VERSION_LABEL_TO_FILENAME:Set this to true if you
always what the version label appended to the filename as it is created on the file
system.
• FLAT_EXPORT: Set this to true if you want ContentBridge to export all the
content to one folder in the staging directory.

6.7.2 Export
Begin configuring the export by accessing the Properties screen.You can access this
screen by clicking the icon in the top-left corner of the Read From OTCS activity.

EDCCM210200-UGD-EN-1 User Guide 219


Chapter 6 Advanced Functions

On the first window, enter the Username and password.The Read from OTCS
connector works on connection parameters defined in the
ContentBridge.MapEditor.exe .config file listed in the installation path.

Note: Your account must have elevated permissions in the source repository to
perform an export activity.

Select Login to verify the connection. A Login Success message is displayed and the
Next button becomes active. Click Next .

Select a workspace from the Repository and any specific sub-folders, if neccesary.

220 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.7. Read from OTCS

You can also configure the following options :

• Object Type: Select the object type you want to export.Document is selected by
default.
• Export All Versions: Exports all versions of each document.
• Recurse Sub-folders: Exports all the content in the sub-folders.

Click Next to view the available Export Options.

EDCCM210200-UGD-EN-1 User Guide 221


Chapter 6 Advanced Functions

The available Export Options are:

• Use ObjectID's for Filenames:This option will set the ObjectID as the filename.
This is most helpful when exporting all versions, as a window's FileShare cannot
have documents with the same name in the same directory.
• Export Primary Content: This option will enable the content to be exported.
When you select this checkbox you will be prompted to select an Export
Destination to store the content.
• Export Rendition: This option allows you to choose what renditions to export.
You can either manually select renditions of your choosing or export all
renditions

Click Next to configure any of the export properties. See the Integrated Config
section for more information.

Click Finish to run the export activity.

222 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.8. Read From DocumentumDB

6.8 Read From DocumentumDB


Read From DocumentumDB addin allows to connect to the Documentum Database
and fetch the records directly.

6.8.1 Prerequisites
The following must be in place before attempting to load into Documentum.

• Database client installed on the CB Machine depending upon the database used
(Oracle/MS SQL Server)
• Communication ports are opened between CB Machine and Database Server
• Data Source is configured properly (e.g. for Oracle, TNSNAMES.ORA is
configured for the database)
• Configured CustomTable named Migration Config

6.8.2 Data Dictionary Configurations


Use following steps to define the configuration parameters required by
DocIDLookup module:

• Add a CustomTable (available under General Functions section on the left)


module to the map.
• Name the CustomTable function as Migration Config

• Click on the Question Mark icon at the top left corner within the module
placeholder to open the schema editor for custom table
• Add two columns, tag & value , to the schema as displayed in the illustration
below.

• Click OK to save the changes and close the schema editor


• Enter the following entries into the Migration Config table
• tableowner - Owner of the Documentum database. For Oracle it is generally the
schema name and for MS SQL Server the owner is dbo

EDCCM210200-UGD-EN-1 User Guide 223


Chapter 6 Advanced Functions

• contentstoragepath - Path to the location of content storage

6.8.3 Configurations for Oracle


The following are the details of how to configure the Read From DocumentumDB
addin.

Provide the database login information to connect to the Documentum database.

Provide the query to fetch the records from the database

224 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.8. Read From DocumentumDB

Provide details of Content Storage Base Path and the Repeating Attributes

EDCCM210200-UGD-EN-1 User Guide 225


Chapter 6 Advanced Functions

Provide the Format details

226 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.8. Read From DocumentumDB

Provide details on Folder Information

EDCCM210200-UGD-EN-1 User Guide 227


Chapter 6 Advanced Functions

6.8.4 Configurations for MS SQL Server


The following are the details of how to configure the Read From DocumentumDB
addin for MS SQL Server.

Provide the database login information to connect to the Documentum database and
the database name as shown in Database Explorer since the database name is case
sensitive.

228 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.8. Read From DocumentumDB

Note: MS SQL Server fetches the table and view names in lower case. Provide the
details of tables and views in lower case

Provide the query to fetch the records from the database

EDCCM210200-UGD-EN-1 User Guide 229


Chapter 6 Advanced Functions

Provide details of Content Storage Base Path and the Repeating Attributes

230 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.8. Read From DocumentumDB

Provide the Format details

EDCCM210200-UGD-EN-1 User Guide 231


Chapter 6 Advanced Functions

Provide details on Folder Information

232 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.9. Update Documentum DB

6.9 Update Documentum DB


Update DocumentumDB addin allows to connect to the Documentum Database and
update the records directly.

6.9.1 Prerequisites
The following must be in place before attempting to load into Documentum.

• Database client installed on theCB Machine depending upon the database used
(Oracle/MS SQL Server)
• Communication ports are opened between CB Machine and Database Server
• Data Source is configured properly (e.g. for Oracle, TNSNAMES.ORA is
configured for the database)

EDCCM210200-UGD-EN-1 User Guide 233


Chapter 6 Advanced Functions

6.9.2 Configurations for Oracle


The following are the details of how to configure the Update Documentum DB
addin.

Provide the database login information to connect to the Documentum database.

Select the ID column name of the input table, and enter the name of the table to
update.

Then select the columns/attributes to update.

234 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.9. Update Documentum DB

Click on Finish to complete.

6.9.3 Configurations for MS SQL Server


The following are the details of how to configure the Update Documentum DB
addin for MS SQL Server.

Provide the database login information to connect to the Documentum database.

EDCCM210200-UGD-EN-1 User Guide 235


Chapter 6 Advanced Functions

Select the ID column name of the input table, and enter the name of the table to
update.

Then select the columns/attributes to update.

236 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.9. Update Documentum DB

Click on Finish to complete.

EDCCM210200-UGD-EN-1 User Guide 237


Chapter 6 Advanced Functions

6.10 Load Into DCTM


Loads content to any Documentum Repository from ContentBridge. All metadata,
content and versions can be imported to Documentum .

This activity utilizes the Documentum Foundation Classes and Primary Interop
Assembly, so ContentBridge does not have to be installed on a Content Server .

6.10.1 Prerequisites
The following must be in place before attempting to load into Documentum.

• Documentum Foundation Classes must be installed and configured properly.


• Microsoft Office (if transmittals are being created)
• Required attributes must be populated in each map
• Configured Data Dictionary

6.10.2 Integrated Config


Read From Dctm module now allows an option to specify the attribute values
directly in the property page rather than using the DataDictionary . However,
ContentBridge will continue to support older maps where DataDictionary is used to
specify the attribute values.

238 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.10. Load Into DCTM

By default, the Use DataDictionary checkbox is checked. If you would like to specify
the attribute values here on the property page, you would have to uncheck the
checkbox and specify the corresponding attribute values.

Note that if Use DataDictionary checkbox is unchecked and attribute values are
specified on the property page , then ReadDctm module would use the values
specified on the property page for processing and not those in the DataDictionary
and vice versa.

EDCCM210200-UGD-EN-1 User Guide 239


Chapter 6 Advanced Functions

On unchecking the checkbox, you can configure an additional property page :

240 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.10. Load Into DCTM

EDCCM210200-UGD-EN-1 User Guide 241


Chapter 6 Advanced Functions

6.10.3 Using Session Manager in Load Into Documentum


Using session Manager Session function is an optional feature supported by all
documentum related functions of ContentBridge.

Session Managerfunction can be used to establish and manage session(s) with one or
more documentum repositories within the same map.

Once a session manager is executed, it makes connection to the documentum


repositories as configured in function properties. The sessions stay active until the
map is closed and can be reused by any documentum facing addins/functions on the
map.

242 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.10. Load Into DCTM

EDCCM210200-UGD-EN-1 User Guide 243


Chapter 6 Advanced Functions

In the revised Addin, there are two options available to establish a connection with
the docbase:

• Enter the username , password and docbase manually like before.


• Select theUse Session from SessionMgr checkbox to select the docbase. Then,
the drop down menu for “Available sessions from Session Mgr” will become
enabled and the username, password and docbase input fields will become
disabled.

When you unselect the checkbox, The input fields for username, password and
docbase becomes enabled and the option to select a docbase from the drop down
menu becomes disabled .

Note: The session manager add-in should be successfully executed prior to being
able to select docbase from the drop down menu in Use Session Mgr in
LoadIntoDCTM. If you try to check the checkbox before executing the Session Mgr,
ContentBridge will throw an error.

6.10.4 Required Attributes for Successful Load


There are four (4) required attributes that need to be set before documents can be
loaded into Documentum. You could set these attributes in a Transformation
activity. They are:

• r_object_type (required): This Attribute should be populated with the


Documentum Object Type e.g. dm_document

• primary_format (optional):This attribute should contain the name of the


documentum format corresponding to the content file being loaded into
Documentum repository e.g. ms8w for Microsoft word document. It is required
only if not using a feature provided by ContentBridge to automatically resolve
file extension to documentum formats.

• object_name (required): This attribute supplies the object name of each


document inside of Documentum
• docbase (optional): This attribute supplies the docbase on a per document bases,
if this attribute is empty the default docbase is used

244 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.10. Load Into DCTM

• folder_path: This attribute supplies the target path for each document in
Documentum e.g. /Cabinet/folder1/folder2

ContentBridge will create folders during the load, but it will not create cabinets.
Your Documentum environment must already have the cabinets created.

If no folder_path is provided, ContentBridge will use the default location provided


in the LoadintoDCTM activity.

• primary_filename: This attribute should provide the source location of the


content for each document being loaded into documentum repository, e.g. C:
\Temp\document1.txt. this value can be left blank if loading content-less
documents or the intention is to just update metadata.
• rendition_filename (optional): This attribute should provide the source location
of the rendition content file per document. e.g. C:\Temp\document1.txt. Used in
relation with the rendition path separator of the data dictionary if you are
passing in more than one rendition.
• rendition_format (optional): This attribute supplies the rendition format you are
loading.
• i_antecedent_id (optional):This attribute needs to be populated if in case of
handling targeted versioning (versioning from a specific object). This works in
conjunction with the DataDictionary field - legacy_object_id_field. This Attribute
is used to fetch the prior version from which the versioning/Branching needs to
be done. If the value is empty, or “0000000000000000”, the versioning/Branching
needs will fail.

** The spelling and format of these attributes must match what is listed above.

In the image below, the transform activity was used to set these attributes. On the
right hand side of the Transformation Activity, click the Edit button to open the
Output Schema .

EDCCM210200-UGD-EN-1 User Guide 245


Chapter 6 Advanced Functions

Click the Add Button to add a new column to the Output Schema .

246 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.10. Load Into DCTM

By double-clicking the name, you can edit it to meet your needs. Clicking on the
String in the Data Type column will allow you to change the type value. Clicking on
the number in the Size column will allow you to change the size value.

The following is an example of what your Transform activity could look like

In this example, Literal Value functions (under the General Tab on the left hand side
of the Transform Activity) were used and mapped to the six columns in the Output
Schema.

EDCCM210200-UGD-EN-1 User Guide 247


Chapter 6 Advanced Functions

6.10.5 Data Dictionary Configurations


The Load into Documentum Function uses the Custom Table Function for
information when performing the load.

The following columns are used by the Load into Documentum Module:

Configuration Type Description Possible Values


debug_mode Int16 Sets the logging 0,1,2,3,4,5, and 5 is
detail level. the highesthighest
verbosity.
.
default_folder_type String Sets the folder type dm_folder or a
created during the subtype thereof.
Documentum
Import.
create_report String Set this to true if you True, False (default)
want a log to be
created of the load.
You set the location
of the log file in the
Load Into
Documentum
Properties in the
Folder Path field.
checkin_as_current String Set this to true to load True, False (default)
a document into the
repository as the
CURRENT
document.
rendition_path_sepe String A single character Any single ASCII
rator used as a delimiter character. Suggestion
between multiple is to use the vertical
values. bar (|); Commas
should be avoided
since values
maycontain commas
in them.
delimiter_character String A single character Any single ASCII
used as a delimiter character. Suggestion
between multiple is to use the vertical
values. bar (|); Commas
should be avoided
since values may
contain commas in
them.

248 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.10. Load Into DCTM

Configuration Type Description Possible Values


version_from String Indicates the current, highest
document version to
version the new
content from.
version_policy String Indicates how Major (default),
existing content will Minor, Same, Save.
be versioned when The Same value
loading new content. requires that the user
account has
appropriate
permissions to use
this policy. The Save
value only updates
metadata (with no
versioning) and does
not update or check-
in content.
create_cabinet String Enables the creation True, False (default)
of cabinets during the
load if they do not
exist.
use_transaction_proc String Enables a DFC True, False (default)
essing transaction buffer for
the entire batch being
loaded into the
repository. If this is
enabled and any
error occurs, the
entire batch is rolled
back.

EDCCM210200-UGD-EN-1 User Guide 249


Chapter 6 Advanced Functions

Configuration Type Description Possible Values


content_size_thresho Integer Prevents Integer > 0
ld contentlarger than
this value from being
loaded into
Documentum. The
object and its
metadata will still be
created but will be
assigned a generic
light-weight content
file. This allows
LARGE content to be
skipped and loaded
onto the object via
another process.

Provide the
maximum content
size required in
Bytes .Example :
52,428,800 (50MB).
content_size_column String Indicates which
column contains the
content size value.

This value is required


if the
content_size_threshol
d field is configured
in the data
dictionary. If this
field is not
configured or left
blank, by default it
will take
r_content_size as
content_size_column.
use_override String Enables the usage of True, False (default)
custom business logic
through a custom
built DLL.
override_class_name String Identifies the custom
DLL to be used as the
override class. The
custom DLL must be
installed in the EMC
Content Bridge
installation path. This
value is required if
the use_override field
is set to true.

250 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.10. Load Into DCTM

Configuration Type Description Possible Values


bypass_attribute_pro String Defines the attributes
cessing that will be ignored
when writing
metadata to the
target object.
Attributes can be
entered as a comma
delimited list or as
one attribute per row.
file_ext String List the file Any valid file
extensions that need extension (txt, doc,
to be assigned to a etc.)
specific Documentum
format. Values
should be entered in
one value per row.
See dctm_format for
related information.
dctm_format String Associates the Any valid
specified Documentum Format
Documentum format type.
to the file_ext value
in the same row. This
field is required if the
file_ext field is
populated.
resolve_extension_to String Automatically True, False (default)
_format associates a typical
Documentum format
type to standard file
extensions.
legacy_object_id_fiel String This attribute needs Any valid column in
d (optional) to be populated if in the target system that
case of handling stores the legacy
targeted versioning object ID from the
(versioning from a source repository.
specific object). This Example
is required to support legacy_object_id.
branching. This
works in conjunction
with the
transformation
activity Field -
i_antecedent_id.
Used to fetch the
prior version of a
document where the
versioning/Branching
will be applied.

EDCCM210200-UGD-EN-1 User Guide 251


Chapter 6 Advanced Functions

Configuration Type Description Possible Values


legacy_chronicle_id_ String This attribute needs This holds the
field (optional) to be populated if in attribute name that
case of handling contains the
targeted versioning legacychronicle id of
(versioning from a the source object.
specific object). This This attribute is
is required to support required for
branching. This constructing the
works in conjunction version tree in the
with the target docbase
transformation
activity Field -
i_antecedent_id.
Used to fetch the
prior version of a
document where the
versioning/Branching
will be applied.

Additional Data Dictionary attributes for loading Records Management.

Configuration Type Description


column_constructed_file_pl String Name of the column to be
an used as output column to
indicate the file plan that
build on demand during the
load process and applied to
the current document

This column is created in the


output table is one does not
already exist

It is only applicable if the


construct file plan flag is set
to true. If it is set to FALSE
this setting is ignored
column_file_plan String Name of the Records file plan
to be applied to the current
document/object to mark it
(or classify) as a formal
record.
column_formal_record_nam String Name of the inut table
e column containing the name
of the formal record
configuration object

252 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.10. Load Into DCTM

Configuration Type Description


column_formal_record_tem String Name of the input table
plate column that contains the
name of the Formal Records
Template to be used in case if
the records file plan forlder
object is constructed on
demand
column_formal_record_fold String Name of the input table
er_template column that contains the
name of the Formal Records
Folder Template to be used
in case if the records file plan
forlder object is built on
demand

EDCCM210200-UGD-EN-1 User Guide 253


Chapter 6 Advanced Functions

Configuration Type Description


construct_file_plan Boolean Boolean flag indicating
whether to assemble target
path for a Records
Management file Plan

If this value is set to False,


the value from the input table
column designated as
“Column File Plan” in DD
will be used as file plan path.

If this flag is set to True, it


will build the file plan path
string nbased on the input
table column name assigned
to the “Column File Plan”
DD field. Maximum of two
column names , separated by
comma, are expected to be
assigned to the column fiel
plan field.

If value of the value of the


inut table column designated
as “Column File Plan 2” is
not provided in the current
input table row being
processed, it uses the target
path associated with the
Source Object ID column
value

If the value for the input


table column designated as
“column file plan 2” is
provided in the inout table
row currently being
processed, it simply
concatenates the file plan
column 1 and file plan
column 2 values to build the
target path string.
enable_formal_records Boolean Boolean flag indicating
whether to classify the
documents being loaded as
formal records and apply
appropriate retention policies
or not.

254 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.10. Load Into DCTM

Configuration Type Description


formal_record_unlink_sourc Boolean Boolean flag indicating
e whether to unlink the current
document, being classified as
formal record, should be
unlinked from its original
location and only retained in
the records file plan location
or to keep it link in both
places.

To create the columns in order to complete the Load into Documentum,

• Go to the Import tab under Functions in the left menu screen.

• Click on the Custom Table Function and drag it into the map editor.

• In the map editor click on the Custom Table name and rename it to
DataDictionary.

• Click on the green question mark in the upper left corner of the custom table.
This opens the properties screen.

• Click the Add Column Button to add a new column.

• Double click the newly created column and rename it to one of the column
names listed above.

• By default the newly added column will be named NewColumn1, if the name is
not already used, and the Data Type will be set to String.

• Repeat this for all nine columns.

• The Data Type must be set to String for all of the newly created columns except
debug_mode.

• Debug_mode must be set to Int16. Once done, select Finish.

Next you must add a value to the newly created columns.

EDCCM210200-UGD-EN-1 User Guide 255


Chapter 6 Advanced Functions

Click the table as shown in the DataDictionary (Custom Table) to show the custom
record values. Add the values you want in the table. The above figure shows the
configuration for a standard Documentum load with logging set to high.

Once you have entered your values, Save the Map .

6.10.6 Loading data into Documentum


After transformation and validation, an export step will take the transformed data,
and associated content files, and load them into a repository (docbase). An object is
created with content and the metadata is applied to one or more Documentum
repositories.

The properties screen of the DCTM-Load function allows you to configure different
options of the load process, as well as the docbase selection and authentication
information for the target repository. You can access this screen by clicking the icon
in the top-left corner of the function box.

256 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.10. Load Into DCTM

The following options can be configured:

• Username : The username to connect to the repository


• Password : The password for the username in the repository
• Docbase : Initial default docbase
• Validate Folder Paths: Optional, if you want the Load into Documentum to
create folders. You have two further options:

EDCCM210200-UGD-EN-1 User Guide 257


Chapter 6 Advanced Functions

• Create Last Folder in Path only:Will only create the last folder
• Create all Folders in Path:Will create all folders.
• Default Document Owner: Used to set a default owner if the owner you are
passing in does not exist.
• Default Folder Path: It specifies the default path in which the objects will be
loaded.
• Use Session from Session Mgr:Select the docbase from the drop down
menu.Click herefor more information regarding this.
• Run Mode: Decides what type of load you want to do. There are three options:
• Create: Used to create new documents
• Create & Update: Used to create new documents and update existing
documents. The update option will update metadata and content for the object.
• Update: Works with primary keys to determine if document already exists, and
then will update the metadata and content file; this option will not version the
document.
• Verify Revision is Incremented:If selected, will verify the revision is equal to or
newer than the revision in the docbase (if not, the document will not be loaded)
• Send Notification to User: If selected, will send all documents to the selected
Documentum user's inbox. You must additionally select the user in which you
want to notify.

The progress of the load can be monitored in the “Output” field below the map.
After the load is complete, the successfully loaded files will be removed from the
target import folder. Those files that failed will be placed in an automatically created
“Failed” folder for review. The reasons for failure will be listed in the “Output” field
and in the log file

Click Next

Configure the properties shown below as explained here : Integrated Config

258 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.10. Load Into DCTM

Click Finish to complete the activity

EDCCM210200-UGD-EN-1 User Guide 259


Chapter 6 Advanced Functions

6.10.7 Import from Cloud Storage

This plugin now supports importing content from Cloud Storage. Amazon S3
Bucket Storage is currently supported.

It works in conjunction with the Cloud Configure add-in which can be found under
the Import tab of ContentBridge. It requires the Cloud Configuration activity to
have executed to utilize that connection when attempting to import from the cloud.

You can either import content from the Amazon S3 bucket or a local folder. You can
import primary content, all versions, and renditions from the cloud storage.The
section below provides additional information:

• s3_primary_filename(optional): This attribute should provide the s3_keyname


of the primary content for each document being loaded into documentum
repository. The format should be s3_keyname. For Example, testfolder/
primary_content/a.pdf.

260 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.11. Create Objects in DCTM

• s3_primary_format (optional): This attribute should contain the name of the


documentum format corresponding to the content file being loaded into
Documentum repository For example., msw12 for Microsoft word document. It
is required only if not using a feature provided by ContentBridge to
automatically resolve file extension to documentum formats.
• s3_rendition_filename (optional): This attribute should provide the s3_keyname
of the rendition content file per document. The format should be s3_keyname.It
is used in relation with the rendition path separator of the data dictionary if you
are passing in more than one rendition. For Example, testfolder/
rendition_content/b.txt|testfolder/rendition_content/c.docx. In this example,
rendition seperator is | .
• s3_rendition_format (optional): This attribute supplies the rendition format you
are loading.

6.11 Create Objects in DCTM


The CreateObjects addin can be found under the Export Tab and allows you to
create non-document type objects in Documentum. These objects are Users, Groups,
Permissions, Folders/Cabinets and Virtual Documents. It also requires a configured
dfc.properties file in order to connect to the target docbase. Before the activity will
expand, it must have data in the map.

You can still configure it; it is just that you will not see the output tables until data is
contained in the activity.

EDCCM210200-UGD-EN-1 User Guide 261


Chapter 6 Advanced Functions

The following options can be configured:

• Username: The username to connect to the repository


• Password: The password for the username in the repository
• Docbase: Initial default docbase

262 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.11. Create Objects in DCTM

• Use Session from Session Mgr:Select the docbase from the drop down
menu.Click here for more information regarding this.

• Migrate User Objects - Used to create users. You need to pass such user required
attributes into the activity such as Name, User Login Name, Email Address
r_object_type and r_object_id. You can set any/all of the remaining attributes
such as User Source, Default Folder, Default Permission set etc.

• Migrate Group Objects - Used to create or update groups. You need to pass in
group required fields such as group name r_object_type, and r_object_id.
Additionally, you can set all remaining attributes such as users_names,
groups_names etc. If you want to update groups, you need to add the
remove_existing_members value to the DataDictionary table and set it to either
True or False. True will remove all existingmembers and you will reload
members. False will leave the existing users and only add new members.

• Migrate Audit Objects - Used to create audit objects in the target docbase. You
need to specify the Legacy r_object_id Object Type and Legacy r_object_id
Attribute which can be used to identify the audited_obj_id (Object id of the object
to be audited in the target docbase). Also, the Legacy r_object_id Attribute of the
target object in the target docbase must contain the legacy r_object_id . The
required attributes of the source dm_audittrail object must be mapped in the
Transform function prior to executing Create Objects In Dctm function

• Migrate Permission Objects -Used to create permissions. You need to pass in


dm_acl required fields such as acl_name, Accessor Name, Accessor Permit,
r_object_type and r_object_id. Acls must be created with dm_world and
dm_owner as the first two accessor names you are passing in (it will error out if
you don't do this).

EDCCM210200-UGD-EN-1 User Guide 263


Chapter 6 Advanced Functions

• Migrate Folder Objects - Used to create folders and/or cabinets. You need to
pass in dm_folder/dm_cabinet required fields such as object_name, acl_name,
acl_domain, r_folder_path, r_object_type and r_object_id. If you leave the
folder_path blank, ContentBridge will treat this as a cabinet. You can pass in
other fields such as owner_name, modifier, r_modify_date, etc.
• Migrate Virtual Documents -Used to create and/or update virtual documents.
You need to pass in the dmr_containment attributes such as parent_id,
component_id, version_label, and order_no. See below for a screen shot of data
loaded into the Create Objects addin when loading virtual documents.

• Migrate Relationships - Migrate Relationships in Create Objects In DCTM can


be used to migrate relationship objects from one docbase to another.

Migrate the individual objects prior to migration of the relationships. Both the
parent and child objects of the source system should have a legacy relationship
attribute

There are four mandatory attributes that have to be given as input to Create Objects
in DCTM. They are notably parent_id, child_id, relation_nameand r_object_type.
The preceding attributes should be mapped in the Transform add-in and should be
present in the output schema.

The following fields, Attribute for Relationship legacy parent idand Attribute for
Relationship legacy child idare mandatory only during the migration of custom
relationship objects.and NOT for dm_relation objects .They contain the names of
attributes which contain the parent id and child id of objects respectively in the
legacy system

264 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.11. Create Objects in DCTM

The Create objects function configuration user interface also has three default fields:

• Default Folder/Cabinet Owner -If no owner_name is provided, you can set an


owner
• Default Cabinet Type - If no object type is set, you can set a default object_type
• Default ACL for Cabinet - If no acl is set you can set a default acl_name.You can
run folders in create or update mode which will reset or update links if you run it
in update mode.

NOTE: Cabinets only run in create mode and you cannot update cabinets.

6.11.1 Integrated Config


Create Objects in Dctm module now allows an option to specify the attribute values
directly in the property page rather than using the DataDictionary . However,
ContentBridge will continue to support older maps where DataDictionary is used to
specify the attribute values.

EDCCM210200-UGD-EN-1 User Guide 265


Chapter 6 Advanced Functions

By default, the Use DataDictionary checkbox is checked. If you would like to specify
the attribute values here on the property page, you would have to uncheck the
checkbox and specify the corresponding attribute values.

Note that if Use DataDictionary checkbox is unchecked and attribute values are
specified on the property page , then ReadDctm module would use the values
specified on the property page for processing and not those in the DataDictionary
and vice versa.

6.11.2 Using Session Manager in Create Objects in DCTM


Using session Manager Session function is an optional feature supported by all
documentum related functions of ContentBridge.

Session Managerfunction can be used to establish and manage session(s) with one or
more documentum repositories within the same map.

Once a session manager is executed, it makes connection to the documentum


repositories as configured in function properties. The sessions stay active until the
map is closed and can be reused by any documentum facing addins/functions on the
map.

266 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.11. Create Objects in DCTM

EDCCM210200-UGD-EN-1 User Guide 267


Chapter 6 Advanced Functions

In the revised Addin, there are two options available to establish a connection with
the docbase:

• Enter the username , password and docbase manually like before.

268 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.12. Read From SharePoint

• Select the Use Session from SessionMgr checkbox to select the docbase. Then,
the drop down menu for “Available sessions from Session Mgr” will become
enabled and the username, password and docbase input fields will become
disabled.

When you unselect the checkbox, The input fields for username, password and
docbase becomes enabled and the option to select a docbase from the drop down
menu becomes disabled .

Note: The session manager add-in should be successfully executed prior to being
able to select docbase from the drop down menu in Use Session Mgr in Create
Objects in DCTM. If you try to check the checkbox before executing the Session Mgr,
ContentBridge will throw an error.

6.12 Read From SharePoint


This add-in exports content from a SharePoint site (2010 or 2013), or library and
loads the data into ContentBridge in order to be processed. All metadata, content
and versions can be exported from SharePoint.

This activity utilizes Web Services, so ContentBridge does not have to be installed on
a SharePoint Server.

The progress of the export can be monitored in the “Output” field below the map.
Any files that failed will be listed in the “Output” field and in the log file.

6.12.1 SharePoint Export (Using CSOM)


Click on the properties icon to display the properties of the activity.You will be
prompted to enter your User Name, Password, Domain, Host Name, Site URL, Port
(defaults to 80) and whether or not you want to use SSL. You can also read from a
SharePoint 365 site by clicking the Is SP online Site? checkbox.

EDCCM210200-UGD-EN-1 User Guide 269


Chapter 6 Advanced Functions

Once you have entered all the necessary information select Connect. ContentBridge
will connect to the SharePoint site and gather the information from the requested
site.

Click Next .

The libraries will load. Multiple libraries can be selected to be imported into
ContentBridge .

270 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.12. Read From SharePoint

The following options are available for the SharePoint Export

• Export All Versions: This will export all the versions of the files as well as the
CURRENT version .
• Export All Subfolders: This will export all of the Folders and Subfolders of the
Libraries as well as their files .
• Export Content: This will export all of the content of the files .

If selected, Click on the Browse button to select a temporary export location for the
content (this can be anything from your local machine to a FileShare)

A folder structure will be created at the temporary export location. A folder of the
document itself will be created, with the subfolders consisting of all the versions

EDCCM210200-UGD-EN-1 User Guide 271


Chapter 6 Advanced Functions

The image on the Left is the folders created for each document (when Export all
versions is selected). The image on the Right shows you the 4 versions of the
document (Versions: 1.0, 2.0, 3.0, and the current document (alabamafs.pdf)). The
previous versions are located in their corresponding folder

272 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.13. Write To SharePoint

6.13 Write To SharePoint


The Write to SharePoint function exports content to a SharePoint site, SharePoint
Online, or library to be loaded into ContentBridge and processed.All metadata,
content and versions can be exported from SharePoint.

This activity utilizes Web Services, so ContentBridge does not have to be installed on
a SharePoint Server.

Write to SharePoint is an export function that allows ContentBridge to export data to


a specified SharePoint site.To configure Write to SharePoint click on the properties
tab and the properties tab will open.

Begin by entering the the SharePoint site url into the field provided.Enter the proper
credentials to access the site and click the Connect button.When the addin connects
the Results field will populate with the SharePoint Libraries.

Click Finish and the function will begin exporting the data to the site.

Note : When entering your Site URL, do not enter “/” as the last
character.ContentBridge will build the URL for you.

EDCCM210200-UGD-EN-1 User Guide 273


Chapter 6 Advanced Functions

6.13.1 Prerequisites
In order to have a successful export to the SharePoint site Write to SharePoint
requires three attributes to be present in the input data. There are three requirements
for a load into SharePoint.

• folder_path: This is the path within your SharePoint library where your
documents will be loaded, e.g. Folder/Sub Folder
• primary_filename: This is the path where the content is located, e.g. C:\Temp
\document.docx
• list_name: This is the list name you wish to load content into within SharePoint.
• SP_Content_Type: This is the SharePoint document type you wish to create and
load content into. If this is not populated, the target document type will
automatically be set to the first document type defined in the target Sharepoint
library.

6.13.2 DataDictionary Configurations


The WriteToSharePoint Function uses the Custom Table Function for information
when performing the load.

There is one column that the Write To SharePoint Function uses:

• delimiter_character: This allows you to choose which character will be used to


separate your incoming data into multiple values. In this example, the “;” will
separate the incoming data, and load them into Sharepoint as multiple values,
instead of one single value.

To create the columns in order to complete the Write To SharePoint,

• Go to the Import tab under Functions in the left menu screen.


• Click on the Custom Table Function and drag it into the map editor.
• In the map editor click on the Custom Table name and rename it to
DataDictionary.
• Then click on the green question mark in the upper left corner of the custom
table.

274 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.14. EmailTable

• This opens the properties screen.


• Click the Add Column Button to add a new column.
• Double click the newly created column and rename it to delimiter_character.
• By default the newly added column will be named NewColumn1, if the name is
not already used, and the Data Type will be set to String.
• Once done, select Finish .

Next you must add a value to the newly created columns.

Click the table as shown in the DataDictionary (Custom Table) to show the custom
record values. Add the values you want in the table. The above figure shows the
configuration for a standard SharePoint.

Once you have entered your values, Save the Map.

6.14 EmailTable
EmailTable is an export function that allows ContentBridge to send an email to a
specified account. To configure the EmailTable add in click on the properties tab to
open the settings.

EDCCM210200-UGD-EN-1 User Guide 275


Chapter 6 Advanced Functions

You have to provide the following information:

• Sender's Email Address: The sender of the email notification.


• Email Address to Send Report To: The receiver of the email notification
• SMTP Address: The address of the SMTP server
• SMTP Port: The SMTP Port (optional depending on Exchange configuration)
• SSL Enabled: Check the Box for SSL Enabled.
• Disable Selected Load Function: If you have this email table notifying users in the
event that something fails, you can disable the Load function to prevent incorrect
data from being loaded. The drop down listcontains all the Load functions
contained on the map.
• Include Log as an Attachment: This will include the ContentBridge log file as an
attachment when the email is sent. You can also use Browse button to select a file

276 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.15. Write To File Share

to be included, in addition to the ContentBridge log, as an attachment when the


email is sent.
• Alternate credentials: The credentials of the user are authenticated via the SMTP
server.
• Browse log location : This will appear when Include Log as an Attachment' is
checked. Select the log file that you want to send as an attachment in the email.

Note : If you are running the map for the first time and the log does not exist on the
file system, execute all other components before selecting the log file in the
EmailTable AddIn and executing the module

The following is an example of what the email notification looks like.

You can see here, the email was received. In this example, no log was attached, but a
XML document of the load was included as an attachment. In this example, this
Email Table activity was set up to execute after a successful load into Documentum .

6.15 Write To File Share


The function Write to FileShare exports content to local FileShare server. To
configure the Write to File share add in, select the properties icon in the top left hand
corner.

EDCCM210200-UGD-EN-1 User Guide 277


Chapter 6 Advanced Functions

Enter the FileShare server address that ContentBridge will export the data to. Enter
the username and password for the server as well as the domain. Click on the
Testbutton. Be patient while ContentBridge connects to the server. Upon connection
to the server the pop up screen will display “Success”. Click Finish.

6.15.1 PreRequisites
In order to have a successful export to the FileShare site, the Write to FileShare
requires two attributes to be present in the input data. The two requirements are:

• folder_path: This attribute supplies the target path for each document in the
FileShare e.g. /Folder/folder1/folder2/
• primary_filename: This attribute supplies the source location of the content per
document. e.g. C:\Temp\document1.txt

6.16 eRoom Exporter


The import function eRoom Exporter imports an exported erm file into
ContentBridge. To start take the eRoom dump file and rename the .erm extension to
a .zip extension. Then extract the archived files onto the machine.

You can browse to the extract location or specify its network path.

278 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.16. eRoom Exporter

Click the Choosebutton to navigate to the extracted data.

There are a variety of options to choose from before data the data can be imported.

• Reconcile Files:Select to process eRoom files (documents)


• Reconcile DB Tables: Select to process eRoom databases
• Reconcile Calenders: Select to process eRoom calenders
• Reconcile Emails: Select to process eRoom emails
• Reconcile Notes: Select to process eRoom notes
• Reconcile Discussions: Select to process eRoom discussions
• Reconcile Projects: Select to process eRoom projects plans
• Reconcile Polls: Select to process eRoom polls
• Reconcile Folders: Select to process eRoom folders

EDCCM210200-UGD-EN-1 User Guide 279


Chapter 6 Advanced Functions

• Reconcile Links: Select to process eRoom links. It will preserve links to outside
websites and the links to other eRoom documents.
• Reconcile Other: Select to process eRoom other files, which are files handled by
another application, like a word-processor document or a spreadsheet
• Generate Special Objects: Select to re-create some of the eRoom proprietary
formats such as databases and emails. This will generate either a file (such as an
email file for emails) or xml file (such as for databases) if the Apply XSLT option
is not checked. If checked, xml files will be created as htmls files.
• Apply XSLT: XSLT stands for XSL Transformations, and ContentBridge allows
you to use XSLT to transform XML documents into other formats, like XHTML.
If you select the checkbox,browseto yourconfiguration file to apply the xslt
settings. You can see below an example of a note being transformed to an html
file.

• Use Web Service:The Use Web Service allows you to call the eRoom API. You
have to provide the URL, Username, Password, Domain, Community, Facility
and Room in order to use this feature. The Web Service component only applies
to calendar events.

More than one option can be selected for the import process. If you select more than
just Reconsile Files, you would also need to select the option for Generate Special
Objects. Once the properties are configured click Finish. ContentBridge will process
the metadata and content based upon the options you selected above.

280 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.17. Read File Folders

6.17 Read File Folders


The Read File Folders function retrieves content from any local directory, or server
FileShare to be loaded into ContentBridge. You can also provide multiple filepaths
within an input file to read documents from all the provided paths.

To read file folders from a single folder:

1. Select the Folder option and click Browse to select the folder you wish to export.

You can configure the following options :

• Export All Subfolders: To export all the files and subfolders of the folder you
selected for export
• Include Folder Metadata: To capture the Folder's metadata in addition to the
File's metadata

2. Click Finish .

To read file folders from multiple folders:

1. Select the Multiple Folder option and click Browse to select a text file which
contains the multiple file paths to export.

2. Select the folders to export. You can configure the following options :

EDCCM210200-UGD-EN-1 User Guide 281


Chapter 6 Advanced Functions

• Export All Subfolders: To export all the files and subfolders of the folder you
selected for export
• Include Folder Metadata: To capture the Folder's metadata in addition to the
File's metadata

3. Click Finish .

Note : If any of the folders are inaccessible, the plugin will automatically skip those
folders and export contents of those that are readable.

282 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.18. Session Manager

6.18 Session Manager


This add-in allows you to connect to multiple (up to four) repositories and manages
your sessions between them. The repositories can be a mix of versions ranging from
7.x to 20.x. You will need the respective Documentum components installed to
connect to the docbases. For example, a configured dfc.properties file would be
required for newer connections and a dmcl.ini file for older connections .

Select your docbase from the drop down list or type it in. For older 4.x docbases, you
will be required to type in the docbase name instead of using the drop down list.
After you have your docbase, select the docbase type:

• 7.x
• 16.x

EDCCM210200-UGD-EN-1 User Guide 283


Chapter 6 Advanced Functions

• 20.x

Finish by entering credentials and selecting a trace level. Domain is not required.
You can confirm your set up by selecting the Test Connection button.

Once complete, repeat the same steps for the other docbases which are configured
on the additional tabs .

6.18.1 Save Credentials using Session Manager


The information about sessions established in a map can be saved and loaded again
when the map is re opened by selecting the Load and Save using option in the
Session Manager properties.

The credentials.xml file will contain user credentials and sessions information from
where you can load or save into.

284 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.19. DCTM Compare

Note: In order to generate the credentials.xml, the map must be saved first. The
credentials.xml file will be saved in the folder location where the map is saved.

6.19 DCTM Compare


The DCTM Compare add-in works in conjunction with the Session Manager add-in
which can be found under the Import tab of ContentBridge. This add-in allows you
to compare multiple docbases to determine any differences or deltas between the
two. It requires the session manager activity to have been executed so it can utilize
those sessions when querying both the source and target.

EDCCM210200-UGD-EN-1 User Guide 285


Chapter 6 Advanced Functions

6.19.1 Compare Definitions


The DCTM Compare uses the Compare Definitions tab to determine all of the
criteria required when comparing the two systems.

The Source section of the dialog is where users enter the Docbase (dropdown list
corresponds to the Docbase tab in the session manager addin) information.

Select the source object type and corresponding attributes to match and key
attribute.

The key attribute is used as a primary key and it will be used to locate the matching
(if it exists) object in the target repository.

The Attributes to Match table allows you to select all the different attributes which
you wish to compare. For example, in the above screen shot, we will be looking at
the object_name, acl_name and modify date.

If any of those attributes are different in the target, the object will be flagged as
“updated or changed” in the source.

The additional search criteria text box allows you to enter the where clause
component of a dql query if you wish to restrict your compare.

286 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.19. DCTM Compare

You do not have to enter “where” only the post where piece of the dql where clause.

Once you have entered all your criteria, users use the Single and Repeating lists to
select all the attributes they wanted Reported on. This will output that attribute
information so you can pass it through your map and into your Load. Hold the
control key to select multiple values .

6.19.2 Compare Options


The DCTM Compare uses the Comparison Options tab to further review your
criteria

You have the option to:

• Compare Link Count


• Compare Link Location
• Output Only Failures - Select if you wish to only output differences and not
matches. If you don't select this, even matches will be output.
• Match Exact Case - Use this option to match the case from your attributes to
match setting on the previous tab. Enabling this setting will improve
performance.

EDCCM210200-UGD-EN-1 User Guide 287


Chapter 6 Advanced Functions

• FileStore Locations - When enabled, this will calculate the source content path
location so you can access the content file during the migration. Use the add
filestore locations to add the different content stores. This is required if you wish
to use the DCTM Compare provide content files to load.

6.20 Attribute Validations


The Attribute Validations add in is located under the General Functions category. It
is used to validate selected attributes only.

Supported Validation models are:

• Type Value Assist


• D2 Property Configuration
• Custom DQL

As seen in the above properties window, an option to Continue Map Execution is


included in times of failure.

The Attribute Validationsadd indisplays Successful and Failed Validations table


after execution :

288 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.20. Attribute Validations

6.20.1 Validation Modes


The following are the Validation modes that can be set in the Attribute Validations
table :

6.20.1.1 Default Validation:


• Uses Type Value Assistance

• Supports Conditional Value Assistance

• Uses dependency attribute values from input table

• Type Validation validates all value assistance rules

6.20.1.2 DQL Validation:


• Query configured in Add in properties

• Supports $value() and $repeatingvalue() keywords

6.20.1.3 D2 Validation
• Validates against D2 Config rules

• Supported validation modes are

• DQL

• Dictionary
• Taxonomy

• Builds Nested DQL for Taxonomy validation

• Uses dependent attribute values from input table

EDCCM210200-UGD-EN-1 User Guide 289


Chapter 6 Advanced Functions

6.20.2 Logging Levels


The logging levels that are supported are:

• Error
• Warning
• Info
• Debug

The below figure shows the logging:

6.21 Read From eRoom


The read from eRoom add-in can be used to read and export artifacts and
documents from an existing eRoom to a destination on your machine.

290 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.21. Read From eRoom

The above window is what you get when you click on Properties icon in the Read
from eRoom add-in.

Follow the below steps to start configuring:

• Enter the UserName and Password authentication details to access your eRoom

• The URL at which your eRoom is accessible should be entered into the URL field.

• Click the Connect button to connect to your eRoom

• Once connected, select the Community from the drop down list and click Go.

• Select the Facility you wish and click Go.

• Out of the populated Rooms, select the required Room from the drop down list.

• Click the Browse button and navigate to an appropriate storage location either
locally or on the network.

Once all the above fields are filled, press Finish to start reading the eRoom.

EDCCM210200-UGD-EN-1 User Guide 291


Chapter 6 Advanced Functions

6.22 Email Exporter


Email Exporter will connect to the exchange sever and extracts and exports the email
from the public folders/PST that are configured in the property screen in the .msg
format to the local folder path mentioned.

Select the Public Folder/PST/Shared Folder to export

• We either select a Public folder, PST, or Shared Folder to extract the emails.
• To extract a Public folder, click the Public folder radio button.

Public Folders :

292 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.22. Email Exporter

• UserName: Enter the user name that has access to the public folder server.
• Password: Password of the above user that is used to connect to the public folder
server.
• Domain: Domain on which the public folder is hosted.
• Email Address: Email address of the user who has access to the public folder
server.

EDCCM210200-UGD-EN-1 User Guide 293


Chapter 6 Advanced Functions

Note: Either combination of Username, Password and Domain or the Email


address of the user should be entered in order to connect to the public folder
server. If both values are entered then the connection establishment using the
combination of Username, Password and Domain will take precedence.

• Exchange URL: Exchange URL from where the public folder is configured.
• Exchange Version: Version of the Exchange server.Click the Connect button after
entering the exchange version to connect.
• Public Folder Path: Exchange folder path of the public folder from where the
email messages are to be extracted. Check the ‘Include SubFolders’ checkbox to
populate the sub folders within a main folder.
• Export Attachment Check: This option will Download Email Attachment.
• Enable HTML Check: By default it will extract Email only in .msg format. It will
convert msg to HTML Format.
• File System Path: The path on the local file system where the msg files are to be
extracted and exported.
• Re-Connect options:Allows the user to set custom values for retrying the
connection (in seconds) and the maximum number of retry attempts.
• PreLoad Check: If enabled, this feature will enable user to do a preload check to
validate if this message is already exported in the target SQL Server.
• SQL Server Name: Sql Server name where the messages were loaded.
• SQL User Name: Sql Username to connect to the DB
• SQL Password: Password of the above user
• SQL Database: Database name where the messages were loaded
• SQL Tablename : Table name of the sql DB where the message details are stored
• Test Link: This will test the connection to the DB using the above user
credentials.

PST Files :

294 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.22. Email Exporter

• PST Folder Path: PST folder path of the public folder from where the email
messages are to be extracted.
• .PST File Path: Local file system path where .pst is located.
• File System Path: The path on the local file system where the msg files are to be
extracted and exported.
• Export Attachment Check: This option will Download Email Attachment.

EDCCM210200-UGD-EN-1 User Guide 295


Chapter 6 Advanced Functions

• Enable HTML Check: By default it will extract Email only in .msg format. It will
convert msg to HTML Format.
• PreLoad Check: If enabled, this feature will enable user to do a preload check to
validate if this message is already exported in the target SQL Server or Oracle
Server.
• SQL Server Name: Sql Server name where the messages were loaded.
• SQL User Name: Sql Username to connect to the DB
• SQL Password: Password of the above user
• SQL Database: Database name where the messages were loaded
• SQL Tablename : Table name of the sql DB where the message details are stored
• Test Link: This will test the connection to the DB using the above user
credentials.

Shared Folders :

296 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.22. Email Exporter

• UserName: Enter the user name that has access to the shared folder server.
• Password: Password of the above user that is used to connect to the shared folder
server.
• Domain: Domain on which the shared folder is hosted.
• Shared Email Address: Shared email address of the user who has access to the
shared folder server.

EDCCM210200-UGD-EN-1 User Guide 297


Chapter 6 Advanced Functions

Note: Either combination of Username, Password and Domain or the Email


address of the user should be entered in order to connect to the shared folder
server. If both values are entered then the connection establishment using the
combination of Username, Password and Domain will take precedence.

• Exchange URL: Exchange URL from where the shared folder is configured.
• Exchange Version: version of the Exchange server.
• All folders:Populates data in all folders.
• Select message folder:The user can select the specific folders to be populated.
Check the ‘Include Subfolders’ option if you wish to include sub folders of a
main folder.
• Export Attachment Check: This option will Download Email Attachment.
• Enable HTML Check: By default it will extract Email only in .msg format. It will
convert msg to HTML Format.
• Export destination: The path on the local file system where the msg files are to be
extracted and exported.
• Re-Connect options:Allows the user to set custom values for retrying the
connection (in seconds) and the maximum number of retry attempts.
• PreLoad Check: If enabled, this feature will enable user to do a preload check to
validate if this message is already exported in the target SQL Server.
• SQL Server Name: Sql Server name where the messages were loaded.
• SQL User Name: Sql Username to connect to the DB
• SQL Password: password of the above user
• SQL Database: Database name where the messages were loaded
• SQL Tablename : Table name of the sql DB where the message details are stored
• Test Link: This will test the connection to the DB using the above user
credentials.

6.22.1 Data Dictionary Configurations


The Email Exporter Function uses the Custom Table Function for information when
performing the load.

Table 6-1:

Configuration Type Description Possible Values


debug_mode Int16 Sets the logging 0,1,2,3,4, 5. 0 is the
(Optional) detail level. lowest verbosity; 5 is
the highest verbosity.

298 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.23. Load Into InfoArchive

PST_CustomAttribut String Set multiple custom N/A


es (Optional) attributes separated
by commas.

6.23 Load Into InfoArchive


6.23.1 InfoArchive Basics
Archive Holding - A holding is a logical destination archive where to ingest and
store data, usually of the same type that share common characteristics.

To create a holding:

• Use the holding configuration wizard.


• Create a template file from a sample holding (introduced in this section)
• Create a holding with the wizard and then manually update the template file.
• Directly create configuration objects in DA.

Refer to InfoArchive Installation Guide for more details on it.

Submission Information Package (SIP)- Data container (.zip) used to transport data
to be archived from the producer (source application) to InfoArchive. It consists of a
SIP descriptor containing packaging and archival information about the package
and the data to be archived. The latter part of the SIP in turn comprises a PDI file
eas_pdi.xml (structured data) and optionally one or more content files (unstructured
data).

Table Archival InfoArchive archives tables directly from the source.

EDCCM210200-UGD-EN-1 User Guide 299


Chapter 6 Advanced Functions

6.23.2 Creating SIP Package


To create the SIP package these are to be configured/created

1. Creating the eas_sip.xml as per the eas_sip.xsd (SIP descriptor schema)


a. Requires Data Submission Session (DSS) information. Check for the
parameters required for this below in Additional information.
b. Other parameters ‒ Check below in Additional information.

1. Creating the eas_pdi.xml and corresponding schema descriptor

• There is no predetermined schema for this and it stores structured data. We also
need to create a schema for it e.g. documentum.xsd . Using the metadata we have
to create this file.
• Typically the format is like

<?xml version="1.0" encoding="UTF-8" ?>

<Rows xmlns="urn:eas-samples:en:xsd:phonecalls.1.0">

<Row>

<attr1>Date1</attr1>

<attr2>String1</attr2>

<Attachment>

<AttachmentName>file</AttachmentName>

<FileName> file.mp3</FileName>

<CreatedBy>ABC App</CreatedBy>

<CreatedOnDate>

2011-05-27T04:57:16.234+01:00

</CreatedOnDate>

</Attachment>

...

<Row>

<Row>

<attr1>Date1</attr1>

<attr2>String1</attr2>

300 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.23. Load Into InfoArchive

...

<Row>

</Rows>

1. Zipping the eas_sip.xml, eas_pdi.xml & the content files

6.23.3 Submission
6.23.3.1 Data Submission Session (DSS)
Every SIP pertains to a data submission session (DSS), also referred to as a batch.
The data submission session (DSS) provides the packaging information used to
identify, bind, and relate SIPs of different levels of granularity produced by the
source application. When information is produced and packaged into a discrete,
standalone SIP, the SIP pertains to a single-package DSS. The DSS name increments
for each SIP package configured in ContentBridge.

6.23.3.2 Operational Modes


Load and Ingest Modes

1. Asynchronous Mode

• SIP Archival ‒ CB creates the SIP packages for IA and InfoArchive performs
scheduled ingestions of large SIPs in batches.
• Table Archival ‒ CB creates Table packages for IA and InforArchive performs
scheduld ingestions of large packages in batches.

1. Synchronous Mode

• SIP Archival ‒ CB calls the IA ingest REST service to synchronously archive data
to the SIP archive holding.
• Table Archival - CB calls the IA ingest REST service to synchronously archive
data to the table archive holding.

Ingest Only Mode - CB synchronously ingests previously created SIP packages from
a specified folder path. The Ingest Only Mode supports multithreaded ingestion of
the SIP packages. You can run this as a standalone mode without any inputs. The
selected folder path is monitored for changes every 10-minutes.

EDCCM210200-UGD-EN-1 User Guide 301


Chapter 6 Advanced Functions

6.23.4 Using InfoArchive Addin


6.23.4.1 Prerequisite
• XSD Files ‒ SIP and PDI XSD files are required for the SIP archival processing.
These are not needed for Table archival.
• Two addins of XSD to DBS converter are required to use the Addin. They are
SIP_XSD and PDI_XSD.
• SIP schema definition file (.xsd) must contain target namespace.
• The XSD files are to be converted to ContentBridge dbs format (output schema)
so that Transform function can understand the input. This is performed using the
XSD to DBS converter Addin.
• The DataDictionary custom table must have a column called delimiter_character.
The value of the delimiter determines the delimiter for repeating elements in
XML. Please ensure that this is set to unique values like pipe (|) which are not
normally part of data values.
• For the PDI transform Addin, the attachment name must be also mapped to the
attribute FileName. This attribute will be used by the Load into InfoArchive
Addin for adding content into SIP packages.

6.23.4.2 Sample Map


A typical map can use any of the following sources:

• Documentum
• eRoom
• File Share
• Database

The standard steps to execute a map are as follows:

1. Read the files from the source.


2. Check if the transform functions are imported. Each map should have two
transform functions:
a. Transform SIP ( dbs file, the output of the SIP Xsd, should be imported in the
Transform function which will load the xml elements)
b. Transform PDI ( dbs file, the output of the PDI Xsd, should be imported in
the Transform function which will load the xml elements)

3. Configure the IA addin using either the Synchronous or Asynchronous Ingestion


modes. You can do this by selecting the file share location and a Zip file containing
SIP descriptor and content files.

302 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.23. Load Into InfoArchive

6.23.4.3 Configurations
Asynchronous Mode with Table Archival

Configure the Load Into InfoArchive Addin by setting the following values:

To complete the export activity:

Browse and select a FileShare location to save the XML files. The FileShare location
is also the location where the content of the SIP package should reside.

Enter permissible values for the field Max Rows in Package. Values entered should
be greater then Zero for the Finish button to appear and complete the export
activity.

EDCCM210200-UGD-EN-1 User Guide 303


Chapter 6 Advanced Functions

Tip: Break down the maximum rows into smaller increments to improve the speed
and performance of the export activity.

For example, if your package consists of 300 rows, enter a value of 100 so that the
Addin processes 100 rows at a time.

Enter your InfoArchive Web Application URL followed by your UserName and
Password, and click Test. A Login Success message is displayed if the connection is
successful.

Enter your InfoArchive REST API URL and click Test Rest URL. A Connection
Success message is displayed if the connection is successful.

Note: The connection success message must be displayed for the Finish button to
appear.

Choose a Tenant and a corresponding InfoArchive Application from the drop-down


menu for data ingestion. The Database and the Schema fields are auto-populated
based on your Tenant and Application selection.

Select a Table Name from the list of available Table names to load content into it.
Check the New Table field if you wish to create a new Table in IA.

Note: The new Table name only accepts alphanumeric entries, special characters and
spaces are not permitted.

Click Finish to complete this activity.

Synchronous Mode with Table Archival

Configure the Load Into InfoArchive Addin by setting the following values:

304 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.23. Load Into InfoArchive

To complete the export activity:

Enter permissible values for the field Max Rows in Package. Values entered should
be greater then Zero for the Finish button to appear and complete the export
activity.

Tip: Break down the maximum rows into smaller increments to improve the speed
and performance of the export activity.

For example, if your package consists of 300 rows, enter a value of 100 so that the
Addin processes 100 rows at a time.

Enter your InfoArchive Web Application URL followed by your UserName and
Password, and click Test. A Login Success message is displayed if the connection is
successful.

EDCCM210200-UGD-EN-1 User Guide 305


Chapter 6 Advanced Functions

Enter your InfoArchive REST API URL and click Test Rest URL. A Connection
Success message is displayed if the connection is successful.

Note: The connection success message must be displayed for the Finish button to
appear.

Choose a Tenant and a corresponding InfoArchive Application from the drop-down


menu for data ingestion. The Database and the Schema fields are auto-populated
based on your Tenant and Application selection.

Select a Table Name from the list of available Table names to load content into it.
Check the New Table field if you wish to create a new Table in IA.

Note: The new Table name only accepts alphanumeric entries, special characters and
spaces are not permitted.

Click Finish to complete this activity.

Asynchronous Mode with SIP Archival

Configure the Load Into InfoArchive Addin by setting the following values:

306 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.23. Load Into InfoArchive

To complete the export activity:

Browse and select a Fileshare location to save the Zip file.

Enter permissible values for the field Max Rows in Package and Max Package size
(MBs), and click Finish. Values entered should be greater then Zero for the Finish
button to appear and complete the export activity.

Tip: Break down the maximum rows into smaller increments to improve the speed
and performance of the export activity.

For example, if your package consists of 300 rows, enter a value of 100 so that the
Addin processes 100 rows at a time.

Click Finish to complete this activity.

EDCCM210200-UGD-EN-1 User Guide 307


Chapter 6 Advanced Functions

Synchronous Mode with SIP Archival

Configure the Load Into InfoArchive Addin by setting the following values:

To complete the export activity:

Enter permissible values for the field Max Rows in Package and Max Package size
(MBs). Values entered should be greater then Zero for the Finish button to appear
and complete the export activity.

Tip: Break down the maximum rows into smaller increments to improve the speed
and performance of the export activity.

For example, if your package consists of 300 rows, enter a value of 100 so that the
Addin processes 100 rows at a time.

308 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.23. Load Into InfoArchive

Enter your InfoArchive Web Application URL followed by your UserName and
Password, and click Test. A Login Success message is displayed if the connection is
successful.

Enter your InfoArchive REST API URL and click Test Rest URL. A Connection
Success message is displayed if the connection is successful.

Note: The connection success message must be displayed for the Finish button to
appear.

Choose a Tenant and a corresponding InfoArchive Application from the drop-down


menu for data ingestion.

Enter an InfoArchive Client ID in the respective field. The Client ID is used to obtain
an InfoArchive token by passing the Username and Password.

Click Finish to complete this activity.

Ingest Only Mode

EDCCM210200-UGD-EN-1 User Guide 309


Chapter 6 Advanced Functions

To complete this activity:

Select Ingest Only Mode from the InfoArchive properties dialog box.

Choose an Archival Type for ingestion and enter a value for the maximum number
of threads. This value cannot exceed 15 threads.

Browse and select a SIP package location in the .Zip format.

310 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.24. XSD to DBS Converter

Enter permissible values for the field Max Rows in Package and Max Package size
(MBs). Values entered should be greater then Zero for the Finish button to appear
and complete the export activity.

Tip: Break down the maximum rows into smaller increments to improve the speed
and performance of the export activity.

For example, if your package consists of 300 rows, enter a value of 100 so that the
Addin processes 100 rows at a time.

Check the Show Progress Dialog box to view the package creation progress and the
Increment DSS ID for New SIP to increment the DSS name for each SIP package
configured.

Enter your InfoArchive Web Application URL followed by your UserName and
Password, and click Test. A Login Success message is displayed if the connection is
successful.

Enter your InfoArchive REST API URL and click Test Rest URL. A Connection
Success message is displayed if the connection is successful.

Note: The connection success message must be displayed for the Finish button to
appear.

Choose a Tenant and a corresponding InfoArchive Application from the drop-down


menu for data ingestion.

Enter an InfoArchive Client ID in the respective field. The Client ID is used to obtain
an InfoArchive token by passing the Username and Password.

Click Finish to complete this activity.

6.24 XSD to DBS Converter


Drag and drop the Write XML File object to the map:

Click the left icon of the Write XML File object to display the properties. Configure
the Load Into XSD to DBS Converter Addin by setting the following values:

• XSD File to be Read


• FileShare location to save the DBS files
• DBS File Name

EDCCM210200-UGD-EN-1 User Guide 311


Chapter 6 Advanced Functions

6.25 Load Into OpenText


Loads content to any OpenText Content Server from Source Systems. All metadata,
content and versions can be imported to OpenText Content Server.

This activity utilizes the Content Web Services configured on the respective Content
Server, so ContentBridge does not have to be installed on a Content Server.

312 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.25. Load Into OpenText

6.25.1 Prerequisites
The following must be in place before attempting to load into OpenText

• Content Web Services must be configured properly.


• Required attributes must be populated in each map
• Configured Data Dictionary
• The endpoint configuration needs to be pointed to the corresponding OpenText
Content Server details in the ContentBridge.MapEditor.exe.config in the
installation folder

EDCCM210200-UGD-EN-1 User Guide 313


Chapter 6 Advanced Functions

6.25.2 Required Attributes for Successful Load


There are 5 required attributes that need to be set before documents can be loaded
into OpenText. You could set these attributes in a Transformation activity. This
plugin now supports renditions.

They are:

• name : This attribute supplies the object name of each document inside of
OpenText Content Server
• type : This Attribute should be populated with the OpenText Object Type e.g.
144 for document
• file : This attribute should provide the source location of the content for each
document being loaded into Content Server repository, e.g. C:\Temp
\document1.txt
• folder_path : This attribute supplies the target path for each document in
Content Server e.g. /workspace/folder1/folder2

If no folder_path is provided, ContentBridge will use the default location provided


in the LoadintoOpenText activity

• primary_format : This attribute should contain the name of the format


corresponding to the content file being loaded into OpenText repository e.g.
ms8w for Microsoft word document.
• rendition_filename (optional): This attribute should provide the source location
of the rendition content file per document. e.g. C:\Temp\document1.txt. Used in
relation with the rendition path separator of the data dictionary if you are
passing in more than one rendition.
• rendition_format (optional): This attribute supplies the rendition format you are
loading.

** The spelling and format of these attributes must match what is listed above .

In the image below, the transform activity was used to set these attributes. On the
right hand side of the Transformation Activity, click the Edit button to open the
Output Schema.

314 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.25. Load Into OpenText

By double-clicking the name, you can edit it to meet your needs. Clicking on the
String in the Data Type column will allow you to change the type value.

Clicking on the number in the Size column will allow you to change the size value.

The following is an example of what your Transform activity could look like the
illustration below:

In this example, Literal Value functions (under the General Tab on the left hand side
of the Transform Activity) were used and mapped to the columns in the Output
Schema.

EDCCM210200-UGD-EN-1 User Guide 315


Chapter 6 Advanced Functions

6.25.3 Configure a Category in OpenText Content Server


The configuration values can be added in the transform add-in or the input add-in.

To configure a category

1. Mention the category in the input add-in and map it to the respective transform
add-in.

2. Map the attribute name in the transform add-in or pass it as an input to the
input add-in if you wish to update the value of an attribute within a category.

Note: The category name and attribute name must be already present in
OTCS before you can map these to configure the category.

6.25.4 Configured Data Dictionary


The Load into OpenText Function uses the Custom Table Function for information
when performing the load. You can alternatively have the already configured
DataDictionary and edit the same by having the below mentioned fields in addition
to the fields mentioned in the LoadIntoDCTM section

The following columns are used by the Load into OpenText Module:

Configuration Type Description Possible Values


debug_mode Int16 Sets the logging 0,1,2,3 or 4. 0 is the
detail level. lowest verbosity; 4 is
the highest verbosity.
legacy_object_id_fiel String This attribute needs Any valid column in
d (optional) to be populated if in the target system that
case of handling stores the legacy
targeted versioning object ID from the
(versioning from a source repository.
specific object). This
is required to support
branching.This is
used to fetch the
prior version of a
document where the
versioning/Branching
will be applied.

316 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.25. Load Into OpenText

Configuration Type Description Possible Values


legacy_version_id_fi String This attribute needs This holds the
eld (optional) to be populated if in attribute name that
case of handling contains the legacy
targeted versioning version id of the
(versioning from a source object. This
specific object). Thi attribute is required
value is used to fetch for constructing the
the prior version of a version tree in the
document where the target repository.
versioning will be
applied.
rendition_path_sepe String A single character Any single ASCII
rator used as a delimiter character. Suggestion
between multiple is to use the vertical
values. bar (|); Commas
should be avoided
since values may
contain commas in
them.

To create the columns in order to complete the Load into OpenText

• Go to the Import tab under Functions in the left menu screen.


• Click on the Custom Table Function and drag it into the map editor.
• In the map editor click on the Custom Table name and rename it to
DataDictionary.
• Click on the green question mark in the upper left corner of the custom table.
This opens the properties screen.
• Click the Add Column Button to add a new column.
• Double click the newly created column and rename it to one of the column
names listed above.

– By default the newly added column will be named NewColumn1, if the name
is not already used, and the Data Type will be set to String.
– Repeat this for all columns.

EDCCM210200-UGD-EN-1 User Guide 317


Chapter 6 Advanced Functions

– The Data Type must be set to String for all of the newly created columns
except debug_mode.
– Debug_mode must be set to Int16. Once done, select Finish

Next you must add a value to the newly created columns.

Click the table as shown in the DataDictionary (Custom Table) to show the custom
record values. Add the values you want in the table. Once you have entered your
values, Save the Map.

6.25.5 Loading Data into OpenText


After transformation and validation, an export step will take the transformed data,
and associated content files, and load them into a repository. An object is created
with content and the metadata is applied.

The properties screen of the OpenText-Load function allows you to configure


different options of the load process and authentication information for the target
repository. You can access this screen by clicking the icon in the top-left corner of the
function box.

318 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.25. Load Into OpenText

The following options can be configured:

• UserName : The user name to connect to the repository


• Password : The password for the user name in the repository
• Domain : Domain of the Content Server
• URL : Url of the OpenText Content Server
• Run Mode : Decides what type of load you want to do. There are three options:

– Create : Used to create new documents


– Create & Update : Used to create new documents and update existing
documents. The update option will update metadata for the object.
– Update : Works with primary keys to determine if document already exists,
and then will update the metadata file; this option will not version the
document.
• Default Folder Path : It specifies the default path in which the objects will be
loaded.
• Delimiter Character : specify the delimiter character here that is used in the map
for handling the multiple values for a single field.
• Validate Folder Paths : Optional, if you want the Load into OpenText to create
folders. You have two further options:
• Create Last Folder in Path only: Will only create the last folder
• Create all Folders in Path : Will create all folders.

The progress of the load can be monitored in the “Output” field below the map.
After the load is complete, the successfully loaded files will be removed from the

EDCCM210200-UGD-EN-1 User Guide 319


Chapter 6 Advanced Functions

target import folder. Those files that failed will be placed in an automatically created
“Failed” folder for review. The reasons for failure will be listed in the “Output” field
and in the log file. Click Finish to complete the activity

6.26 Write to Excel


The Write to Excel Add-in allows you to export content and metadata from the
OpenText Content Server into an MS Excel file. You can write the export data to a
new MS Excel file or append it to an existing file in your repository. This function
supports both .xls and .xlsx file formats.

To Write to Excel:

Select Write to Excel from the functions toolbar and drag and drop the widget onto
the grid.

Click the title bar to view the properties wizard which will guide your through the
rest of the process to write data onto an MS Excel file.

6.26.1 Select a File


To select an output MS Excel file:

1. Enter the path and the name of the new MS Excel output file to export data. A new
MS Excel output file is created at the location specified.

Note : ContentBridge accepts absolute paths as well as a path relative to the Map.

2. Select the Append new records to end of file (if already exists) option to append
the exported data to an existing MS Excel file with the same name and location
specified. Alternatively, click Browse next to the address bar to browse for an
existing file.

3. Click Next to define a format.

320 OpenText ContentBridge EDCCM210200-UGD-EN-1


6.26. Write to Excel

6.26.1.1 Parameterized File Name


Write to an Excel File addin will now allow parameterized Values for log file name.
The allowed parameters that filename can select are listed below.

For eg, The filename can be like ‒

testfilename -$value(batch_id)-$value(datetime)- $value(DDName!ColumnName)'


or testfilename-$value(batch_id)' etc..

The format should always match the below.

• $value (batch_id): current batch number.

• $value(date) : current date in the format ‒ dd-MM-yyyy

• $value(datetime) : current dateTime in the format ‒ yyyy-MM-dd hh.mm.ss

• $value (DDName!ColumnName): looks up for a column from the


Datadictionary. DDName' in the key mentioned can be any custom table addin in
the map followed by an ! (exclamation symbol) and column name can be any
column present in that particular Custom table. The custom table name and
column name are case sensitive and to be entered exactly as defined in the map.

Make sure that you have saved the old file before you undertake this task.

6.26.2 Define the Format


To define the format of the output file:

1. Enter a name for your worksheet in the Worksheet Name field.

2. Select the First row contains field names option to indicate that column names
are displayed on the first row of this worksheet.

3. Click Next to define a Schema.

6.26.3 Define the Schema


This screen allows you to specify names, data type, and maximum width of each of
the fields within the worksheet.

To define the Schema:

1. Enter values of your choice for the field. ContentBridge will truncate or pad the
data to fit the worksheet.

2. Click Finish to complete writing the data to an MS Excel file.

EDCCM210200-UGD-EN-1 User Guide 321


Chapter 7

Reference

This section describes each transform and validate function.

The functions are grouped by Validate and Transform and the ordered
alphabetically.

There is an index to each group:

• Transform

• Validate

7.1 Function Properties


Many of the functions have properties that you will need to set. Click on the left icon
of the function object and a dialog box will appear. The example below is for the
Splitfunction. It allows you to define the delimiter character (as a space in this case)
by clicking on the underlined text in the function description and entering space.
Press the OK button

EDCCM210200-UGD-EN-1 User Guide 323


Chapter 7 Reference

The properties of all functions are similar is style. A natural English sentence
describes the action of the function. The blue underlined text can be clicked on. This
will then either:

• Cycle through the allowed value


• Bring up a dialog box to allow entry of a value. You may type in a value or pick
from this list. Characters such as a period are displayed as {period} as the period
character would be difficult to see

The action of a function can be tested. You can run this test with the data presented
from the data in your map or by typing in data. The type is set to the data type by
default but can be modified as required (see the Glossary for more information on
Data Types).

Where data is entered (as shown in the above example of the character used to split)
you may be given a choice of the type of data to enter. The choices will include those
that are allowed in a given situation and are drawn from:

• Data types: such as String; Int16; Int32; Int64; Decimal; Single; Double; Boolean;
Date; Time; DateTime
• Null
• Input: one of the inputs to the function
• Dynamic: a value such as The date: The Machine name; TheContentBridge map
name; Your username

7.2 Reference to the Validate Functions


This section gives a brief description of each validation function. The functions are
given in alphabetical order and there is an index below organized by function type.

Please note that many of the string validate functions are done by the use of regular
expressions. Our thanks is extended to RegExLib.com and its contributors. This
excellent site, http://www.regexlib.com/Default.aspx, holds a very useful library of
regular expressions many of which have been reproduced within ContentBridge to
help you validate your data. The contributors are too many to mention.

Users of ContentBridge can add their own regular expressions. If you do write such
expressions can we encourage you to send them to us. we will incorporate them in
future versions of ContentBridge. You may also want to publish them to the
RegExLib.

324 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

String General Date & Time


AlphaAlpha
NumericArgentine Post
CodeAustralian Post .NET ScriptActiveX Valid DateAMPMLast
CodeAustralian Telephone ScriptANDCompareLookup HourCurrent HourNext
NumberBelgian Post NOT Not EmptyNot HourMondayTuesdayWedne
CodeBrazilian Post Code NullNullOR Range sdayThursdayFridaySaturda
Contains Credit Card ySundayYesterdayTodayTo
NumberDutch Post morrowJanuaryFebruaryMar
CodeEmail Address Ends chAprilMayJuneJulyAugustS
WithEuropean Style eptemberOctoberNovember
PostcodeForename/s DecemberLast MonthCurrent
SurnameFormatFrench Post MonthNext Month1st
CodeGerman Post CodeIP Quarter2nd Quarter3rd
AddressISBNItalian Post Quarter4th QuarterNext
CodeLengthNumericRegular QuarterCurrent QuarterLast
ExpressionSouth African QuarterLast YearCurrent
Cellular NumberSpanish YearNext YearLast Financial
Post Code Starts YearCurrent Financial
WithSurname YearNext Financial Year
(detailed)Swedish Phone
NumberSwedish Post
CodeUK Bank Sort CodeUK
Car RegistrationUK National
Insurance NumberUK Post
CodeUK Telephone
NumberURLUS or Canadian
Zip CodeUS Social Security
NumberUS State
AbbreviationUS Telephone
NumberUS Zip CodeUS,
Canadian or UK Zip Code

Please note that these tests are not warranted in any way and while we endeavor to
QC all validation functions data can vary widely and results are not always
predictable. Please email us with any details of any false negatives (good data
classified as bad) or incorrect data passed as valid.

7.2.1 .NET Script


Function Class: Validate
Function Subclass: General

EDCCM210200-UGD-EN-1 User Guide 325


Chapter 7 Reference

Description: Ad Hoc validate functions can be created by


using C#.

Multiple inputs and Outputs can be


connected to the Script object and used to
calculate the result.

On opening the Script properties a wizard is


presented allowing C# code to be created and
compiled.

For a full description please see the section


on the Map Level .NET Script object. The
wizard presents the same stages.
Map object:

326 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

Properties:

7.2.2 1st - 4th, Last, Current, Next Quarter


Function Class: Validate
Function Subclass: Date and Time

EDCCM210200-UGD-EN-1 User Guide 327


Chapter 7 Reference

Description: 7 functions to check the data is in a particular


quarter of the year or the last, next or current
quarter. Quarters are quarters of the calendar
year.

Please note that times will be assumed to be


today and will pass if the day they are run on
happens to be in the appropriate quarter (1st
in this case).
Map object:

Properties: None
Examples: “3/1/05” passes

“10/1/05 12:34” passes

“4/6/05” fails

“7/9/05” fails

“12:34” will pass if today happens to be in


the 1st quarter

7.2.3 Alpha
Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the only alpha
characters
Map object:

Properties: None
Examples: “FGtryr” passes

“Fred” passes

“Fred Smith” fails

“Fred99” fails

328 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

7.2.4 Alpha Numeric


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the only
alphanumeric characters
Map object:

Properties: None
Examples: “FGtryr” passes

“Fred99” passes

“Fred Smith” fails

“Fred-99” fails

7.2.5 AM, PM
Function Class: Validate
Function Subclass: Date and Time
Description: Two functions to check the data is AM or
PM.
Map object:

Properties: None
Examples: “12:00” fails

“00:00” passes

“12:34” fails

“02:23 PM” fails

EDCCM210200-UGD-EN-1 User Guide 329


Chapter 7 Reference

7.2.6 AND
Function Class: Validate
Function Subclass: General
Description: Combines two or more validate functions to
allow rows to pass if they match both
conditions. Can accept any number of
Boolean inputs and has a single output, True
or False.

If the data connected to the input is not


Boolean the left icon (when in preview
mode) will be a yellow warning triangle.

This function is normally used to built


complex logic for controlling tests. An
example might be pass rows where the
Country is USA or Canada (where the region
is BC).

Please remember that the row passes if all


unconnected outputs are True. See more
information on Validate.

Map object:

Properties: None
Examples: see above

330 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

7.2.7 Argentine Post Code


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for an Argentine Post Code
Map object:

Properties: None
Examples: “C1406HHA” passes

“A4126AAB” passes

“c1406HHA” fails

“C1406hha” fails

7.2.8 Australian Post Code


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for an Australian Post Code
Map object:

Properties: None
Examples: “200” passes

“0820” passes

“SA 0897” fails

“abcd” fails

EDCCM210200-UGD-EN-1 User Guide 331


Chapter 7 Reference

7.2.9 Australian Telephone Number


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for an Australian Telephone
Number including mobile numbers and 13,
1300, 1800, 1900, 1902 numbers
Map object:

Properties: None
Examples: “(02)12341234” passes

“0312341234” passes

“03 1234 1234” passes

“00 1234 1234” fails

“03-1234-1234” fails

7.2.10 Belgian Post Code


Function Class: Validate
Function: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a Belgian Post Code
Map object:

Properties: None
Examples: “1234” passes

“1056” passes

“0897” fails

“abcd” fails

332 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

7.2.11 BinaryLookup
Function Class: Validate
Function Subclass: General
Description: Compare the data against a list of allowed
values. The comparison uses binary search
algorithm which is faster compared to
LookUp which uses sequential search for
comparison. The input function should be a
sorted function in order to use the Binary
Lookup. Binary Lookup also allows you to
lookup multiple tags on an input line.
• Function: The map object to be used for
the list of allowed values
• Output: The data from the map object,
normally the Records Read
• Column to be searched: The column
where the matching data will be found
• Delimiter : It allows you to define the
delimiter. If you don't define a delimiter
it will use what is in the datadictionary. If
there is no datadictionary and it is not
defined, it will default to �,�

ContentBridge will validate data against the


value mentioned in the Column of the object
mentioned in the Function
Map object:

EDCCM210200-UGD-EN-1 User Guide 333


Chapter 7 Reference

Properties:

7.2.12 Brazilian Post Code


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a Brazilian Post Code. The
function matches standard 5 digit Brazilian
Postal Codes (CEP), or the CEP + 3 digits
(distribution identifiers - suffix).
Map object:

Properties: None
Examples: “13165-000” passes

“13165” passes

“13165-00” fails

“13165-abc” fails

334 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

7.2.13 Compare
Function Class: Validate
Function Subclass: General
Description: The Compare accepts to inputs.

Compare the data against a value you type in


or against other data. The comparison can be
any of equals, not equals, less than, greater
than, less then or equal or greater then or
equal.

This validate function works for all data


types including for example string, numeric
and date.
Map object:

EDCCM210200-UGD-EN-1 User Guide 335


Chapter 7 Reference

Properties:

The comparison can be a literal value,


dynamic data or other data from the row.
Click on the blue text to bring up the
properties dialog

This dialog can be used to specify the value


when false as:
• An input (as shown)
• A literal value
• Null

336 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

• A dynamic value such as the date, map


name or username.
Examples: “Sales” passes a test of = “Sales”

“sales” fails a test of = “Sales”

“sales” passes a test of = “sales”

“Sales” passes a test of >“Sale”

7.2.14 Contains
Function Class: Validate
Function Subclass: String
Description: Checks the strings contain one or more
characters
Map object:

EDCCM210200-UGD-EN-1 User Guide 337


Chapter 7 Reference

Properties:

Enter the characters to compare with the


string and if the comparison should be case
sensitive.
Examples: “ISBN 0 93028 923 4” passes Contains“ISBN”

“ISBN 1-56389-668-0” passes Contains“-0”

“ISBN 0 93028 923 4A” fails Contains“ISBN


1”

“ISBN 9-87654321-2” fails Contains“4”

338 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

7.2.15 Credit Card Number


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a credit card. Matches major
credit cards including:
• Visa (length 16, prefix 4)
• Mastercard (length 16, prefix 51-55)
• Diners Club/Carte Blanche (length 16,
prefix 36, 38, or 300-305)
• Discover (length 16, prefix 6011)
• American Express (length 15, prefix 34 or
37)
Map object:

Properties: None
Examples: “4111-2222-3333-4444” passes

“5111222233334444” passes

“4111-2222-3333-444” fails

“Mastercard” fails

7.2.16 Dutch Post Code


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a Dutch Post Code
Map object:

Properties: None

EDCCM210200-UGD-EN-1 User Guide 339


Chapter 7 Reference

Examples: “1234 AA” passes

“1056AB” passes

“0897 AA” fails

“1234 ab” fails

7.2.17 Email Address


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for an email. Allows composite
names such as john.bull, john-bull and
john_bull
Map object:

Properties: None
Examples: “bob@a.com” passes

“bob.smith@company.com” passes

“bob@.com” fails

“bob@-a.smith.com” fails

7.2.18 Ends With


Function Class: Validate
Function Subclass: String
Description: Checks the strings ends with one or more
characters
Map object:

340 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

Properties:

Enter the characters to compare with at the


end of the string and if the comparison
should be case sensitive.

7.2.19 European Post Code


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
those required for a European style postcode.
The postcode must be prefixed by the
country code such as D-12345 or DK-1530
Map object:

Properties: None

EDCCM210200-UGD-EN-1 User Guide 341


Chapter 7 Reference

Examples: “DK-1234” passes

“GR-117 80” passes

“Dk-1234” fails

“DK1234” fails

Country codes are as follows:

Belgium B-1040
Denmark DK-1530
France FR-100
Finland FIN-20540
Faeroe Islands F-75700
Germany D-13355
Greece GR-117 80
Iceland IS-101
Israel IL-61 200
Italy I-00100
Liechtenstein FL-9490
Monaco MC-98030
The Netherlands NL-1000 NA
Norway N-7950
Portugal P-1100
Romania R-77113
Spain E-12345
Sweden S-10500
Switzerland CH-8050
Tunisia TN-1030
Turkey TR-06101
Vatican V-00120

342 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

7.2.20 Forename/s Last Name


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for one or more
forenames followed by a surname. The
Surname test is not as thorough as the
Surname (detailed) test also available
Map object:

Properties: None
Examples: “John Bull” passes

“John Tom Bull-Smyth” passes

“Smith” fails

“K Smith” fails

“Smith-Johnson” fails

7.2.21 French Post Code


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a French Post Code.
Includes Corsica with a different format
Map object:

Properties: None
Examples: “F-12345” passes

“12345” passes

“F0897” fails

“2A123” passes

EDCCM210200-UGD-EN-1 User Guide 343


Chapter 7 Reference

7.2.22 Fuzzy Compare


Function Class: Validate
Function Subclass: String
Description: Used to perform a relational operation using
Fuzzy logic. It comparesthe input
valueagainst a comparison value and
provides a boolean output(True or False).

The accuracy value can also be set.


Map object:

Properties:

The comparison value can be a literal value,


dynamic data or other data from the row.

Also define the accuracy by moving the


sliding bar.

344 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

Examples: “CustomerID” passes a test of =


“CustomerID”

“customerID” passes a test of =


“CustomerID”

“customerID” passes a test of =


“CustomerID”

“customerID” passes a test of >“CustomerI”

7.2.23 German Post Code


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a Germany Post Code
Map object:

Properties: None
Examples: “D-12345” passes

“12345” passes

“01234” fails

“d-12345” fails

7.2.24 IP Address
Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for an IP address
Map object:

Properties: None

EDCCM210200-UGD-EN-1 User Guide 345


Chapter 7 Reference

Examples: “10.0.0.3” passes

“255.255.0.32” passes

“256.2.1.201” fails

“192.168.12.12.” fails

7.2.25 ISBN Number


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for an ISBN code
Map object:

Properties: None
Examples: “ISBN 0 93028 923 4” passes

“ISBN 1-56389-668-0” passes

“123456789X” fails

“ISBN 9-87654321-2” fails

7.2.26 Italian Post Code


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for an Italian Post Code.
Includes the Vatican City
Map object:

Properties: None

346 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

Examples: “V-12345” passes

“12345” passes

“1234” fails

“i-12345” fails

“I-12345” passes

7.2.27 January - December, Last, Current, Next Month


Function Class: Validate
Function Subclass: Date and Time
Description: 15 functions to check the data is in a
particular month of the year or last, next or
current month. Please note that times will be
assumed to be today and will pass if the day
they are run on happens to be the month or
in this case January.
Map object:

Properties: None
Examples: “3/1/05” passes

“10/1/05 12:34” passes

“4/2/05” fails

“7/3/05” fails

“12:34” will pass if today happens to be in


January

7.2.28 Last, Current, Next Financial Year


Function Class: Validate
Function Subclass: Date and Time
Description: 3 functions to check the data is in a particular
UK Financial Year.

Please note that times will be assumed to be


today and will pass if the day if the test is the
current Financial Year.

EDCCM210200-UGD-EN-1 User Guide 347


Chapter 7 Reference

Map object:

Properties: None
Examples:

7.2.29 Last, Current, Next Hour


Function Class: Validate
Function Subclass: Date and Time
Description: Three functions to check the data is within
the last, current or next hour
Map object:

Properties: None
Examples:

7.2.30 Last, Current, Next Year


Function Class: Validate
Function Subclass: Date and Time
Description: 3 functions to check the data is in a particular
Year.

Please note that times will be assumed to be


today and will pass if the day if the test is the
current Year.
Map object:

Properties: None
Examples:

348 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

7.2.31 Length
Function Class: Validate
Function Subclass: String
Description: Checks the length of a string and fails if
greater than the test figure given.
Map object:

Properties:

Examples: “ISBN 0 93028 923 4” passes no longer then


18

“ISBN 1-56389-668-0” passes no longer then


18

“ISBN 0 93028 923 4A” fails no longer then 18

“ISBN 9-87654321-2” fails no longer then 18

EDCCM210200-UGD-EN-1 User Guide 349


Chapter 7 Reference

7.2.32 Lookup
Function Class: Validate
Function Subclass: General
Description: Compare the data against a list of allowed
values. The comparison is case-sensitive. If
you want case-insensitivity then you should
transform the reference and source data
columns to for example upper case.

The list of allowed values are another object


on the map. They could be imported from a
database or a list or manually entered using a
Custom Table.

In the example shown here there is a list of


countries shipped with ContentBridge. This
has been imported onto the map and called
Countries. ContentBridge will validate data
against the CountryName column of the
Countries object. Please see the short tutorial.

The results are displayed and more test can


be run by changing the input value.
Map object:

Properties:

Examples: In this example Germany is confirmed as a


valid country

350 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

7.2.33 Lookup - a tutorial


In this quick tutorial we will validate data against a list of countries.

Drag a Read Text File object onto


the main map

Click the left icon


Set the file to Countries.csv in the
samples folder

EDCCM210200-UGD-EN-1 User Guide 351


Chapter 7 Reference

Select Delimited and First row


contains field names

Finish the wizard


Double click the name and change
to Countries
If you have not already done so
add a Validateobject to the main
map and Click the left icon to open
the properties

Drag a Lookup validate function


onto the validate map and bring
up the properties by double
clicking the left icon

352 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

Set the properties to point to the


list of countries. The Column
specifies the column holding the
list of countries. The result is
shown, in this case confirming
Germany is in the list of allowed
countries. Further tests can be run
by changing the value and
pressing the Test button.

Save the properties

Link the data you want to test to


this validate function
Close the Validate properties. The
data will now validate against the
allowed list of countries

7.2.34 Monday - Sunday, Yesterday, Today, Tomorrow


Function Class: Validate
Function Subclass: Date and Time
Description: 10 functions to check the data is a particular
day of the week or yesterday, today or
tomorrow. Please note that times will be
assumed to be today and will pass if the day
they are run on happens to be a Monday.
Map object:

Properties: None

EDCCM210200-UGD-EN-1 User Guide 353


Chapter 7 Reference

Examples: “3/1/05” passes

“10/1/05 12:34” passes

“4/1/05” fails

“7/1/05” fails

“12:34” will pass if today happens to be


Monday

7.2.35 Not
Function Class: Validate
Function Subclass: General
Description: Reverses a Boolean value. This function is
normally used to reverse the results of a test.
For example the logic below will pass rows
that have any value in the Country field
except Germany, France or the UK:

Map object:

Properties: None
Examples: In the above example Country = “Mexico”
passes
In the above example Country = “UK” fails

354 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

7.2.36 Not Empty


Function Class: Validate
Function Subclass: General
Description: Test if the data is not empty. Null, an empty
string or whitespace chars will produce a
false result.
Map object:

Properties: None
Examples: Null fails

Space fails

Blank fails

One or more normal character pass

7.2.37 Not Null


Function Class: Validate
Function Subclass: General
Description: Test if the data is not null. Null is a technical
term for nothing at all. It is different from
zero or space, which are values even if they
indicate nothing.
Map object:

Properties: None
Examples:

EDCCM210200-UGD-EN-1 User Guide 355


Chapter 7 Reference

7.2.38 Null
Function Class: Validate
Function Subclass: General
Description: Test if the data is null. Null is a technical
term for nothing at all. It is different from
zero or space, which are values even if they
indicate nothing.
Map object:

Properties: None
Examples:

7.2.39 Numeric
Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the only Numeric
characters
Map object:

Properties: None
Examples: “1234” passes

“01234” passes

“G1234” fails

“66 890” fails

356 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

7.2.40 OR
Function Class: Validate
Function Subclass: General
Description: Combines two or more validate functions to
allow rows to pass if they match one of many
conditions. Can accept any number of
Boolean inputs and has a single output, True
or False.

If the data connected to the input is not


Boolean the left icon (when in preview
mode) will be a yellow warning triangle.
Map object:

Properties: None
Examples:

7.2.41 Range
Function Class: Validate
Function Subclass: General
Description: Compare the data against an upper and
lower limit. Optionally the comparison can
be inclusive.

This function supports all data types


including for example, Date, Time, String
and Numeric.
Map object:

EDCCM210200-UGD-EN-1 User Guide 357


Chapter 7 Reference

Properties:

Examples: “5/1/05” passes a test of 3/1/05 to 3/2/05

“5 Jan 2005” passes a test of 3/1/05 to 3/2/05

“5/4/05” fails a test of 3/1/05 to 3/2/05

7.2.42 Regular Expression


Function Class: Validate
Function Subclass: String

358 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

Description: An ad hoc test by a regular expression.


ContentBridge will evaluate most regular
expressions to allow the user (of
ContentBridge Pro only) to build a test not
offered by ContentBridge. For more
information on regular expressions please go
to a number of useful sites on the Internet
including:
• http://www.regular-expressions.info/
(file://vmware-host/Shared%20Folders/
abhyah1/Tempo%20Box/habhyank/ECD
%20Solutions/ContentBridge/
Developement%20Team/Help%20Files/
From%20Harshad/Word%20Export/
%25E2%2580%25A2http:/www.regular-
expressions.info/)
• http://www.regexlib.com/ (file://vmware-
host/Shared%20Folders/abhyah1/Tempo
%20Box/habhyank/ECD%20Solutions/
ContentBridge/Developement%20Team/
Help%20Files/From%20Harshad/Word
%20Export/%25E2%2580%25A2http:/
www.regexlib.com/)
• http://www.regexbuddy.com/index.html
(file://vmware-host/Shared%20Folders/
abhyah1/Tempo%20Box/habhyank/ECD
%20Solutions/ContentBridge/
Developement%20Team/Help%20Files/
From%20Harshad/Word%20Export/
%25E2%2580%25A2http:/
www.regexbuddy.com/index.html) - this
is a great tool for building Regular
Expressions

The data and data type can be edited and a


test run.
Map object:

EDCCM210200-UGD-EN-1 User Guide 359


Chapter 7 Reference

Properties:

This regular expression will test for alpha


numeric characters only
Examples: “A1867” passes

“D 1867” fails

“a-1345” fails

“Bb1006” passes

7.2.43 South African Cellular Number


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for an South African Mobile
Telephone Number
Map object:

Properties: None

360 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

Examples: “0820123456” passes

“0740123456” passes

“0770123456” passes

“07401234562” fails

“0640123456” fails

7.2.44 Spanish Post Code


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a Spanish Post Code.
Map object:

Properties: None
Examples: “12345” passes

“E-12345” passes

“01234” fails

“e-12345” fails

7.2.45 Starts With


Function Class: Validate
Function Subclass: String
Description: Checks the strings starts with one or more
characters
Map object:

EDCCM210200-UGD-EN-1 User Guide 361


Chapter 7 Reference

Properties:

Enter the characters to compare with at the


start of the string and if the comparison
should be case sensitive.
Examples: “ISBN 0 93028 923 4” passes Starts With
“ISBN”

“ISBN 1-56389-668-0” passes Starts With


“ISBN 1”

“ISBN 0 93028 923 4A” fails Starts With


“ISBN 1”

“ISBN 9-87654321-2” fails Starts With “ISBN


1”

362 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

7.2.46 Last Name (detailed)


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for a valid surname. Mc,
Mac, O', Hyphens, Van, La, Le, Da and De
are allowed
Map object:

Properties: None
Examples: “O,Brian” passes

“Bull-Smyth” passes

“smith” fails

“K Smith” fails

“Smith-johnson” fails

7.2.47 Swedish Post Code


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a Swedish Post Code.
Broader rules than the European postcode
validation allowing lower case “s”, no “-”
after the “S” or “s” and a space or “-” after
three digits
Map object:

Properties: None

EDCCM210200-UGD-EN-1 User Guide 363


Chapter 7 Reference

Examples: “S-12345” passes

“S12345” passes

“S-123-56” passes

“12345” fails

“s-123-123” fails

7.2.48 Swedish Telephone Number


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a Swedish Telephone
Number according to SIS standards
Map object:

Properties: None
Examples: “+46 8 123 456 78” passes

“08-123 456 78” passes

“0123-456 78” passes

“+46 08-123 456 78” fails

“0123 456 78” fails

7.2.49 UK Bank Sort Code


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that of a UK Bank Sort Code. The format is
nn-nn-nn
Map object:

Properties: None

364 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

Examples: “01-02-03” passes

“12-34-56” passes

“010203” fails

“1-02-03” fails

7.2.50 UK Car Registration


Function Class: Validate
Function String
Subclass:
Description: Compare the data against a regular
expression to check for the format
matching that of a UK car registration
number. There are four systems used
in the UK. This functions tests them as
described below:

Current system: DR03 FGT

Prefix system: A234 GTH

Suffix system: GTH 234A

Dateless system: GTH 234

For the current system the allowed


letters are tested so that inclusion of
for example an “I” will fail the data.
All letters are allowed by the test for
the prefix and suffix systems.
Map object:

Properties: None
Examples: “S 453 EWR” passes

“DF 54 RTH” passes

“GTH 234” fails

“DI54 RTH” fails

EDCCM210200-UGD-EN-1 User Guide 365


Chapter 7 Reference

7.2.51 UK National Insurance Number


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular expression to check for the
format matching that of a UK National Insurance (NI) number. The
format is two capital letters then 6 digits then one letter drawn from
A-D, F or M.
Map object:

Properties: None
Examples: “AB123456A” passes

“AA654321B” passes

“Aa654321B” fails

“AA654321E” fails

7.2.52 UK Post Code


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a UK Post Code. Spaces can
be present or absent between the two blocks,
but must not be present elsewhere. The test
does check for allowed letters.
Map object:

Properties: None
Examples: “RH4 1WZ” passes

“RH41WZ” passes

“RH4 1 WZ” fails

“RH 41WZ” fails

366 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

7.2.53 UK Telephone Number


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a UK Telephone Number.
The +44 is allowed as long as it is followed
by (0). Spaces or dashes are allowed between
blocks, but not elsewhere.
Map object:

Properties: None
Examples: “+44 (0)1304 877253” passes

“01304 877253” passes

“01304877253” passes

“01304 8772532” fails

“1304 877253” fails

7.2.54 URL
Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a URL address. Addresses
can start with www and no prefix or a prefix
of http://, https:// or ftp://
Map object:

Properties: None
Examples: “http://www.OpenText.com” passes

“www.OpenText.com” passes

“HTTP://www.OpenText.com” fails

“www.OpenText.com.” fails

EDCCM210200-UGD-EN-1 User Guide 367


Chapter 7 Reference

7.2.55 US or Canadian Zip Code


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a US or Canadian Zip code.
The US Zip allows the 4 digit extension, but
if present must follow a dash. The Canadian
code allows upper and lower case.
Map object:

Properties: None
Examples: “00501” passes

“84118-3423” passes

“n3a 3B7” passes

“0005012” fails

“84118 3423” fails

7.2.56 US Social Security Number


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that of a US Social Security Number (SSN).
Dashes are allowed between the number
groups. 000 and 666 are not allowed for the
first block of digits. 00 and 0000 are not
allowed for the 2nd and 3rd blocks
Map object:

Properties: None

368 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

Examples: “111-22-3333” passes

“111223333” passes

“111-00-3333” fails

“000-22-3333” fails

7.2.57 US State Abbreviation


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that of a two letter US state abbreviation.

Please note that ContentBridge is shipped


with a list of US states and State
abbreviations. You may wish to consider
validating against this list using the Lookup
function
Map object:

Properties: None
Examples: “IL” passes

“NY” passes

“Illinois” fails

“ny” fails

7.2.58 US Telephone Number


Function Class: Validate
Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a US Telephone Number.
Spaces or dashes may be used between the
blocks. The area code does not need to be
present. If present it can be in parenthesis.
The international code is not allowed.

EDCCM210200-UGD-EN-1 User Guide 369


Chapter 7 Reference

Map object:

Properties: None
Examples: “312-452-4569” passes

“(312) 452 4569” passes

“452-4569” passes

“+001-312-452-4569” fails

“312-4524-569” fails

7.2.59 US Zip Code

Function Class: Validate


Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a US Zip Code. The 4 digit
extension can be present and the separator if,
present, must be a dash.
Map object:

Properties: None
Examples: “14467” passes

“14467-1234” passes

“14467 1234” fails

“144673” fails

7.2.60 US, Canadian or UK Zip Code

Function Class: Validate


Function Subclass: String
Description: Compare the data against a regular
expression to check for the format matching
that required for a US, Canadian or UK Zip
code. The test for only the US Zip and UK
Postcode is far more thorough and should be
used where possible.

370 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.2. Reference to the Validate Functions

Map object:

Properties: None
Examples: “RH4 1WZ” passes

“61245” passes

“N3A 3B7” passes

“RH4 1WZZ” fails

“612V34” fails

7.2.61 Valid Date


Function Class: Validate
Function Subclass: Date and Time
Description: Check the data for a valid date, time or date
and time. The regional setting of the machine
will determine if 12/13/04 is treated as not a
valid date or 13 December.
Map object:

Properties: None
Examples: “3/1/05” passes

“34 Mar 2005” fails

“2 March 2005” passes

“3/1/2005 12:34” passes

“12:45” passes

EDCCM210200-UGD-EN-1 User Guide 371


Chapter 7 Reference

7.3 Reference to the Transform Functions


This section gives a brief description of each Transform function. The functions are
given in alphabetical order and there is an index below organized by function type.

Users of ContentBridge Pro can add their own transform functions using VBScript .
If you do write such functions can we encourage you to send them to us. we will
incorporate them in future versions of ContentBridge.

String General Numeric Lookup


AbbreviateAppendC .NET ScriptActiveX Sequence Doc ID LookUp
oncatenateDeleteLeft ScriptFirst Non
Left DeleteLeft NullIfLookupLiteral
TrimLengthLower ValueTo BooleanTo
CaseMiddleName DateTimeTo
SplitPad PrefixProper DecimalTo DoubleTo
CaseRemove Replace Int16To Int32To
RightRight Int64To SingleTo
DeleteRight String
TrimSentence
CaseSplitTrim Upper
Case

Please note that these tests are not warranted in any way and while we endeavor to
QC all validation functions data can vary widely and results are not always
predictable. Please email us with any details of any false negatives (good data
classified as bad) or incorrect data passed as valid.

7.3.1 .NET Script


Function Class: Transform
Function Subclass: General
Description: Ad Hoc transform functions can be created
by using C#.

Multiple inputs and Outputs can be


connected to the Script object and used to
calculate the result.

On opening the Script properties a wizard is


presented allowing C# code to be created and
compiled.

For a full description please see the section


on the Map Level .NET Script object. The
wizard presents the same stages.
Map object:

372 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Properties:

Examples:

EDCCM210200-UGD-EN-1 User Guide 373


Chapter 7 Reference

7.3.2 Abbreviate
Function Class: Transform
Function Subclass: String
Description: Transforms fields to and from abbreviations.

This function will substitute an abbreviation with the full term or


change all data into the abbreviations. Check the abbreviations you
want to use. You can check one or more groups or expand the tree
view and only use some abbreviations within a group.

ContentBridge is provided with a number of standard abbreviation


such as US States, UK Counties and others. You can change these and
even add new categories of abbreviations.

Please see the advanced topic for more details on maintaining


abbreviations. The abbreviations can be edited from the Abbreviate
function properties or from the Abbreviations editor available from
the Tools menu
Map object:

374 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Properties:

Examples: “IL” to “Illinois” or “Illinois” to “IL” “Ltd” to “Limited”

EDCCM210200-UGD-EN-1 User Guide 375


Chapter 7 Reference

7.3.3 Append
Function Class: Transform
Function Subclass: String
Description: Appends a literal string to the data field.

To modify the string click on the blue text in


the properties dialog box.
Map object:

Properties:

Examples: Append “.com” to “mycompany” to get


“mycompany.com”

376 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

7.3.4 BinaryLookup
Function Class: Transform
Function Subclass: General
Description: Finds the field in a Binary lookup table or list
and replaces the value with the reference
value.

The comparison uses binary search


algorithm which is faster compared to the
LookUp function which uses sequential
search for comparison. Binary Lookup also
allows you to lookup multiple tags on an
input line. The input function should be a
sorted function in order to use the Binary
Lookup

This is similar to the Binary lookup


validation function. Please read the tutorial
for this function.

• Function: The map object to be used for


the list of allowed values
• Output: The data from the map object,
normally the Records Read
• Column to be searched: The column
where the matching data will be found
• Column whose Value will be
returned:The ID from the list or reference
table to be used in the data
• Delimiter : It allows you to define the
delimiter. If you don't define a delimiter
it will use what is in the datadictionary. If
there is no datadictionary and it is not
defined, it will default to �,�
Map object:

EDCCM210200-UGD-EN-1 User Guide 377


Chapter 7 Reference

Properties:

7.3.5 Concatenate
Function Class: Transform
Function Subclass: String
Description: Concatenates (joins) two or more strings. The
delimiter is placed between the fields
Map object:

378 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Properties:

Examples: Concatenate “John” and “Bull” with a


delimiter of space to create “John Bull”

7.3.6 Doc ID Lookup


Function Class: Transform
Function Subclass: Lookup

EDCCM210200-UGD-EN-1 User Guide 379


Chapter 7 Reference

Description: Doc ID lookup module is


designed to query a database
and return values
corresponding to the
specified key. The function
accepts two input values. It is
designed to query the
database for a set of records
based on the first input value
or Key1 provided to the
module. This value is used to
build the where clause for the
database query. The function
returns a value
corresponding to the second
input value provided to the
module.

Example: The module can be


configured to retrieve ALL
records from a database
where document_type =
‘Procedures' and return value
of the field owner_name for
the document whose name is
OperatingProicedure for
XYZ.

In this use case Procedures


will be passed in to the
DocIDLookupfunction as
Input1 and
OperatingProicedure for XYZ
is passed in to the
DocIDLookup as input2.

Based on the above use case


the the Database query used
to retrieve the set of records
will be:

Select document_name,
owner_name from
TableName where
document_type = Procedures

The field names used in the


database query above are
defined in the external
configuration required for
the Doc ID Lookup function.
For the above example to
work, document_type must
be defined as KeyField1,
Document_name must be

380 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

defined as KeyField2 and


owner_name must be
defined as ReturnField in the
configuration table described
in the following section.

EDCCM210200-UGD-EN-1 User Guide 381


Chapter 7 Reference

Configuration Parameters: Doc ID Lookup function


requires additional
configuration parameters to
be able to connect to the
Database and retrieved
specified field values.

Use following steps to define


the configuration parameters
required by Doc ID Lookup
module:
• Add a Custom Table
(available under General
Functions section on the
left) module to the map.
• Name the Custom Table
function as DocIDLookup
Config
• Click on the Question
Mark icon at the top left
corner within the module
placeholder to open the
schema editor for custom
table
• Add two columns, Name
& Value, to the schema as
displayed in the
illustration below.

• Click OK to save the


changes and close the
schema editor.
• Right click on the
DocIDLookup Config
module and select
Execute from the popup
menu

382 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

• Click on the Grid icon at


the bottom right corner of
the module placeholder to
open the output table area
in the bottom pane.
• Add following
configuration parameters.
Enter the name of the
parameter in the Name
column and value in the
Value column as listed
below:
1. Server � Database server
Name ‒ For SQL Server
its host/SQLServerName
or IP Address, For
ORACLE it's the
DataSourceName as
included in
TNSNAMES.ORA file
2. UserName � Name of the
database user
3. Password � Password for
the database user
4. KeyField1 � Name of the
database field to be used
to to build a where clause
while building a database
query.
5. KeyField2 � Name of the
database field returned in
the query results. This
field value will used as a
key for the lookup
function. Sample Config
entries for Oracle DB
Lookup

EDCCM210200-UGD-EN-1 User Guide 383


Chapter 7 Reference

Sample Config entries for


MS SQL Server DB
Lookup

Map Object:

384 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Properties :

7.3.7 Delete
Function Class: Transform
Function Subclass: String
Description: Deletes characters starting from a position
and continuing either for a fixed number of
characters or up to another character.

Click on the blue sections of the sentence to


change the numbers and stop characters.

To retain characters in the middle of a string


rather than delete please see the Transform
Middle Function
Map object:

EDCCM210200-UGD-EN-1 User Guide 385


Chapter 7 Reference

Properties:

386 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Examples: “17GB3478” to “173478” “Fred John Smith”


to “Fred Smith”

7.3.8 First Non Null


Function Class: Transform
Function Subclass: General
Description: This function will accept multiple inputs and
has a single output. The first non null value
is passed with precedence given in the order
of the inputs.

Where several alternate transformations are


made on a field this function allows the one
that returns a result to be passed through.
Map object:

Properties:

EDCCM210200-UGD-EN-1 User Guide 387


Chapter 7 Reference

Examples: “01306 77665” or “01306-77665” or “(01306)


77665” can be transformed to “01306” by
three functions and the correct output
selected using the First Non Null function

7.3.9 If
Function Class: Transform
Function Subclass: General
Description: Makes a logical test on row data. The result
will depend on this test.

Supports up to 4 pieces of input data and 2


output. Supports Literals and Dynamic Data
Map object:

388 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Properties:

Click on for example the last link for the

This dialog can be used to specify the value


when false as:
• An input (as shown)
• A literal value
• Null
• A dynamic value such as the date, map
name or username.
Examples: “GB” to “UK” and “France” to “France” and
“UK” to “UK”

EDCCM210200-UGD-EN-1 User Guide 389


Chapter 7 Reference

7.3.10 Left
Function Class: Transform
Function Subclass: String
Description: Passes through the left characters of a string.
This function can be used to retain the a fixed
number of characters or those up to a
character.

For the latter specify if the character itself


should be included.

The function can be tested from the


properties dialog box. If the Transform map
was in preview mode the data being
previewed will be available for testing. Also
new test data can be simply typed in and the
Test button pressed.
Map object:

Properties:

390 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Examples: “01306-77665” to “01306”

“020-7440-1234” to “020” and “01306-77665”


to “01306”

“36 High Street” to “36”

7.3.11 Left Delete


Function Class: Transform
Function Subclass: String
Description: Deletes characters starting with from the left
and continuing either for a fixed number of
characters or up to another character.

Click on the blue sections of the sentence to


change the numbers and stop characters.

Please also see Right Deleteand


Deletefunctions.
Map object:

EDCCM210200-UGD-EN-1 User Guide 391


Chapter 7 Reference

Properties:

392 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Examples: “17GB3478” to “3478” “Fred John Smith” to


“Smith”

7.3.12 Left Trim


Function Class: Transform
Function Subclass: String
Description: Removes any Space, Tab, Carriage Return or
Linefeed characters from the left end of the
data. This is normally applied to data of type
string.
Map object:

Properties:
Examples: “01306 77665” to “01306 77665”

EDCCM210200-UGD-EN-1 User Guide 393


Chapter 7 Reference

7.3.13 Length
Function Class: Transform
Function Subclass: String
Description: Determines the length of a string. Might for
example be used in conjunction with Pad to
set the length of a field to match that of
another field.
Map object:

Properties: None
Examples: Output of 6 for “Wales”

Output of 3 for “USA”

7.3.14 Literal Value


Function Class: Transform
Function Subclass: General
Description: Allows the entry of a value onto the map to force a particular column
to a single value. In the example shown here the Country field is set
to “USA”.

Please note that the Literal Value object is automatically named to


match the literal data entered.
Map object:

Properties:

The value can be set to any data type and the value typed in. In
addition a dynamic value such as the date, map name or machine
name can be used.

394 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Examples:

7.3.15 Lookup
Function Class: Transform
Function Subclass: General
Description: Finds the field in a lookup table or list and
replaces the value with the reference value.
The comparison is case-sensitive. If you want
case-insensitivity then you should transform
the reference and source data columns to for
example upper case.

If there is a reference table of countries and


France is ID 15. The data “France” will be
changed into 15.

This is similar to the lookup validation


function. Please read the tutorial for this
function.

• Function: The map object to be used for


the list of allowed values
• Output: The data from the map object,
normally the Records Read
• Column to be searched: The column
where the matching data will be found
• Column whose Value will be returned:
The ID from the list or reference table to
be used in the data

Data can be typed in a tests run.


Map object:

EDCCM210200-UGD-EN-1 User Guide 395


Chapter 7 Reference

Properties:

Examples: In the example above Germany will be


replaced with the ID 109. This points to the
entry for Germany in the Countries list or
reference table

7.3.16 Lower Case


Function Class: Transform
Function Subclass: String
Description: Transforms a field to all lower case
characters
Map object:

Properties: None

396 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Examples: “ContentBridge” to “contentbridge”

“New England Patriots” to “new england


patriots”

7.3.17 Middle
Function Class: Transform
Function Subclass: String
Description: Passes through the Middle characters of a
string. This function can be used to retain the
a fixed number of characters or those up to a
character.

For the latter specify if the character itself


should be included.

The function can be tested from the


properties dialog box. If the Transform map
was in preview mode the data being
previewed will be available for testing. Also
new test data can be simply typed in and the
Test button pressed.

Please note that the order of the tests is not


important. ContentBridge will adjust the
order is required. Looking at the example
below the following test will produce the
same results:

Return characters starting at the


1stoccurrenceof - upto the 1st occurrence of
{space} .
Map object:

EDCCM210200-UGD-EN-1 User Guide 397


Chapter 7 Reference

Properties:

Examples: “01306-776-655” to “776”

“G456HGT” to “456” and “Part G456HGT”


to “456”

“198.168.13.234” to “13”

7.3.18 Name Split


Function Class: Transform
Function Subclass: String

398 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Description: Splits a contact name into separate fields.

The data may have a single column with the


contact name. This could be data like:

Mr John Smith PhD

Mr John Harry Smith

Dr Smith

Jane Van Percie

The Name Split transform function will split


this into separate fields, working out if all
fields are not present where to place the data.

You are required to specify how many names


exist in the data and what the precedence is
if not all are present. The default assumes
that:
• The First (or Given), Second (or Middle)
and Last (or Family) name are potentially
all present
• If only one name is present this will be
the Family name
• If two names are present they will be the
Given and Family names.

Lastly indicate what additional fields are


present:
• Title, for example Mr. Mrs, Miss...
• Post Nominal letters, for example Dr,
PhD, JP...

The allowed Titles and Post Nominal Letters


can be edited from the tools menu. Please see
the Names Definition Editor. The list of
allowed values is used for example to
identify the string Mr as a Title and not a
Given name.
Map object:

EDCCM210200-UGD-EN-1 User Guide 399


Chapter 7 Reference

Properties:

400 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Examples: “Mr John Harry Smith” to Mr, John, Harry,


Smith, Null

“Dr Smith PhD” to Dr, Null, Null, Smith,


PhD

“Jane Van Percie” to Null, Jane, Null, Van


Percie, Null

7.3.19 Pad
Function Class: Transform
Function Subclass: String
Description: Left or right Pads a field
Map object:

Properties:

Examples: In the example above BC will be replaced


with the BCxxx.

EDCCM210200-UGD-EN-1 User Guide 401


Chapter 7 Reference

7.3.20 Prefix
Function Class: Transform
Function Subclass: String
Description: Prefixes a field with a literal string or dynamic data such as the date,
machine name and others
Map object:

Properties:

Examples: “34581424” to “GB34581424”

7.3.21 Proper Case


Function Class: Transform
Function Subclass: String
Description: Transforms a field to proper case with a
capital at the beginning of each word
Map object:

Properties: None
Examples: “The TITLE page” to “The Title Page”

402 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

7.3.22 Remove
Function Class: Transform
Function Subclass: String
Description: Removes characters from the data
Map object:

Properties:

Examples: “3458 1424” to “34581424”

“WA1 1DP” to “WA!!DP”

EDCCM210200-UGD-EN-1 User Guide 403


Chapter 7 Reference

7.3.23 Repeating Lookup


Function Class: Transform
Function Subclass: String

404 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Description: Takes as input a string of


values separated by a
delimiter and Finds the field
in a lookup tableor list for
each value inputted and
replaces the value with the
reference value. The
reference values are then
concatenated with each value
separated by a delimiter.

The comparison is case-


sensitive. If you want case-
insensitivity then you should
transform the reference and
source data columns to for
example upper case.
• Split value delimited by -
The delimiter character
used for separating
inputs. In the below
example, it is vertical bar
• Look up in function - The
function in which lookup
has to be performed. In
the below example, it is
Read Text File1
• Output Table - The name
of the output table of the
look up function in which
lookup has to be
performed. In the below
example, it is Records
Read
• Search in column - The
column in which the
inputs should be
searched.In the below
example, it is Column1
• Return value in column -
The column from which
the reference value
should be returned.In the
below example, it is
Column2
• Join together all values
with- The delimiter
character used to
concatenate reference
values. In the below
example, it is Hyphen

EDCCM210200-UGD-EN-1 User Guide 405


Chapter 7 Reference

Map object:

Properties:

Examples: The lookup table looks like

Column1: A, B, C, D, E, F

Column2: Argentina,
Belgium, China, Denmark,
Egypt, France

The input is given as C|D|E|


F

The output returned will be


China-Denmark-Egypt-
France

406 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

7.3.24 Replace
Function Class: Transform
Function Subclass: String
Description: Replaces a one or more characters from the
data with zero or more new characters.

Please note that while this function can be


used to remove characters (by replacing with
nothing) there is also a dedicated
Removewhich will remove all instances of a
number of characters in one pass. Remove
can be used for example to remove all
instances of hyphen and space even if they
are not adjacent to each other.
Map object:

Properties:

Examples: “3458-1424” to “3458 1424”

“WA1-1D-P” to “WA1 1D P”

EDCCM210200-UGD-EN-1 User Guide 407


Chapter 7 Reference

7.3.25 Right
Function Class: Transform
Function Subclass: String
Description: Passes through the right characters of a
string. This function can be used to retain the
a fixed number of characters or those from to
a character.

For the latter specify if the character itself


should be included.

The function can be tested from the


properties dialog box. If the Transform map
was in preview mode the data being
previewed will be available for testing. Also
new test data can be simply typed in and the
Test button pressed.
Map object:

Properties:

408 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Examples: “01306-77665” to “776655”

“020-7440-1234” to “7440-1234” and


“01306-77665” to “776655”

“PO Box 419” to “419”

7.3.26 Right Delete


Function Class: Transform
Function Subclass: String
Description: Deletes characters starting with from the
right and continuing either for a fixed
number of characters or up to another
character.

Click on the blue sections of the sentence to


change the numbers and stop characters.

Please also see Left Deleteand


Deletefunctions.
Map object:

EDCCM210200-UGD-EN-1 User Guide 409


Chapter 7 Reference

Properties:

410 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Examples: “66GG66” to “66GG”

“Fred John Smith” to “Fred”

7.3.27 Right Trim


Function Class: Transform
Function Subclass: String
Description: Removes any Space, Tab, Carriage Return or
Linefeed characters from the right end of the
data. This is normally applied to data of type
string.
Map object:

Properties:
Examples: “01306 77665” to “01306 77665”

EDCCM210200-UGD-EN-1 User Guide 411


Chapter 7 Reference

7.3.28 Sentence Case


Function Class: Transform
Function Subclass: String
Description: Transforms a field to sentence case where
only the first character of a sentence is upper
case
Map object:

Properties: None
Examples: “the quick brown FOX. This IS a set of
WORDS” to “The quick brown fox. This is a
set of words”

7.3.29 Sequence
Function Class: Transform
Function Subclass: Numeric
Description: Used to add a sequence column to the data.

Edit the schemato add a column, for example


called Sequence, and then connect the output
of the Sequence function to this column.

The default is to increment the sequence by


one for each row and to reset the sequence if
the map is executed again. You may choose
to change these settings.
Map object:

412 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

Properties:

7.3.30 Split
Function Class: Transform
Function Subclass: String
Description: Splits a field into more than one field. The
split is made where a character appears. A
common use is to split a name into
individual Title , FirstNameand LastName
fields.

You normally enter a single character as the


character used for the split. You can enter
more than one character and the split will
occur on any of the characters. You can
require the split character to be case sensitive
and limit the number of splits.

The limit in splits is useful for example in the


split described above to prevent a double
surname such as “Johnston Smith” splitting
into “Johnston” and “Smith”

EDCCM210200-UGD-EN-1 User Guide 413


Chapter 7 Reference

Map object:

Properties:

Examples: “Mr John Smith” using a delimiter of space


to “Mr” and “John” and “Smith”

“PO Box 419, Dorking, Surrey, RH4 1WZ”


using a delimiter of comma to “PO Box 419”
and “Dorking” and “Surrey” and “RH4
1WZ”

“Franco de Silva” will split using a delimiter


of space and a limit of 1 to “Franco” and “de
Silva”.

414 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

7.3.31 ToBoolean,ToDataTime......
Function Class: Transform
Function Subclass: General

EDCCM210200-UGD-EN-1 User Guide 415


Chapter 7 Reference

Description: Forces the data to a particular


type. Support is available for:
• Boolean
• DateTime
• Decimal
• Double
• Int16
• Int32
• Int64
• Single
• String

The ToString function will


allow control of the format,
for example defining how a
date should be shown - e.g.
dd-MMM-YYYY would show
a date in the format 01-
March-2008.

The specifiers are:

d
The day of the month:
1-31
dd
The day of the month:
01-31
ddd
The abbreviated day of
the week: Mon, Tues...
dddd
The full day of the week
h
The hour of the day: 1-12
hh
The hour of the day:
01-12
H
The hour of the day: 0-23
HH
The hour of the day:
00-23
m
The minute of the day:
0-59

416 OpenText ContentBridge EDCCM210200-UGD-EN-1


7.3. Reference to the Transform Functions

mm
The minute of the day:
00-59
M
The month of the year:
1-12
MM
The month of the year:
01-12
MMM
The abbreviated month
MMMM
The full month
s
The seconds: 0-59
ss
the seconds: 00-59
t
A or P
tt
AM or PM
YY
The year with 2 digits
YYYY
The year with 4 digits

Map object:

Properties: None
Examples: 12/12/2008 10:34 to:

Fri 12 December 2008 using


ddd d MMMM yyyy

12-12-08 using d-M-yy

12-12-08 10:34 using dd-MM-


yy hh:mm

EDCCM210200-UGD-EN-1 User Guide 417


Chapter 7 Reference

7.3.32 Trim
Function Class: Transform
Function Subclass: String
Description: Removes any Space, Tab, Carriage Return or
Linefeed characters from the both ends of the
data. This is normally applied to data of type
string.
Map object:

Properties:
Examples: “01306 77665” to “01306 77665”

7.3.33 Upper Case


Function Class: Transform
Function Subclass: String
Description: Transforms a field to all upper case
characters
Map object:

Properties: None
Examples: “ContentBridge” to “CONTENTBRIDGE”

“New England Patriots” to “NEW


ENGLAND PATRIOTS”

418 OpenText ContentBridge EDCCM210200-UGD-EN-1


Chapter 8

Notes on Databases

This page offers some notes on databases to help you understand some of facilities
provided as part of ContentBridge. You might also check on t et in general and on
the OpenText forum in particular.

Databases

Databases consist of Tables . Each table holds data and in general different tables are
used to hold different data. Tables consist of Columns and Rows . Each row
contains a record for example the details of one contact. The columns are the data
fields held in each row for example the Title, First Name and Last Name.

Each Column will hold data of a particular type such as a number or some text. The
data ed by ContentBridge are listed below:

String Normal text characters including letters,


numbers and special characters such as $,’,%
an ore. String data types have a maximum
length, this being th of characters allowed in
the field
Int16 A whole number from either -32768 to 32767
or 0 to 65
Int32 A whole number from either -8388608 to
8388607 or 0 to 16777215
Int64 A whole number from either
-9223372036854775808 to
9223372036854775807 or 0 to
18446744073709551615
Decimal A non-integer number. This data type is used
for currency
Single A number in the range -3.402823466E+38 to
-1.175494351E-38, 0, and 1.175494351E-38 to
3.402823466E+38.
Double A number in the range -1.7976931348623157E
+308 to -2.2250738585072014E-308, 0, and
2.2250738585072014E-308 to
1.7976931348623157E+308
DateTime Date and time such as 12/3/1956 12:34
Date Date only. Databases hold dates as
DateTime. ContentBridge allows validations
to be performed against a date only

EDCCM210200-UGD-EN-1 User Guide 419


Chapter 8 Notes on Databases

MySQLDateTime DateTime format supported by MySQL. This


is different from the DateTime format above
as it supports a zero date, 00-00-0000
Time Time only. Databases hold times as
DateTime. ContentBridge allows validations
to be made against the time segment only,
but the data will be displayed with a date as
well.
Boolean True or False
Byte This is for binary objects such as images and
be handled correctly by ContentBridge

Schema

The details of the columns and the data types of each column is called the schema.
ContentBridge will pickup the schema where it can by looking at the data or in the
example of a Microsoft Database by querying the database. ContentBridge will make
an attempt to guess the data type, but in some circumstances you may need to adjust
this. ContentBridge might for example mistakenly think a telephone number field is
an Int16 or Int32 when it really should be a string.

In most database tables one column is allocated to be the primary key. This will
normally be of type Int32 and unique for each row. This is the data that uniquely
identifies each row. It is normally not displayed to the user and is created
automatically by your application. If you can identify this primary key to
ContentBridge, it will help ContentBridge to better handle and manage the data.

When data is written to a database ContentBridge will look for a matching row
using the primary key. If one is found, only the changed data is adjusted using an
Update rather than anInsert and creating a new (duplicate) row.

If your data does not have a suitable primary key you can use the Transform
Sequence Functionto add number.

Null

So what is null? A data field can have data in but it can also be empty. This should
not be confused with a zero or a space, which is actual data, but means nothing.
ContentBridge allows you to check for nulls and if necessary exclude rows where an
important field is Null.

Data errors when writing to Access and other databases

Your destination database may have a rule that sets a field as mandatory, not allow
duplicate data or not allow Null. ContentBridge will not be aware of these internal
rules and you may see errors displayed in the Output panel indicating this type of
error . If you see such an error you can go pack to the map and add validation for
example remove rows with the Null.

420 OpenText ContentBridge EDCCM210200-UGD-EN-1


How does ContentBridge work with Microsoft Access autonumber columns?

ContentBridge will add data to an Access table that includes an autonumber


column. All you have to do is to ensure that you do not attempt to write data to this
column, but allow Access to take care of setting this filed as each row is added.

Do not forget to take a backup copy of your database before you start.

EDCCM210200-UGD-EN-1 User Guide 421


Chapter 9
Maintaining Abbreviations

The tools menu includes a item that allows the user to maintain the abbreviations
used by the AbbreviateTransform Function. This is called the Abbreviation Editor.

The editor shows all the abbreviations


currently available.

Add a new group by pressing the new icon


in the toolbar.

To delete a group highlight and press the


delete icon.

EDCCM210200-UGD-EN-1 User Guide 423


Chapter 9 Maintaining Abbreviations

Type the name of the new group and save

To enter a new abbreviation highlight the


group and press the new icon in the toolbar.

Enter the full word and the associated


abbreviation

You can add as many abbreviations and abbreviation groups as you require. You are
also at liberty to share your abbreviations with other ContentBridge users. Send
them to us and we will make them available to the community of ContentBridge
users. OpenText will publish more abbreviations from time to time.

The names definitions are stored in a reference file in a reference folder within the
ContentBridge folder. The location of all reference files can be changed to support a
shared reference file on the network. You may want to locate the reference files on a
network location that is saved to a tape backup. Please see the Folders tab in the
Optionsdialog box.

424 OpenText ContentBridge EDCCM210200-UGD-EN-1


Chapter 10
Importing Maps From Previous Versions

Reverting to Trial mode


Validate Script functions

Functions in the Trial mode are restricted to only execute 50 rows. To change a
function out of trial mode highlight the function and either use the right-click
context menu or the Functions menu.

EDCCM210200-UGD-EN-1 User Guide 425


Chapter 10 Importing Maps From Previous Versions

Lookup functions need to be deleted and re-entered and some other Validate and
Transform functions may need to be re-entered as well.

426 OpenText ContentBridge EDCCM210200-UGD-EN-1


Chapter 11
Names Definition Editor

The tools menu includes a item that allows the user to maintain the definitions of
names used by the Name SplitTransform Function. This is called the Names
Definition Editor.

The editor shows all the names data.

There are three groups:


• Titles
• Family Names such as Van, De La, La Du
and others.
• Post Nominal Letters

EDCCM210200-UGD-EN-1 User Guide 427


Chapter 11 Names Definition Editor

To add a new definition press the New icon


on the toolbar.

To edit highlight an entry and press the icon


toolbar button.

Entries can also be deleted.

You can add as many Names, Tittles and Letters as you require. You are also at
liberty to share your abbreviations with other ContentBridge users. Send them to us
and we will make them available to the community of ContentBridge users.
OpenText will publish more name definitions from time to time.

The names definitions are stored in a reference file in a reference folder within the
ContentBridge folder. The location of all reference files can be changed to support a
shared reference file on the network. You may want to locate the reference files on a
network location that is saved to a tape backup. Please see the Folders tab in the
Optionsdialog box.

428 OpenText ContentBridge EDCCM210200-UGD-EN-1


Chapter 12
Building the Map and the Data Schema

The ContentBridge map allows data you have read in to be linked to validate and
transform functions before writing out to a file or database. As you do this the
schema is adjusted to help you transform the data to match the target. If you can not
see any inputs or outputs you may have changed the schema by changing the map
links. To reset this press the reset button on the toolbar. There are two cases you
should be aware of:

Destinations that support a schema

If your map ends in a database such as Microsoft Access that supports a schema,
ContentBridge will pickup this schema and present it in the Transform function.
ContentBridge will make an attempt to map the data to that schema as shown
below, but you will need to adjust and complete the job of mapping. You may also
need to adjust the data to help, for example splitting or concatenating fields.

Destinations that do not support a schema

EDCCM210200-UGD-EN-1 User Guide 429


Chapter 12 Building the Map and the Data Schema

Where the output object has no schema, for example when writing to a comma
separated file, ContentBridge will copy the input schema to the output. You can
adjust this schema, renaming, changing the data type, removing columns and
adding columns.

What happens when I change the Map?

If you make changes to the map, for example, changing the output from a text file to
a Microsoft Access database the schema will need to be reset. This will impose the
new output schema to match the destination. Any transformation functions you
have put onto the Transformation map will be lost. You can at any time reset the
transformation by pressing the Reset button on the toolbar.

Do not forget that to carry out this adjustment of the schema ContentBridge must be
able to see the data. If the Input or Output toolbars are empty close the transform
and make sure data has flowed through ContentBridge by executing all (F5).

430 OpenText ContentBridge EDCCM210200-UGD-EN-1


Chapter 13
Writing .NET Script

This object can be used to build a wide range functions that you may require to
manipulate your data. Examples are:

• Processing complex data files that have records on multiple lines.


• Processing files with variable data held within a row.
• Data requiring complex processing.

Scripts can be built in C# or VB.NET and may refer to external assemblies.

Highlight .NET Script from the Functions toolbar and drag and drop it on the grid.
The following object will appear:

Click the title bar to display the properties wizard. The four stages of the wizard
allow:

• Selection of the scripting language and specifying assemblies referenced.


• Creation of the C# of VB.NET source code.
• Compiling the source code.
• Setting the entry point for execution.

EDCCM210200-UGD-EN-1 User Guide 431


Chapter 13 Writing .NET Script

Click to enlarge Click to enlarge

Click to enlarge Click to enlarge

13.1 Compilation Settings

432 OpenText ContentBridge EDCCM210200-UGD-EN-1


13.1. Compilation Settings

There are a number of sections to the first part of the wizard:

Language

Select the language you wish to use. Source written in C# and VB are supported.

You can choose to suppress compilation warnings.

Reference Assemblies

Specify the assemblies referenced by your code. Either enter the dll name if located
as part of the Microsoft .NET Framework or point to a file. Two assemblies are
included by default.

Source Code

You can either embed the source in the object or refer to a external files. Use the
buttons to add and remove external files.

Return to the overview of .NET Script.

EDCCM210200-UGD-EN-1 User Guide 433


Chapter 13 Writing .NET Script

13.2 Source Code

An outline script is provided into which you can add code as required. Please note
that the wizard can be re-sized with the mouse or by double clicking on the title bar.

Return to the overview of .NET Script.

13.3 Compilation Result

434 OpenText ContentBridge EDCCM210200-UGD-EN-1


13.4. Execution

Compilation errors and warnings are listed. You cannot move forward to the next
stage of the wizard should there be an error.

Return to the overview of .NET Script.

13.4 Execution

EDCCM210200-UGD-EN-1 User Guide 435


Chapter 13 Writing .NET Script

Lastly specify the entry point within your code.

Settings can be provided at this stage. A code segment such as that shown below can
define a setting. This is then provided in the last stage of the wizard.

/// <summary> /// The Settings class is used to hold configuration settings /// that
determine how the script is to execute. /// Allowed values are Multiply, Add, Minus
and Divide /// </summary> public class Settings {

private string _operation = “Add”;

public string operation {

get { return _operation; } set { _operation = value; }

You can request sample scripts by contacting


ContentBridgeInfo@opentext.com?subject=Content%20Bridge%20Info.

Return to the overview of .NET Script.

436 OpenText ContentBridge EDCCM210200-UGD-EN-1


Chapter 14
Substituting settings when a map executes

Any element in a map can be substituted when the map runs using a dbc file. This
can be useful if you need to copy a map from a development machine to production
machine and need to for example adjust the location of input data as you move the
map.

You could edit the map before copying, but the dbc file allows the value to be
substituted as required.

For example to change the source file in a Map called Data_Import.dbm create a
Data_Import.dbc file placed in the same location. Place the following in this file:

<Configuration>
<Function guid=""
name="Read Text
File1">
<Filename>F:
\Data\List2.
csv</Filename>
</Function>
</Configuration>

The map may point to a test file, but when executed with the dbc file the filename is
substituted to F:\Data\List2.csv.

A function can be selected by using the GUID or the name. Edit a map (dbm file)
with notepad to see the guids and elements names.

EDCCM210200-UGD-EN-1 User Guide 437


Chapter 15
Content Bridge InfoArchive (IA) App Creator

15.1 Introduction
The InfoArchive (IA) App creator is an add-on module for the Content Bridge
Solution (CB). It is a standalone application designed to guide the user in creating an
IA application.

15.2 Prerequisites
Set your Info Archive Client ID and Client Secret in the
CBInfoArchiveAppCreator.exe.config file listed in the installation path. Those
values are configured in the corresponding client section of the application-
CLIENTS.yml file located in the IA Server (IA Root Folder/config/webapp) Place the
following code under the configurations >appsettings tag in the
CBInfoArchiveAppCreator.exe.config file.
<appSettings>
<add key="InfoArchive_ClientID" value="Your Client ID" />
<add key="InfoArchive_ClientSecret" value="Your Client Secret" />
</appSettings>

15.3 Run the IA App Creator


To launch the program from the Windows Start menu, click Start >All Programs >
OpenText Content Bridge > CB InfoArchiveAppCreator.

You can also browse to the executable CB InfoArchiveAppCreator.exefrom the


path : %ProgramFiles%\OpenText Corporation\Content Bridge.

15.4 Configuring IA URL’s and REST Endpoints


You must configure the IA URI and REST Server Endpoints before creating an IA
App.

1. Click on IA Server Settings on the Login page.

2. Enter the Connection Name, IA URL, and the Rest URL.


InfoArchive example URL: http://localhost:8080/oauth/token
3. Click Save & Exit.

EDCCM210200-UGD-EN-1 User Guide 439


Chapter 15 Content Bridge InfoArchive (IA) App Creator

15.5 Creating the IA Application


To create a new IA Application:

1. Choose the desired IA server from the drop-down menu and enter your login
credentials
2. Provide a name for your application in the Application Name field.
3. Choose an Application Type and Archive Type from their respective drop-
down menus and click Next.
4. Select the Federation from the available list or click the Create New Federation
checkbox to create a new federation by providing a Federation name, Bootstrap
URL , and a password. Click Next.
5. Select the Storage from the available list or click the Create New Storage
checkbox to create a Storage by providing the Storage name, Storage
Description and the Storage Path. Click Next.
6. Select the Database from the available list or click the Create New Database
checkbox to create a new database by providing a Database Name and a
Database Password. Click Next.
7. Create an Application Space by providing a new name for the space and filling
in the following details:

• Space Name
• Structured Data Database
• Structured Data Database Library
• Search Result Database
• Search Result Database Library

Click Next.
8. Create an Application Store by providing a Store Name and choosing a status
from the following options:

• Online
• Read Only
• Offline

Click Next.
9. Configure the Xdb Library Policy by entering the following details:

• XDB Library Policy Name


• Aip Quota
• Aiu Quota

440 OpenText ContentBridge EDCCM210200-UGD-EN-1


15.5. Creating the IA Application

• Close Mode
• Close Period

Click Next.

10. Create a new Ingest Node by providing the following details:

• Log Level
• Enumeration Cutoff Days
• Enumeration Max Result Count
• Enumeration Minus Running

Click Next.

11. Creating PDI Schema: To configure the PDI Schema, you can Create a new
schema or choose to upload an existing PDI schema.
If you choose to create a new schema, enter the Schema URN, and the name of
the Main node and click Create.
This creates the new schema and displays it as a tree view on the right.
Adding Nodes:
Add nodes by entering the Node Name, and choose Node Type. Click Add
Node.
To add child nodes, select Parent Node from the tree view , and enter the Node
Name, and choose a Node Type. Click Add Node.

Note: You can also select the nodes from the Tree View and use the Edit
or Remove buttons at the bottom to rename or delete nodes. Click Save
after making any changes.

12. Configuring the PDI XML:


You can create a new PDI XML or choose to upload an existing PDI XML.
If you choose to create a new PDI XML, select the Nodes to be used as index
and pKeys. Click Next.

13. You can create a new Ingest XML or choose to upload an existing Ingest XML
by providing the Ingest XML name and the XML location.
Click Next.

14. Retention:
Configure the Retention field by providing the following details:

• Retention Name
• Description
• Aging Period (Unit and Value)

EDCCM210200-UGD-EN-1 User Guide 441


Chapter 15 Content Bridge InfoArchive (IA) App Creator

• Disposition Blocked

Click Finish.

The creation of the IA application is now complete. A confirmation screen displays


the successful app creation with the location of the created PDI schema.

442 OpenText ContentBridge EDCCM210200-UGD-EN-1


Chapter 16
Troubleshooting

Following Table provides resolution/workarounds for typical issues

My Transform output toolbar is empty Close the transform and ensure the map has
executed so that data is presented through
the map. Press F5 to execute all
I have lost some transform functions If you have changed the map for example
changing the output from a text file to an
Access database the schema is automatically
adjusted to reflect the new destination. As
ContentBridge resets the transform any
functions will unfortunately be lost
Times that I have read in have dates added Times are actually stored as DateTime fields
so that 12:34 becomes for example 5/2/2005 in Databases. Where a time is read in the
12:34 date is set to today. You can continue to run
validation tests against the time part only,
but the display of data will continue to show
the date.
When text files are read in ContentBridge ContentBridge will look at the first 50 rows
assumes all data types are text of a file to try and guess what the delimiter is
and what data type should be applied to
each column. If there is for example an
invalid date in the first 50 rows
ContentBridge will set the data type of that
column to string.

Do not forget to tell ContentBridge is the first


row contains the column names. If you forget
to do this first row is read as data and will
prevent for example a date or numeric
column being set as such.
I have maximized the Transform dialog box Double click the title bar to restore.
and it is stuck maximized
I have maximized the Validate dialog box Double click the title bar to restore.
and it is stuck maximized
Records with null data are passed by If you wish to ensure that null data (no data
validate functions at all) is passed then also add a Not Null
function to the Validate map. Input data can
be linked to more than one validate function
When I connect to an ODBC driver through Microsoft does not support the OLE DB
OLE DB I get an error provider for ODBC from .NET applications
such as ContentBridge . Please ensure you
use the ContentBridge ODBC specific
connector.

EDCCM210200-UGD-EN-1 User Guide 443


Chapter 16 Troubleshooting

I get no data written to my output Please check that the function is not set to
manual execution (a red square in the bottom
right corner)
I do not have any Oracle objects Oracle objects will only appear if you have
the Oracle client component (ODAC)
installed on your machine
ContentBridge locks up or becomes Are you working with large data sets? As
unresponsive ContentBridge displays the data to help you
see the data migration, large data sets can
use up a large amount of memory and bring
your machine to its knees.

To help, ContentBridge includes a batch


mode. This will process the data in batches
so as to avoid using large amounts of
resources. Please read more...

You should also use Trial modewhen


initially building your map. This restricts an
object to just 50 rows. Start with the main
object reading in your data in Trail mode.
When the map is built change this object out
of Trial mode and put it in Batch mode.

Lastly change the ContentBridge Options to


turn off Auto-Sizefor the data grids.
Microsoft.Jet.OLEDB.4.0' provider is not Download and install the Microsoft Access
registered on the local machine Database Engine 2010 Redistributable.
Google will help you find this.

444 OpenText ContentBridge EDCCM210200-UGD-EN-1


Cannot support 1. Close ContentBridge and terminate any
TLS_DH_anon_WITH_AES_256_CBC_SHA DFCManager (32-bit) processes running.
with currently installed providers while
using CS with certificates with JDK 1.8 2. Verify that Java unlimited security
libraries are present under a folder named
Unlimitedunder <cb_java_location>/jre/lib/
security/policy. If not, click here (https://
www.oracle.com/technetwork/java/javase/
downloads/jce8-download-2133166.html) to
download them.

3. Make the following changes to


java.security in the folder <cb_java_location>/
jre/lib/security:

a.Comment the following line as per JIRA


DFC-14968

jdk.tls.disabledAlgorithms=SSLv3, RC4,
MD5withRSA, DH keySize < 768, \ EC
keySize < 224

b.Uncomment the following line if


commented:

#crypto.policy=unlimited

4. Start ContentBridge
Load JVM DLL Failed on LoadLibraryfor 1. Verify that VC++ Runtime 2010 32 bit and
Documentum Addins 64 bit are installed (For newer OS these are
not installed by default) . If not, download
and install the runtime from Microsoft site.

2. Verify that the Java configured for DFC.dll


is Java 1.8 32 Bit (preferable JDK 1.8 Update
152). The java location will be found at
registry entry : HKLM\SOFTWARE
\WOW6432Node\Documentum
\Components\DJCB\JavaVM
ActiveX Component errors for Documentum 1. The root cause for this is that DFC.dll is
Addin not registered properly

2. Open the command prompt as


Administrator and navigate to the location
where DFC.dll is located. Default location
will by <DFC Runtime folder>\Shared.

3. Execute command regsvr32 dfc.dll and


wait for a success message before you restart
ContentBridge.

EDCCM210200-UGD-EN-1 User Guide 445


Chapter 16 Troubleshooting

Could not load file or assembly The prerequisite for ChilkatDotNet4.dll are
'ChilkatDotNet4.dll’ Microsoft Visual C++ 2010 x64 and x86
redistributable. Verify that it they are
installed. If not, download and install the
runtime from the Microsoft site.
Info archive Connection issue with IA 21.2 - Set your Info Archive Client ID and Client
(401) Unauthorized Error Secret in the ContentBridge.MapEditor.
exe.config file listed in the installation
path.
<appSettings>
<add key="InfoArchive_ClientID"
value="Your Client ID" />
<add key="InfoArchive_ClientSecret"
value="Your Client Secret" />
</appSettings>

InfoArchive app Creator - 401 Unauthorized Set your Info Archive Client ID and Client
error with IA 21.2 Secret in the CBInfoArchiveAppCreator.
exe.config file listed in the installation
path.
<appSettings>
<add key="InfoArchive_ClientID"
value="Your Client ID" />
<add key="InfoArchive_ClientSecret"
value="Your Client Secret" />
</appSettings>

16.1 Microsoft Office 32 Bit Support


Solution for 32 bit office and ACE database engine 64 bit incompatibility:

1. Make sure that you have 32 bit Office 2010 installed on the CB test machine.
2. Open registry editor (regedit.exe) and browse to HKEY_LOCAL_MACHINE
\SOFTWARE\Microsoft\Office\14.0\Common\FilesPathskey
3. Check if you have mso.DLL value in the contents pane on the right hand side.
Most probably you will not if you have not installed ACE 12.0 component (either
32 bit or 64 bit)
4. Install the ACE database engine 12.0 64-Bitcomponent using the
AccessDatabaseEngine_x64.exethat we ship with our CB installer under
<install_location>\OpenText Corporation\OpenText Content Bridge\PreReqs
folder.

1. Make sure that you run this installer from command line using the /passive
switch e.g. Launch command window and run following command at the
command prompt AccessDatabaseEngine XXX_x64.exe /passive

1. Open registry editor (regedit.exe) and browse to HKEY_LOCAL_MACHINE


\SOFTWARE\Microsoft\Office\14.0\Common\FilesPathskey
2. You should see mso.DLL value added to this key in the contents pane on right
hand side.

446 OpenText ContentBridge EDCCM210200-UGD-EN-1


16.2. Obtaining Technical Support

3. Rename it to something like say MSO.DLL.NOTRequired, Don't change the


path c:\Programfiles.... Change the key name itself to mso.dll.NotRequired
4. Run ContentBridge and try to read data from XL spreadhsheet and an Access
database ReadExcel and ReadAccess addins.
5. Close ContentBridge and try opening a Spreadsheet and a database directly
from Excel and Access applications respectively. Excel or access should not go
into Reconfigure mode at startup.
6. Open ContentBridge and make sure you can still read data from Excel
spreadsheet and access database using ReadExcel and ReadAccess addins.

Note: If Office 32 has been re-configured/re-installed/upgraded, please follow the


above process again to work with the office addins

16.2 Obtaining Technical Support


Support queries can be logged using the opentext suport site http://
support.opentext.com

Please include a clear description of the problem, including all the symptoms and
the steps required to reproduce the problem if necessary. If you are a registered user,
please include your registered name and license key at the top of the message in
order to receive priority attention. Please include the following information:

• Operating System (version of Windows and any service packs applied)


• Version of ContentBridge
• Where applicable the Source database or data file
• Where applicable the Target database or data file
• A sample of the data may be requested. Where this is supplied, please ensure
that data files are as small as possible. You may consider usingContentBridge to
extract the relevant part of the data.

EDCCM210200-UGD-EN-1 User Guide 447


Chapter 17
Dashboard Integration

This section describes the Dashboard Integration mechanism for the ContentBridge
application.

The pre-requisite for Dashboard data collection with ContentBridge are the
following

• Configure the Dashboard from the Options dialog


• Enable the Dashboard posting in Map Properties for the map

Once the configuration is complete and map is saved, the map execution data will be
posted to the Dashboard server.

Dashboard portal consists of a web based user interface backed by a database that
stores execution data posted by any running CB instance.

The dashboard is designed to provide current status of all active servers and the CB
maps running on all those servers. It can be used a monitoring tool in multi-server
CB implementation or if you are running multiple instances of CB on any given
server.

The Dashboard also supports producing bar charts with various parameters, e.g.,
Average throughput per map or per server, Average time required for execution of
any given CB map or for comparing performance of function included in the
selected CB map.

ContentBridge application can be configured to post data against a specific instance


of a dashboard portal, in case there are multiple Dashboard instances are deployed
in the organization. ContentBridge Options dialog allows users to configure the URL
for the dashboard instance where the data should be posted

The options dialog also allows users to configure the frequency, in number of rows,
for posting data to the dashboard. e.g. if the update frequency is set to 500 in the CB
options dialog, CB application will attempt to post an update to the dashboard after
processing a batch of 500 rows through each of the function. The update includes
number of rows processed, the number of successful rows and failed rows.

ContentBridge maps can be executed in following three different modes. Following


section describes how the data is posted to the dashboard when executing the map
in the different execution modes supported by the application.

• Executing Entire Map


• Executing Single Step/Function at a time

EDCCM210200-UGD-EN-1 User Guide 449


Chapter 17 Dashboard Integration

• Executing Single Step/Function with Cascading Option

17.1 Executing Entire Map


In production environment, it is recommended to run entire map at once, with or
without batch mode, to get the best results in terms of performance as well as
posting execution data to dashboard. When the entire map is executed, CB
application can properly detect the start and end of the map execution and post the
appropriate data to the dashboard at every step of the way. This will result in
providing most accurate statistics regarding the current map execution on the
dashboard portal.

Each execution of the map will be tagged with a dynamically generated instance ID
to keep independent records of each execution cycle in case if the same CB map is
executed multiple times from the same CB instance.

Known Issues:

1. If any function in the map is set to Prompt Execute or Pause Mode and the user
chooses not to execute that function when executing the map, ContentBridge
will not execute the functions following the paused function. This could create
incomplete data entries in the dashboard database, especially when running a
map in batch mode.
2. When executing the same map multiple times from the same ContentBridge
session, some of the functions are executed only during the first execution and
NOT executed during the subsequent executions. Typical example of this is the
Custom Table used as DataDictionary configurations or other lookup functions.
Obviously, in this scenario the execution data regarding the functions that are
not executed will not be posted to the dashboard.
3. If the Map execution is halted by pressing the STOP button from the tool bar,
end of map execution will be posted to the dashboard. If the same map is
executed again from the currently active CB session, it will be tagged with the
new Instance Id value and the data for the functions/steps executed in current
cycle will posted to the dashboard using the new Instance ID. Map execution
End will not be posted to the dashboard until ALL the functions in the map are
executed..

450 OpenText ContentBridge EDCCM210200-UGD-EN-1


17.2. Executing Single Step/Function at a time

17.2 Executing Single Step/Function at a time


When executing single function at a time, CB will check if this is the first ever
function being executed for this map or not. If it is the first function being executed,
it will post the start of the map execution first so that the subsequent functions
executed from the same CB session will be tagged with the same instance ID.

When the user executes the last function in the map, CB will detect the completion of
the map execution and post end of Map execution.

If the user decides to close the map or save the map after executing subset of
functions, the end map execution will be posted to the dashboard. so it is
recommended to execute ALL functions in the map one by one to properly post the
execution data to the dashboard.

Known Issues:

1. Map execution End will not be posted to the dashboard until ALL the functions
in the map are executed.

2. Executing same function over and over within same CB session will overwrite
the data posted to dashboard from the earlier executions of the same function.

17.3 Executing Single Step/Function with Cascading


Option
Executing a particular function/step in the CB map using Execute Cascading option
executes the selected function followed by all the downstream functions connected
to the selected function. Execution data from all the downstream functions will also
be posted to the dashboard as CB execution framework continues to execute
downstream functions.

If the collection of connected (cascading functions) contains the last function in the
map then after executing the last function end of map will be posted to the
dashboard.

If the cascading set of functions does not complete the map execution then the end of
map will be posted when the map is closed or the user decides to save the map. So it
is recommended to execute the remaining functions in the map to properly post the
execution data to the dashboard.

Known Issues:

1. Map execution End will not be posted to the dashboard until ALL the functions
in the map are executed.

2. Executing same function over and over within same CB session will overwrite
the data posted to dashboard from the earlier executions of the same function.

EDCCM210200-UGD-EN-1 User Guide 451


Chapter 18
Uninstalling ContentBridge

ContentBridge can be quickly uninstalled by following the instructions below:

• Open the Control Panel


• Double click on the Add or Remove Programs icon
• Highlight theContentBridge entry
• Press the Remove button
• Follow the instructions on screen

Following your evaluation should you decide not to proceed with the use of
ContentBridge we would be most grateful if you would email us at
ContentBridgeInfo@opentext.com?subject=Content%20Bridge%20Info indicating the
reasons for your decision.

EDCCM210200-UGD-EN-1 User Guide 453


Chapter 19
Appendix A-Supported Databases

Data connectivity shipped with ContentBridge:

Database or Data File Version


Microsoft Access Access 2010 or higher*
Comma Delimited Files
Other character delimited files
Fixed format files
Microsoft Excel 2010 or higher*
MySQL
Microsoft SQL Server
Oracle
ODBC databases
OLE DB databases
XML files

* You will need to install the Microsoft Office Data Connectivity Components
(Microsoft ACE drivers) using installer package provided under prerequisites folder
inside ContentBridge install directory.

Please contact ContentBridgeInfo@OpenText.comto check if any additional Data


connectivity adapters are available for download.

EDCCM210200-UGD-EN-1 User Guide 455

You might also like