Sterling B2B Integrator - Viewers

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

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.

Based on the configuration settings defined in an offer, multiple signatories may have to sign the order to process the order data. If an order is submitted for processing without obtaining the required signatures, EBICS Client does not process the order. Notifications for pending signatures are sent to the mailboxes of the concerned signatories requesting them to sign to the order. If the order is pending and needs to be signed, the user who is a signatory, sees the Sign link. If all the required signatures are obtained and the order is ready to be submitted, the user who is a submitter, sees the Submit link.

The Pending Tasks page is the landing page for Sterling B2B Integrator EBICS Client users. Use this page to view and sign or submit pending orders. To sign or submit a pending order, complete the following steps:

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the Viewers menu, select Pending tasks. The pending tasks are displayed in a tabular format.

   Column names	Description
   Order ID	Displays the order ID. Click the order ID to view the order summary and sign the order. Click the order document link in the order details page to view the payload.
   Submitter ID	Displays the submitter ID.
   Bank ID(Host ID)	Displays the bank ID.
   Order type	Displays the type of the order.
   Datetime	Displays the timestamp in date and time format.
   Status	Displays the status of the order. For example, Success, Pending at Client, Pending at Server, and so on. Depending on the required action, Sign or Submit links are displayed next to the status.

3. To sign a pending order, click Sign. To submit a pending order, click Submit.
4. If hardware security for electronic signature is configured for an EBICS Client user, then the Electronics Signatures page is displayed after you click Sign. Enter the values for the fields listed in the following table and click Sign:

   Field	Description
   Provider name	The name of the PKCS11 hardware signature module (HSM) provider is displayed.
   Select DLL	Click Browse, navigate to the appropriate location, and select the DLL file of the HSM.
   Select PKCS11 provider	Click Load providers, navigate to the appropriate location, and select the PKCS11 service provider file. After loading the provider files, select the appropriate file from the drop-down list.
   Enter pin	Specify the security pin in the Enter pin field.
   Select private key	Click Load keys, navigate to the appropriate location, and select the keys. After loading the keys, select the appropriate key from the drop-down list.

Distributed Electronic Signature (VEU) enables you to transmit data remotely to multiple subscribers. Multiple subscribers can authorize orders remotely, independent of time and space.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the User Menu, select Viewers > Pending VEU Tasks.
3. In the Pending VEU tasks page, specify the values for the fields listed in the following table and click Search.

   Field	Description
   Partner name	Required. Select a partner name from the drop-down list.
   Bank ID(Host ID)	Required. Select a bank ID associated with the partner from the drop-down list.
   Bank URL	Required. Select the required bank URL from the drop-down list. The selected URL is used to establish an HTTP or HTTPS session with the EBICS Banking Server.

   A request is sent to the bank to retrieve the details of the pending VEU orders.
4. Click Advanced Search to specify additional search criteria for VEU management orders in the Order Submission page.
5. If the response from the bank is delayed, click Cancel.
6. Click Reset to re-enter the search criteria.

You can view pending VEU tasks from the User Menu.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the User Menu, select Viewers > Pending VEU Tasks.
3. In the Pending VEU tasks page, specify the values for the fields listed in the following table and click Search.

   Field	Description
   Partner name	Required. Select a partner name from the drop-down list.
   Bank ID(Host ID)	Required. Select a bank ID associated with the partner from the drop-down list.
   Bank URL	Required. Select the required bank URL from the drop-down list. The selected URL is used to establish an HTTP or HTTPS session with the EBICS Banking Server.

   A request is sent to the bank to retrieve the details of the pending VEU orders.
4. In the Search Results section of the Pending VEU tasks page, you can view the following information in the search results:

   Field	Description
   Order type	The order type of the pending VEU order. For example, FUL.
   Order ID	The order ID of the pending VEU order. Click the Order ID link to view information about the order data.
   Order data size	The size of the uncompressed order data in kilobytes.
   Signatures required	Total number of electronic signatures required for activation in the server.
   Signatures done	The number of signatures already provided for the validation of the order.
   Status	The status of the order is displayed. Valid values are pending and complete. For example, if a user has signed an order but if the order requires additional signatures to validate the order, the status of the order is pending in the VEU store. The user who has already signed the order cannot sign or cancel the order in the pending status. However, this user can submit HVT or HVD order types.
   Datetime	The timestamp is displayed in date and time format.

