Human Interaction Query Service

Requirements

How the Human Interaction Query Service Works

Use the Human Interaction Query service to search the Sterling B2B Integrator database for business process data that requires human interaction. The query results returned from this service include the reference data for documents that were previously saved in the Sterling B2B Integrator database by the Human Interaction Event service.

Business Scenario

Your company receives purchase orders in XML format from a trading partner. All purchase orders exceeding $1,000.00 need to be approved. You want to view a list of all purchase orders requiring approval.

Business Solution Example

Business Solution Example Dependencies

This business solution example focuses only on the Human Interaction Query service functionality.

GPM Example

The following GPM example shows a solution for retrieving the list of purchase orders requiring approval to display in a Web browser.

After the Human Interaction Query service completes, a list of purchase orders that are waiting for approval are returned to the business process in a document named MinedDataQueryResults. The returned document for this example looks like the following, returning reference data for the two purchase orders meeting the query criteria:

The MinedDataQueryResults document is then sent to the Human Interaction XForms service and the B2B HTTP Server adapter for display in the Web browser.

For example, you might have a Web template that displays the reference data in the following format:

Business Process Modeling Language (BPML) Example

The following example shows the corresponding business process solution using BPML.

<process name="ExamplePurchaseOrderHIQueryAndHIXform"> 
<sequence name="Start HI Query and HI Xform Services"> 
<operation name="SampleHIQueryService"> 
<participant name="HumanInteractionQuery"/> 
<output message="HumanInteractionQueryTypeInputMessage"> 
	<assign to="DocumentType">Purchase Order</assign> 
	<assign to="State">Awaiting Approval</assign> 
	<assign to="." from="*"/> 
</output> 
<input message="inmsg"> 
	<assign to="." from="*"/> 
</input> 
</operation> 
<operation name="SampleHIXFormsService"> 
<participant name="HumanInteractionXForms"/> 
<output message="HumanInteractionXFormsTypeInputMessage"> 
	<assign to="TemplateName" from="DocToDOM(MinedDataQueryResults)/listItem/templateName/text()"/> 
	<assign to="." from="*"/> 
</output> 
<input message="inmsg"> 
	<assign to="." from="*"/> 
</input> 
</operation> 
<operation name="HTTP Respond Service">
      <participant name="HttpRespond"/>
      <output message="HttpRespondServiceInputMessage">
        <assign to="." from="*"></assign>
      </output>
      <input message="inmsg">
        <assign to="." from="*"></assign>
      </input>
    </operation> 
</sequence> 
</process>

Implementing the Human Interaction Query Service

Human Interaction Query Service Business Process Usage

The following screen shows a graphical view of the GPM parameters for the Human Interaction Query service. There are no fields to be configured on the Message From Service tab.

The following example shows the corresponding BPML parameters for the Human Interaction Query service GPM parameters.

<process name="ExamplePurchaseOrderHIQuery"> 
<sequence name="Start HI Query Service"> 
<operation name="SampleHIQueryBP"> 
<participant name="HumanInteractionQuery"/> 
<output message="HumanInteractionQueryTypeInputMessage"> 
	<assign to="DocumentType">Purchase Order</assign> 
	<assign to="endDateTime">2004-02-25 00:00:00</assign> 
	<assign to="endModDateTime">2004-02-25 00:00:00</assign> 
	<assign to="FromAccount">SendingTradingPartnerSystemAccountID</assign> 
	<assign to="GroupName">SendingTradingPartnerSecurityPermissionGroup</assign> 
	<assign to="IdentityName">SendingTradingPartnerName</assign> 
	<assign to="ParentAccount">ManagerOfTheDocumentSender</assign> 
	<assign to="ReferenceId">PO1234</assign> 
	<assign to="startDateTime">2004-02-24 00:00:00</assign> 
	<assign to="startModDateTime">2004-02-24 00:00:00</assign> 
	<assign to="State">Awaiting Approval</assign> 
	<assign to="Status">Unread</assign> 
	<assign  to="StorageArea">Inbox</assign> 
	<assign to="SystemAccount" from="ReceiverCompanyUserAccount"/> 
	<assign to="." from="*"/> 
</output> 
<input message="inmsg"> 
	<assign to="." from="*"/> 
</input> 
</operation> 
</sequence> 
</process>

The following table describes the fields used to configure the Human Interaction Query service in the GPM. The values specified for these parameters are the input to the Human Interaction Query service from the business process.

The following table describes additional fields used to configure the Human Interaction Query service. You can specify these fields using the Advanced Editor option in the GPM Service Editor or by using BPML.

Output from Service to Business Process

The following table describes the output returned from the Human Interaction Query service to the business process: