52
IBM Tivoli Directory Integrator 5.2: Administrator Guide SC32-1379-00

IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

  • Upload
    vudan

  • View
    227

  • Download
    2

Embed Size (px)

Citation preview

Page 1: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

SC32-1379-00

���

Page 2: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide
Page 3: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

SC32-1379-00

���

Page 4: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Note

Before

using

this

information

and

the

product

it

supports,

read

the

general

information

under

Appendix

B,

“Notices,”

on

page

39.

First

Edition

(November

2003)

This

edition

applies

to

version

5,

release

2,

of

The

IBM

Tivoli

Directory

Integrator

and

to

all

subsequent

releases

and

modifications

until

otherwise

indicated

in

new

editions.

©

Copyright

International

Business

Machines

Corporation

2003.

All

rights

reserved.

US

Government

Users

Restricted

Rights

Use,

duplication

or

disclosure

restricted

by

GSA

ADP

Schedule

Contract

with

IBM

Corp.

Page 5: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Preface

This

document

contains

the

information

that

you

need

to

administer

the

IBM®

Tivoli®

Directory

Integrator.

Who

should

read

this

book

This

book

is

intended

for

system

administrators.

Publications

Read

the

descriptions

of

the

IBM

Tivoli

Directory

Integrator

library

to

determine

which

publications

you

might

find

helpful.

After

you

determine

the

publications

you

need,

refer

to

the

instructions

for

accessing

publications

online.

IBM

Tivoli

Directory

Integrator

library

The

publications

in

the

IBM

Tivoli

Directory

Integrator

library

are:

IBM

Tivoli

Directory

Integrator

5.2:

Readme

Contains

last-minute

information

about

IBM

Tivoli

Directory

Integrator

5.2.

IBM

Tivoli

Directory

Integrator

5.2:

Getting

Started

Guide

A

brief

tutorial

and

introduction

to

IBM

Tivoli

Directory

Integrator

5.2.

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Includes

complete

information

for

installing

the

IBM

Tivoli

Directory

Integrator.

Includes

information

about

migrating

from

a

previous

version

of

IBM

Tivoli

Directory

Integrator.

Includes

information

about

configuring

the

logging

functionality

of

IBM

Tivoli

Directory

Integrator.

IBM

Tivoli

Directory

Integrator

5.2:

Users

Guide

Contains

information

about

using

the

IBM

Tivoli

Directory

Integrator

5.2

tool.

Contains

instructions

for

designing

solutions

using

the

IBM

Tivoli

Directory

Integrator

tool

(ibmditk)

or

running

the

ready-made

solutions

from

the

command

line

(ibmdisrv).

Also

provides

information

about

interfaces,

concepts

and

AssemblyLine/EventHandler

creation

and

management.

Includes

examples

to

create

interaction

and

hands-on

learning

of

IBM

Tivoli

Directory

Integrator

5.2.

IBM

Tivoli

Directory

Integrator

5.2:

Reference

Guide

Contains

detailed

information

about

the

individual

components

of

IBM

Tivoli

Directory

Integrator

5.2

AssemblyLine

(Connectors,

EventHandlers,

Parsers,

Plug-ins,

and

so

forth).

Related

publications

Information

related

to

the

IBM

Tivoli

Directory

Integrator

is

available

in

the

following

publications:

v

The

IBM

Tivoli

Directory

Integrator

5.2

uses

the

JNDI

client

from

Sun

Microsystems.

For

information

about

the

JNDI

client,

refer

to

the

Java™

Naming

and

Directory

Interface™

1.2.1

Specification

on

the

Sun

Microsystems

Web

site

at

http://java.sun.com/products/jndi/1.2/javadoc/index.html.

v

The

Tivoli

Software

Library

provides

a

variety

of

Tivoli

publications

such

as

white

papers,

datasheets,

demonstrations,

redbooks,

and

announcement

letters.

©

Copyright

IBM

Corp.

2003

iii

Page 6: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

The

Tivoli

Software

Library

is

available

on

the

Web

at:

http://www.ibm.com/software/tivoli/library/

v

The

Tivoli

Software

Glossary

includes

definitions

for

many

of

the

technical

terms

related

to

Tivoli

software.

The

Tivoli

Software

Glossary

is

available,

in

English

only,

from

the

Glossary

link

on

the

left

side

of

the

Tivoli

Software

Library

Web

page

http://www.ibm.com/software/tivoli/library/

Accessing

publications

online

The

publications

for

this

product

are

available

online

in

Portable

Document

Format

(PDF)

or

Hypertext

Markup

Language

(HTML)

format,

or

both

in

the

Tivoli

software

library:

http://www.ibm.com/software/tivoli/library.

To

locate

product

publications

in

the

library,

click

the

Product

manuals

link

on

the

left

side

of

the

Library

page.

Then,

locate

and

click

the

name

of

the

product

on

the

Tivoli

software

information

center

page.

Information

is

organized

by

product

and

includes

READMEs,

installation

guides,

user’s

guides,

administrator’s

guides,

and

developer’s

references

as

necessary.

Note:

To

ensure

proper

printing

of

PDF

publications,

select

the

Fit

to

page

check

box

in

the

Adobe

Acrobat

Print

window

(which

is

available

when

you

click

File->Print).

Accessibility

Accessibility

features

help

a

user

who

has

a

physical

disability,

such

as

restricted

mobility

or

limited

vision,

to

use

software

products

successfully.

With

this

product,

you

can

use

assistive

technologies

to

hear

and

navigate

the

interface.

After

installation

you

also

can

use

the

keyboard

instead

of

the

mouse

to

operate

all

features

of

the

graphical

user

interface.

Contacting

software

support

Before

contacting

IBM

Tivoli

Software

support

with

a

problem,

refer

to

IBM

System

Management

and

Tivoli

software

Web

site

at:

http://www.ibm.com/software/sysmgmt/products/support/

If

you

need

additional

help,

contact

software

support

by

using

the

methods

described

in

the

IBM

Software

Support

Guide

at

the

following

Web

site:

http://techsupport.services.ibm.com/guides/handbook.html

The

guide

provides

the

following

information:

v

Registration

and

eligibility

requirements

for

receiving

support

v

Telephone

numbers

and

e-mail

addresses,

depending

on

the

country

in

which

you

are

located

v

A

list

of

information

you

must

gather

before

contacting

customer

support

iv

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 7: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Contents

Preface

.

.

.

.

.

.

.

.

.

.

.

.

.

.

. iii

Who

should

read

this

book

.

.

.

.

.

.

.

.

. iii

Publications

.

.

.

.

.

.

.

.

.

.

.

.

.

. iii

IBM

Tivoli

Directory

Integrator

library

.

.

.

. iii

Related

publications

.

.

.

.

.

.

.

.

.

. iii

Accessing

publications

online

.

.

.

.

.

.

. iv

Accessibility

.

.

.

.

.

.

.

.

.

.

.

.

.

. iv

Contacting

software

support

.

.

.

.

.

.

.

.

. iv

Chapter

1.

Introduction

.

.

.

.

.

.

.

. 1

Chapter

2.

IBM

Tivoli

Directory

Integrator

installation

instructions

.

.

. 3

Installing

on

Windows

platforms

.

.

.

.

.

.

. 3

Installing

on

UNIX

platforms

.

.

.

.

.

.

.

.

. 3

Silent

install

(command

line)

.

.

.

.

.

.

.

.

. 4

Uninstalling

on

Windows

platforms

.

.

.

.

.

. 4

Uninstalling

on

UNIX

platforms

.

.

.

.

.

.

.

. 4

Silent

uninstall

(command

line)

.

.

.

.

.

.

.

. 5

Distribution

components

.

.

.

.

.

.

.

.

.

. 5

Other

files

on

install

directory

.

.

.

.

.

.

. 5

Jar-files

(/jars

subdirectory)

.

.

.

.

.

.

.

. 6

Libraries

(Windows)

libs/

subdirectory

.

.

.

. 7

log4j.properties

.

.

.

.

.

.

.

.

.

.

.

. 8

executetask.properties

.

.

.

.

.

.

.

.

.

. 9

global.properties

.

.

.

.

.

.

.

.

.

.

.

. 9

Troubleshooting

.

.

.

.

.

.

.

.

.

.

.

.

. 11

Chapter

3.

Supported

platforms

.

.

.

. 13

Chapter

4.

Migrating

from

IBM

Tivoli

Directory

Integrator

5.1.2

to

IBM

Tivoli

Directory

Integrator

5.2

.

.

.

.

.

.

.

. 15

Chapter

5.

System

Store

.

.

.

.

.

.

. 17

Chapter

6.

Logging

and

debugging

.

. 19

Background

.

.

.

.

.

.

.

.

.

.

.

.

.

. 19

Logging

.

.

.

.

.

.

.

.

.

.

.

.

.

.

. 19

Log

Levels

.

.

.

.

.

.

.

.

.

.

.

.

.

.

. 22

log4j

default

parameters

.

.

.

.

.

.

.

.

.

. 23

Creating

your

own

log

strategies

.

.

.

.

.

. 23

Chapter

7.

Administration

and

Monitor

Console

.

.

.

.

.

.

.

.

.

.

.

.

.

. 25

Administration

and

Monitor

Console

.

.

.

.

.

. 25

Considerations

.

.

.

.

.

.

.

.

.

.

.

. 25

Some

AMC

functions

.

.

.

.

.

.

.

.

.

. 26

AMC

setup

.

.

.

.

.

.

.

.

.

.

.

.

.

. 28

AMC

properties

.

.

.

.

.

.

.

.

.

.

.

. 28

Accounts

configuration

file

.

.

.

.

.

.

.

. 29

SSL

configuration

.

.

.

.

.

.

.

.

.

.

. 30

Example

AMC

configuration

in

global.properties

30

Chapter

8.

IBM

Tivoli

Directory

Integrator

as

Windows

Service

.

.

.

. 31

Installing

and

uninstalling

the

service

.

.

.

.

. 31

Installing

the

service

.

.

.

.

.

.

.

.

.

. 31

Uninstalling

the

service

.

.

.

.

.

.

.

.

. 31

Starting

and

stopping

the

service

.

.

.

.

.

.

. 31

Manual

start

and

stop

.

.

.

.

.

.

.

.

.

. 32

Changing

service

startup

type

.

.

.

.

.

.

. 32

Logging

.

.

.

.

.

.

.

.

.

.

.

.

.

.

. 32

Configuring

the

service

.

.

.

.

.

.

.

.

.

. 32

Appendix

A.

Dictionary

of

terms

.

.

.

. 35

LDAP

terms

.

.

.

.

.

.

.

.

.

.

.

.

.

. 35

IBM

Tivoli

Directory

Integrator

terms

.

.

.

.

.

. 35

Appendix

B.

Notices

.

.

.

.

.

.

.

.

. 39

Third-party

component

statements

.

.

.

.

.

. 41

Apache

statement

.

.

.

.

.

.

.

.

.

.

. 41

Rhino

statement

.

.

.

.

.

.

.

.

.

.

.

. 42

Trademarks

.

.

.

.

.

.

.

.

.

.

.

.

.

. 42

©

Copyright

IBM

Corp.

2003

v

Page 8: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

vi

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 9: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Chapter

1.

Introduction

For

an

overview

of

the

general

concepts

of

the

IBM

Tivoli

Directory

Integrator

5.2,

refer

to

″IBM

Tivoli

Directory

Integrator

concepts,″

in

IBM

Tivoli

Directory

Integrator

5.2:

Users

Guide.

For

more

detailed

information

about

IBM

Tivoli

Directory

Integrator

5.2

concepts,

see

IBM

Tivoli

Directory

Integrator

5.2:

Reference

Guide.

©

Copyright

IBM

Corp.

2003

1

Page 10: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

2

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 11: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Chapter

2.

IBM

Tivoli

Directory

Integrator

installation

instructions

Note:

PATH

system

variable

is

not

set

during

installation.

Set

the

path

so

commands

such

as

ibmditk,

ibmdisrv,

ibmditk.bat

and

ibmdisrv.bat

can

work

in

a

directory

other

than

IBM

Tivoli

Directory

Integrator

root

directory.

Installing

on

Windows

platforms

1.

Locate

the

setupwin32.exe

file.

2.

Double-click

on

setupwin32.exe,

or

type

setupwin32.exe

at

a

command

prompt.

The

program

loads

Installshield

and

begins

installing.

3.

The

first

panel

provides

you

information

about

the

product.

4.

Click

Next

to

continue.

5.

The

next

panel

is

the

license

agreement.

Read

this

carefully.

Click

to

accept

the

terms

of

the

agreement.

6.

Click

Next

to

continue.

7.

The

next

panel

displays

a

default

working

directory

where

the

product

is

installed.

You

can

change

this

location

by

clicking

