Process Engine Connector for IBM FileNet

Lets you create processes that interact with IBM FileNet Workflow Step stored in the FileNet Process Engine. (See IBM FileNet P8 documentation.)

    Dispatch Workflow Step operation

    Takes a FileNet Workflow Step from the specified queue and dispatches it. This operation is used to advance a workflow object in the FileNet Workflow.

    For information about the General and Route Evaluation property groups, see Common operation properties.

    Login Settings properties

    Login settings for invoking the FileNet Process Engine Connector service.

    User Name

    A string value that specifies the account name to use when connecting to the FileNet Process Engine.

    Password

    A string value that specifies the password that is associated with the account name specified in the User Name property to use when connecting to the FileNet process engine.

    FileNet Workflow Step Information properties

    Queue Name

    A string value that represents the name of the queue where the FileNet Workflow Step is located.

    Work Object Number

    A string value that represents the Work Object Number of a FileNet Workflow Step.

    Exceptions

    This operation can throw a RepositoryException exception.

    Retrieve Workflow Step Parameters operation

    Retrieves the FileNet Workflow Step parameters from a process running on LiveCycle.

    For information about the General and Route Evaluation property groups, see Common operation properties.

    Login Settings properties

    Login settings for invoking the FileNet Process Engine Connector service.

    User Name

    A string value that specifies the account name to use when connecting to the FileNet Process Engine.

    Password

    A string value that specifies the password that is associated with the account name specified in the User Name property to use when connecting to the FileNet process engine.

    FileNet Workflow Step Information properties

    Properties to specify the IBM FileNet Workflow Step to retrieve.

    Queue Name

    A string value that represents the name of the queue where the FileNet Workflow Step is stored.

    Work Object Number

    A string value that represents Work Object Number of the FileNet Workflow Step.

    FileNet Workflow Step Parameters properties

    Properties to specify the IBM FileNet Workflow Step to retrieve.

    Object Store

    (Optional) A string value that represents the name of the FileNet repository. You can choose from the list of available repositories from your current connection broker defined in Administration Console. (See FileNet Administration Help.)

    Workflow Definition GUID Or Path

    (Optional) A string value that represents the GUID or path of the Workflow Definition file in the IBM FileNet repository.

    If you provide a literal value, type the path or click Browse to select the folder from the FileNet repository.

    When typing the folder path, use the following rules:

    • Do not include the object store name in the folder path.

    • Because the use of attachments is not supported, the path cannot reference an attachment.

    • Use a forward slash (/) to separate folder names if you specify a folder location, as shown in this example:

      /[FolderPath]/[Workflow Definition]

    Workflow Map Name

    (Optional) A string value that species the Workflow Map that the FileNet Workflow Step is part of.

    Workflow Step ID

    (Optional) A string value that represents identifier of the FileNet Workflow Step.

    Step Parameter Mapping Table

    A map value that maps a list of FileNet Workflow Step parameters to process variables. During parameter retrieval, the mapped process variables are set with the values from the corresponding FileNet Workflow Step parameters.

    If you provide a literal value, follow these steps to populate the table:

    1. Specify GUID or path of the Workflow Definition file in the Workflow Definition GUID or Path box.

    2. Select a step ID from the Workflow Step ID list.

    3. Repeat step 1 and 2 if required.

    Result properties

    Step Parameter Name Value Map

    The location to store the Workflow Step parameters from the IBM FileNet process engine. The data type is map.

    Exceptions

    This operation can throw a RepositoryException exception.

    Set Workflow Step Parameters operation

    Sets the parameters in a FileNet Workflow Step from within a process running on LiveCycle.

    For information about the General and Route Evaluation property groups, see Common operation properties.

    Login Settings properties

    Login settings for invoking the FileNet Process Engine Connector service.

    User Name

    A string value that specifies the account name to use when connecting to the FileNet Process Engine.

    Password

    A string value that specifies the password that is associated with the account name specified in the User Name property to use when connecting to the FileNet process engine.

    FileNet Workflow Step Information properties

    Properties to specify the FileNet Workflow Step to set.

    Queue Name

    A string value that represents the name of the queue where the FileNet Workflow Step is stored.

    Work Object Number

    A string value that represents identifier of the FileNet Workflow Step.

    FileNet Workflow Step Parameters properties

    Parameters to set within the FileNet Workflow Step.

    Object Store

    (Optional) A string value that represents the name of the FileNet repository. You can choose from the list of available repositories from your current connection broker defined in Administration Console.

    Workflow Definition GUID Or Path

    (Optional) A string value that represents the GUID or path of the Workflow Definition file in the IBM FileNet repository.

    If you provide a literal value, type the path or click Browse to select the folder from the FileNet repository.

    When typing the folder path, use the following rules:

    • Do not include the object store name in the folder path.

    • Because the use of attachments is not supported, the path cannot reference an attachment.

    • Use a forward slash (/) to separate folder names if you specify a folder location, as shown in this example:

      /[FolderPath]/[Workflow Definition]

    Workflow Map Name

    (Optional) A string value that species the Workflow Map that the FileNet Workflow Step is part of.

    Workflow Step ID

    (Optional) A string value that represents identifier of the FileNet Workflow Step.

    Step Parameter Mapping Table

    A map value that maps a list of IBM FileNet Workflow Step parameters to process variables. During parameter setting, the mapped Workflow Step parameters are set with the values from the corresponding process variables.

    If you provide a literal value, follow these steps to populate the table:

    1. Specify GUID or path of the Workflow Definition file in the Workflow Definition GUID or Path box.

    2. Select a step ID from the Workflow Step ID list.

    3. Repeat step 1 and 2 if required.

    Exceptions

    This operation can throw a RepositoryException exception.

    Process Engine Connector for IBM FileNet exceptions

    The Process Engine Connector for IBM FileNet service provides the following exceptions for throwing exception events.

    RepositoryException

    Thrown if an error occurs while retrieving or storing a document in a FileNet repository (for example, if the value of an operation parameter is NULL or if FileNet returns an error).

    // Ethnio survey code removed