IBM Directory Integrator 4.7: Reference Guide

Transcription

1 IBM Directory Integrator 4.7: Reference Guide

2

3 IBM Directory Integrator 4.7: Reference Guide

4 Note Before using this information and the product it supports, read the general information under Appendix C, Notices on page 189. First Edition (August 2002) This edition applies to ersion 4, release 7, of The IBM Directory Integrator and to all subsequent releases and modifications until otherwise indicated in new editions. Copyright International Business Machines Corporation All rights resered. US Goernment Users Restricted Rights Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

5 Contents Preface ii Chapter 1. Introduction General concepts Program components and interface Admin tool IBM Directory Integrator serer IBM Directory Integrator components IBM Directory Integrator API Script objects Chapter 2. Getting Started Guide Chapter 3. Supported platforms and known issues Chapter 4. IBM Directory Integrator concepts The AssemblyLine Starting an AssemblyLine Starting from the Admin tool Accessing connectors inside the AssemblyLine.. 9 Connectors How do Connectors share data? Iterator mode Multiple Iterators in an AssemblyLine Using the Iterator mode Lookup mode AddOnly mode Update mode Delete mode Passie mode Link criteria EentHandler Starting the EentHandler The Eent object Configuration and data flow Prolog Actions Attribute/property names Epilog Scripting When is scripting needed? Integrating scripting into the AssemblyLine?.. 17 How will scripting affect execution? Control points for scripting Comparing JaaScript strings Accessing your own Jaa classes Scripting in JaaScript Scripting in languages without new jaa.* Using binary alues in scripting Using date alues in scripting Using floating point alues in scripting Hooks Enabling/disabling Hooks Oerride Hooks Failure Hooks Hooks called on other eents List of Hooks Deltas and compute changes Deltas Inheritance Attribute Mapping Null Value Behaior Conn object Tasks How to control the number of threads The configuration file Externalizing fields like username and password 33 Export, import and include IBM Directory Integrator Secure Sockets Layer Support Securing the connection between IBM Directory Integrator and serers with SSL (IBM Directory Integrator as a client) Securing the connection between client and IBM Directory Integrator with SSL (IBM Directory Integrator as a serer) Replacing security from IBM JCE and JSSE to another ender Chapter 5. IBM Directory Integrator installation instructions Installing on Windows platforms Installing on Unix platforms Uninstalling on Windows platforms Uninstalling on Unix platforms Chapter 6. Connectors Connector aailability and reference Raw Connectors Script-based Connectors Configurations ADSI Connector Preconditions Btree Connector Configuration Btree object Downloads Command line Connector Configuration Downloads Direct TCP /URL scripting TCP URL EMI/UCP Connector Configuration Downloads See also Copyright IBM Corp iii

6 File system Connector Configuration See also FTP Connector Configuration Note See also GSM Phone Connector Configuration Downloads HTTP Client Connector Modes Special attributes Configuration Samples Lookup Mode Downloads See also HTTP Client Connector Version Changes from earlier ersions Modes Special attributes Configuration Samples Lookup Mode See also HTTP Serer Connector Configuration Downloads See also HTTP Serer Connector Version Configuration See also JDBC Connector Configuration Other Notes See also ODBC specifying database paths directly JMS Connector Configuration Specific topics JNDI Connector Configuration Downloads See also LDAP Connector Configuration Notes Handling memory problems in the LDAP Connector Duplicating a whole directory from a serer to another IBM Directory Changelog Connector Lotus Notes Connector Configuration Downloads Ports Security Mailbox Connector Configuration Predefined Properties/Attributes See also Memory Stream Connector Configuration NT4 Connector Preconditions Character sets NT4 Connector functional specifications and software requirements Functionality Business Objects Use cases Hardware and software configuration Oracle8 JDBC Drier Configuration Note See also (runtime proided) Connector Configuration Downloads See also Script Connector Predefined script objects Functions Configuration Note See also SMPP Connector Configuration Downloads See also SNMP Connector Configuration Notes TCP Connector Iterator Mode AddOnly Mode Configuration See also URL Connector Configuration Downloads See also Chapter 7. EentHandlers EentHandler types When are they started? What do they do? EentHandlers Listeners: simple EentHandlers Connector EentHandler Configuration Objects/properties/attributes Downloads See also HTTP EentHandler Example Configuration See also IBM SecureWay LDAPEentHandler Configuration i IBM Directory Integrator 4.7: Reference Guide

