USER MANUAL

Newgen Software Technologies Ltd

A-6, Satsang Vihar Marg, Qutab Institutional Area

New Delhi - 110067, INDIA

Tel: 91-11-40770100, 26964733, 26963571

Fax: +91-11-26856936

E-mail: helpdesk@newgen.co.in

FEB – 2020

iBPS

BRMS Integration with iBPS

TABLE OF CONTENTS

1. Integration using BusinessRule Workstep……………..….……...4 2. Integration using Webservice Workstep…...…………..….……...8

2.1 Catalog Definition…………………………………………...9 2.2 Configuring Webservice Workstep………………………..12 2.3 Variable Mapping……………………………………………14

About this User Manual Restful Webservice configuration User Manual provides steps to register and use a

webservice in iBPS. Basic knowledge of Process Modeler is assumed prior to the usage of this

manual. The main chapters of this manual are:

PART 1 – Integration using BusinessRule

Workstep

This chapter discusses how to integrate BRMS and iBPS through

BusinessRule workstep.

PART 2 – Integration using Webservice

Workstep

This chapter discusses how to integrate BRMS and iBPS through

Webservice workstep.

1. Integration using BusinessRule Workstep BRMS integration can be done through the use of BusinessRule workstep. The webservice to be used can be registered as demonstrated in Part 2 by specifying the WSDL URL for the corresponding Rule package or Rule flow. Now, double-click on the BusinessRule workstep imported in the process to open its dialog box.

Figure 7 Next, click on the ‘Business Rule’ tab of this workstep. The list of available Rule flows/packages will be shown as below. User needs to just click the check box on the left of the Rule flow/package to be integrated.

Figure 8 Once the check box is enabled, the Version No can be selected from the available deployed versions of that particular Rule flow/package as shown below. Once that is

done, click on the plus icon to finally associate the selected Rule flow/package of the specified version number with the Business Rule workdesk. The iBPS workstep and the BRMS webservice are thus linked in this step and a new row is added

under ‘Associated RuleSets’ after clicking on the sign.

Figure 9 The next step is variable mapping between the process variables and the BRMS variables. Type matching needs to be ensured for the mapping to work as expected.

Click on the two sided blue green arrow to specify the variable mapping.

Figure 10

Mapping Steps : 1. System displays Define Mapping Window with Forward Mapping and Reverse

Mapping tabs.

Figure Error! No text of specified style in document..60

2. Select checkbox against parameters and map with current process variables.

Selected Rule flow or package name is displayed at the top of the pop up. AO_RF

is the Rule flow selected above. (Invocation type is synchronous by default for

Business Rule workstep mapping. It can be configured differently in Webservice

type workstep mapping. Refer Part 2 of this document for type of invocation details.)

3. Click on Reverse Mapping Tab.

Figure Error! No text of specified style in document..61

4. Select checkbox against current process variables and select business rule output

parameters.

5. Click on Ok button.

Thus, the BusinessRule workstep can be used to consume BRMS Rule flows and packages in iBPS Process Modeler.

2. Integration using Webservice Workstep

BRMS integration with iBPS can also be done through webservice calls using the WSDL URLs generated for every deployed Rule Package and Rule Flow. Every time a Rule Package or Rule Flow is deployed succesfully in BRMS, a corresponding WSDL is generated for it which can be accessed through the Axis2 login as described below. The WSDL path is taken from the URL: http://<IP>:<port>/axis2. This WSDL is then registered in iBPS as a web service, using Catalog Definition screen. The list of available services can be seen through Axis2 URL as shown below :

Figure 1 By clicking on a particular web service, the entire XML for that WSDL can be seen as below (The WSDL URL is displayed on the top) :

Figure 2

Once the WSDL URL is at hand, one can go ahead and configure webservice calls in iBPS through the steps outlined in the later parts of this document.

NOTE : All WSDLs obtained from deployed BRMS Rule packages and Rule flows are fetched through SOAP type webservice calls from iBPS (through their respective WSDL paths)

2.1 Catalog Definition This is the screen where new webservices are registered in Process Modeler. It is available as a pop-up dialog box from the Tools Menu :

Figure 3 The catalog definition dialog box appears :

Figure 4

This has two tabs : Webservice and Catalog. The webservice tab is used to manage webservices for the process. Users can register, modify and un-register a webservice method from this window. The Web Service tab has option naming “WSDL Location” through which the required web service can be registered in the process by simply supplying the WSDL path obtained from Axis2 login.

Figure 5