You can retrieve details of a pending VEU order from the User Menu.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the User Menu, select Viewers > Pending VEU Tasks.
3. In the Pending VEU tasks page, specify the values for the fields listed in the following table and click Search.

   Field	Description
   Partner name	Required. Select a partner name from the drop-down list.
   Bank ID(Host ID)	Required. Select a bank ID associated with the partner from the drop-down list.
   Bank URL	Required. Select the required bank URL from the drop-down list. The selected URL is used to establish an HTTP or HTTPS session with the EBICS Banking Server.

   A request is sent to the bank to retrieve the details of the pending VEU orders.
4. In the Search Results section of the Pending VEU tasks page, click the Order ID link. The details of the order data are displayed.

   Field	Description
   Order ID	The order ID of the pending VEU order. Click the Order ID link to view information about the order data.
   Order type	The order type of the pending VEU order. For example, FUL.
   Originator Partner ID	The Partner ID associated with the user who submitted the upload order type.
   Originator user ID	Subscriber ID of the user who submitted the upload order type.
   Order data available	After submitting an HVZ order type, indicates whether the order data can be downloaded in the original format or not.
   Order details available	The order information for HVU order type.
   Order data size	The size of the uncompressed order data in kilobytes.
   Datetime	The timestamp is displayed in date and time format.
   Ready to be signed	Indicates whether the order is already signed by the user or not. False indicates that the order is already signed by the user. True indicates that the order is ready to be signed by the user.
   Signatures required	Displays the minimum number of signatures required to authorize the order.
   Signatures done	The number of signatures that completed the validation of the order. Indicates the number of electronic signatures already provided and the information about previous signatories. Click the Signer info link to view the details of the signer: Partner name: name of the trading partner User ID Name: name of the signatory Time stamp Authorization level: the authorization level of the signatory
   Order info link	Click the order info link to view details about the order: Account: Click the account info link to view the name of the account holder, currency code, account description, the role of the account holder, account number, and the bank code. Amount: view the amount of the order transaction. Currency code: view the currency code of the order transaction. Debit Execution date: view the date of the execution of the order. Description: Click the description link to view the description and description type of the signatory.

5. In the Order data window, select one of the following options to retrieve the details for a pending VEU order:
   • From the Submit drop-down list, select HVT – order details to retrieve the transaction details of the order data
   • From the Submit drop-down list, select HVT – complete order data to retrieve the complete order data
   • From the Submit drop-down list, select HVD to retrieve the state of an order that is currently in VEU processing and for which the subscriber is authorized as a signatory. The subscriber receives information about the order in the form of an electronic accompanying note (DisplayFile), the order hash value (DataDigest), and the previous signatories (SignerInfo).
6. In the VEU order details window, specify the values for the following parameters:

   Field	Description
   Order id prefix	Select an alphabet from the drop-down list.
   Security medium	Security medium for the user’s bank-technical key. Type a four-digit security number in the 0100 – 0499 range.
   Bank URL	Select the bank URL from the drop-down list.
   Fetch limit	Valid if you selected HVT-order details. Maximum number of order details to be transmitted if the completeOrderData attribute is set to false. The default value is 100. Valid value is any non-negative integer. Specify 0 to fetch unlimited number of details. While it is possible to retrieve more than 100 details at a time, it is not ideal.
   Fetch offset	Valid if you selected HVT-order details. The offset position in the original order file that marks the starting point of the transaction details to be transmitted. If the completeOrderData attribute is set to false, then the offset position applies to the sequential number of a particular order. The default value is 0. Valid value is any non-negative integer. To retrieve more than 100 records, set fetch offset as 0 to retrieve the first 100 records, then set fetch offset as 101 to retrieve the next 100 records. Continue as needed.

7. Click Submit.

You can sign a pending VEU order when the Ready to be Signed parameter displays True and one of the VEU orders is submitted.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the User Menu, select Viewers > Pending VEU Tasks.
3. In the Pending VEU tasks page, specify the values for the fields listed in the following table and click Search.

   Field	Description
   Partner name	Required. Select a partner name from the drop-down list.
   Bank ID(Host ID)	Required. Select a bank ID associated with the partner from the drop-down list.
   Bank URL	Required. Select the required bank URL from the drop-down list. The selected URL is used to establish an HTTP or HTTPS session with the EBICS Banking Server.

   A request is sent to the bank to retrieve the details of the pending VEU orders.
4. In the Pending VEU tasks page, click the Order ID link. The details of the order data are displayed.

   Field	Description
   Order ID	The order ID of the pending VEU order. Click the Order ID link to view information about the order data.
   Order type	The order type of the pending VEU order. For example, FUL.
   Originator Partner ID	The Partner ID associated with the user who submitted the upload order type.
   Originator user ID	Subscriber ID of the user who submitted the upload order type.
   Order data available	After submitting an HVZ order type, indicates whether the order data can be downloaded in the original format or not.
   Order details available	The order information for HVU order type.
   Order data size	The size of the uncompressed order data in kilobytes.
   Datetime	The timestamp is displayed in date and time format.
   Ready to be signed	Indicates whether the order is already signed by the user or not. False indicates that the order is already signed by the user. True indicates that the order is ready to be signed by the user.
   Signatures required	Displays the minimum number of signatures required to authorize the order.
   Signatures done	The number of signatures that completed the validation of the order. Indicates the number of electronic signatures already provided and the information about previous signatories. Click the Signer info link to view the details of the signer: Partner name: name of the trading partner User ID Name: name of the signatory Time stamp Authorization level: the authorization level of the signatory
   Order info link	Click the order info link to view details about the order: Account: Click the account info link to view the name of the account holder, currency code, account description, the role of the account holder, account number, and the bank code. Amount: view the amount of the order transaction. Currency code: view the currency code of the order transaction. Debit Execution date: view the date of the execution of the order. Description: Click the description link to view the description and description type of the signatory.

5. Click Sign order.
6. In the VEU order details window, specify the values for the following parameters:

   Field	Description
   Order id prefix	Select an alphabet from the drop-down list.
   Security medium	Security medium for the user’s bank-technical key. Type a four-digit security number in the 0100 – 0499 range.
   Bank URL	Select the bank URL from the drop-down list.

7. Click Submit.

You can cancel a pending VEU order if the Ready to be Signed parameter displays True and one VEU order is submitted.

1. Log in to Sterling B2B Integrator EBICS Client.
2. From the User Menu, select Viewers > Pending VEU Tasks.
3. In the Pending VEU tasks page, specify the values for the fields listed in the following table and click Search.

   Field	Description
   Partner name	Required. Select a partner name from the drop-down list.
   Bank ID(Host ID)	Required. Select a bank ID associated with the partner from the drop-down list.
   Bank URL	Required. Select the required bank URL from the drop-down list. The selected URL is used to establish an HTTP or HTTPS session with the EBICS Banking Server.

   A request is sent to the bank to retrieve the details of the pending VEU orders.
4. In the Search Results section of the Pending VEU tasks page, click the Order ID link. The details of the order data are displayed.

   Field	Description
   Order ID	The order ID of the pending VEU order. Click the Order ID link to view information about the order data.
   Order type	The order type of the pending VEU order. For example, FUL.
   Originator Partner ID	The Partner ID associated with the user who submitted the upload order type.
   Originator user ID	Subscriber ID of the user who submitted the upload order type.
   Order data available	After submitting an HVZ order type, indicates whether the order data can be downloaded in the original format or not.
   Order details available	The order information for HVU order type.
   Order data size	The size of the uncompressed order data in kilobytes.
   Datetime	The timestamp is displayed in date and time format.
   Ready to be signed	Indicates whether the order is already signed by the user or not. False indicates that the order is already signed by the user. True indicates that the order is ready to be signed by the user.
   Signatures required	Displays the minimum number of signatures required to authorize the order.
   Signatures done	The number of signatures that completed the validation of the order. Indicates the number of electronic signatures already provided and the information about previous signatories. Click the Signer info link to view the details of the signer: Partner name: name of the trading partner User ID Name: name of the signatory Time stamp Authorization level: the authorization level of the signatory
   Order info link	Click the order info link to view details about the order: Account: Click the account info link to view the name of the account holder, currency code, account description, the role of the account holder, account number, and the bank code. Amount: view the amount of the order transaction. Currency code: view the currency code of the order transaction. Debit Execution date: view the date of the execution of the order. Description: Click the description link to view the description and description type of the signatory.

5. Click Cancel order.
6. In the VEU order details window, specify the values for the following parameters:

   Field	Description
   Order id prefix	Select an alphabet from the drop-down list.
   Security medium	Security medium for the user’s bank-technical key. Type a four-digit security number in the 0100 – 0499 range.
   Bank URL	Select the bank URL from the drop-down list.

7. Click Submit.