7 See also LDAP EentHandler Object Added (objadded) Object Rename (objrenamed) Object Modified (objmodified) Object Remoed (objremoed) Configuration Notes See also Mailbox EentHandler Configuration Objects/properties/attributes Downloads See also TCPEentHandler Configuration Objects/properties/attributes See also Port listener AdminPort (simple EentHandler) Generic thread (simple EentHandler) LDAP listener MailboxListener (simple EentHandler) TCPListener (simple EentHandler) Timer EentHandler Chapter 8. Script languages BeanShell Perl Perl example Script languages BSF-based script languages WSH-based script languages Chapter 9. Parsers Parser aailability and reference Base parsers Character set conersion Aailability CSV parser Configuration Notes DSML parser Configuration Example References See also CDS-EDB file parser Configuration Notes Fixed parser Configuration HTTP parser Configuration Attributes/properties See also LDIF parser See also LineReader Configuration Regular Expression parser Functional specification Source code Regular Expression parser source code Script parser Objects Functions Configuration Note See also Simple parser Configuration SOAP parser Sample Entry Sample SOAP Configuration Parser-specific calls XML parser Configuration Examples Notes References See also Chapter 10. Objects The AssemblyLine Connector object The Attribute object Methods Examples See also The Raw Connector object Methods The Entry object Methods Global Entry instances aailable in scripting See also The FTP object Methods Example Main object The Search criteria object Methods Operands Example The shellcommand object Methods The status object Methods The system object Methods The task object task AssemblyLine task EentHandler Chapter 11. Program interfaces AssemblyLine setting tab IBM Directory Integrator command line options 144 IBM Directory Integrator Admin tool IBM Directory Integrator serer Discoer schemas and browsing data Contents

8 Distribution components Other files on install directory Jar-files (jars/subdirectory) Jaa Naming and Directory Interface (JNDI) JaaMail API XML Libraries (Windows) libs/ subdirectory Other global.properties file JDBC Client Parameter labels on the Connector/parser tabs LDAP Client Preferences/system properties System/Jaa properties Using external properties Chapter 12. Samples VBScript Connector and MSOutlook connector Sample code See also JaaScript Connector Sample code See also JaaScript parser Sample code See also Writing a new Raw Connector Script-based Connector Jaa-based Connector Building and installing a Jaa-based Connector 157 system.parsedate (string alue, string format) Example Other examples Chapter 13. Logging and debugging 161 AssemblyLine Debugger Logging and debugging Dumping the content of an Entry object Dumping the content of an Attribute Dumping the state of a Connector Dumping arbitrary log messages Chapter 14. Optional tasks in IBM Directory Integrator Copying directories with the LDAP Connector Chapter 15. Optimizing IBM Directory Integrator Chapter 16. IBM Directory Integrator 4.7 Downloads and related material 169 Installation notes IBM Directory Integrator Download instructions Download New features GUI improements Bugs fixed since 4.6 beta Fixed issues Script libraries not aailable to Listeners JMS 1.13 can lose queue elements when Iterating JMS MQ Series does not support topics NT/ADSI Connector can clear passwords during update Connectors: Oerride Add hook defect in Update and AddOnly modes HTTP EentHandler using Auth Connector XML parser limitations Memory leak Running out of file handles If you use as part of the URL, the AssemblyLine will fail In certain situations, the Lotus Domino Connector (and possibly some others) do not run from the Admin Tool Installer fails for some systems Backward compatibility Known issues Delta on iterator Memory leak Chapter 17. Release Notes Appendix A. FAQ IBM Directory Integrator Questions Installation and licensing Writing AssemblyLines Security Error messages Limitations Third party software Answers Installation and licensing Writing AssemblyLines Security Error messages Limitations Third party software Appendix B. Dictionary of terms LDAP terms IBM Directory Integrator terms Appendix C. Notices Trademarks i IBM Directory Integrator 4.7: Reference Guide

9 Preface In order to work with examples complementing this manual, you must refer back to the installation package to download the necessary files. To access these example files, go to the %IBMDI_ROOT%/sample directory in the installation directories. Copyright IBM Corp ii

10 iii IBM Directory Integrator 4.7: Reference Guide

11 Chapter 1. Introduction General concepts The following are some of the general concepts that can be found in the IBM Directory Integrator documentation: The AssemblyLine on page 7 Connectors on page 9 Scripting on page 17 Hooks on page 23 Chapter 9, Parsers on page 111 EentHandler on page 15 Deltas and compute changes on page 28 Inheritance on page 30 Attribute Mapping on page 30 Tasks on page 32 The configuration file on page 33 Accessing your own Jaa classes on page 21 Chapter 13, Logging and debugging on page 161 Appendix B, Dictionary of terms on page 185 Program components and interface Admin tool Distribution components on page 145 IBM Directory Integrator command line options on page 144 Preferences/system properties on page 149 System/Jaa properties on page 149 AssemblyLine setting tab on page 143 Discoer schemas and browsing data on page 145 Parameter labels on the Connector/parser tabs. on page 148 JDBC Client on page 147 LDAP Client on page 148 IBM Directory Integrator serer IBM Directory Integrator command line options on page 144 IBM Directory Integrator components Chapter 7, EentHandlers on page 93 Connector aailability and reference on page 41 Parser aailability and reference on page 111 Copyright IBM Corp