Browse

and

selecting

another

location.

8.

Click

Next

to

continue.

9.

The

next

panel

gives

you

information

about

where

the

product

is

installed

and

the

disk

space

the

product

requires.

10.

Click

Next

to

continue.

11.

The

product

finishes

installing

and

continues

to

the

final

panel.

This

is

another

information

panel

telling

you

that

the

install

completed

successfully.

12.

Click

Finish.

Installing

on

UNIX

platforms

1.

Locate

the

setupNameofunixOS.bin

file.

You

might

need

to

change

your

permissions:

chmod

+x

setupNameofunixOS.bin

2.

Run

setupNameofunixOS.bin:

./setupNameofunixOS.bin

The

program

loads

Installshield

and

begins

installing.

3.

The

first

panel

gives

you

information

about

the

product.

4.

Click

Next

to

continue.

5.

The

second

panel

is

the

license

agreement.

Read

this

carefully.

Click

to

accept

the

terms

of

the

agreement.

6.

Click

Next

to

continue.

7.

The

next

panel

displays

a

default

working

directory

where

the

product

is

installed.

You

can

change

this

location

by

clicking

Browse

and

selecting

another

location.

8.

Click

Next

to

continue.

9.

The

next

panel

gives

you

information

about

where

the

product

is

installed

and

the

disk

space

the

product

requires.

©

Copyright

IBM

Corp.

2003

3

Page 12: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

10.

Click

Next

to

continue.

11.

The

product

finishes

installing

and

continues

to

the

final

panel.

This

is

another

information

panel

telling

you

that

the

install

completed

successfully.

12.

Click

Finish.

Silent

install

(command

line)

Do

the

following

to

perform

a

silent

install

of

IBM

Tivoli

Directory

Integrator:

Windows®

platforms

setupwin32.exe

-is:silent

-silent

AIX®

setupAIX.bin

-is:silent

-silent

Linux

s/390

setupLinux390.bin

-is:silent

-silent

HPUX

setupHPUX.bin

-is:silent

-silent

Linux

Intel™

setupLinux.bin

-is:silent

-silent

Solaris

setupSolaris.bin

-is:silent

-silent

Uninstalling

on

Windows

platforms

1.

Go

to

Control

Panel—>Add/Remove

Programs.

2.

Highlight

IBM

Tivoli

Directory

Integrator

5.2,

and

click

Remove.

This

initiates

the

Uninstall

Wizard.

3.

Click

Next

on

the

first

panel.

The

product

is

now

being

uninstalled.

4.

An

information

panel

is

displayed.

Read

this

carefully.

IBM

Tivoli

Directory

Integrator

leaves

files

it

creates

such

as

configuration

files.

They

must

be

manually

deleted,

if

required.

5.

Click

Next.

6.

A

panel

is

displayed

that

says

IBM

Tivoli

Directory

Integrator

successfully

uninstalled.

7.

Click

Finish.

Uninstall

is

complete.

Uninstalling

on

UNIX

platforms

1.

Go

to

the

install

directory

of

IBM

Tivoli

Directory

Integrator.

This

is

the

directory

where

IBM

Tivoli

Directory

Integrator

was

installed.

2.

Change

your

directory

to

the

uninstall

directory:

cd

_uninst

3.

Start

the

uninstaller:

./uninstaller

This

initiates

the

Uninstall

Wizard.

4.

Click

Next

on

the

first

panel.

The

product

is

now

being

uninstalled.

5.

Click

Next

on

the

second

panel.

This

panel

tells

you

where

the

product

is

being

uninstalled

from.

6.

An

informational

panel

is

displayed.

Read

this

carefully.

IBM

Tivoli

Directory

Integrator

leaves

files

it

creates

such

as

configuration

files.

They

must

be

manually

deleted,

if

required.

4

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 13: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

7.

Click

Next.

Uninstall

is

complete.

8.

Click

Finish

to

close

the

wizard.

Silent

uninstall

(command

line)

Do

the

following

to

perform

a

silent

uninstall

of

IBM

Tivoli

Directory

Integrator:

All

platforms

uninstall.exe

-is:silent

-silent

Distribution

components

Here

is

the

list

of

all

components

(.jar

and

.dll

files)

installed

on

your

computer

with

IBM

Tivoli

Directory

Integrator.

.jar

files

are

found

in

the

jars/

subdirectory.

Connectors,

EventHandlers

and

Parsers

are

found

in

separate

subdirectories

and

not

described

here.

Other

files

on

install

directory

log4j.properties

File

where

the

baseline

log

strategy

is

described.

IDILoader.jar

Makes

sure

jar-files

in

jars/

subdirectory

are

loaded

by

ibmditk

and

ibmdisrv.

global.properties

Stores

configuration

information.

See

“global.properties”

on

page

9.

log.txt

Install

log

file.

ibmditk

Executable

file

for

graphical

user

interface

(GUI),

also

known

as

Config

Editor.

Non-Windows

platforms

only.

Note:

PATH

system

variable

is

not

set

during

installation.

Set

the

path

so

commands

such

as

ibmditk

can

work

in

a

directory

other

than

IBM

Tivoli

Directory

Integrator

root

directory.

ibmditk.bat

Executable

file

for

Config

Editor

(Windows

platforms

only).

Note:

PATH

system

variable

is

not

set

during

installation.

Set

the

path

so

commands

such

as

ibmditk.bat

can

work

in

a

directory

other

than

IBM

Tivoli

Directory

Integrator

root

directory.

ibmdisrv

Executable

file

for

server

(non-Windows

platforms

only).

Note:

PATH

system

variable

is

not

set

during

installation.

Set

the

path

so

commands

such

as

ibmdisrv

can

work

in

a

directory

other

than

IBM

Tivoli

Directory

Integrator

root

directory.

ibmdisrv.bat

Executable

file

for

server

(Windows

platforms

only).

Note:

PATH

system

variable

is

not

set

during

installation.

Set

the

path

so

commands

such

as

ibmdisrv.bat

can

work

in

a

directory

other

than

IBM

Tivoli

Directory

Integrator

root

directory.

Chapter

2.

IBM

Tivoli

Directory

Integrator

installation

instructions

5

Page 14: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

executetask.properties

This

configures

the

logging

strategy

for

AssemblyLines

run

within

the

Config

Editor,

as

opposed

to

log4j.properties

that

configures

the

standalone

server

(ibmdisrv).

Jar-files

(/jars

subdirectory)

IBM

Tivoli

Directory

Integrator

jar-files

miadmin.jar

IBM

Tivoli

Directory

Integrator

Config

Editor

miserver.jar

IBM

Tivoli

Directory

Integrator

Server

management.jar

AMC

miconfig.jar

Configuration

interfaces

mmconfig.jar

Configuration

implementation

WebService.jar

Used

by

the

WebService

Event

Handler

The

rest

are

3rd

party

libraries

used

by

the

product.

Scripting

Framework

bsf.jar

The

IBM

open

source

wrapper

for

a

variety

of

script

engines

