Home > Documents > Legend for Diagrams - IBM · Legend for Diagrams Hook Flow diagrams Lookup ... The Continuation...

Legend for Diagrams - IBM · Legend for Diagrams Hook Flow diagrams Lookup ... The Continuation...

Date post: 26-Aug-2018
Category:
Author: hoangdien
View: 215 times
Download: 0 times
Share this document with a friend
Embed Size (px)
of 22 /22
Legend for Diagrams Hook Flow diagrams Lookup Attribute Map Continue from Previous Iterator or Start of AL On Multiple Entries* Multiple Entries Found?* Yes No On Error Add Black arrows indicate normal flow. Red arrows show error/exception flow. Errors can occur both in scripted flow components, as well as in Integrator operations. The Flow Endpoint symbol represents the start or end of the flow for a flow diagram. The text contained in the symbol provides more information about system state and behavior at this point. These boxes represent scripted flow components, and are used for both Attribute Maps and Hooks. Note that if a Hook is enabled, then control is passed to the script in the Hook. If a Hook is not enabled, then the flow continues past the Hook without executing it. A few Hooks are mandatory and must be enabled, although they do not need to actually contain any script. If a mandatory Hook is not enabled and the flow reaches this point, then this is considered an error, and control faults out to error handling. This box represents an Integrator operation (these are available as functions in the component Interface object. Note that Integrator operations may also result in error flows. Decision components represent logical branches in component flow execution, depending on state information at this point. The Continuation symbol indicates that the flow is continued on another page that is common for one or more modes. The page being referenced will appear in a label below this symbol. This is a Continuation symbol that is used when the referenced page is still part of the same component mode flow. The page being referenced will appear in a label below this symbol. Hook Flow rev. 7.0 20081028 Directory Integrator For Each Non-Iterator (Enabled) Mode- specific Flow* The yellow trapezoid describe flow which is detailed elsewhere (i.e. on another page in this document. The optional rounded blue box includes the
Transcript
  • Legend for DiagramsHook Flow diagrams

    Lookup

    Attribute Map

    Continuefrom

    Previous Iteratoror Start of

    AL

    On MultipleEntries*

    MultipleEntries Found?* Yes

    No

    OnError

    Add

    Black arrows indicate normal flow.

    Red arrows show error/exception flow. Errors can occur both in scriptedflow components, as well as in Integrator operations.

    The Flow Endpoint symbol represents the start or end of the flow for aflow diagram. The text contained in the symbol provides more informationabout system state and behavior at this point.

    These boxes represent scripted flow components, and are used for bothAttribute Maps and Hooks. Note that if a Hook is enabled, then control ispassed to the script in the Hook. If a Hook is not enabled, then the flowcontinues past the Hook without executing it.

    A few Hooks are mandatory and must be enabled, although they do notneed to actually contain any script. If a mandatory Hook is not enabledand the flow reaches this point, then this is considered an error, andcontrol faults out to error handling.

    This box represents an Integrator operation (these are available asfunctions in the component Interface object. Note that Integratoroperations may also result in error flows.

    Decision components represent logical branches in component flowexecution, depending on state information at this point.

    The Continuation symbol indicates that the flow is continued on anotherpage that is common for one or more modes. The page being referencedwill appear in a label below this symbol.

    This is a Continuation symbol that is used when the referenced page isstill part of the same component mode flow. The page being referencedwill appear in a label below this symbol.

    Hook Flow rev. 7.020081028

    Directory Integrator

    For Each Non-Iterator

    (Enabled)

    Mode-specificFlow*

    The yellow trapezoid describe flow which is detailed elsewhere (i.e. onanother page in this document. The optional rounded blue box includesthe

  • For Each Flowcomponent

    (Enabled)

    *Flow References

    These yellow trapezoidsrepresent flows

    found inthe AssemblyLine

    components.

    Initialization Flowsare found on the

    pages entitledInitialization & Close

    Flows

    Iterator Flow isdescribed on thepage for Iterator

    Mode flow.

    Mode-specific Flowcan be found

    on the page(s)for that component

    Mode.

    AssemblyLine FlowHook Flow diagrams

    Work Entry

    Available?+

    Epilog -Before Close

    Hook Flow rev. 7.020081028

    Directory Integrator

    Active IteratorAvailable? Yes

    Work EntryExists?

    No

    Zero out Work Entry

    Yes

    Epilog -After Close

    Prolog -Before

    Initialization

    Prolog -After

    Initialization

    Yes

    No

    For Each component

    (Enabled & Passive)

    InitializationFlow*

    Process TCB

    Load AL Configuration

    GlobalPrologs

    IteratorFlow*

    Mode-specificFlow*

    For Each component

    (Enabled & Passive)

    CloseFlow*

    AL Termination

    On Start ofCycle

    +Work Entry Available

    This test checks to see if thereis an Entry object whichis to be used as work for

    the new cycle.

    This Entry can be providedin a number of ways:

    o an Initial Work Entry (IWE)o via a call to task.setWork()o using system.restartEntry()

    Switch to next Iterator

    No

  • Directory Integrator

    Prolog -Before

    Initialization

    Connector Initialization

    Prolog -After Selection

    Connector inIterator Mode?

    Prolog -Before Selection

    Yes

    selectEntries() call

    Prolog -After Initialization

    No

    Continue fromAssemblyLineProlog - Before

    Intialization

    Continue toAssemblyLine

    Prolog(After

    Initialization)

    ConnectorInitialization Flow

    Hook Flow diagrams

    Hook Flow rev. 7.020081028

    Available Objects

    The work object is notavailable in Initialization

    Hooks (unless it isprovided as an

    Initial Work Entry (IWE).

    As always, if anError Hook

    is enabled, the errorflow continues anddoes not go to the

    Error Flow.

    No

    Is ErrorHandled (and not

    re-thrown) in Hookabove?

    Yes

    PrologOn Error

    AbortAssemblyLine(AL On Error

    will beexecuted)

    error

    Available temporaryscript variables

    Error Handling

    Please note that if the Prolog OnError Hook is enabled, then control

    is passed to back to theAssemblyLine flow;

    Otherwise, the AssemblyLineaborts.

    The error condition can bepassed on to next On Error

    Hook (i.e. to theAssemblyLine Error Hook)

    by re-throwing the exception:

    throw error.getObject(exception);

    Furthermore, if an error occursin an On Error Hook, then

    the AssemblyLine will also abort.

    The error object (of type Entry) isavailable throughout an

    AssemblyLine, and providesinformation about the error situation

    through its attributes:status, exception, class, message,

    operation and connectorname.

    The status attributewill have the string value OK

    until an error situation arises, atwhich time it is assigned

    the value fail and the otherattributes are added to error.

    t

  • Directory Integrator

    ConnectorClose FlowHook Flow diagrams

    Hook Flow rev. 7.020081028

    Epilog -Before Close

    Connector Close

    Epilog -After Close

    Continue fromAssemblyLineEpilog - Before

    Close

    Continue toAssemblyLine

    Epilog(After Close)

    Available Objects

    Close Hooks willhave access to the

    last work Entryprocessed by the

    AssemblyLine

    As always, if anError Hook

    is enabled, the errorflow continues anddoes not go to the

    Error Flow.

    No

    Is ErrorHandled (and not

    re-thrown) in Hookabove?

    Yes

    Epilog -On Error

    AbortAssemblyLine(AL On Error

    will beexecuted)

    error

    Available temporaryscript variables

    Error Handling

    Please note that if the Prolog OnError Hook is enabled, then control

    is passed to back to theAssemblyLine flow;

    Otherwise, the AssemblyLineaborts.

    The error condition can bepassed on to next On Error

    Hook (i.e. to theAssemblyLine Error Hook)

    by re-throwing the exception:

    throw error.getObject(exception);

    Furthermore, if an error occursin an On Error Hook, then

    the AssemblyLine will also abort.

    The error object (of type Entry) isavailable throughout an

    AssemblyLine, and providesinformation about the error situation

    through its attributes:status, exception, class, message,

    operation and connectorname.

    The status attributewill have the string value OK

    until an error situation arises, atwhich time it is assigned

    the value fail and the otherattributes are added to error.

    t

  • OnSuccess

    OnError

    End-Of-Flow

    work conn

    Available Objects

    As always, work gives youaccess to the attributes that

    are currently inthe AssemblyLine.

    The information stored inthe conn object is

    written to the data source bythe Add operation.

    AddOnly ModeHook Flow diagrams

    Continuefrom

    previouscomponent or

    Start ofAL

    Before Execute

    OverrideAddOnlyEnabled?

    Yes

    No

    OverrideAddOnly

    OutputAttribute Map

    Before Add

    After Add

    Add

    Hook Flow rev. 7.020081028

    Directory Integrator

    Available temporaryscript variables

  • OnSuccess

    OnError

    End-Of-Flow

    work conn

    Available Objects

    As always, work gives youaccess to the attributes that

    are currently inthe AssemblyLine.

    *The information stored inthe conn object is

    slightly different in thismode.

    It is important to note thatthe conn object servestwo different purposesin Call/Reply mode:

    1) Storing the callattributes/parameters

    defined in theOutput Attribute Mapto be transmitted by the

    Call/Reply operation,

    2) Receiving returnattributes/parameters that

    will be accessed by theInput Attribute Mapafter the Call/Reply

    operation

    Call/Reply ModeHook Flow diagrams

    Continuefrom

    previouscomponent or

    Start ofAL

    Before Execute

    OverrideCall/ReplyEnabled?

    Yes

    NoOverrideCallReply

    OutputAttribute Map

    BeforeCall/Reply

    AfterCall/Reply

    Call/Reply

    Hook Flow rev. 7.020081028

    Directory Integrator

    InputAttribute Map

    *

    Available temporaryscript variables

    AnswerReceived?

    No AnswerReturned

  • Delete 2/2

    Delete OnError

    End-Of-Flow

    Delete Mode 1/2Hook Flow diagrams

    work conn

    Available Objects

    As always, work gives youaccess to the attributes that

    are currently inthe AssemblyLine.

    After the Build Link Criteriaoperation, there is a script object

    called search availablewhich gives you access to this

    information (i.e. for use inthe Override Hook).

    The record/entry matchingthe Link Criteria (and that

    is about to be deleted)is available for scripting as

    the conn object, andAttribute Mapping is carried out

    to allow your AssemblyLineto use Attributes from

    the Entry which is to bedeleted.

    *On Multiple EntriesIf more than one record/entry is

    found that matches the Link Criteriathen the On Multiple Entries

    Hook must also be enabled, or thisis treated as an error.

    You can access the set ofrecords/entries found by usingeither of these two Connector

    functions:

    getFirstDuplicateEntry()or

    getNextDuplicateEntry()

    Each of these functions returnsan Entry object that can be used

    to call a Connector Interfacesdata access methods

    (.update(), delete(), etc.).

    If you wish to proceed withthe delete flow/operation, then you

    must set the current Entrywith the following Connector

    function:

    myConnector.setCurrent( myEntry )

    If you do not set a currentEntry, then execution willcontinue to On Success,

    bypassing the rest of the mode-specific flow.

    Note:

    Data sources behave differentlywhen multiple Entries are

    to be handled.

    Even if you select a specificEntry as described above,

    it is not recommendedthat you continue with

    the delete flow,as this may result in

    an error, or that the operation isperformed on multiple entries.

    Continuefrom

    previouscomponent or

    Start ofAL

    Before Execute

    OverrideDelete

    Enabled?Yes

    No

    Lookup

    Build Link Criteria

    MultipleEntries Found?*

    Yes

    No

    OverrideDelete

    On MultipleEntries*

    Current EntrySet?

    Yes

    No

    Hook Flow rev. 7.020081028

    Directory Integrator

    Build Link Criteria

    Before Lookup

    OnSuccess

    Available temporaryscript variables

  • OnSuccess

    OnError

    End-Of-Flow

    Delete Mode 2/2Hook Flow diagrams

    work conn

    Before Delete

    Delete

    After Delete

    InputAttribute Map

    Hook Flow rev. 7.020081028

    Directory Integrator

    (contd)Delete

    Match Found?

    Yes

    No

    On No Match

    After Lookup

    Available temporaryscript variables

    current

  • Delta 2/4 End-Of-Flow

    OnSuccess

    OnError

    Delta Mode 1/4Hook Flow diagrams

    Before Execute

    OverrideDelta

    Continuefrom

    previouscomponent or

    Start ofAL

    DeltaSupport

    work

    OverrideDelta

    Enabled?

    No

    Available Objects

    As always, work gives youaccess to the attributes that

    are currently inthe AssemblyLine.

    After the Build Link Criteriaoperation, there is a script object

    called search availablewhich gives you access to this

    information (e.g. for use inthe Override Hook).

    Hook Flow rev. 7.020081028

    Directory Integrator

    Before Delta

    Build Link Criteria

    Available temporaryscript variables

    *Valid Operation Code

    Be default, an exception isthrown if Delta mode detectsthat the work Entry does nothave a valid operation code

    (for example, generic).Operation code detection

    occurs after theBefore Execute Hook.

    Delta mode can be configuredto ignore these Entries

    instead.

    Yes

    EntryOperation Code

    Unchanged?

    No

    InvalidEntry Operation

    Code?*

    Is InvalidCode anError?

    No

    Yes

    No

    Yes

    Yes

    Delta Application

    During Delta processing,the necessary steps are taken to

    prepare for for applying thedetected changes as efficiently

    as possible.

    For example, multi-value Attributesrequire special handling so that

    value-level Delta operation codesare applied correctly.

  • conn

    Delta 3/4End-Of-Flow

    OnSuccess

    OnError

    Delta Mode 2/4Hook Flow diagrams

    Lookup

    Build Link Criteria

    MultipleEntries Found?

    No

    ApplyDelta

    work

    Current EntrySet? No

    Hook Flow rev. 7.020081028

    Directory Integrator

    *On Multiple EntriesIf more than one record/entry is

    found that matches the Link Criteriathen the On Multiple Entries

    Hook must also be enabled, or thisis treated as an error.

    You can access the set ofrecords/entries found by usingeither of these two Connector

    functions:

    getFirstDuplicateEntry()or

    getNextDuplicateEntry()

    Each of these functions returnsan Entry object that can be used

    to call a Connector Interfacesdata access methods

    (.update(), delete(), etc.).

    In addition, conn may beset to the desired Entry object by

    calling the Connectors setCurrent()function:

    myConnector.setCurrent( myEntry )

    If no Entry object isset, then execution will continue

    to On Success, skipping therest of the mode-specific flow.

    Note:

    Please note that data sources(and therefore related Connectors)

    behave differently whenmultiple Entries are to be handled.

    Even if you set a specificEntry as described above,

    it is not recommended that youcontinue with the delta

    operation, as this may result inan error, or that the operation isperformed on multiple entries.

    Before Lookup

    After Lookup

    Available temporaryscript variables

    current

    EntryOperation Code

    Add?

    No

    Yes

    On MultipleEntries*

    IncrementalModificationpossible?#

    No

    Yes

    (contd)Delta

    Support

    Match Found?

    No

    On No Match

    Yes

    Yes

    Yes

    Build Link Criteria#Incr. Mod. possible?

    The Connector checksto see if the underlying

    system supportsincremental modifications.

    For the LDAP Connector,this will always be Yes.

    For the JDBC Connectorthe answer is currently

    always be No.

  • conn

    End-Of-Flow

    OnError

    Delta Mode 3/4Hook Flow diagrams

    No

    work

    Hook Flow rev. 7.020081028

    Directory Integrator

    Available temporaryscript variables

    current

    (contd)ApplyDelta

    EntryOperation Code

    Add?

    OverrideAdd

    OverrideAdd

    Enabled?Yes

    Before Add

    After Add

    No

    Add

    OutputAttribute Map

    Yes

    Delta 4/4

    DeltaDelete

    AfterDelta

    Delta 4/4

    On No Add

    Yesconn Entry empty?

    No

    Continueto next

    component, nextAL section,

    or start of nextcycle

  • work currentconn

    Delta Mode 4/4Hook Flow diagrams

    End-Of-Flow

    OverrideModify

    Enabled?Yes

    No ModifyOverride Script

    OutputAttribute Map

    Before Modify

    On No Changes

    After Modify

    Modify*

    After Delta

    (contd)Delta

    Delete

    ChangesDetected? No

    Yes

    OnSuccess

    OnError

    Hook Flow rev. 7.020081028

    Directory Integrator

    Available temporaryscript variables

    *Modify operationIf the Connector supports Deltadirectly, then this operation iscarried out by this specializedbehavior (for example, doing

    an incremental modify operationfor an LDAP directory).

    Otherwise, a standard modifycall is made.

    (contd)AfterDelta

    EntryOperation Code

    Delete?

    OverrideDelete

    Enabled?Yes

    Before Delete

    After Delete

    No

    Delete

    Yes

    OverrideDelete

    No

  • *After the End Of Datahook, execution flow continues

    as shown below:

    Iterator ModeHook Flow diagrams

    More Iterators inFeeds section?

    Yes

    No

    Continue tonext Iterator

    End ofAssemblyLine

    execution

    work conn

    Available Objects

    As always, work gives youaccess to the attributes that

    are currently inthe AssemblyLine.

    The data read in by eachGetNext operation is

    available in the conn object.

    Note:

    If a Connector in Iteratormode detects the presence

    of a valid work object atthe start of its execution -

    for example, that thereis another Iterator in

    front of this one in the sameAssemblyLine, or that the

    initial work Entry hasbeen passed into the

    AssemblyLine from a callingprocess or system -

    then this Connector willnot be executed, passing

    instead this Entry tothe next Connector in the

    AssemblyLine.

    The sidebar belowillustrates what happenswhen an Iterator reaches

    its end-of-data. At thispoint it will not pass

    a work object tothe next Connector, which

    in the case of anotherIterator, will signal it

    to begin its owniteration.

    Before Execute

    OverrideGetNext

    Enabled?

    OverrideGetNextBefore GetNext

    After GetNext

    No

    GetNext

    InputAttribute Map

    Continuefrom

    previouscomponent or

    Start ofAL

    OnSuccess

    OnError

    End-Of-Flow

    Hook Flow rev. 7.020081028

    Directory Integrator

    End of Data?

    No

    End Of Data*

    Yes

    End Of Data

    Yes

    Available temporaryscript variables

  • work conn

    Available Objects

    As always, work gives youaccess to the attributes that

    are currently inthe AssemblyLine.

    After the Build Link Criteriaoperation, there is a script object

    called search availablewhich gives you access to this

    information (i.e. for use inthe Override Hook).

    The record/entry matchingthe Link Criteria is

    available through theconn object.

    *On Multiple EntriesIf more than one record/entry is

    found that matches the Link Criteriathen the On Multiple Entries

    Hook must also be enabled, or thisis treated as an error.

    During this hook, conn may beset to the desired Entry object by

    calling the Connectors setCurrent()function:

    myConnector.setCurrent( myEntry )

    You can access the set ofrecords/entries found by usingeither of these two Connector

    functions:

    getFirstDuplicateEntry()or

    getNextDuplicateEntry()

    Each of these functions returnsan Entry object that can be used

    in the setCurrent() call.

    If setCurrent() is not called(e.g. no current entry is set)then the flow is passed on to

    On Success, skippingthe rest of the mode-specific

    flow.

    Lookup ModeHook Flow diagrams

    Continuefrom

    previouscomponent or

    Start ofAL

    Before Execute

    OverrideLookup

    Enabled?

    No

    Lookup

    OverrideLookup

    Build Link Criteria

    Before Lookup

    Build Link Criteria

    After Lookup

    InputAttribute Map

    MultipleEntries Found?*

    On MultipleEntries*

    Yes

    No

    OnError

    End-Of-Flow

    OnSuccess

    Match Found?

    On No Match

    No

    Yes

    Yes

    Current EntrySet?

    Yes

    No

    Hook Flow rev. 7.020081028

    Directory Integrator

    Available temporaryscript variables

    current

  • Available Objects

    The only temporary Entry objectis conn, which is available in the

    After Accepting ConnectionHook.

    This Entry contains a singleAttribute called

    connectorInterface

    Its only value is a referenceto the Connector Interfacethat will be paired up withthe Flow component list in

    in Iterator Modeto feed it with event data.

    Server ModeHook Flow diagrams

    Launchedfrom

    Feedslist

    BeforeAccepting

    Connection

    AfterAccepting

    Connection

    Accept Connection

    OnError

    End-Of-Flow

    Hook Flow rev. 7.020081028

    Directory Integrator conn

    Available temporaryscript variables

    Server Behavior

    Server Mode Connectorsdo not run exclusively

    like Iterators do.Instead, each is launched as

    a separate process inevent listening mode and

    control is passed to thenext Feeds Connector.

    When an event is detected(for example, a client attempts

    to connect) then theConnector creates a clone

    of itself in Iterator Modeonce the

    After Accepting ConnectionHook has completed.

    This cloned Iterator is thenpaired up with the

    AssemblyLine Flow componentlist (possibly from the AL Pool)

    and Hook flow continues aswith standard Iterator mode.

    Furthermore, once the Flowsection of the AssemblyLinecompletes, control is passed

    to the Server Responselogic which then creates andsends the required reply to

    the caller/client system.

    The Response Hook flow isdetailed on the page

    entitled Server Response.

  • work conn

    Available Objects

    As always, work gives youaccess to the attributes that

    are currently inthe AssemblyLine.

    The information stored inthe conn object is

    sent to the data source bythe Reply operation.

    Continuefrom

    last Flowcomponent

    Before Execute

    OverrideReply

    Enabled?Yes

    No

    OverrideReply

    OutputAttribute Map

    Before Reply

    After Reply

    Reply

    Server ResponseHook Flow diagrams

    Directory Integrator

    Available temporaryscript variables

    Hook Flow rev. 7.020081028

    OnError

    End-Of-Flow

    ReplySuccessful

    Continueto start of next

    cycle

  • Update 3/3

    Modify

    conn

    Update 2/3 End-Of-Flow

    OnSuccess

    OnError

    Update Mode 1/3Hook Flow diagrams

    Before Execute

    OverrideUpdate

    No

    Lookup

    Continuefrom

    previouscomponent or

    Start ofAL

    Build Link Criteria

    No

    Yes

    MultipleEntries Found? Yes

    On MultipleEntries*No

    Add

    work

    Match Found?

    OverrideUpdate

    Enabled?Yes

    Available Objects

    As always, work gives youaccess to the attributes that

    are currently inthe AssemblyLine.

    After the Build Link Criteriaoperation, there is a script object

    called search availablewhich gives you access to this

    information (e.g. for use inthe Override Hook).

    Current EntrySet?

    Yes

    No

    Hook Flow rev. 7.020081028

    Directory Integrator

    *On Multiple EntriesIf more than one record/entry is

    found that matches the Link Criteriathen the On Multiple Entries

    Hook must also be enabled, or thisis treated as an error.

    You can access the set ofrecords/entries found by usingeither of these two Connector

    functions:

    getFirstDuplicateEntry()or

    getNextDuplicateEntry()

    Each of these functions returnsan Entry object that can be used

    to call a Connectorsdata access methods

    (.update(), delete(), etc.).

    In addition, conn may beset to the desired Entry object by

    calling the Connectors setCurrent()function:

    myConnector.setCurrent( myEntry )

    If no Entry object isset, then execution will continue

    to On Success, skipping therest of the mode-specific flow.

    Note:

    Please note that data sources(and therefore related Connectors)

    behave differently whenmultiple Entries are to be handled.

    Even if you set a specificEntry as described above,

    it is not recommended that youcontinue with the update

    operation, as this may result inan error, or that the operation isperformed on multiple entries.

    Before Update

    Before Lookup

    After Lookup

    Build Link Criteria

    Available temporaryscript variables

    current

  • Update Mode 2/3Hook Flow diagrams

    Available Objects

    As always, work gives youaccess to the attributes that

    are currently inthe AssemblyLine.

    If the Update results inan Add operation,

    conn holds the data that iswritten to the data source.

    AfterUpdate

    Update 3/3End-Of-Flow

    OnError

    Add OverrideScript

    OverrideAdd

    Enabled?Yes

    Before Add

    After Add

    No

    Add

    OutputAttribute Map

    (contd)Add

    connwork

    Hook Flow rev. 7.020081028

    Directory Integrator

    Available temporaryscript variables

    conn Entry empty?

    On No Add

    No

    Continueto next

    component, nextAL section,

    or start of nextcycle

    Yes

  • work currentconn

    Update Mode 3/3Hook Flow diagrams

    Available Objects

    As always, work gives youaccess to the attributes that

    are currently inthe AssemblyLine.

    If the update results ina Modify operation,

    the current object gives youaccess to the record/entry

    in the connected data source thatmatched the Link Criteria

    (e.g. is about to be modified).Note that until the Output

    Map, both conn and currentcontain the same information.

    As in the case of an Add,the conn object holds the

    information that is tobe written to the data source,

    in this case, by the Modifyoperation.

    The conn object

    The conn object is emptiedimmediately before

    the Output Map. Afterthis point, conn and current

    no longer contain theEntry object found bythe lookup operation.

    End-Of-Flow

    OverrideModify

    Enabled?Yes

    No ModifyOverride Script

    OutputAttribute Map

    Before Modify

    ComputeChanges?

    On No Changes

    After Modify

    Before ApplyingChanges

    Modify*

    After Update

    (contd)Modify

    (contd)After

    Update

    ChangesDetected?

    NoNo

    Yes

    Yes

    *ModifyPlease note that some

    data sources will computechanges automatically,

    and if none are detected,will revert with a

    No Changes exception.This will cause flowto be directed to the

    On No ChangesHook.

    OnSuccess

    OnError

    Hook Flow rev. 7.020081028

    Directory Integrator

    Available temporaryscript variables

    conn Entry empty?

  • End-Of-Flow for AllConnector Modes

    Hook Flow diagrams work

    Available Objects

    As always, work gives youaccess to the attributes that

    are currently inthe AssemblyLine,.

    The conn and curent objectsare available in the

    On Error and On SuccessHooks if they were present

    previously in the flow

    End-Of-Flow

    This flow applies to allcomponents that either terminate

    normally (e.g. successfully) ordue to an error.

    Error Handling

    Please note that if either On ErrorHook is enabled, then control ispassed to the next component,

    as if the Connector had terminatedsuccessfully; Otherwise, the

    AssemblyLine aborts.

    The error condition can bepassed on to next On Error

    Hook (either the Defaultfor the Connector, or the

    AssemblyLine Error Hook)by re-throwing the exception:

    throw error.getObject(exception);

    Furthermore, if an error occursin an On Error Hook, then

    the AssemblyLine will also abort.

    The error object (of type Entry) isavailable throughout an

    AssemblyLine, and providesinformation about the error situation

    through its attributes:status, exception, class, message,

    operation and connectorname.

    The status attributewill have the string value OK

    until an error situation arises, atwhich time it is assigned

    the value fail and the otherattributes are added to error.

    t

    (Mode-Specific)On Success

    (Default)On Success

    AbortAssemblyLine(AL On Error

    will beexecuted)

    Continueto next

    component, nextAL section,

    or start of nextcycle

    (Mode-Specific)On Error

    (Default)On Error

    Yes

    Is ErrorHandled (and not

    re-thrown) in Hooksabove?

    No

    OnSuccess

    OnError

    error

    Hook Flow rev. 7.020081028

    Directory Integrator

    Available temporaryscript variables

    AssemblyLineEnd-of-Flow

    If the AssemblyLinecompletes without

    unhandled errors, theAssemblyLine

    On Success Hookis invoked.

    Otherwise, if an errorhas occurred than

    control is passed tothe AsemblyLineOn Error Hook.

    Return tothe point after

    where this errororiginated

  • Connector ReconnectHook Flow diagrams

    ConnectionFailure

    Detected

    On ConnectionFailure

    Auto Reconnect*

    Hook Flow rev. 7.020081028

    Directory Integrator

    RetryConnectorInterface

    Operation

    AutoReconnectEnabled?

    Yes

    No

    ConnectionRestored?

    Yes

    No

    Available Objects

    As always, work gives youaccess to the attributes that

    are currently inthe AssemblyLine,.

    The error object (of type Entry) isavailable throughout an

    AssemblyLine, and providesinformation about the an errorsituation through its attributes:

    status, exception, class, message,operation and connectorname.

    The status attributewill have the string value OK

    until an error situation arises, atwhich time it is assigned

    the value fail and the otherattributes are added to error.

    *Auto ReconnectThe Auto Reconnect feature

    is configured through theparameters found in the

    Connector Reconnect tab.

    These parameters controlthe maximum number of times

    a reconnect will be tried,as well as the number

    seconds to wait betweeneach attempt.

    AbortAssemblyLine(AL On Error

    will beexecuted)

    (Default)On Error

    At Least OneOn Error Hook

    Enabled?

    Yes

    No

    Return tothe point after

    where this errororiginated

  • work conn

    Available Objects

    As always, work gives youaccess to the attributes that

    are currently inthe AssemblyLine.

    *The information stored inthe conn object changes

    during FC operation.

    It is important to note thatthe conn object servestwo different purposes

    in a Function:

    1) Storing the callattributes/parameters

    defined in theOutput Attribute Mapto be transmitted by theFunction call operation,

    2) Receiving returnattributes/parameters thatwill be mapped in by the

    Input Attribute Mapafter the Function call

    operation

    Function (FC)Continue

    fromprevious

    component orStart of

    AL

    Before Execute

    OutputAttribute Map

    BeforeCall

    AfterCall

    function call

    Hook Flow rev. 7.020081028

    Directory Integrator

    InputAttribute Map

    *

    Available temporaryscript variables

    AnswerReceived?

    No AnswerReturned

    No

    Yes

    (Default)On Success

    AbortAssemblyLine(AL On Error

    will beexecuted)

    Continueto next

    component, nextAL section,

    or start of nextcycle

    No

    error

    Is ErrorHandled (and not

    re-thrown) in Hookabove?

    Yes

    (Default)On Error

    FunctionSuccess

    FunctionError


Recommended