12 IBM Directory Integrator API Script objects Full technical JaaDoc of all aailable internal jaa objects is found in the installation package. Script objects are aailable eerywhere inside the AssemblyLines (proided their context is alid). Some of the major objects are described below: The Attribute object on page 130 The AssemblyLine Connector object on page 129 The Raw Connector object on page 131 The Entry object on page 132 The FTP object on page 134 Main object on page 135 The shellcommand object on page 136 The status object on page 136 The system object on page 137 The task object on page 141 AssemblyLine Debugger on page IBM Directory Integrator 4.7: Reference Guide

13 Chapter 2. Getting Started Guide IBM Directory Integrator 4.7: Getting Started Guide is a brief tutorial and introduction to IBM Directory Integrator 4.7. You need Acrobat Reader to read the IBM Directory Integrator 4.7: Getting Started Guide as it is in PDF format. Copyright IBM Corp

14 4 IBM Directory Integrator 4.7: Reference Guide

15 Chapter 3. Supported platforms and known issues IBM Directory Integrator 4.7 ships with IBM JRE The following are the platforms supported for IBM Directory Integrator 4.7. A minimum of 128 MB RAM is required for each platform (256 MB is strongly recommended): Windows NT 4.0, Windows 2000 AIX 4.3.3, or later Solaris 7, or later HP-UX 11, or later Linux Intel RedHat 7.1 or later SuSE 7.2 or later Linux s/390 RedHat 7.1 or later SuSE 7.0 or later, kernel Copyright IBM Corp

16 6 IBM Directory Integrator 4.7: Reference Guide

17 Chapter 4. IBM Directory Integrator concepts The AssemblyLine The general philosophy of an AssemblyLine, is that it processes data (for example, entries, records, items, objects) from one data source, transform and aggregate it with data from others sources and finally output it to one or seeral targets. It is important to keep in mind that the AssemblyLine is designed and optimized for working with one item at a time. Howeer, if you would like to do multiple updates or multiple deletes (i.e. processing more than a single item at the time) then you must write AssemblyLine scripts to handle this same thing if you want to sort data. This kind of processing can be implemented using your choice of scripts, Jaa libraries and standard IBM Directory Integrator functionality (like pooling the data to a sorted datastore, for example, ODBC Connector) and then reading it back and processing it with a second AssemblyLine. The AssemblyLine consists of a number of Connectors that operate in specific modes. It is the AssemblyLine that does the work (it is in a way your program). For an oeriew of the AssemblyLine please read the Getting Started guide. In short the AssemblyLine consists of: EentHandler. (Optional) An EentHandler that decides when the AssemblyLine runs (could be when a file shows up on a directory or when a mail arries). Connectors. Two or more Connectors that are plugged into your data-source (file system, ldap, database, com-port etc.) At least one Connector proides input to the AssemblyLine, and at least one proides output. A rich Connector library is one of the strength of the IBM Directory Integrator, but you can of course write your own Connectors. The Connectors can be run in different modes like Iterator, Update, Delete etc. AssemblyLines can in fact hae fewer Connectors (this is for the adanced user). Parser. (sometimes) If the Connector deliers a bytestream (such as a url-connector or a file Connector), the Connector has a Parser associated with it. As for Connectors, you can write your own but a set of standard Parsers are aailable. A business body where data from the Connectors are subject to your business logic such as transformation, erification etc. If you leae the body (Prolog, Dataflow and Epilog in the IBM Directory Integrator Admin tool) empty, you hae probably implemented a filter translating from one format to another. This body is not physical, since the code is located in the Connectors. The exception being the Component, that just contains code. The workobject contains attributes that can be shared between Connectors. Mapping between the data source and the work Entry is described in detail under Attribute Mapping on page 30. The AssemblyLine is usually started by some external eent or by the user from the IBM Directory Integrator Admin tool. The AssemblyLine is defined by a file. This file defines a serer that is independent of the Admin Tool Graphical User Interface to run. Copyright IBM Corp

