Searching for Orders

With the Sterling B2B Integrator EBICS Client, you can search for orders and obtain an order summary using simple or advanced search options.

You can perform either a simple search or an advanced search by using multiple parameters to refine your search. Depending on the requirement of your search, you can:
  • Indicate whether you want to search the order records in the live tables or in the restore (archived) tables.
  • Select date ranges and time ranges.
  • Specify additional parameters to refine the search results.
To search the order records and obtain an order summary that meets your search criteria:
  1. Log in to Sterling B2B Integrator EBICS Client.
  2. From the Viewers menu, select Order search.
  3. Enter your search criteria according to the following table:
    Table 1. Searching for orders
    Field Description
    Search location Required. Select the appropriate search location. The options are:
    • Live tables: This option is selected by default. When this option is selected, orders are searched in the live tables (current) database.
    • Restore tables: When this option is selected, orders are searched in the restore database.
    Start date Required. The current date by default is populated in this field based on the timezone specified while configuring the user. Click the Start Date field to view the calendar and select the start date from the calendar.
    End date Required. The current date by default is populated in this field based on the timezone specified while configuring the user. Click the End Date field to view the calendar and select the end date from the calendar.
    Bank ID(Host ID) Optional. Select the required bank ID.
    Order ID Optional. Type the order ID in the Order ID field.
    Order type Optional. Select an appropriate order type from the Order Type drop-down list.
    Status Optional. Select the appropriate status of the order from the Status drop-down list:
    • All (default)
    • All completed
    • All incompleted
    • Success
    • Failed
    • In progress
    • Pending at Client
    • Pending at Server
    User ID Optional. From the drop-down list, select the user ID of the EBICS Client user who initiated the order you are searching for. This option is not available for an EBICS Client user.
    Permission type Optional. Select the appropriate permission type. The options are:
    • Submitter: This option is selected by default. Orders are searched based on the submitter of the order.
    • Signer: Select this option to search for orders based on the signer of the order. Click the order ID link to view the order details. Order events, Activities, and Pending signatures tabs are not displayed when orders are searched by signer.
    Start time Required. The default system time is displayed in the field based on the timezone specified while configuring the user. Click the Start time field to select the start time.
    End time Required. The default system time is displayed in the field based on the timezone specified while configuring the user. Click the End time field to select the end time.
    Partner name Optional. Select the required partner name.
    Order Seq ID Optional. Type the order sequence ID in the Order Seq ID field.
    File format Optional. Select an appropriate file format from the File format drop-down list.
    FUL Ack status Optional. Type the FUL acknowledgment status in the FUL Ack status field.
    Sort by Optional. You can sort the search results based on one of the following options:
    • Datetime (default)
    • Last activity datetime
    • Order ID
    • Order type
    • Partner name
    • Bank ID(Host ID)
    • User ID
    You can also sort the search results in an ascending or descending order. Select the ASC or DSC option from the drop-down list. DSC is the default option.
    Refresh rate Optional. Using the up or down arrow, specify the frequency at which you want the search results to refresh.
    Refresh icon Optional. By default, refreshing of the search results is disabled (Off). Click the refresh icon to enable the refreshing of the search results (On).
  4. Click Search.
    The order summary displays the following information in a tabular format:
    Table 2. Order information fields
    Field Description
    Order Seq ID

    Order ID

    Click the Order ID or Order Seq ID link to view the order details. The Order summary details page is divided into two sections: Order data and Order details. The Order data section provides the following information about the selected order:
    • Order Seq ID
    • Order type
    • File format
    • Number of signatures (Signatures required to submit the order)
    • Start date and time
    • Last activity date and time
    • Order ID
    • Partner name
    • User ID
    • Bank ID(Host ID)
    • Status of the order
    • Completion date and time
    • Workflow ID
    • Document (The order payload). The order document link is displayed only for the EBICS Client user. Click the link to view the payload (for upload and download technical orders) or the order request XML (for other order types).
    The Order details section has three tabs:
    Order events
    Provides information about events pertaining to an order, such as, data compressed, data encoded, and EBICS packaging passed.
    Activities
    Provides information about the activities pertaining to an order, such as, Pending at client for signature and Submit action by submitter. The activities can be in one of the following states:
    • In progress
    • Completed
    • Failed
    Activities are not generated for INI, HIA, and HPB order types.
    Pending tasks
    Lists the users whose signatures are pending for the selected order.
    HAC States
    Provides processing status and details for all submitted orders
    User ID The user ID of the EBICS Client user who submitted the order.
    Partner name Name of the partner to which a user is associated, is displayed.
    Bank ID(Host ID) The bank ID or the host ID of the bank to which the EBICS Client user submitted the order. It is a unique ID for the bank in the banks system.
    Order type The order type is displayed.
    Status The status of the order is displayed. For example: Success, Failed, In progress, and Pending at Client.
    FUL Ack status The FUL acknowledgment status of the order is displayed.
    HAC Action The HAC action is displayed.

    For information, see HAC Processing.

    HAC Reason The HAC Reason code is displayed.

    For information, see HAC Processing.

    Start DateTime The start date and time are displayed.
    Completion DateTime The completion date and time are displayed.
  5. Click Reset to clear the order search parameters. Resetting the search parameters does not clear the previous search results.