(http://oss.software.ibm.com/developerworks/projects/bsf).

It

provides

a

unified

interface

to

the

various

script

engines

available

(BSF).

Note

that

this

framework

does

not

provide

any

script

engines

at

all.

The

script

engines

must

be

downloaded

from

other

Web

sites.

See

also

“Libraries

(Windows)

libs/

subdirectory”

on

page

7.

js.jar

The

Mozilla

implementation

of

JavaScript™

engine

(Rhino)

(www.mozilla.org/rhino).

It

is

100%

java.

Java

Naming

and

Directory

Interface

(JNDI)

ldapbp.jar,

ldapjdk.jar

JNDI

provider

for

LDAP

and

LDAP

controls.

Used

by

JNDI.

JavaMail

API

smtp.jar,

imap.jar,

pop3.jar,

mail.jar,

mailapi.jar,

activation.jar

JavaMail

libraries

for

SMTP,

IMAP,

POP3

(http://java.sun.com/products).

XML

xalan.jar,

xercesImpl.jar

The

Apache

XML

project

that

provides

XML

parsing

(xercesImpl.jar)

and

XPath/XSL

(xalan.jar)

(http://xml.apache.org).

CloudScape

db2j.jar

The

primary

CloudsScape

library

db2jcc.jar

Required

to

use

the

DB2®

JDBC

Universal

Driver

6

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 15: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

db2jnet.jar

Required

to

use

any

of

the

CloudScape

Network

Server

functions

Logging

framework

log4j-1.2.jar

The

log4j

library

DSML

support

dsml.jar

Support

for

DSML

v.

1

dsml2.jar,

castor-0.9.4.1–xml.jar,

antlr-2.7.2.jar

(Partial)

support

for

DSML

v.

2

Java

Web

Services

Support

files

JAXP

group:

dom.jar

Part

of

XML

support,

Document

Object

Model

sax.jar

Part

of

XML

support,

SAX

parser

xalan.jar

Part

of

XML

support,

XSLT

stylesheet

processing

xsltc.jar

Part

of

XML

support,

for

XSLT

translations

SAAJ

group:

dom4j.jar

Part

of

XML

support,

Java

interface

to

Document

Object

Model

wsdl4j.jar

Part

of

XML

support,

Java

interface

to

Web

Service

Definition

Language

saaj-api.jar,

saaj-ri.jar

Part

of

XML

support,

SOAP

with

attachments

API

for

Java

Management

mx4j.jar,

mx4j-tools.jar,

mx4j-jmx.jar

JMX

java

management

interface

Other

jms.jar

Support

for

Java

Messaging

Service

snmp.jar

Support

for

SNMP

protocol

ncso.jar

Lotus®

Notes®

client

support

library

ibmjndi.jar

Java

Naming

and

Directory

Interface

library

(IBM

version)

Libraries

(Windows)

libs/

subdirectory

bsfactivescriptengines.dll

(part

of

BSF)

This

is

the

wrapper

used

by

BSF

to

access

the

Windows

Scripting

Host

Chapter

2.

IBM

Tivoli

Directory

Integrator

installation

instructions

7

Page 16: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

engine.

The

WSH

engine

in

turn

can

access

the

installed

windows

scripting

engines

such

as

JScript,

VBScript

and

PerlScript.

NTEventLogAppender.dll

Using

log4j,

IBM

Tivoli

Directory

Integrator

is

able

to

log

to

the

NT

event

log

system

when

running

on

a

Windows

system.

To

do

this

logging,

NTEventLogAppender.dll

must

be

in

a

directory

that

is

in

the

PATH.

JdbcOdbc.dll

This

is

the

native

library

that

supports

the

system-provided

JDBC

to

ODBC

bridge.

This

bridge

is

supported

by

IBM

on

the

Windows

platform

only.

NtMetaData.dll

(component

of

NT4

Connector)

Wraps

calls

of

WinAPI

functions

that

interact

with

NT/AD

database.

log4j.properties

This

file

sets

a

baseline

for

the

log-strategy

for

the

server

(ibmdisrv).

See

“executetask.properties”

on

page

9

for

behavior

of

the

Config

Editor

(ibmditk)

console.

Log

options

configured

in

the

Logging

tab

in

the

Config

Editor

are

written

into

the

Configuration

file,

and

are

supplementary

to

the

following:

log4j.rootCategory=INFO,

Default

#

This

is

the

default

logger,

you

will

see

that

it

logs

to

ibmdi.log

log4j.appender.Default=org.apache.log4j.FileAppender

log4j.appender.Default.file=ibmdi.log

log4j.appender.Default.layout=org.apache.log4j.PatternLayout

log4j.appender.Default.layout.ConversionPattern=%d{ISO8601}

%-5p

[%c]

-

%m%n

log4j.appender.Default.append=false

log4j.logger.com.ibm.di.config=WARN

log4j.logger.com.ibm.di.loader=WARN

log4j.logger.com.ibm.di.admin=WARN

#

Uncomment

the

lines

below

to

activate

them

#

Here

is

an

example

on

how

to

make

a

logger

that

logs

to

the

console

#log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender

#log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout

#log4j.appender.CONSOLE.layout.ConversionPattern=%d

[%t]

%-5p

-

%m%n0

#

Here

is

an

example

that

logs

to

myFile.log

#log4j.appender.fileLOG=org.apache.log4j.FileAppender

#log4j.appender.fileLOG.file=myFILE.log

#log4j.appender.fileLOG.layout=org.apache.log4j.PatternLayout

#log4j.appender.fileLOG.layout.ConversionPattern=%d{ISO8601}

%-5p

[%c]

-

%m%n

#log4j.appender.fileLOG.append=false

#

Finally,

make

use

of

the

loggers

defined

above:

#

Tell

AssemblyLines

myAL

to

log

using

CONSOLE

logger

defined

above.

#

log4j.logger.AssemblyLine.myAL=INFO,

CONSOLE

#

Or

you

could

log

to

myFile.log

#

log4j.logger.AssemblyLine.myAL=INFO,

fileLOG

#

Finally,

make

EventHandler

myEH

log

to

myFile.log

#

log4j.logger.EventHandler.myEH=INFO,

fileLOG

8

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 17: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

executetask.properties

This

file

controls

the

log-strategy

for

the

Config

Editor

(ibmditk)

console.

See

“log4j.properties”

on

page

8

for

behavior

of

the

server

(ibmdisrv).

log4j.rootCategory=INFO,

Default

log4j.appender.Default=org.apache.log4j.ConsoleAppender

log4j.appender.Default.layout=org.apache.log4j.PatternLayout

log4j.appender.Default.layout.ConversionPattern=%d{HH:mm:ss}

%m%n

log4j.logger.com.ibm.di.config=ERROR

log4j.logger.com.ibm.di.loader=ERROR

global.properties

This

file

is

read

by

ibmditk

and

ibmdisrv

on

startup:

##

##

##

Enter

<name>=<value>

to

set

system

properties.

##

Enter

!include

<file

|

url>

to

include

other

files

##

com.metamerge.securityTransformation=DES/ECB/NoPadding

##

To

have

the

ScriptEngine

to

precompile

##

javascript/jscript

code

set

this

prop

to

true

com.ibm.di.scriptengine.precompile=true

##

##

SYSTEM

STORE

##

##

Location

of

the

database

(embedded

mode)

com.ibm.di.store.database=install_directory\CloudScape

com.ibm.di.store.jdbc.driver=com.ibm.db2j.jdbc.DB2jDriver

com.ibm.di.store.jdbc.urlprefix=jdbc:db2j:

##

Location

of

the

database

(networked

mode)

#com.ibm.di.store.database=//localhost:1527/install_directory/CloudScape

#com.ibm.di.store.jdbc.driver=com.ibm.db2.jcc.DB2Driver

#com.ibm.di.store.jdbc.urlprefix=jdbc:db2j:net:

#com.ibm.di.store.jdbc.user=APP

#com.ibm.di.store.jdbc.password=APP

##

server

authentication

##

example

##

javax.net.ssl.trustStore=d:\test\KeyRings\namtp2.jks

##

javax.net.ssl.trustStorePassword=secret

##

javax.net.ssl.trustStoreType=jks

javax.net.ssl.trustStore=

javax.net.ssl.trustStorePassword=

javax.net.ssl.trustStoreType=

##

client

authentication

##

example

##

javax.net.ssl.keyStore=d:\test\KeyRings\namtp2.jks

##

javax.net.ssl.keyStorePassword=secret

##

javax.net.ssl.keyStoreType=jks

javax.net.ssl.keyStore=

javax.net.ssl.keyStorePassword=

javax.net.ssl.keyStoreType=

Chapter

2.

IBM

Tivoli

Directory

Integrator

installation

instructions

9

Page 18: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

##

Turns

on

java

debug

#

javax.net.debug=true

##

java

interpreter

override

#

com.ibm.di.javacmd=

#

com.ibm.di.installdir=

##

Limits

the

number

of

threads

IBM

Tivoli

Directory

Integrator

uses

##

Must

be

set

higher

than

3

to

have

any

effect

#

com.ibm.di.server.maxThreadsRunning=500

##

--------------

##

AMC

properties

##

--------------

##

If

this

is

true,

MOBJ

is

started

by

the

server

mobj.on=true

##

If

this

is

true,

and

mobj.on

is

also

true,

AMC

is

started

by

the

server

amc.on=false

##

the

port

where

AMC

will

listen

for

HTTP

browser

requests

amc.port=8989

##

the

AMC

host

name

or

IP

address

##

amc.host=

##

the

file

path

of

the

file

where

AMC

user

accounts

are

stored

amc.accountsFileName=install_directory/amc/accounts.txt

##

specifies

the

path

to

the

AMC

XSL

stylesheets

##

usually

this

is

the

path

to

the

"management.jar"

file

amc.xsl.path=install_directory/jars/management.jar

##

specify

"true"

or

"false"

to

correspondingly

turn

on

/

off

AMC

SSL

amc.ssl.on=false

##

----------------------

##

RMI

Adaptor

properties

##

----------------------

##

specify

"true"

/

"false"

to

correspondingly

enable

/

disable

the

RMI

Adaptor

#mobj.rmi.adaptor.on=true

##

the

port

where

the

RMI

Registry

will

run

#mobj.rmi.adaptor.registry.port=1099

##

the

specified

name

will

be

bound

to

the

RMI

Adaptor

in

the

RMI

Registry

#mobj.rmi.adaptor.jndiname=jrmp

##

specify

"true"

or

"false"

to

correspondingly

turn

on

/

off

RMI

Adaptor

SSL

#mobj.rmi.adaptor.ssl.on=false

##

the

RMI

registry

service

provider

for

JNDI

#mobj.rmi.adaptor.naming.factory.initial=

\

com.sun.jndi.rmi.registry.RegistryContextFactory

10

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 19: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Troubleshooting

If

you

are

experiencing

difficulties

with

the

installer,

you

might

want

to

generate

the

install

log.

Specify

-is:log

logfile

on

the

command

line

of

the

installer.

For

example,

on

AIX

you

issue

the

following

command:

setupAIX.bin

-is:log

mylogfile.txt

If

you

do

not

have

much

space

in

your

system

temp

directory,

you

can

override

the

temp

directory

used

by

the

installer

during

install.

Specify

-is:tmpdir

tmp

directory

on

the

command

line

of

the

installer.

For

example,

on

AIX

you

issue

the

following

command:

setupAIX.bin

-is:tmpdir

/home/bigfilesys

Chapter

2.

IBM

Tivoli

Directory

Integrator

installation

instructions

11

Page 20: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

12

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 21: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Chapter

3.

Supported

platforms

IBM

Tivoli

Directory

Integrator

ships

with

IBM

JRE

1.4.1

on

most

platforms,

except

on

SUN

Solaris

and

HP-UX,

where

a

vendor-specific

J2SE

1.4-compliant

JRE

is

included.

Plug-ins

still

use

the

1.3.1

JRE.

See

″Password

Synchronization

Plug-ins″

in

IBM

Tivoli

Directory

Integrator

5.2:

Reference

Guide.

The

following

are

the

platforms

supported

for

IBM

Tivoli

Directory

Integrator.

A

minimum

of

128

MB

RAM

is

required

for

each

platform

(256

MB

is

strongly

recommended):

v

Microsoft®

Windows

Windows

2000

Professional

Windows

2000

Server

Windows

2000

Advanced

Server

Windows

XP

Pro

Windows

2003

Std

Ed

Windows

2003

Enterprise

Edv

AIX

5.1,

5.2

v

Solaris

8,

9

v

HP-UX

11,

11i

v

Linux

Intel

RedHat

7.2,

7.3

RedHat

Advanced

Server

2.1

RedHat

Advanced

Server

3.0

IA32

(except

plug-ins)

SuSE

7.2,

SLES

7

for

IA32

(7.2

Base)

United

Linux

1.0

for

IA32v

Linux

s/390

RedHat

7.2

RedHat

Advanced

Server

3.0

SuSE

SLES

7

United

Linux

1.0v

Linux

pSeries

RedHat

7.1

RedHat

Advanced

Server

3.0

for

pSeries™

SuSE

SLES

7

and

8.1

for

pSeries

United

Linux

1.0

for

pSeries

©

Copyright

IBM

Corp.

2003

13

Page 22: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

14

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 23: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Chapter

4.

Migrating

from

IBM

Tivoli

Directory

Integrator

5.1.2

to

IBM

Tivoli

Directory

Integrator

5.2

Do

the

following

to

migrate

an

IBM

Tivoli

Directory

Integrator

5.1.2

system

to

IBM

Tivoli

Directory

Integrator

5.2:

1.

Save

any

configuration

files

created

by

IBM

Tivoli

Directory

Integrator.

2.

Uninstall

IBM

Tivoli

Directory

Integrator

5.1.2

3.

Install

IBM

Tivoli

Directory

Integrator

5.2

4.

Copy

your

config

files

and

any

other

custom

files

from

your

old

installation

directory

to

the

new

installation

directory.

Note:

Optionally,

you

might

decide

to

move

the

way

your

Delta

information

is

maintained

from

the

old

Btree

objects

to

the

new

Delta

Tables

in

the

System

Store.

The

best

strategy

for

doing

this

is

engineering

a

situation

where

your

Delta

information

is

empty

(for

example,

establishing

a

new

baseline)

and

then

switch

from

the

Btree

objects

to

the

CloudScape

Delta

Tables.

Note

that

the

parameter

that

used

to

hold

the

filename

of

the

Btree

objects

now

indicates

a

table

name

in

a

database,

so

some

editing

of

this

value

might

be

required.

5.

You

can

now

safely

remove

the

old

installation

directory.

6.

Determine

if

multiple

instances

of

AssemblyLines

in

different

Java

VMs

attempt

to

use

the

same

System

Store,

either

for

Checkpoint/Restart

information

or

for

Persistent

Objects

like

Delta

Tables.

If

so,

configure

the

System

Store

(CloudScape)

for

network

access,

as

outlined

in

the

chapter

about

the

System

Store,

below.

7.

IBM

Tivoli

Directory

Integrator

now

requires

and

includes

a

J2SE

version

1.4

compliant

JVM.

If

you

have

developed

your

own

code

in

Java,

linked

this

code

against

the

JVM

libraries

and

integrated

this

with

your

IBM

Tivoli

Directory

Integrator

solution,

you

might

need

to

recompile

and

re-link

your

code.

8.

Test

your

solution

with

the

new

version.

©

Copyright

IBM

Corp.

2003

15

Page 24: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

16

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 25: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Chapter

5.

System

Store

IBM

Tivoli

Directory

Integrator

supports

persistent

storage

(that

is,

storage

of

objects

that

survive

across

JVM

restarts),

by

means

of

a

relational

database,

the

System

Store.

The

product

deployed

to

implement

the

system

store

is

IBM

DB2

for

Java,

also

known

as

CloudScape.

CloudScape

can

run

in

either

of

two

modes:

embedded

and

networked.

By

default,

as

specified

in

the

global.properties

file,

CloudScape

is

configured

to

run

in

embedded

mode,

and

as

such

runs

as

a

separate

thread

within

the

JVM

when

required.

Startup

and

shutdown

of

CloudScape

are

automatic

in

embedded

mode.

However,

when

run

this

way,

this

CloudScape

thread

claims

exclusive

access

to

the

database

files.

This

can

become

problematic

when

different

JVMs,

each

with

their

own

CloudScape

thread,

try

to

access

the

same

System

Store.

The

following

causes

a

new,

independent

JVM

to

be

started,

triggering

an

access

conflict

when

more

than

one

JVM

is

active

at

any

given

time:

v

A

command

line

invocation

of

the

IBM

Tivoli

Directory

Integrator

Server

with

a

config

file,

causing

one

or

more

AssemblyLines

to

run

or

one

or

more

EventHandlers

to

be

activated

v

Startup

of

the

Config

Editor

(GUI)

v

Startup

of

an

AssemblyLine

or

EventHandler

from

within

the

Config

Editor

None

of

these

actions

by

themselves

can

cause

the

CloudScape

thread

to

start.

However,

the

CloudScape

thread

does

start

if

access

to

any

of

the

objects

in

the

System

Store

is

required

(for

example,

Objects

supported

by

the

System

Store

such

as

Checkpoint/Restart

info,

Delta

Tables

and

the

User

Property

Store).

The

solution

to

the

access

conflicts

as

outlined

previously

is

to

run

CloudScape

in

networked

mode,

which

enables

concurrent

access

to

the

System

Store.

In

the

global.properties

file

in

the

installation

directory,

there

are

two

sections

that

are

concerned

with

the

configuration

of

the

System

Store:

v

The

first

section

(enabled

by

default)

deals

with

running

CloudScape

in

embedded

(dedicated),

non-shared

mode.

v

The

second

section

(commented

out

by

default)

deals

with

CloudScape

in

networked

or

shared

mode.

If

you

determine

that

you

must

use

networked

mode,

comment

the

first

section

and

uncomment

the

second.

However,

when

deploying

this

networked

or

shared

mode,

startup

of

the

CloudScape

database

thread

is

no

longer

automatic.

You

must

start

a

CloudScape

instance

before

you

start

your

first

AssemblyLine

or

EventHandler,

and

shut

down

the

instance

when

you

are

finished

with

your

last

AssemblyLine

and

the

last

EventHandler

has

shut

down.

To

make

working

with

the

CloudScape

database

more

convenient,

consider

creating

a

script

(dbserver)

with

the

following

line:

java

-classpath

jars/db2jnet.jar:jars/db2jcc.jar:jars/db2j.jar

\

com.ibm.db2j.drda.DB2jServer

$1

$2

$3

©

Copyright

IBM

Corp.

2003

17

Page 26: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Note:

The

script

must

be

started

from

within

the

IBM

Tivoli

Directory

Integrator

installation

path

as

the

working

directory,

as

the

following

classpath

is

relative

to

this

directory.

The

following

is

an

example

of

this

utility

script:

Show

all

available

commands:

./dbserver

Start

DBServer

./dbserver

startup

-p

1527

Start

Database

instance

(IDI)

./dbserver

dbstartup

/home/stadheim/DI52/CloudScape

Stop

Database

instance

./dbserver

dbshutdown

/home/stadheim/DI52/CloudScape

Stop

DBServer

./dbserver

shutdown

When

running

in

networked

mode,

the

CloudScape

database

is

of

course

reachable

over

the

network,

not

only

by

IBM

Tivoli

Directory

Integrator

instances

but

also

by

other

applications

using

the

appropriate

drivers.

The

credentials

required

for

such

access

are

defined

in

the

global.properties

file,

and

might

need

to

be

tailored

for

your

particular

site

needs.

Pay

particular

attention

to

the

username

and

password

parameters.

18

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 27: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Chapter

6.

Logging

and

debugging

IBM

Tivoli

Directory

Integrator

relies

on

log4j

as

a

logging

engine.

It

is

a

very

flexible

framework

that

lets

you

log

to

file,

eventlog,

syslog

and

can

be

tuned

so

it

suits

most

needs.

The

log

scheme

for

the

server

(ibmdisrv)

is

described

by

the

file

log4j.properties

and

elements

of

the

config

file,

while

the

console

window

you

get

when

running

from

the

Config

Editor

(ibmditk)

is

governed

by

the

parameters

set

in

executetask.properties

(see

“log4j

default

parameters”

on

page

23).

In

addition

to

the

IBM

Tivoli

Directory

Integrator

built-in

logging,

you

can

log

by

adding

script

code

in

your

AssemblyLine.

This

is

described

in

much

more

detail

in

the

IBM

Tivoli

Directory

Integrator

5.2:

Users

Guide.

Background

Logging

and

debugging

is

mainly

done

through

the

Task

object.

Note:

The

logmsg

calls

available

to

the

user

(task

&

main)

can

have

an

optional

string

parameter

indicating

the

log4j

level

at

which

the

messages

are

to

be

logged.

Default

is

INFO.

If

the

log-level

given

by

the

user

is

invalid

for

log4j,

the

message

is

logged

at

DEBUG

level.

Levels

include

DEBUG,

INFO,

WARN,

ERROR,

FATAL

(see

″Logging″

in

IBM

Tivoli

Directory

Integrator

5.2:

Users

Guide).

Logging

Configuring

the

logging

of

IBM

Tivoli

Directory

Integrator

is

done

globally

or

specifically,

using

the

ibmditk

tool,

for

each

AssemblyLine,

EventHandler

and

Server.

To

provide

this

level

of

flexibility

and

customization,

the

Java

Log4J

API

is

used.

Only

the

parameters

that

describe

how

messages

are

logged

are

described

here.

All

log

configuration

windows

operate

in

the

same

way:

For

each

one

you

can

set

up

one

or

more

log

schemes.

These

are

active

at

the

same

time,

in

addition

to

whatever

defaults

are

set

in

the

log4j.properties

and

executetask.properties

files.

The

possible

log

schemes

are

as

follows:

IDIFileRoller

Sometimes,

you

want

to

log

to

file

but

keep

a

limited

number

of

files,

as

they

can

fill

your

disks.

IDIFileRoller

generates

a

new

file

for

each

run

of

the

Server.

The

system

saves

only

the

specified

number

of

previous

logs.

If

your

log

is

called

mylog.txt,

and

you

ask

for

2

generations,

then

after

3

runs

you

have

a

mylog.txt

(last

run)

as

well

as

the

files

mylog.txt.1

and

mylog.txt.2,

where

mylog.txt.2

is

the

oldest

log.

From

this

point,

you

do

not

get

more

files,

only

newer

versions

with

the

same

name.

Keep

two

generations

of

backup

files.

IDIFileRoller

has

the

following

parameters:

©

Copyright

IBM

Corp.

2003

19

Page 28: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

File

Path

The

name

of

the

file

to

log

to.

The

path

is

relative

to

where

you

installed

IBM

Tivoli

Directory

Integrator.

The

special

macro

{0}

used

in

filenames

is

replaced

by

the

name

of

the

Server.

Similarly,

{1}

used

in

filenames

is

replaced

by

a

unique

identifier

generated

by

the

system

for

you.

The

{1}

macro

has

no

relevance

for

the

special

case

where

you

use

IDIFileRoller,

but

is

important

where

you

want

unique

file

names.

Number

of

backup

files

If

your

File

Path

was

mylog.txt,

and

you

select

2

backup-files,

the

two

previous

runs

have

their

files

renamed

to

mylog.txt.1

and

mylog.txt.2

when

you

run

a

third

time.

Layout

Determines

the

format

of

the

log

message.

Options

are:

v

Pattern

(used

if

you

want

to

customize

the

way

the

messages

are

logged)

v

Simple

(format

containing

just

the

loglevel

and

the

message)

v

HTML

(creates

an

HTML

file

containing

some

(relative)

time

info,

thread

info,

loglevel,

category,

and

message)

v

XML

(similar

to

HTML,

but

generates

an

XML

file

(using

namespace-prefix

log4j))

Pattern

Only

used

when

Layout

is

Pattern.

See

″Creating

your

own

log

strategies″

in

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide.

Log

level

Severity

level

of

the

log

messages.

Options

are

(from

maximum

to

minimum

information):

v

DEBUG

v

INFO

v

WARN

v

ERROR

v

FATAL

Log

Enabled

Click

to

enable

the

use

of

this

appender.

Console

Logs

to

the

console

(standard

output).

This

is

in

the

window

where

you

started

the

server

(ibmdisrv)

or

the

execute

task-window

in

the

Config

Editor

(ibmditk).

Console

has

the

following

parameters:

Layout

See

IDIFileRoller,

previous.

Pattern

See

IDIFileRoller,

previous.

Log

level

See

IDIFileRoller,

previous.

Log

Enabled

See

IDIFileRoller,

previous.

File

Logs

to

a

file.

File

has

the

following

parameters:

20

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 29: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

File

Path

See

IDIFileRoller,

previous.

Append

to

file

Click

to

append

log

information

to

file.

If

this

is

not

checked,

the

file

is

overwritten.

Layout

See

IDIFileRoller,

previous.

Pattern

See

IDIFileRoller,

previous.

Log

level

See

IDIFileRoller,

previous.

Log

Enabled

See

IDIFileRoller,

previous.

Syslog

Enables

IBM

Tivoli

Directory

Integrator

to

log

on

UNIX®

Syslog.

Syslog

has

the

following

parameters:

Host

name/IP

Address

Host

to

log

to.

Syslog

Facility

Legal

facilities

found

in

the

drop-down.

Must

be

supported

by

the

host

you

are

logging

to.

Print

Facility

String

If

set,

the

printed

message

includes

the

facility

name

of

the

application.

Layout

See

IDIFileRoller,

previous.

Pattern

See

IDIFileRoller,

previous.

Log

level

See

IDIFileRoller,

previous.

Log

Enabled

See

IDIFileRoller,

previous.

NTEventLog

Enables

applications

to

log

using

the

Windows

NT®

EventHandler

(on

Windows

platforms).

NTEventLog

has

the

following

parameters:

Layout

See

IDIFileRoller,

previous.

Pattern

See

IDIFileRoller,

previous.

Log

level

See

IDIFileRoller,

previous.

Log

Enabled

See

IDIFileRoller,

previous.

Chapter

6.

Logging

and

debugging

21

Page 30: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

DailyRollingFile

DailyRollingFile

saves

old

files

with

a

datestamp

in

their

names.

It

usually

is

used

with

the

Append

to

file

parameter

set

to

true.

DailyRollingFile

has

the

following

parameters:

File

Path

See

IDIFileRoller,

previous.

Append

to

file

Create

new

file

or

append

to

existing

file,

depending

on

whether

this

is

checked.

You

usually

want

this

on

when

using

the

DailyRollingFile.

Date

Pattern

How

often

the

file

is

rotated.

Use

the

drop-down

to

choose

resolution

from

minutes

to

months.

For

example,

if

the

File

Path

is

set

to

example.log

and

the

DatePattern

set

to

’.’yyyy-MM-dd,

on

2003-10-31

at

midnight,

the

logging

file

example.log

is

copied

to

example.log.2003-10-31.

Logging

for

2003-11-01

continues

in

example.log

until

it

rolls

over

the

next

day.

Layout

See

IDIFileRoller,

previous.

Pattern

See

IDIFileRoller,

previous.

Log

level

See

IDIFileRoller,

previous.

Log

Enabled

See

IDIFileRoller,

previous.

MOBJ

AMC

shows

log

files

generated

by

MOBJ

loggers

only.

MOBJ

has

the

following

parameters:

Pattern

Specifies

the

format

of

the

log

as

defined

by

LOG4J.

The

default

value

is:

"%d{ISO8601}

%-5p

[%c]

-

%m%n"

Additional

values

available

in

the

field

are:

"%d{HH:mm:ss}

%p

[%t]

-

%m%n"

"%p

[%t]

%c

%d{HH:mm:ss,SSS}

-

%m%n"

Log

level

See

IDIFileRoller,

previous.

Log

Enabled

See

IDIFileRoller,

previous.

Log

Levels

Log

levels

can

be

v

ALL

v

DEBUG

v

INFO

v

WARN

v

ERROR

v

FATAL

22

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 31: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

v

OFF

ALL

logs

everything.

DEBUG,

INFO,

WARN,

ERROR

and

FATAL

have

increasing

levels

of

message

filtration.

Nothing

is

logged

on

OFF.

Note

that

the

IBM

Tivoli

Directory

Integrator

logmsg

calls

log

on

INFO

level.

This

means

that

setting

loglevel

to

WARN

or

lower

silences

your

logmsg

as

well

as

all

Detailed

Log

settings.

log4j

default

parameters

These

are

some

of

the

parameters

you

find

in

the

files

log4j.properties

(for

ibmdisrv

and

ibmditk)

and

executetask.properties

(for

the

Execute

Task

window

that

you

see

in

the

Config

Editor

when

you

run

an

AssemblyLine

from

it).

Full

documentation

can

be

found

at

http://jakarta.apache.org/log4j/docs/manual.html.

log4j.rootCategory=

DEBUG,

Default

DEBUG

is

the

loglevel

for

the

named

Appender

(log4j

term

called

Default).

If

you

set

this

to

OFF

or

level

above

INFO

you

do

not

get

output

from

your

script

logmessages

(see

following):

log4j.appender.Default

Defines

what

type

of

Appender

the

named

appender

Default

is.

It

can

be

one

of

the

following:

v

IDIFileRoller

(generates

a

new

file

for

each

run

of

the

Server)

v

Console

(log

to

console)

v

File

(log

to

file)

v

Syslog

(log

to

UNIX

Syslog)

v

NTEventLog

(log

to

Windows

NT

EventLog)

v

DailyRollingFile

(saves

old

files

with

a

datestamp

in

their

names)

v

MOBJ

(AMC

shows

log

files

generated

by

MOBJ

loggers

only)

log4j.appender.Default.file

Default

log

file

for

File

Appender,

relative

to

your

installation

directory

(default

ibmdi.log).

log4j.logger.com.ibm.di.*

Log

level

of

various

IBM

Tivoli

Directory

Integrator

components.

Note

that,

for

example,

ibmditk

shows

the

log

level

of

the

IBM

Tivoli

Directory

Integrator

Config

Editor

itself

(not

the

processes

you

are

running

inside

it).

Do

not

change

these.

Creating

your

own

log

strategies

You

can

use

this

framework

to

differentiate

how

the

different

AssemblyLines

and

EventHandler

log.

Note:

This

information

is

intended

for

users

who

want

to

continue

using

global.properties

file

to

customize

logging

output.

Users

can

customize

logging

output

through

the

Config

Editor

(ibmditk).

The

following

section

defines

a

log

scheme

called

CONSOLE,

and

that

can

later

be

used

by

specific

AssemblyLines

or

EventHandlers:

Chapter

6.

Logging

and

debugging

23

Page 32: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender

log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout

log4j.appender.CONSOLE.layout.ConversionPattern=%d

[%t]

%-5p

-

%m%n0

Now

in

order

to

have

the

AssemblyLines

and

EventHandler

myAL

and

myEH,

you

need

the

lines:

log4j.logger.AssemblyLine.myAL=INFO,

CONSOLE

log4j.logger.EventHandler.myEH=INFO,

CONSOLE

Refer

to

the

full

log4j

documentation

for

description

of

the

ConversionPattern

parameters.

Here

are

some

parameters:

%d

Date/time

depending

on

format.

%p

Priority.

%c

Category.

Note:

this

is

typically

in

the

form

Type.alName.xxx.

Type

can

be

EventHandler

or

AssemblyLine,

alName

is

the

name

of

the

AssemblyLine

(or

EventHandler

as

name

by

the

creator),

and

xxx

is

a

unique

ID

for

the

thread.

%c{2}

outputs

alName.

%m

Message.

%n

Newline.

%t

Threadname.

24

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 33: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Chapter

7.

Administration

and

Monitor

Console

Administration

and

Monitor

Console

Considerations

The

Administration

and

Monitor

Console

(AMC)

lets

you

monitor

your

AssemblyLines

by

pointing

a

browser

to

a

host

(default

http://server_ip_address:8989).

IBM

Tivoli

Directory

Integrator

Servers

are

AMC-enabled

by

the

-m

switch

(see

″IBM

Tivoli

Directory

Integrator

command

line

options″

in

IBM

Tivoli

Directory

Integrator

5.2:

Reference

Guide)

or

the

global

properties

amc.on

and

mobj.on

(see

″amc.on″

on

page

28).

IBM

Tivoli

Directory

Integrator

Server

operates

with

a

single

configuration.

All

Administration

and

Monitor

Console

users

connected

to

an

IBM

Tivoli

Directory

Integrator

Server

at

a

given

time

work

on

and

see

the

same

configuration.

That

is

why

when

a

user

modifies

the

configuration,

another

user

works

with

the

updated

configuration

even

though

they

have

not

changed

the

configuration.

Another

consequence

of

there

being

only

one

configuration

is

that

when

a

user

saves

the

configuration,

they

might

save

other

users’

changes

the

configuration

without

being

aware

of

it.

The

bottom-line

is

that

AMC

does

not

provide

configuration

isolation

between

users.

When

you

activate

the

IBM

Tivoli

Directory

Integrator

Config

Editor,

the

IBM

Tivoli

Directory

Integrator

Server

itself

is

not

started.

Whenever

you

activate

an

AssemblyLine

or

EventHandler

from

the

IBM

Tivoli

Directory

Integrator

Config

Editor,

a

new

system

process

is

started

which

runs

the

IBM

Tivoli

Directory

Integrator

Server

with

the

AssemblyLine

or

EventHandler

you

have

chosen,

for

example,

if

you

start

two

AssemblyLines

consecutively

from

the

IBM

Tivoli

Directory

Integrator

Config

Editor,

there

are

two

IBM

Tivoli

Directory

Integrator

Servers

running

on

your

machine,

one

supporting

the

first

AssemblyLine,

the

second

Server

supporting

the

second

AssemblyLine.

AMC

itself

is

a

Web

interface

for

managing

a

single

IBM

Tivoli

Directory

Integrator

Server.

When

you

start

AssemblyLines

or

EventHandlers

from

IBM

Tivoli

Directory

Integrator

Config

Editor,

AMC

is

disabled

for

the

correspondingly

started

IBM

Tivoli

Directory

Integrator

Servers.

You

cannot

work

on

the

same

IBM

Tivoli

Directory

Integrator

Server

(and

operate

on

the

memory

representation

of

the

server’s

configuration)

from

IBM

Tivoli

Directory

Integrator

Config

Editor

and

AMC.

AMC

(and

the

underlying

management

engine

called

MOBJ)

are

enabled

with

the

-m

option

when

you

start

the

IBM

Tivoli

Directory

Integrator

Server

(ibmdisrv)

from

the

command

prompt.

Note:

You

can

change

an

IBM

Tivoli

Directory

Integrator

configuration

disk

file

both

from

the

IBM

Tivoli

Directory

Integrator

Config

Editor

and

from

AMC.

In

this

case

AMC

and

IBM

Tivoli

Directory

Integrator

Config

Editor

have

nothing

in

common

and

they

just

compete

to

write

on

a

single

file

on

the

disk.

It

is

only

the

operating

system

that

guards

from

concurrent

©

Copyright

IBM

Corp.

2003

25

Page 34: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

modification,

and

basically

the

one

who

saves

last

(IBM

Tivoli

Directory

Integrator

Config

Editor

or

AMC)

has

its

configuration

state

saved

in

the

disk

file.

Apply

Changes

approach

After

entering

a

new

value

for

a

setting,

attribute,

parameter

or

anything

else,

click

Apply

Changes

(on

the

corresponding

screen)

in

order

to

apply

the

changes

to

the

loaded

configuration

on

the

IBM

Tivoli

Directory

Integrator

server.

If

you

don’t

click

Apply

Changes

then

the

value

you

have

entered

is

not

applied

to

the

configuration

on

the

server,

and

if

you

later

save

the

configuration,

your

changes

are

not

saved.

That

is

why

if

you

want

to

save

your

changes

right

after

you

have

entered

them

you

must

click

Apply

Changes

and

then

click

Save

to

save

the

configuration.

If

you

modify

the

configuration,

AMC

displays

an

asterisk

(*)

in

front

of

the

configuration

name

as

a

reminder

that

you

have

not

saved

your

changes.

When

you

save

the

configuration

(by

clicking

Save)

the

asterisk

disappears.

Note

that

other

users’

modifications

and

saves

of

the

configuration

do

not

show

or

hide

the

asterisk.

Browser

compatibility

AMC

has

been

tested

with

Internet

Explorer

6.0,

Netscape

6.0

and

Opera

6.0.

Note:

On

Opera

6.0,

modify

the

default

browser

cache

settings

to

avoid

AMC

malfunction:

1.

Go

to

File->Preferences.

2.

Select

History

and

Cache

in

the

Network

section.

3.

Select

Always

in

the

Check

modified

\

Documents

section.

You

might

experience

that

the

back

button

of

your

browser

does

not

always

work.

If

this

is

the

case,

the

back

link

is

generated

in

the

AMC

pages

themselves.

SSL

support

AMC

supports

SSL.

See

“AMC

setup”

on

page

28

for

detailed

information

on

how

to

turn

on

and

configure

SSL.

When

SSL

is

turned

off,

AMC

is

accessed

from

the

browser

at

http://host:port.

When

SSL

is

turned

on,

AMC

is

accessed

from

the

browser

at

https://host:port.

Some

AMC

functions

TCB-aware

(All

and

AssemblyLines

screens)

If

an

AssemblyLine’s

TCB

defines

input

parameters,

then

AMC

displays

a

Run...

button

in

the

AssemblyLine’s

table

row

on

the

Configuration\AssemblyLines

AMC

page.

When

you

click

this

button,

a

pop-up

window

is

displayed

in

which

you

are

prompted

to

enter

values

for

the

AssemblyLine

input

parameters.

You

can

start

the

AssemblyLine

by

clicking

the

Run

button

in

the

pop-up

window.

If

an

AssemblyLine

does

not

have

a

TCB,

or

the

AssemblyLine’s

TCB

defines

no

input

parameters,

then

a

simple

Run

button

is

displayed

on

the

AssemblyLine’s

table

row.

Click

this

button

to

start

the

AssemblyLine

(not

dealing

with

TCB).

Server

Operations

screen

The

following

operations

are

available:

Reload

configuration

Refreshes

(reloads)

the

current

configuration

from

where

it

was

loaded.

26

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 35: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Load

Configuration

from

File

Loads

the

configuration

saved

in

the

specified

file.

Note:

AMC

cannot

be

used

to

load

encrypted

configuration

files.

Load

Configuration

from

URL

This

is

a

two-step

process,

carried

out

automatically

from

AMC.

You

must

specify

a

URL

and

a

local

filename

(local

for

the

IBM

Tivoli

Directory

Integrator

server

machine).

When

you

click

Load

Configuration

from

URL,

AMC

downloads

the

configuration

specified

by

the

URL

and

saves

it

on

the

IBM

Tivoli

Directory

Integrator

server

machine

into

the

local

file

specified.

Then

AMC

loads

the

configuration

from

the

local

file

specified.

Save

Configuration

Saves

the

current

configuration

to

where

it

was

loaded

from

(if

possible).

Save

Configuration

as

Saves

the

current

configuration

into

the

specified

file

on

the

local

IBM

Tivoli

Directory

Integrator

server

machine.

Shutdown

Server

Stops

the

IBM

Tivoli

Directory

Integrator

server.

Note

that

stopping

the

IBM

Tivoli

Directory

Integrator

server

also

stops

AMC.

That

is

why

you

cannot

use

AMC

after

shutting

the

IBM

Tivoli

Directory

Integrator

server

down,

nor

can

you

start

the

IBM

Tivoli

Directory

Integrator

server

again

from

AMC.

Import

screen

v

Configuration

Path

The

path

to

the

configuration

file

to

import

from.

The

path

syntax

depends

on

the

configuration

driver

used.

Probably

the

most

often

used

path

is

a

filename

on

the

local

IBM

Tivoli

Directory

Integrator

server

machine

(when

using

old-style

configurations

or

XML

configurations).

v

In

each

of

AssemblyLine

Name,

EventHandler

Name,

Connector

Name,

Parser

Name

and

Script

Name

text

boxes

you

must

enter

the

name

of

the

corresponding

component

you

want

to

import

and

then

click

the

corresponding

Import

button.

The

result

is

that

the

configuration

of

the

specified

component

is

copied

into

the

current

configuration.

v

Download

and

save

Server

Configuration

This

feature

is

provided

for

convenience.

Pressing

the

Download

&

Save

button

downloads

the

configuration

file

specified

by

the

URL

and

saves

it

as

the

specified

local

filename

on

the

IBM

Tivoli

Directory

Integrator

server

machine.

You

can

then

type

or

copy

and

paste

the

local

filename

into

the

Configuration

Path

text

box

and

import

the

components

you

want.

Log

Files

Cleanup

screen

For

5.2,

AMC

only

reports

logs

generated

by

MOBJ

on

AssemblyLines

and

EventHandlers.

See

“log4j

default

parameters”

on

page

23

for

more

information

about

setting

up

AssemblyLines

and

EventHandlers

to

log

to

MOBJ.

The

Log

Files

Cleanup

section

enables

deletion

of

old

log

files

created

on

AssemblyLines

and

EventHandlers

runs.

There

are

three

sections

on

this

screen

enabling

correspondingly:

Multiple

components

logs

deletion

When

a

cleanup

operation

is

performed

from

this

section,

log

files

of

many

AssemblyLines

or

EventHandlers

or

both

are

deleted.

The

scope

is

further

specified

to

one

of:

v

All

AssemblyLines

and

EventHandlers

Chapter

7.

Administration

and

Monitor

Console

27

Page 36: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

v

All

AssemblyLines

v

All

EventHandlers

Single

AssemblyLine

When

a

cleanup

operation

is

performed

from

this

section,

only

log

files

of

the

specified

AssemblyLine

are

deleted.

Single

EventHandler

When

a

cleanup

operation

is

performed

from

this

section,

only

log

files

of

the

specified

EventHandler

are

deleted.

In

all

of

the

three

cases

described

previously,

log

files

deletion

can

be

performed

by

two

criteria:

Deletion

of

all

log

files

older

than

a

specified

date

In

this

case

all

log

files

that

were

last

modified

before

the

specified

date

are

deleted.

Deletion

of

all

log

files

except

the

latest

k

In

this

case

the

user

specifies

an

integer

k,

and

the

cleanup

deletes

all

log

files,

except

those

generated

from

the

latest

k

runs

of

each

component

in

the

scope

of

the

cleanup

operation.

Specifying

0

results

in

deletion

of

all

log

files.

AMC

setup

AMC

properties

AMC

is

configured

through

the

global.properties

file

which

resides

in

the

root

IBM

Tivoli

Directory

Integrator

folder.

If

the

properties

described

below

are

not

correctly

set

in

global.properties,

AMC

does

not

start.

The

following

are

the

basic

AMC

properties

stored

in

global.properties

(another

group

of

AMC

properties,

those

for

AMC

SSL

configuration,

are

also

stored

in

global.properties.

See

page“SSL

configuration”

on

page

30):

mobj.on

Specify

true

or

false.

Enables

the

JMX

Manageable

Object.

Note

that

this

has

some

impact

on

performance,

but

enables

the

AMC

console.

(-m

as

a

switch

to

the

server

corresponds

to

mobj.on

=

true

and

amc.on

=

true)

amc.on

Specify

true

or

false.

Note

that

mobj.on

must

be

true

for

this

to

have

any

effect.

Enables

AMC

on

the

host:port

specified

by

amc.host

and

amc.port.

(-m

as

a

switch

to

the

server

corresponds

to

mobj.on

=

true

and

amc.on

=

true).

If

amc.on

=

true,

you

cannot

start

two

parallel

processes

(for

example,

AssemblyLines

and

EventHandlers)

from

the

Config

Editor

(the

second

server

initialization

logs

an

error

message

because

the

AMC

port

is

already

busy).

amc.port

The

port

on

which

AMC

listens

for

HTTP

browser

requests.

amc.host

The

name

or

IP

address

of

the

network

interface

on

which

AMC

listens

for

incoming

HTTP

requests.

This

can

be

useful

on

computers

with

multiple

network

interfaces

(IP

addresses

accordingly).

It

can

also

be

used

as

a

security

measure.

By

setting

amc.host=localhost,

connections

from

the

local

computer

only

are

enabled.

If

this

property

is

not

specified

(default),

the

28

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 37: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

IBM

Tivoli

Directory

Integrator

Server

machine’s

IP

address

is

retrieved

and

used

(in

the

case

of

multiple

IP

addresses

on

one

machine,

only

one

IP

address

is

chosen).

Note:

To

use

the

construct

http://localhost:8989

in

your

browser,

you

must

set

amc.localhost=localhost.

Also

note

that

for

some

platforms,

setting

amc.host=0.0.0.0

makes

AMC

listen

to

all

network

interfaces,

thus

acting

as

a

wildcard.

However,

this

is

platform

dependent

and

must

not

be

relied

upon

if

you

want

portability.

amc.accountsFileName

The

file

path

of

the

file

which

stores

AMC

user

accounts.

These

accounts

are

used

for

AMC’s

basic

HTTP

authentication

and

user

roles

mechanism.

amc.xsl.path

Specifies

the

path

to

the

XSL

stylesheets.

Usually

this

is

the

path

to

the

management.jar

file

(AMC

expects

to

find

its

stylesheets

in

the

xsl

folder

in

the

specified

jar).

Another

option

for

the

amc.xsl.path

is

to

specify

the

path

to

a

folder.

In

this

case,

AMC

looks

for

its

stylesheets

in

the

specified

folder.

amc.ssl.on

Specify

true

or

false

to

correspondingly

turn

SSL

on

(true)

or

off

(false).

Accounts

configuration

file

This

is

the

file

specified

by

the

amc.accountsFileName

property

from

the

global.properties

file.

This

file

contains

the

AMC

user

accounts.

You

can

manually

edit

this

file

to

change,

add

and

remove

user

accounts.

Each

account

is

presented

in

the

form:

account[num].full_name

=

user’s

full

name

entered

here

is

displayed

in

the

browser

account[num].login_name

=

login

name

for

the

basic

authentication

required

account[num].password

=

password

for

the

basic

authentication

required

account[num].role=

one

of

"administrator"

or

"operator"

or

"user"

Users

with

administrator

role

can

use

each

and

every

feature

of

AMC.

Users

with

operator

roles

can

view

all

AMC

output,

details

for

all

components,

and

start

or

stop

AssemblyLines

or

EventHandlers.

However,

they

cannot

perform

administrator

operations,

such

as:

v

Change

or

save

an

IBM

Tivoli

Directory

Integrator

configuration.

v

Import

components.

v

Reload

or

shut

down

IBM

Tivoli

Directory

Integrator

Server.

Users

with

user

role

can

access

all

AMC

screens

from

the

main

menu,

but

they

cannot

perform

any

actions:

v

Cannot

start

and

stop

AssemblyLines

or

EventHandlers

v

Cannot

update

the

IBM

Tivoli

Directory

Integrator

configuration

v

Cannot

view

logs

and

details

for

components

such

as

parameters

and

statistics.

Here

num

represents

the

consecutive

account

number.

The

account

numbers

must

be

natural

numbers

between

0

and

1000.

Of

course,

neither

account

numbers

nor

login_name

property

values

occur

more

than

once.

Chapter

7.

Administration

and

Monitor

Console

29

Page 38: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

AMC

loads

the

user

accounts

file

on

startup

and

stores

the

loaded

accounts

until

AMC

shuts

down.

Therefore,

if

you

modify

the

user

accounts

file,

you

must

restart

AMC

before

the

changes

can

take

effect.

SSL

configuration

When

SSL

is

turned

on,

AMC

uses

the

IBM

Tivoli

Directory

Integrator

default

SSL

settings.

They

are

set

using

the

javax.net.ssl.*

properties

in

the

global.properties

file.

Note:

AMC

clients

are

browsers

and

this

forces

some

restrictions

on

the

keystore

file.

Microsoft

Internet

Explorer,

Netscape

Navigator

and

Mozilla

do

not

recognize

DSA-signed

SSL

certificates,

and

DSA

is

used

by

default

from

the

keytool

utility.

In

order

to

make

a

successful

SSL

connection

from

Internet

Explorer,

Netscape

or

Mozilla,

the

certificate

used

by

IBM

Tivoli

Directory

Integrator

(and

from

AMC)

must

use

RSA

algorithm

for

key

pair

generation.

keytool

generates

RSA

certificates

when

the

-keyalg

RSA

option

is

specified.

For

example:

keytool

-genkey

-keystore

certs

-keyalg

RSA

Example

AMC

configuration

in

global.properties

#

--------------

#

AMC

properties

#

--------------

##

If

this

is

true,

MOBJ

is

started

by

the

server

mobj.on=true

##

If

this

is

true,

and

mobj.on

is

also

true,

AMC

is

started

by

the

server

amc.on=false

#

the

port

where

AMC

listens

for

HTTP

browser

requests

amc.port=8989

#

the

AMC

host

name

or

IP

address

amc.host=220.10.3.222

#

the

file

path

of

the

file

where

AMC

user

accounts

are

stored

amc.accountsFileName=amc/accounts.txt

#

specifies

the

path

to

the

AMC

XSL

stylesheets

#

usually

this

is

the

path

to

the

management.jar

file

amc.xsl.path=jars/management.jar

#

specify

true

or

false

to

correspondingly

turn

on/off

AMC

SSL

amc.ssl.on=true

30

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 39: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Chapter

8.

IBM

Tivoli

Directory

Integrator

as

Windows

Service

The

IBM

Tivoli

Directory

Integrator

can

be

registered

and

run

as

a

Windows

Service

on

the

following

Windows

Platforms:

v

Windows

2000

Server

v

Windows

2000

Advanced

Server

v

Windows

XP

Pro

v

Windows

2003

Std.

Ed.

v

Windows

2003

Enterprise

Ed.

Installing

and

uninstalling

the

service

Installing

the

service

Do

the

following

to

install

the

IBM

Tivoli

Directory

Integrator

service:

1.

Make

sure

the

IBM

Tivoli

Directory

Integrator

is

installed.

The

install

folder

of

the

IBM

Tivoli

Directory

Integrator

is

referred

to

as

root_directory.

See

″IBM

Tivoli

Directory

Integrator

installation

instructions″

in

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide.

2.

Execute

the

following

command

from

the

root_directory/win32_service

folder:

ibmdiservice.exe

-i

Uninstalling

the

service

Do

the

following

to

uninstall

the

IBM

Tivoli

Directory

Integrator

service:

1.

Make

sure

the

IBM

Tivoli

Directory

Integrator

service

is

stopped.

2.

Execute

the

following

command

from

the

root_directory/win32_service

folder:

ibmdiservice.exe

-u

Notes:

1.

Uninstalling

the

IBM

Tivoli

Directory

Integrator

service

does

not

uninstall

the

IBM

Tivoli

Directory

Integrator

itself.

You

can

still

use

the

IBM

Tivoli

Directory

Integrator,

but

it

is

not

registered

and

run

as

a

Windows

service.

You

can

install

IBM

Tivoli

Directory

Integrator

service

again

later.

2.

If

the

IBM

Tivoli

Directory

Integrator

service

is

installed

and

you

wish

to

completely

uninstall

the

IBM

Tivoli

Directory

Integrator

(not

just

the

service),

do

the

following:

a.

Uninstall

the

Windows

service.

b.

Uninstall

the

IBM

Tivoli

Directory

Integrator

(see

″IBM

Tivoli

Directory

Integrator

installation

instructions″

in

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide).

Starting

and

stopping

the

service

The

IBM

Tivoli

Directory

Integrator

service

automatically

starts

the

IBM

Tivoli

Directory

Integrator

at

system

boot.

The

IBM

Tivoli

Directory

Integrator

is

not,

however,

automatically

started

when

the

service

is

installed.

After

installing

the

service

you

have

two

options

to

start

the

service:

v

Reboot

the

machine.

©

Copyright

IBM

Corp.

2003

31

Page 40: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

v

Start

the

IBM

Tivoli

Directory

Integrator

service

from

the

Windows

Services

panel.

Manual

start

and

stop

You

can

manually

start

and

stop

the

IBM

Tivoli

Directory

Integrator

service

from

the

Windows

Services

panel.

In

the

Services

panel

you

must

select

the

service

IBM

Tivoli

Directory

Integrator

and,

depending

on

the

Windows

version,

either

click

the

Start/Stop

button,

or

right-click

on

the

service

name

and

select

Start/Stop.

Changing

service

startup

type

By

default,

the

IBM

Tivoli

Directory

Integrator

service

is

configured

to

start

automatically

on

system

boot.

You

can

manually

change

the

service

startup

mode

from

the

Windows

Services

panel

to

Manual

or

Disabled.

Logging

The

IBM

Tivoli

Directory

Integrator

service

logs

all

messages

(error,

info

and

debug)

in

the

Application

Windows

system

log.

You

can

view

these

messages

with

the

Windows

Event

Viewer.

Configuring

the

service

The

IBM

Tivoli

Directory

Integrator

service

is

configured

through

the

ibmdiservice.props

file

placed

in

the

root_directory/win32_service

folder.

Note:

Before

running

the

service,

make

sure

this

file

is

properly

configured

as

described

in

this

section.

The

service

might

fail

if

the

file

contains

incorrect

values.The

following

properties

are

specified

in

the

ibmdiservice.props

file:

classpath

Specifies

the

Java

class

path

necessary

to

start

the

IBM

Tivoli

Directory

Integrator

(this

property

is

usually

the

same

as

the

MYCLASSPATH

variable

from

ibmdisrv.bat,

but

you

can

change

it).

This

is

a

required

property.

path

Specifies

the

PATH

environment

variable

used

for

running

the

IBM

Tivoli

Directory

Integrator

process

(this

property

is

usually

the

same

as

the

PATH

variable

from

ibmdisrv.bat,

but

you

can

change

it).

This

is

an

optional

property.

ibmdiroot

Specifies

the

root

folder

of

the

IBM

Tivoli

Directory

Integrator

(for

example,

C:\Program

Files\IBM\IBMDirectoryIntegrator).

This

is

a

required

property.

configfile

Specifies

the

file

path

to

the

IBM

Tivoli

Directory

Integrator

configuration

file.

This

is

a

required

property.

32

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 41: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

assemblylines

Specifies

in

a

comma-delimited

format

the

AssemblyLines

that

are

started

automatically

when

the

IBM

Tivoli

Directory

Integrator

service

is

started.

This

is

an

optional

property.

eventhandlers

Specifies

in

a

comma-delimited

format

the

EventHandlers

that

are

started

automatically

when

the

IBM

Tivoli

Directory

Integrator

service

is

started.

This

is

an

optional

property.

cmdoptions

Specifies

other

command

line

options

that

are

directly

passed

to

the

IBM

Tivoli

Directory

Integrator

on

service

startup

(see

″IBM

Tivoli

Directory

Integrator

command

line

options″

in

IBM

Tivoli

Directory

Integrator

5.2:

Users

Guide

for

the

full

list

of

IBM

Tivoli

Directory

Integrator

command

line

options).

This

is

an

optional

property.

debug

Specifies

true

or

false

to

correspondingly

turn

debug

information

on

or

off.

When

debug

information

is

turned

on,

detailed

trace

messages

are

dumped

in

the

Application

Windows

system

log.

This

is

an

optional

property.

Note:

When

specifying

properties

in

the

configuration

file,

specify

each

property

on

a

single

line

and

use

the

following

format:

<property_name>=<property_value>

There

must

be

no

spaces

around

the

equals

(

=

)

sign.

An

example

of

a

completed

ibmdiservice.props

file

looks

like

the

following:

classpath="IDILoader.jar";"jars\log4j-1.2.jar";"jars\dsml.jar";

"jars\activation.jar";"jars\comm.jar";"jars\ibmjndi.jar";"jars\imap.jar";

"jars\jaas.jar";"jars\ldapbp.jar";"jars\mail.jar";"jars\mailapi.jar";

"jars\pop3.jar";"jars\smtp.jar";"jars\xalan.jar";"jars\xercesImpl.jar";

"jars\dom.jar";"jars\sax.jar";"jars\xsltc.jar";"jars\xml-apis.jar";

"jars\xmlParserAPIs.jar";"jars\ibmjlog.jar";"jars\saaj-api.jar";

"jars\saaj-ri.jar";"jars\commons-logging.jar";"jars\wsdl4j.jar";

"jars\ncso.jar";"jars\dom4j.jar";"jars\ibmpkcs.jar";"jars\ibmpkcs11.jar";

"jars\db2j.jar";"jars\antlr-2.7.2.jar";"jars\dsml2.jar";"jars\ldapjdk.jar";

"jars\castor-0.9.4.1-xml.jar";"jars\jakarta-regexp-1.2.jar"

path=C:\Program

Files\IBM\IBMDirectoryIntegrator\_jvm\bin;

C:\Program

Files\IBM\IBMDirectoryIntegrator\libs;

ibmdiroot=C:\Program

Files\IBM\IBMDirectoryIntegrator

configfile=rs.xml

assemblylines=AssemblyLine1,AssemblyLine2

eventhandlers=EventHandler1,EventHandler2

cmdoptions=-m

debug=false

Note:

If

you

change

any

of

the

properties

in

ibmdiservice.props,

you

must

restart

the

service

for

the

changes

to

take

effect.

Chapter

8.

IBM

Tivoli

Directory

Integrator

as

Windows

Service

33

Page 42: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

34

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 43: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Appendix

A.

Dictionary

of

terms

LDAP

terms

Distinguished

Name

(DN)

In

LDAP

terms

the

fully

qualified

name

of

an

object

in

the

directory.

It

is

usually

written

in

a

format

known

as

the

User

Friendly

Name

(UFN).

The

name

is

a

sequence

of

(RDNs)

separated

by

a

single

comma

(

,

).

Relative

Distinguished

Name

(RDN)

In

LDAP

terms

the

name

of

an

object

that

is

unique

relative

to

its

siblings.

RDNs

have

the

form

attribute

name=attribute

value.

cn=John

Doe

IBM

Tivoli

Directory

Integrator

terms

Accumulator

A

special

object

in

the

Task

Call

Block

that

lets

you

accumulate

data

from

a

called

AssemblyLine

and

return

it

in

one

chunk.

Advanced

EventHandler

Wraps

up

even

more

than

the

Standard

EventHandler

in

the

Config

Editor.

AL

Shorthand

for

AssemblyLine.

Appender

Appender

is

a

log4j

term

(a

third

party

Java

library)

for

a

module

that

directs

log-messages

to

a

certain

device

or

repository.

Not

used

consistently

within

IBM

Tivoli

Directory

Integrator.

AssemblyLine

The

basic

work

object

within

a

Server

(see

page

38).

It

consists

of

Connectors,

Parsers

and

business

logic.

Connectors

feed

data

in

and

out

of

the

AssemblyLine.

Attribute

Contained

in

Entries

(see

page

36)

and

holding

Values

(single

or

multiple).

See

also

Task

Parameters

(see38).

Attribute

Mapping

Mapping

of

Attributes

from

the

data

source

to

the

AssemblyLine.

To

be

more

precise

this

is

mapping

from

the

raw

Connector

attributes

to

the

work

entry.

Attribute

mapping

is

done

either

in

the

Input

Map

tab

or

the

Output

Map

tab

(depends

of

the

mode

of

the

Connector).

CloudScape

See

″System

Store″,

page

38

Components

The

IBM

Tivoli

Directory

Integrator

consists

of

a

kernel

being

the

Server

(see

page

38)

and

the

IBM

Tivoli

Directory

Integrator

Config

Editor.

In

addition,

we

talk

about

components

such

as

Connectors,

EventHandlers

and

Parsers.

These

can,

to

a

certain

extent,

be

distributed

and

upgraded

independent

of

the

kernel.

Computed

Changes

A

special

feature

of

the

Update

mode

(see

page

38)

of

a

Connector.

©

Copyright

IBM

Corp.

2003

35

Page 44: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Config

Editor

(ibmditk

or

ibmditk.bat)

Also

known

as

the

GUI.

The

IBM

Tivoli

Directory

Integrator

server

(ibmdisrv

or

ibmdisrv.bat)

consists

of

scripts

to

run

a

Java

engine

on

a

configuration

file

that

defines

the

IBM

Tivoli

Directory

Integrator

server.

The

configuration

file

is

an

xml-format.

The

Config

Editor

is

used

to

edit

this

configuration

file

in

order

to

define

a

server.

Connector

A

plug-in

into

your

data

source

in

order

to

read

it.

Inside

the

AssemblyLine

we

differ

between

the

Raw

Connector

object

and

the

AssemblyLine

Connector

object,

the

latter

wrapping

the

former

and

having

a

different

set

of

methods.

See

″Objects″

in

IBM

Tivoli

Directory

Integrator

5.2:

Reference

Guide

for

more

information

about

objects.

Connectors

can

work

in

different

modes

(for

example,

Iterate,

Delete,

Update,

AddOnly,

Lookup

and

CallReply).

Delta

A

special

term

in

Iterator

mode,

used

when

synchronizing

a

master

and

a

slave.

See

″Deltas

and

compute

changes″

in

IBM

Tivoli

Directory

Integrator

5.2:

Users

Guide.

Entry

A

term

used

for

both

the

Entry

object

and

the

top

level

item

used

by

the

AssemblyLine

and

Connectors

(see

″Connectors″

in

IBM

Tivoli

Directory

Integrator

5.2:

Reference

Guide).

An

entry

typically

corresponds

to

a

row

in

a

database

table/view,

a

record

from

a

file

or

an

object

in

a

directory.

Entries

contain

Attributes

which

contains

Values.

For

example,

an

Iterator

might

return

the

next

person

(the

Entry),

having

the

attributes

city,

name

and

phone.

The

values

of

the

three

attributes

might

beLondon,

Holmes

and

5632.

Epilog

A

piece

of

code

that,

if

present,

is

run

after

the

AssemblyLine

data

flow

ends.

It

typically

saves

a

parameter

to

be

used

the

next

time

the

AssemblyLine

runs.

See

″AssemblyLine

setting

tab″

in

IBM

Tivoli

Directory

Integrator

5.2:

Reference

Guide..

See

also

Prolog

(page37).

EventHandler

Waits

for

a

specific

event,

and

performs

an

action.

Used

to

decide

when

AssemblyLines

are

started.

Usually

passes

an

initial

work

Entry

to

the

AssemblyLine.

External

Properties

A

way

of

externalizing

certain

Component

parameters,

such

as

filename,

user,

password

and

so

forth.

If

the

parameter

is

not

to

be

used

as

Component

parameter,

you

probably

want

to

use

Task

Parameters

(see

38).

GUI

(ibmditk

or

ibmditk.bat)

Also

known

as

the

Config

Editor.

The

IBM

Tivoli

Directory

Integrator

server

(ibmdisrv

or

ibmdisrv.bat)

consists

of

scripts

to

run

a

Java

engine

on

a

configuration

file

that

defines

the

IBM

Tivoli

Directory

Integrator

server.

The

configuration

file

is

an

xml-format.

The

GUI

is

used

to

edit

this

configuration

file

in

order

to

define

a

server.

Integrator

The

name

of

the

product.

Referred

to

as

IBM

Tivoli

Directory

Integrator.

It

consists

of

the

Config

Editor

and

the

Server

(see

page

38).

Iterator

A

Connector

in

Iterator

mode.

Java

VM

Java

Virtual

Machine.

IBM

Tivoli

Directory

Integrator

runs

inside

what

is

36

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 45: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

known

as

a

Java

Virtual

Machine.

It

has

its

own

memory

management

and

is

in

most

respects

a

Machine

within

the

Machine.

Link

Criteria

Used

to

tell

Update,

Lookup

and

Delete-mode

Connectors

what

to

access.

It

links

an

Attribute

(see

page

35)

from

the

AssemblyLine

to

a

field

(attribute,

column)

in

the

data-source.

Mode

Connectors

have

modes:

The

mode

describes

what

the

Connector

is

used

for:

v

Iterate

v

AddOnly

v

Lookup

v

Update

v

Delete

v

CallReply

See

″Connectors″

in

IBM

Tivoli

Directory

Integrator

5.2:

Reference

Guide

for

more

information

about

modes.

Null

Value

Behavior

How

Attribute

Mapping

is

to

be

done

when

attribute

values

are

missing.

Persistent

Object

Store

See

″System

Store″,

page

38.

Persistent

Parameter

Store

See

″User

Property

Store″,

page

38

Primitive

EventHandler

(

simple

EventHandler,

trigger

or

port

listener)

You

can

script

everything.

With

this

EventHandler

you

have

full

control

but

you

must

code

your

actions

by

hand.

Prolog

Code

that,

if

present,

is

run

before

the

AssemblyLine

data

flow

starts.

Code

can

be

run

both

before

and

after

all

Connectors

are

initialized.

See

also

Epilog.

Properties

Contained

in

Entries

(see

page

36)

and

holding

a

single

value.

Mostly

used

in

Handler

Action

maps.

See

also

″Attribute,″

page

35.

Raw

Connector

The

part

of

the

AssemblyLine

that

sees

the

external

data

source.

See

also

″Connectors″

in

IBM

Tivoli

Directory

Integrator

5.2:

Reference

Guide.

Sandbox

The

feature

of

the

IBM

Tivoli

Directory

Integrator

that

enables

you

to

record

AssemblyLine

operations

for

later

playback

without

any

of

the

data

sources

being

present.

See

″Sandbox″

in

IBM

Tivoli

Directory

Integrator

5.2:

Users

Guide.

Script

Component

Something

that

looks

like

a

Connector

in

the

Config

Editor.

It

can

be

regarded

as

Connector

without

pre-configured

input

or

output

capabilities.

It

is

inserted

by

a

separate

Script

utility

in

the

Config

Editor

and

is

not

confused

by

the

Connector.

Script

Connector

A

Script

Connector

is

a

Connector

where

you

write

the

functionality

yourself:

It

is

empty

in

the

sense

that,

in

contrast

to

an

already-existing

Appendix

A.

Dictionary

of

terms

37

Page 46: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Connector,

the

Script

Connector

does

not

have

the

base

methods

getNextEntry,

findEntry

and

so

forth

implemented.

Not

to

be

confused

with

the

Script

Component.

Server

(ibmdisrv

or

ibmdisrv.bat)

The

Config

Editor

lets

you

define

Servers.

Once

you

have

defined

a

Server,

it

is

started

from

the

command

line

(see

″IBM

Tivoli

Directory

Integrator

command

line

options″

in

IBM

Tivoli

Directory

Integrator

5.2:

Users

Guide)

and

perform

the

actual

work.

The

Server

might

run

AssemblyLines

directly,

but

it

might

also

start

EventHandlers

that

start

AssemblyLines

when

needed.

State

Connectors

can

be

in

one

of

these

states:

v

Enabled

(the

normal

state)

v

Passive

(initialized,

but

not

part

of

the

AssemblyLine

flow)

v

Disabled

(not

initialized

by

the

AssemblyLine)

System

Store

Also

known

as

Persistent

Object

Store,

or

POS.

The

relational

database

that

IBM

Tivoli

Directory

Integrator

uses

to

store

Delta

Tables

(if

the

CloudScape

type

is

chosen),

and

the

underlying

storage

method

for

the

objects

created

and

maintained

by

the

Checkpoint/Restart

functionality

as

well

as

the

User

Property

Store.

In

the

current

implementation,

the

IBM

DB2

for

Java

product

(also

known

as

CloudScape)

is

used.

See

http://www-3.ibm.com/software/data/cloudscape

for

more

details.

Task

By

convention,

all

threads

(AssemblyLines,

EventHandlers

and

so

forth)

are

referred

to

as

the

task

object.

Task

Call

Block

A

Java

structure

used

to

pass

parameters

to

and

from

AssemblyLines.

Task

Parameters

Parameters

that

are

saved

and

loaded

from

a

file.

Filename

to

be

set

in

the

AssemblyLine

Setting

tab.

See

also

External

Properties

(see

36).

Update

One

of

the

modes.

Update

performs

a

lookup

for

the

object

you

want

to

update,

and

if

it

is

found

it

modifies

the

existing

entry.

If

it

does

not

exist

it

adds

it.

See

also

Computed

Changes

(see

35).

User

Property

Store

An

area

of

the

System

Store

available

to

the

user

to

save

any

values

the

user

might

need.

This

is

used

for

various

items

like

saving

the

position

of

Changelogs

and

so

forth.

See

″System

Store″,

page38.

User

Store

See

″User

Property

Store″,

page38.

Value

See

″Entries,″

page

36

and

″Attribute,″

page

35.

Work

Entry

An

instance

of

the

Entry

(see

page

36)

class

called

work.

If

no

work

Entry

exists,

non-Iterator

Connectors

are

not

called.

The

work

Entry

is

an

object

that

lets

Connectors

share

data

within

an

AssemblyLine.

If

you

don’t

get

work

from

an

Iterator,

you

can

create

it

in

the

Prolog

by

using

task.setWork():

init_work

=

system.newEntry();

//

Create

a

new

Entry

object

init_work.setAttribute("uid",

"cchateauvieux");

//

populate

it

task.setWork(init_work);

//

make

it

known

as

work

to

the

Connectors

38

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 47: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Appendix

B.

Notices

This

information

was

developed

for

products

and

services

offered

in

the

U.S.A.

IBM

might

not

offer

the

products,

services,

or

features

discussed

in

this

document

in

other

countries.

Consult

your

local

IBM

representative

for

information

on

the

products

and

services

currently

available

in

your

area.

Any

reference

to

an

IBM

product,

program,

or

service

is

not

intended

to

state

or

imply

that

only

that

IBM

product,

program,

or

service

may

be

used.

Any

functionally

equivalent

product,

program,

or

service

that

does

not

infringe

any

IBM

intellectual

property

right

may

be

used

instead.

However,

it

is

the

user’s

responsibility

to

evaluate

and

verify

the

operation

of

any

non-IBM

product,

program,

or

service.

IBM

may

have

patents

or

pending

patent

applications

covering

subject

matter

in

this

document.

The

furnishing

of

this

document

does

not

give

you

any

license

to

these

patents.

You

can

send

license

inquiries,

in

writing,

to:

IBM

Director

of

Licensing

IBM

Corporation

North

Castle

Drive

Armonk,

NY

10504-1785

U.S.A.

For

license

inquiries

regarding

double-byte

(DBCS)

information,

contact

the

IBM

Intellectual

Property

Department

in

your

country

or

send

inquiries,

in

writing,

to:

IBM

World

Trade

Asia

Corporation

Licensing

2-31

Roppongi

3-chome,

Minato-ku

Tokyo

106,

Japan

The

following

paragraph

does

not

apply

to

the

United

Kingdom

or

any

other

country

where

such

provisions

are

inconsistent

with

local

law:

INTERNATIONAL

BUSINESS

MACHINES

CORPORATION

PROVIDES

THIS

PUBLICATION

“AS

IS”

WITHOUT

WARRANTY

OF

ANY

KIND,

EITHER

EXPRESS

OR

IMPLIED,

INCLUDING,

BUT

NOT

LIMITED

TO,

THE

IMPLIED

WARRANTIES

OF

NON-INFRINGEMENT,

MERCHANTABILITY

OR

FITNESS

FOR

A

PARTICULAR

PURPOSE.

Some

states

do

not

allow

disclaimer

of

express

or

implied

warranties

in

certain

transactions,

therefore,

this

statement

may

not

apply

to

you.

This

information

could

include

technical

inaccuracies

or

typographical

errors.

Changes

are

periodically

made

to

the

information

herein;

these

changes

will

be

incorporated

in

new

editions

of

the

information.

IBM

may

make

improvements

and/or

changes

in

the

product(s)

and/or

the

program(s)

described

in

this

information

at

any

time

without

notice.

Any

references

in

this

information

to

non-IBM

Web

sites

are

provided

for

convenience

only

and

do

not

in

any

manner

serve

as

an

endorsement

of

those

Web

sites.

The

materials

at

those

Web

sites

are

not

part

of

the

materials

for

this

IBM

product

and

use

of

those

Web

sites

is

at

your

own

risk.

IBM

may

use

or

distribute

any

of

the

information

you

supply

in

any

way

it

believes

appropriate

without

incurring

any

obligation

to

you.

©

Copyright

IBM

Corp.

2003

39

Page 48: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

Licensees

of

this

program

who

wish

to

have

information

about

it

for

the

purpose

of

enabling:

(i)

the

exchange

of

information

between

independently

created

programs

and

other

programs

(including

this

one)

and

(ii)

the

mutual

use

of

the

information

which

has

been

exchanged,

should

contact:

IBM

Corporation

Department

MU5A46

11301

Burnet

Road

Austin,

TX

78758

U.S.A.

Such

information

may

be

available,

subject

to

appropriate

terms

and

conditions,

including

in

some

cases,

payment

of

a

fee.

The

licensed

program

described

in

this

document

and

all

licensed

material

available

for

it

are

provided

by

IBM

under

terms

of

the

IBM

Customer

Agreement,

IBM

International

Program

License

Agreement,

or

any

equivalent

agreement

between

us.

Any

performance

data

contained

herein

was

determined

in

a

controlled

environment.

Therefore,

the

results

obtained

in

other

operating

environments

may

vary

significantly.

Some

measurements

may

have

been

made

on

development-level

systems

and

there

is

no

guarantee

that

these

measurements

will

be

the

same

on

generally

available

systems.

Furthermore,

some

measurement

may

have

been

estimated

through

extrapolation.

Actual

results

may

vary.

Users

of

this

document

should

verify

the

applicable

data

for

their

specific

environment.

Information

concerning

non-IBM

products

was

obtained

from

the

suppliers

of

those

products,

their

published

announcements

or

other

publicly

available

sources.

IBM

has

not

tested

those

products

and

cannot

confirm

the

accuracy

of

performance,

compatibility

or

any

other

claims

related

to

non-IBM

products.

Questions

on

the

capabilities

of

non-IBM

products

should

be

addressed

to

the

suppliers

of

those

products.

This

information

contains

examples

of

data

and

reports

used

in

daily

business

operations.

To

illustrate

them

as

completely

as

possible,

the

examples

include

the

names

of

individuals,

companies,

brands,

and

products.

All

of

these

names

are

fictitious

and

any

similarity

to

the

names

and

addresses

used

by

an

actual

business

enterprise

is

entirely

coincidental.

COPYRIGHT

LICENSE:

This

information

contains

sample

application

programs

in

source

language,

which

illustrate

programming

techniques

on

various

operating

platforms.

You

may

copy,

modify,

and

distribute

these

sample

programs

in

any

form

without

payment

to

IBM,

for

the

purposes

of

developing,

using,

marketing

or

distributing

application

programs

conforming

to

the

application

programming

interface

for

the

operating

platform

for

which

the

sample

programs

are

written.

These

examples

have

not

been

thoroughly

tested

under

all

conditions.

IBM,

therefore,

cannot

guarantee

or

imply

reliability,

serviceability,

or

function

of

these

programs.

You

may

copy,

modify,

and

distribute

these

sample

programs

in

any

form

without

payment

to

IBM

for

the

purposes

of

developing,

using,

marketing,

or

distributing

application

programs

conforming

to

IBM’s

application

programming

interfaces.

Each

copy

or

any

portion

of

these

sample

programs

or

any

derivative

work,

must

include

a

copyright

notice

as

follows:

40

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 49: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

©

(your

company

name)

(year).

Portions

of

this

code

are

derived

from

IBM

Corp.

Sample

Programs.

©

Copyright

IBM

Corp.

_enter

the

year

or

years_.

All

rights

reserved.

If

you

are

viewing

this

information

softcopy,

the

photographs

and

color

illustrations

may

not

appear.

Third-party

component

statements

Apache

statement

This

product

includes

software

developed

by

the

Apache

Software

Foundation

(http://www.apache.org/).

The

Apache

components

include

the

Xerces,

Xalan,

XML4J,

and

Log4J

libraries,

and

these

are

provided

in

object

code

form.

This

object

code

was

obtained

from

the

Apache

web

site

and

is

unmodified.

Apache

license

The

Apache

Software

License,

Version

1.1

Copyright

(c)

1999-2002

The

Apache

Software

Foundation.

All

rights

reserved.

Redistribution

and

use

in

source

and

binary

forms,

with

or

without

modification,

are

permitted

provided

that

the

following

conditions

are

met:

1.

Redistributions

of

source

code

must

retain

the

above

copyright

notice,

this

list

of

conditions

and

the

following

disclaimer.

2.

Redistributions

in

binary

form

must

reproduce

the

above

copyright

notice,

this

list

of

conditions

and

the

following

disclaimer

in

the

documentation

and/or

other

materials

provided

with

the

distribution.

3.

The

end-user

documentation

included

with

the

redistribution,

if

any,

must

include

the

following

acknowledgment:

″This

product

includes

software

developed

by

the

Apache

Software

Foundation

(http://www.apache.org/).″

Alternately,

this

acknowledgment

may

appear

in

the

software

itself,

if

and

wherever

such

third-party

acknowledgments

normally

appear.

4.

The

names

″Xerces″,

″Xalan″,

″log4j″,

″mx4j″

and

″Apache

Software

Foundation″

must

not

be

used

to

endorse

or

promote

products

derived

from

this

software

without

prior

written

permission.

For

written

permission,

please

contact

[email protected].

5.

Products

derived

from

this

software

may

not

be

called

″Apache″,

nor

may

″Apache″

appear

in

their

name,

without

prior

written

permission

of

the

Apache

Software

Foundation.

THIS

SOFTWARE

IS

PROVIDED

″AS

IS″

AND

ANY

EXPRESSED

OR

IMPLIED

WARRANTIES,

INCLUDING,

BUT

NOT

LIMITED

TO,

THE

IMPLIED

WARRANTIES

OF

MERCHANTABILITY

AND

FITNESS

FOR

A

PARTICULAR

PURPOSE

ARE

DISCLAIMED.

IN

NO

EVENT

SHALL

THE

APACHE

SOFTWARE

FOUNDATION

OR

ITS

CONTRIBUTORS

BE

LIABLE

FOR

ANY

DIRECT,

INDIRECT,

INCIDENTAL,

SPECIAL,

EXEMPLARY,

OR

CONSEQUENTIAL

DAMAGES

(INCLUDING,

BUT

NOT

LIMITED

TO,

PROCUREMENT

OF

SUBSTITUTE

GOODS

OR

SERVICES;

LOSS

OF

USE,

DATA,

OR

PROFITS;

OR

BUSINESS

INTERRUPTION)

HOWEVER

CAUSED

AND

ON

ANY

THEORY

OF

LIABILITY,

WHETHER

IN

CONTRACT,

STRICT

LIABILITY,

OR

TORT

(INCLUDING

NEGLIGENCE

OR

OTHERWISE)

ARISING

IN

ANY

WAY

OUT

OF

THE

USE

OF

THIS

SOFTWARE,

EVEN

IF

ADVISED

OF

THE

POSSIBILITY

OF

SUCH

DAMAGE.

Appendix

B.

Notices

41

Page 50: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

This

software

consists

of

voluntary

contributions

made

by

many

individuals

on

behalf

of

the

Apache

Software

Foundation.

For

more

information

on

the

Apache

Software

Foundation,

please

see

http://www.apache.org

Rhino

statement

The

IBM

Tivoli

Directory

Integrator

uses

Rhino

(JavaScript

for

Java)

object

code.

The

source

code

for

Rhino

is

located

at

http://www.mozilla.org/rhino/download.html

and

is

available

under

the

terms

of

the

Netscape

Public

License

1.1

(http://www.mozilla.org/MPL/NPL-1.1.html).

The

Rhino

source

code

found

on

the

mozilla

Web

site

was

not

modified

in

generating

the

object

code

used

in

IBM

Tivoli

Directory

Integrator.

Trademarks

The

following

terms

are

trademarks

of

International

Business

Machines

Corporation

in

the

United

States,

or

other

countries,

or

both:

IBM

Tivoli

AIX

Lotus

Notes

pSeries

DB2

Java,

JavaScript

and

all

Java-based

trademarks

and

logos

are

trademarks

or

registered

trademarks

of

Sun

Microsystems,

Inc.

in

the

United

States

and

other

countries.

Microsoft,

Windows

NT

and

Windows

are

registered

trademarks

of

Microsoft

Corporation.

Intel

is

a

trademark

of

Intel

Corporation

in

the

United

States,

other

countries,

or

both.

UNIX

is

a

registered

trademark

of

The

Open

Group

in

the

United

States

and

other

countries.

This

product

includes

software

developed

by

the

Apache

Software

Foundation

(http://www.apache.org/).

Other

company,

product,

and

service

names

may

be

trademarks

or

service

marks

of

others.

42

IBM

Tivoli

Directory

Integrator

5.2:

Administrator

Guide

Page 51: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide
Page 52: IBM Tivoli Directory Integrator 5.2: Administrator Guidepublib.boulder.ibm.com/tividd/td/IBMDI/SC32-1379-00/en_US/PDF/... · 4 IBM Tivoli Directory Integrator 5.2: Administrator Guide

����

Printed

in

USA

SC32-1379-00