18 Starting an AssemblyLine The AssemblyLine flow starts with the execution of code placed in the Before Connectors Actiated subtab of the Prolog tab. This could be a good place to create a file one of the Connectors expects (typically the result of a preprocessed input file). You could also place code here which change connector specific parameters, such as filenames. Then Connectors are initialized. Each Connector s initialize function is called in this step. If the Connector operates in Iterator mode, then the Connector s selectentries function is also called. Then, when all Connectors are ready for action, the AssemblyLine s Prolog s After Connectors Actiated code is executed. The Connectors are then called in the sequence in which they appear in the configuration. Think of this as haing each of your data entries flowing down the AssemblyLine. If you hae more than one Connector in Iterator mode, these Connectors are stacked in the order in which they appear in the configuration. If you hae two iterators, a and b, then a is called until it returns no more entries before the AssemblyLine switches to b. If you hae no Connectors in Iterator mode, you must make sure there exists an Entry proided by a calling Handler or set in the Prolog. If no Working Entry exist, no Connectors are called. Controlling an AssemblyLine Hooks can be used to add extra code and logic within a Connector. If you want to skip or re-execute parts of the AssemblyLine entirely, you typically do this from within a Hook in a Connector: (system.ignoreentry) - Ignore the current Connector and continue processing your existing data entry with the next Connector. (system.skipentry) - Skip (drop) the entry completely and get the next entry (from the current iterator). (system.restartentry) - Re-execute the AssemblyLine without getting fresh entry data from the current Iterator. system.skipto(string name) - Skip to the named Connector. system.abortassemblyline(string reason) - Abort the entire AssemblyLine. Note that if you put any of these command in an Error Hook, the AssemblyLine continues regardless of how you got to the Error Hook. This means that een syntax errors in your script are ignored. Check the object if you want to know what caused the error. Also note that the methods aboe are implemented as exceptions: This means that no code following these calls are called. Starting from the Admin tool When you start an AssemblyLine from the admin tool you must hae at least one Connector operating in Iterator mode. If you don t hae an iterator the AssemblyLine has no data feeding it. You can hae multiple Connectors as iterators: The AssemblyLine starts with the first iterator and continue with the next after draining each iterator in the AssemblyLine. 8 IBM Directory Integrator 4.7: Reference Guide

19 Connectors Starting from an EentHandler or script When an AssemblyLine is started through startal by an EentHandler or from a script, the AssemblyLine may be passed parameters feeding it, e.g. an initial working entry (work). Passing an initial working entry causes the AssemblyLine to run through the list of Connectors once before terminating. You can inestigate the result (which is the working entry when the AssemblyLine terminates) by using the (getresult()) function. See also (runtime proided) Connector on page 86 Example: ar entry = system.newentry(); entry.setattribute ("cn", "My Name"); // Here we start the AssemblyLine itself ar al = main.startal ( "AssemblyLine", entry ); // wait for al to finish al.join(); ar result = al.getresult(); // assume al sets the mail attribute in its working entry task.logmsg ("Returned = " + result.getstring("mail")); Accessing connectors inside the AssemblyLine You may hae noticed that you can dynamically load Connectors in your scripts using the system.getconnector function. The Connector object you get from that is what we call the raw Connector object. Inside the assembly howeer, each Connector is embedded in a wrapper that proides additional functionality to the Connector. Each Connector is aailable in the AssemblyLine scripts as the name you chose for the Connector when it was added to the AssemblyLine. For example, the Sample1 AssemblyLine in the default configuration has two Connectors named input and output. Connectors are used to access and update information sources in a ariety of formats and protocols. There are basically two types of connectors. The first is where both transport and content is known to the connector using a well known API (like ODBC, LDAP). The second type is where the transport mechanism is known but not the content. The latter requires a Parser to interpret or generate the content in order to function properly. A list of all Connectors included with the IBM Directory Integrator is included (see Connector aailability and reference on page 41). But you can also write your own Connector (see Writing a new Raw Connector on page 156). Connectors operate in the following modes: Iterator, Lookup, AddOnly, Update, Delete and Passie. Each Connector mode determines a specific Connector s behaior. Note howeer, that it is not necessary that eery Connector support all of the modes aailable. When you use a Connector you should first consult its manual for the modes supported. How do Connectors share data? Connectors not in Iterator mode hae their data passed through the work object. If no work object exist because you hae no Iterator, the non-iterator Connectors are not called. You can create your own Working Entry in the Prolog by: Chapter 4. IBM Directory Integrator concepts 9