For Example, one can enter the URL under Specify WSDL location and click ‘Go’ button. The WSDL file for the web service is parsed at the server end automatically. The location of the WSDL file can be any URL or any absolute path, which should be present on the server. The web service names and methods exposed by the specified web service will be populated in the Service Name and Method Name selection lists. One can select the required Service Name and Method Name from the respective selection lists. Click ‘Register’ button to register the specified Web service. The registered Web services are displayed in the WebService pane, as shown in the following figure.

Figure 6

Once successfully registered, one can select any one of the webservices from the available list on the left pane, to view details of it or even un-register it.

2.2 Configuring Webservice Workstep Now, double-click on the WebService workstep imported in the process to open its dialog box and set the type of webservice call that will be made. Select from the drop down available in Basic Details tab as shown below (BRMS integration uses SOAP type webservice calls) :

Figure 11 Next, click on the Webservice tab of this workstep. Depending on the type of webservice selected, the drop down beside Webservice field will show the list of available (already registered) webservices. The arrow inside the yellow highlight below shows the drop down list of registered webservices. One can also click on ‘Manage’ button to open the Catalog Definition box and register a new webservice if not already done before.

Figure 12 Once the webservice is selected from the available list, its corresponding method name is populated and selected.

Figure 13

Click on the icon to add the selected webservice/method to this workstep. The Webservice workstep and the BRMS webservice are thus linked in this step. A

new row is added under ‘Associated Webservice’ after clicking on the sign. Proceed to Variable Mapping now, as explained in the Part 5 of this document.

Figure 14

2.3 Variable Mapping

Click on the two sided blue green arrow to specify the variable mapping from the Webservice workdesk :

Figure 15

Invocation Type : This is the technique with which the webservice methods are to be invoked. The following are the three different modes of invoking a Webservice: a) Fire and Forget - In this type of invocation, the server will simply invoke the webservice and continue the workitem further in the process. It will not wait for any Status or response from the webservice. b) Synchronous - In this type of invocation, the server will invoke the Web method of the Webservice in synchronous manner. In this technique, the server will block the step, until the Web method executes successfully and a response is received. Then only will the workitem be processed further in the process. c) Asynchronous - In this type of invocation, the server invokes the specified Web method of the Webservice in an asynchronous manner. In this technique, the server will not wait for the response and continue processing the workitem routing it further in the process. Only when the webservice response is received will the workitem be updated. When the Asynchronous option is selected, user will be prompted to select the JMS/SOAP.

Only when the webservice response is received, will the workitem be updated. When the Asynchronous option is selected, user will be prompted to select the JMS/SOAP Subscriber workstep. All the worksteps that have been configured as the Message Consumer Worksteps in the current process will fill up in the JMS/SOAP Subscriber workstep list. In case asynchronous mode of invocation is selected and the web service invoked returns some values, which may be required for setting the values of process variables - the Webservice Consumer workstep must follow the Webservice workstep in the process. When the Webservice is called synchronously, the calling thread is blocked. As a result, the workitem will not be routed for further processing until the webservice provides some response. While in asynchronous call, the workitem does not wait for the invoked webservice response to come for continuing with its further tasks. Time Out : Enter the Time Out Period, which is the time in seconds that the server will wait for the remote webservice to respond, before returning back from the failed attempt. If the user does not enter any timeout period, then it will be treated as ‘0’ and thus will be taken as infinite amount of time set for that particular webservice on that particular workstep. Variable Mapping : Only those queue and external data variables, which have the Read access permissions on the workstep, will be available in Forward Mapping tab. The variables with the Modify access rights are displayed in the Reverse Mapping tab. Forward Mapping Tab - This tab enables the user to map the input parameters of a Web method with the workflow process variables. Thus all the input parameters of the web method are displayed on the LHS, along with the workflow process variables in the selection lists on the RHS. To map the variables, the user can check the web method parameter and select the process variable in the corresponding selection list. This mapping ensures that at run-time, the values of the selected process variables will be passed to the corresponding mapped web method parameters. A sample forward mapping is shown as defined below :

Figure 17

Reverse Mapping - This tab enables the user to map the output parameters of a Web method with the workflow process variables. Thus, all the workflow process variables are displayed on the LHS, along with output parameters of the web method in the selection lists on the RHS. To map the variables, the user can check the process variable and select the web method parameter in the corresponding selection list. This mapping ensures that at run-time the values of the output parameters returned by the Web methods will be set in the corresponding mapped process variables. A sample forward mapping is shown as defined below :

Figure 18

Process, Error, Requirements, Data and Entry Settings tabs are similar to the Start Event. Click ‘Save changes’ and close the dialog box for Webservice workstep as shown above. Thus, iBPS can be integrated with BRMS through the Process Modeler using Webservice workstep.