20 init_work = system.newentry(); // Create a new Entry object init_work.setattribute("uid", "cchateauieux"); // populate it task.setwork(init_work); // make it known as work to the Connectors Note that an initial work Entry in the Prolog can be regarded as fed from an inisible one pass Iterator. See Multiple Iterators in an AssemblyLine below for side effect this causes. Iterator mode Connectors in Iterator mode are used to scan a data source and extract its data. The Iterator Connector actually iterates through the data source entries, reads their attributes alues and deliers each Entry to the AssemblyLine and its non-iterator connectors. Note that it does not matter exactly what the data source is (database, LDAP directory, XML document, etc.) and how its data is actually stored. Each Connector presents an abstract layer oer the particular data source and you access and process data through instances of the Entry and Attribute classes. In fact, each AssemblyLine (except those called with an initial Entry, see How do Connectors share data? on page 9) should contain at least one Connector in Iterator mode. Iterators (if we call the Connectors in Iterator mode this way) supply the AssemblyLine with data. If an AssemblyLine has no Iterator it is useless because its Connectors are passed nothing to process. Iterators are always regarded as being first in the AssemblyLine. They are executed before other non-iterator Connectors, regardless of their place in the AssemblyLine. Multiple Iterators in an AssemblyLine If you hae more than one Connector in Iterator mode, these Connectors are stacked in the order in which they appear in the configuration and processed one at the time. An initial work Entry is treated as coming from an inisible Iterator processed before any other Iterators. Assume you hae an AssemblyLine with two Iterators, a preceding b. a is first used (the AssemblyLine ignoring b) until it returns no more entries. Then the AssemblyLine switches to b (ignoring a). An initial work Entry is treated like it came from an inisible Iterator before a and b: It would be processed (the AssemblyLine ignoring both a and b), before the AssemblyLine starts calling a. If you do not want an initial work Entry to be used in the AssemblyLine because it contains the wrong Attributes, and has been used for instance in the Prolog, you could call task.setwork(null) in the Prolog to remoe the initial work Entry, thus causing the first Iterator to be used to get the first work Entry. Using the Iterator mode The most common pattern for using a Connector in Iterator mode should be: 1. Add a Connector in Iterator mode to your AssemblyLine. 2. Choose the configure... link from IBM Directory Integrator Admin user interface. 3. Set alues for the Connector s parameters (usually specifying the data source to be used). 4. Go to the Attributes section (tab) of the Configure Connector dialog. 5. Click Connect to connect to the data source. 10 IBM Directory Integrator 4.7: Reference Guide

21 6. Click Query Schema (or Next if Query Schema is not supported) to retriee an Entry s Attributes. 7. In the Attribute Map Connector s section push the Select button and mark all Attributes you need in your integration process. These Attributes are retrieed from the data source and passed to the non-iterator Connectors in your AssemblyLine. Lookup mode Connectors in Lookup mode are used to retriee particular Entry s attributes from a data source by other most often key Entry s attributes (already retrieed from another data source or set by the Administrator). Lookup Connectors gie the possibility to join data from different data sources using the relations among the entities from these data sources. The main action in setting up and using a Lookup Connector is the configuration of its Link Criteria. It is always configured through the IBM Directory Integrator Admin user interface - each Lookup Connector has an associated Link Criteria tab. The tab defines the rule for finding releant entries. The Link Criteria rule itself is either a conjunction of simple conditions required for certain Entry s attributes or a more general Connector specific mini script. Note that the Link Criteria may identify more than one Entry (these Entries are called Duplicates).Lookup Connectors hae an option that allows/disallows Duplicates. You can control this option from the Allow Duplicates check-box. If Allow Duplicates is turned off (default state) and Duplicates appear then: if the Multiple Entries Found Hook is not enabled, the work Entry being processed is skipped (i.e. not passed to the other Connectors in the AssemblyLine) if the On Error Hook is not enabled. If the On Error Hook is enabled it should handle the situation. if the Multiple Entries Found Hook is enabled, the custom script placed there should handle the situation. If Allow Duplicates is turned on and Duplicates appear then automatically the first of the Duplicates is used. If no additional processing is performed in any of the Hooks aailable, the rest of the Duplicate Entries are ignored. Howeer they can be handled according to user-defined logic by scripting in the Lookup OK Hook. See On Success, page 27 for code example on this. Using the Lookup mode The most common pattern for using a Connector in Lookup mode should be: 1. Add a Connector in Lookup mode to your AssemblyLine. 2. Choose the configure... link from IBM Directory Integrator Admin user interface. 3. Set alues for Connector s parameters (usually specifying the data source to look up in). 4. Go to the Attributes section (tab) of the Configure Connector dialog. 5. Push the Connect button to connect to the data source. 6. Push the Query Schema button (or the Next button if Query Schema is not supported) to retriee Entry s Attribute. 7. In the Attribute Map Connector s section (tab) push the Select button and mark all Attributes you need in your integration process (these include the Attributes used for looking up). 8. In the (Link Criteria) tab of the Connector, add all criteria for looking up. Chapter 4. IBM Directory Integrator concepts 11

22 9. All new Attributes added from the Lookup Connector along with the Attributes added from preious Iterator and Lookup Connectors are aailable for the other Connectors in the AssemblyLine. AddOnly mode Connectors in AddOnly mode are used for adding new data in a data source. This Connector mode requires almost no configuration - just point out the attributes of the Entry and the data source parameters. The AddOnly Connector receies Entries (most often from an Iterator) and writes them in its data source. Using the AddOnly mode The most common and simple pattern for using a Connector in AddOnly mode should be: 1. Add a Connector in AddOnly mode to your AssemblyLine. 2. Choose the configure... link from IBM Directory Integrator Admin user interface. 3. Set alues for Connector s parameters (usually specifying the output data source to be used). 4. In the Connector s Attribute Map section, click Select and mark all working Attributes you need in your integration process. You can also create your own Attributes and calculate their alues through scripting. Entries with the Attributes you hae selected are added in the data source during AssemblyLine s execution. Update mode Connectors in Update mode are used for adding and modifying data in a data source. For each Entry passed from the AssemblyLine, the Update Connector tries to locate an Entry from the data source to modify with the Entry s attributes alues receied. The rule for finding the Entry for modification is configured in the Link Criteria section in the same format as in the Lookup mode. If no such Entry is found, a new Entry is added to the data source. If one such Entry is found, it is modified. If more than one entry matches the Link Criteria, the Multiple Entries Found Hook is called. Furthermore, each attribute can be tuned whether to be modified or added, when respectiely Modify or Add operation is performed. When doing a Modify operation, only those attributes that are marked as Modify, are changed in the data source. If the Entry passed from the AssemblyLine does not hae a alue for one attribute, the Null Value Behaior for that attribute becomes significant. If it is set to Delete, the attribute does not exist in the modifying entry, thus the attribute cannot be changed in the data source. If it is set to NULL, the attribute exists in the modifying entry, but with a null alue, which means that the attribute is deleted in the data source. An important feature that Update Connectors offer is the Compute Changes option. When turned on, the Connector first checks the new alues against the old ones and updates only if and where needed. Thus you can skip unnecessary updates which can be really aluable if the update operation is a heay one for the particular data source you are updating. Using the Update mode The most common and simple pattern for using a Connector in Update mode should be: 1. Add a Connector in Update mode to your AssemblyLine. 12 IBM Directory Integrator 4.7: Reference Guide

23 2. Choose the configure... link from IBM Directory Integrator Admin user interface. 3. Set alues for Connector s parameters (usually specifying the output data source to be used). 4. Go to the Attributes section (tab) of the Configure Connector dialog. 5. Push the Connect button to connect to the data source. 6. Push the Query Schema button (or the Next button if Query Schema is not supported) to retriee Entry s Attributes. 7. In the Attribute Map Connector s section push the Select button and mark all Attributes you need to update in your integration process. Through the Add and Modify check-boxes you can specify for each Attribute whether it should be modified or added when respectiely Modify or Add operation is performed. 8. In the Link Criteria tab of the Connector, add all criteria for fixing the Entry to be updated (or finding out that it is missing and has to be added). Entries Attributes you hae selected are updated in the data source during AssemblyLine s execution. Delete mode Connectors in Delete mode are used for deleting data from a data source. For each Entry passed from the AssemblyLine, the Delete Connector tries to locate an Entry from the data source. If one Entry is found, it is deleted, otherwise nothing happens. The rules for finding the Entry for deletion is configured in the Link Criteria section in the same format as in the Lookup mode. Using the Delete mode The most common and simple pattern for using a Connector in Delete mode should be: 1. Add a Connector in Delete mode to your AssemblyLine. 2. Choose the configure... link from IBM Directory Integrator Admin user interface. 3. Set alues for Connector s parameters (usually specifying the output data source to be used). 4. In the Link Criteria tab of the Connector, add all criteria for locating the Entry to be deleted. If exactly one Entry matches the Link Criteria, it is deleted. 5. The Attribute Map section is ignored for a Connector in Delete mode. Passie mode Connectors in Passie mode are not passed Entries during the AssemblyLine execution. They are configured by the Administrator and initialized by the AssemblyLine, but neer used in the standard AssemblyLine s execution process. They can be inoked by script code from any of the control points for scripting proided by IBM Directory Integrator (see Scripting on page 17). Using the Passie mode The most common and simple pattern for using a Connector in Passie mode should be: 1. Add a Connector in Passie mode anywhere in your AssemblyLine. 2. Set alues for the Connector s parameters (usually specifying the output data source to be used). The name of the Connector is used to refer to it from other Connectors. Chapter 4. IBM Directory Integrator concepts 13

24 3. Add scripting code to use the Connector, usually in Hooks in other Connectors (it could be in a Script Component or prolog/epilog as well). If you hae named the Passie Connector MyPassie and want it to add an entry with an error message, the code may look like this: ar err = system.newentry(); err.merge(work); err.setattribute ( "ERROR", "Failed to do something" ); MyPassie.connector.putEntry ( err ) ; 4. The methods aailable to the connector attribute of the Passie Connector, are documented in The Raw Connector object on page 131. The instructions aboe assume that you only want to use the Raw Connector and Parser components of the Passie mode Connector. If you also want to use the Attribute Mapping and Hooks that the Connector proides, you can do the following instead: 1. Add the Connector in the mode that matches the way you are going to use it. 2. Specify the Attribute Mapping and the Hooks you want. 3. Change the mode of the Connector to Passie. The attribute mapping is remembered. 4. You may now use the calls aailable to the Connector, e.g. MyPassie.lookup(myEntry). The parameter specified is treated as the work entry by the Passie Connector. 5. Note that the local work entry reference is set to myentry when you use the code just aboe, and you need to sae a reference to the original local work entry if you want to continue using it in your Hook or Script Component. The AssemblyLine work entry reference is not changed, only the reference in the current Hook or Script Component. Of course, if myentry really is the AssemblyLine work entry, it s content is changed as well. Link criteria The Link Criteria is used to let Update, Lookup and Delete Connectors know what record to access in the external data-source. The Link Criteria is accessible in the admin tool through a tab that you find in Update, Lookup and Delete Connectors. There are to ariants of Link Criteria: Simple and Adanced. Note that usually the Connector goes to the On Error Hook if more than one record match the link criteria. Simple link criteria In the simplest case it links a alue from the AssemblyLine with a alue from the Data-source. To be more precise it links the alue of an attribute in the work entry to a alue of an attribute in the raw Connector. As an example, imagine we hae a work entry with an attribute called Name. We want from a database the row of table Student where column ID is equal to work.name. Using Simple Link Criteria (default), the syntax would be: ID equal ($Name) As you will see from the Link Criteria tab, drop-downs for these three columns are proided. For the Connector Attribute column you must hae preiously done a Connect/Query Schema in the Configure/Attribute window in order to get drop-down alues. 14 IBM Directory Integrator 4.7: Reference Guide

25 A Connector can hae many link criteria. They are added by using the Add button. If you hae seeral link criteria, there is an implicit AND operator between them. Note that in the example aboe, the Value was set to $Name. The possible formats for Value are A text string - mapped to a constant with that alue $Name - corresponds to work.getstring( Name ), that is the first alue of the attribute - meaning one of the alues of the multi-alued attribute Name Adanced link criteria Sometime, the Simple Link Criteria is not enough, because multiple link criteria are always ANDed. If you select the Adanced Link Mode check box, you are able to script your link criteria. You will hae to populate a text string called ret.filter that will proide the Link Criteria or filter. Howeer, you will hae to know the syntax used by the underlying Raw Connector: An LDAP and an SQL Connector will hae different syntax. A simple JaaScript example for a SQL Connector would be ret.filter = ID LIKE + work.getstring( Name ) + ; The example assumes an example where the Raw Connector has an attribute called ID (typically a column name) and that we want to match it with work.name. Notes: 1. The first part of the SQL expression, Select * from Table Where, is proided by the IBM Directory Integrator. 2. Single quotes hae been added since work.getstring() returns a string, while SQL Syntax asks for single quotes around strings constants. 3. The special syntax with $ is not used here. EentHandler EentHandlers are meant to simplify the task of eent enabling the IBM Directory Integrator serer. With the EentHandlers you can configure actions to be taken using a point & click metaphor. you can script eenthandlers if you want, but IBM Directory Integrator proides some predefined functions to make life easier. Starting the EentHandler In the admin-tool, under the Configuration tab, there is an EentHandler tab. If an EentHandler has the auto-start check-box set, it starts up wheneer the Serer is started with that configuration file. You can disable it by the -D switch as seen under Line Options. While working with the Admin-tool, you typically start the serer (and thus all your auto-started EentHandlers) simply by selecting File Start Serer. If you want to start just one EentHandler, press the EentHandler Object tab, select the EentHandler you want to run, and press the Run Button. Some new EentHandlers een hae their own Run button you can press while configuring the EentHandler. Chapter 4. IBM Directory Integrator concepts 15

26 The Eent object The key object in the EentHandlers is the eent object. This object is an instance of the familiar entry object you find in AssemblyLines. Configuration and data flow Each EentHandler consists of a configuration section and a data flow section. The configuration section contains the parameters that goern each specific EentHandler. The data flow consists of a prolog, action map and an epilog. The prolog and epilog are executed before and after the action map. The action map contains a number of actions and dependencies for the actions. This enables you to perform simple tests and start AssemblyLines without typing a single line of script code. Prolog In this section you can execute script code before the action map is executed. You hae access to the eent object and global functions (e.g. system, main etc.) as usual. Eent Handler action map In this section you add action items. Each action item has an associated list of Conditions and actions. If the list of conditions is true, the actions under the On Success tab is executed, otherwise the On Fail actions are executed. If the Consumeeent option is set, and actions are executed, the rest of the action map is skipped. It is also possible to temporarily Disable an action item. Conditions If Match any condition is set, the list of conditions ealuates to true when at least one condition is true, otherwise all conditions must be true for the list to ealuate to true. An empty list of conditions is true. Each condition can be a small script, or a test based on properties or attributes of the eent object. See Attribute/property names on page 17 Actions Each action in the action list could be any one of these: Apply Parser - In Read Mode you set the Parser Input, and the result is put into the eent object. In Write Mode you set the Parser Output, and the eent object is written, unless you hae specified another Entry object as the Parser Input, in which case that object is written. Run AssemblyLine - Runs a named AssemblyLine. You may send the eent object to the AssemblyLine as the initial work entry, by setting Proide eent object. You may een specify a connector to send to the AssemblyLine, see (runtime proided) Connector on page 86. If you set the Wait for completion flag, the action list waits for the AssemblyLine to finish, and sets the properties AssemblyLine.result, AssemblyLine.error and AssemblyLine.stats. Some of the properties may not be set, depending on what happens in the AssemblyLine. Custom Script - The script may refer to the eent and task objects. Dump Eent Object - writes the eent object to the Eent Handler s log file. Set Property/Attribute - See Attribute/property names on page 17 Remoe Property/Attribute - See Attribute/property names on page 17 Terminate Handler - terminates the Eent Handler with a specified message. 16 IBM Directory Integrator 4.7: Reference Guide

27 Scripting Attribute/property names If the name begins with entry., it is assumed to be an attribute of the eent object, otherwise it is a property of the eent object. The same rule applies to alues in a condition or Set Property/Attribute, but strings surrounded by quotes ( ) are constants. Epilog This section is executed after the action map has been completed. IBM Directory Integrator proides its users with a highly-flexible engine that can be tuned both from the user interface controls of IBM Directory Integrator Admin as well as through script input from the user. While the user interface controls proide a means of controlling the data flow on a higher leel, scripting proides users with the ability to control almost any aspect of the data flow at any leel (including oerriding standard IBM Directory Integrator processing). Special function exists within the System object to reiterate on an AssemblyLine, skip a Connector and so forth, for example, skipentry, ignoreentry, and restartentry. IBM Directory Integrator proides support for a number of scripting languages. You can set the Script Language for the entire AssemblyLine in the Settings tab. If you change the language, remember that this affects the code used in the Prolog, Epilog, Hooks and Attribute Maps. It does not affect a Connector or Parser written in a script language. When is scripting needed? Scripting is necessary when you need to add custom processing to your AssemblyLine. Examples of where scripting would be helpful include: The alue of an attribute in your output Connector is calculated based on one or more of the input Connector s attributes. You want to process only entries that match a particular set of criteria. You want to oerride the update operation of the Connector you are using. You want to run some initializing procedures before your AssemblyLine starts. Each of these cases mentioned (and many others not mentioned) require scripting. Integrating scripting into the AssemblyLine? As we already explained, you must utilize scripting when the need for custom processing arises in the integration process. The need for custom data processing will ineitably come in some identifiable point in the flow of data (e.g., before any processing begins, before processing a particular entry, after a failure, etc.). IBM Directory Integrator proides you with a number of control points throughout the data flow where you may proide direction through scripting (e.g., the AssemblyLines Prolog and Epilog sections, Connectors Hooks sections, etc.). These control points are easily accessed within the IBM Directory Integrator Admin tool. Implementing custom processing is simply a matter of identifying the correct control point and adding your script in the appropriate edit window. It is important to both correctly identify the appropriate control point where you will input your script as well as limit the scope of your script to coer just that single goal associated with the control point. Chapter 4. IBM Directory Integrator concepts 17