Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net. Product Version: Corticon 5.6

Size: px

Start display at page:

Download "Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net. Product Version: Corticon 5.6"

Paula West
6 years ago
Views:

1 Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net Product Version: Corticon 5.6

2 Introduction... 3 Setting up the tutorial... 4 Step 1: Installing Corticon Server for.net... 4 Step 2: Deploying Corticon Server for.net on IIS... 5 A: Run the IIS batch script... 5 B: Converting the axis subdirectory into an ASP.NET application... 7 C: Configuring a Wildcard Script Map to handle ASMX requests... 9 D: Verifying that Corticon Server for.net is properly deployed Step 3: Starting Corticon Server Step 4 : Importing a Sample Project Preparing the Vocabulary Deploying the Decision Service Packaging the Ruleflow into an EDS file Deploying the EDS file using Web Console Testing the Decision Service Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 2

3 Introduction Once the rules in a Ruleflow are modeled, analyzed and tested, they are ready to be deployed to Progress Corticon Server as a Decision Service. There are a number of ways you can deploy a Decision Service. You can deploy a Decision Service inprocess or as a Web Service for either Java or.net. In this tutorial, you will learn how to deploy a Decision Service as a Web Service for.net. Corticon Server is a set of core Java classes that comprises all the functionality required to host and manage Decision Services. These Java classes are deployed on an application server. For this tutorial, we will use the Microsoft IIS application server. To deploy a Decision Service as a Web Service, you have to perform the following tasks: 1. Prepare Vocabulary and Ruleflow for deployment 2. Package the Ruleflow as a Decision Service 3. Use the Web Console to deploy the Decision Service to an IIS Web Server configured for Corticon. 4. Test if the Decision Service can be accessed as a Web Service In this tutorial, you will learn how to perform these tasks. Note: Before you deploy Decision Services, you need to ensure that Corticon Studio, Corticon Server and Corticon Web Console are installed. Follow the Corticon Installation Guide and install Corticon Studio 5.6. You will install Corticon Server next as part of setting up the environment for this tutorial. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 3

4 Setting up the tutorial Before you work on deploying a Decision Service, you need to set-up your environment for this tutorial. You must: 1. Install Corticon Studio and Corticon Server for.net 2. Deploy Corticon Server for.net on IIS (Internet Information Services) 3. Start Corticon Server 4. Import a Sample Project Step 1: Installing Corticon Server for.net Click here for the Corticon Installation Guide. Follow the instructions and Install Corticon Server 5.6. Make sure that you install Corticon Server for.net as well as Corticon Web Console. Verifying that Corticon Server is installed Select Start > All Programs > Progress > Corticon 5.6. You should see new options in the menu including Corticon Web Console. A Corticon Server for.net installation contains a number of components, including an IIS installation batch script, which you will use next when you deploy Corticon Server for.net on IIS. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 4

5 Step 2: Deploying Corticon Server for.net on IIS Corticon Server for.net must be deployed on IIS as an ASP.NET application that uses the Classic pipeline mode to process requests. This requires you to configure ASP.NET settings on IIS. The target system for a Corticon Server for.net installation requires: Supported.NET Framework and Internet Information Service (IIS) 8 GB System RAM (minimum of 2 GB available RAM) 500 MB disk space Corticon Server 5.6 is compatible with Microsoft.NET Framework 4.0 and 4.5; and is compatible with IIS 7.5, 8 and 8.5. Before beginning this task, you should install IIS and register.net framework v4.0 or v4.5 with IIS. To deploy Corticon Server for.net on IIS, you need to perform the following tasks: A. Run the IIS batch script B. Convert the axis directory in IIS into an ASP.NET application. C. Configure a Wildcard Script Map to handle ASMX requests. D. Verify that Corticon Server for.net is properly deployed A: Run the IIS batch script The IIS install batch script creates a subdirectory named axis in the IIS installation directory (typically C:\inetpub\wwwroot). The axis subdirectory contains Corticon Server for.net components that have to be hosted on IIS. To run the IIS install batch script: Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 5

$In the command console, enter the path of the IIS installation directory. If the path is the default path (C:\inetpub\wwwroot), press ENTER. 3.$ $Note that the axis subdirectory should also be visible in the IIS installation directory (the default path is C:\inetpub\wwwroot).$

6 1. Select Start > All Programs > Progress > Corticon 5.6 > Corticon Server.NET > IIS Install. A command console opens. 2. In the command console, enter the path of the IIS installation directory. If the path is the default path (C:\inetpub\wwwroot), press ENTER. 3. Verify that the axis subdirectory has been created. In IIS Manager, the axis folder should be visible under Sites > Default Web Site in the Connections panel. Note that the axis subdirectory should also be visible in the IIS installation directory (the default path is C:\inetpub\wwwroot). Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 6

NET application that uses the Classic managed pipeline mode to process requests. To convert the axis subdirectory into an ASP.

7 B: Converting the axis subdirectory into an ASP.NET application The next step is to convert the axis subdirectory in IIS manager into an ASP.NET application that uses the Classic managed pipeline mode to process requests. To convert the axis subdirectory into an ASP.NET application: 1. In IIS Manager, right-click the axis subdirectory and select Convert to Application. The Add Application window opens. 2. Click Select. The Select Application Pool window opens. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 7

The axis subdirectory should now be denoted by an application icon.

8 3. Select ASP.NET v4.0 Classic from the Application Pool drop-down list. Then click OK. 4. In the Add Application window that appears, click OK. 5. The axis subdirectory should now be denoted by an application icon. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 8

C: Configuring a Wildcard Script Map to handle ASMX requests To use Corticon Studio to test the Decision Service, you must configure the Wildcard Script Map in IIS.

9 C: Configuring a Wildcard Script Map to handle ASMX requests To use Corticon Studio to test the Decision Service, you must configure the Wildcard Script Map in IIS. The web-based Server Management utility as well as some other resources have the file extension.asmx. You should configure a wildcard in IIS to handle requests made to these resources that do not explicitly add.asmx at the end of the URL. To configure a Wildcard Script Map to handle ASMX requests: 1. In IIS Manager, click the root node (typically the computer name) in the Connections panel. 2. In the root node s home page on the right, double-click Handler Mappings in the IIS section. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 9

$dll file. The default path for 64- bit systems is C:\Windows\Microsoft.NET\Framework64 \v4.0.x.$

10 3. In the Handler Mappings page, click Add Wildcard Script Map in the Actions panel on the right. The Add Wildcard Script Map window opens. 4. In the Add Wildcard Script Map window: a) In the Executable field, specify the path to the aspnet_isapi.dll file. The default path for 64- bit systems is C:\Windows\Microsoft.NET\Framework64 \v4.0.x. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 10

11 b) In the Name field, enter a name for the mapping. In this example it is CorticonWildcard. c) Click OK. 5. In the dialog box that appears, click Yes. 6. Verify that the ISAPI extension is allowed by navigating to the ISAPI and CGI restrictions page. The ASP.NET v4.0 row with the path that references the aspnet_isapi.dll file should show Allowed in the Restriction column. If it does not, right-click on the row, and then choose Allow from the dropdown list. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 11

12 D: Verifying that Corticon Server for.net is properly deployed To verify that Corticon Server for.net is properly deployed on IIS, you should access the Server Management utilities that are exposed as ASP.NET-based Web Services. You access these utilities by opening a web browser and entering the following URL: Step 3: Starting Corticon Server Start Corticon Server by selecting Start > All Programs > Progress > Corticon 5.6 > Start Corticon Server. This launches a command console. Corticon Server takes a few minutes to start. When it is up and running, you will see the following screen: Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 12

13 Check for the message INFO: Server startup in xxxx ms. This indicates that Progress Application Server and Corticon Server Web Console started successfully. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 13

We will use one of the sample projects for this tutorial.

14 Step 4 : Importing a Sample Project Corticon Studio comes with built-in sample rule projects. We will use one of the sample projects for this tutorial. To import the sample: 1. Launch Corticon Studio. 2. Go to Help > Samples. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 14

15 3. On the Samples page that appears, select Tutorial and click Open. 4. In the Import Projects window that opens, click OK. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 15

16 5. The sample rule project appears in Corticon Studio. Your environment is now set up. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 16

17 Preparing the Vocabulary When a Web Service client sends a request message to a Decision Service that is exposed as a Web Service, the message contains data enclosed within XML or JSON tags. For Corticon to correctly process the request message, you must ensure that XML or JSON tag names map to entity and attribute names in the Corticon Vocabulary. By default, Corticon Studio specifies the entity or attribute name as the XML Element Name. If XML or JSON tag names are different from the entity or attribute names, you need to prepare the Vocabulary by manually mapping them. For this tutorial, our request messages will use XML. In the left column, you can see the XML request message. The right column shows our project Vocabulary. Notice that the request message contains two tag names Shipment and itemweight that do not appear in our Vocabulary. They correspond to the Cargo entity and the Cargo.weight attribute. For this reason, you need to prepare the Vocabulary by manually mapping Shipment to Cargo and itemweight to Cargo.weight. 1. Open the Vocabulary file Cargo.ecore in the Done folder in the Tutorial Rule Project. 2. Click the Cargo entity. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 17

3. Click the Show Vocabulary Details icon.

In the XML Element Name property, you can see the default name Cargo in

18 3. Click the Show Vocabulary Details icon. You should now see some additional properties. 4. In the XML Element Name property, you can see the default name Cargo in grey. Change the default name by double-clicking the property value and then entering Shipment. 5. Similarly, change the XML Element Name for the weight attribute in Cargo to itemweight. 6. Save the file. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 18

19 You have now prepared the Vocabulary. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 19

Deploying the Decision Service Now that you have prepared the Vocabulary, you are ready to package the Ruleflow as a Decision Service that can be deployed to a Corticon Server for.net.

20 Deploying the Decision Service Now that you have prepared the Vocabulary, you are ready to package the Ruleflow as a Decision Service that can be deployed to a Corticon Server for.net. There are different ways to deploy a Ruleflow to Corticon Server. In this tutorial, you will package the Ruleflow in a pre-compiled EDS file and then deploy it to Corticon Server using the Web Console. To learn about other methods of deployment, watch the video: Options for Publishing a Decision Service, available in the Corticon Learning Center. You can also refer to the Corticon Server: Integration & Deployment Guide. Packaging the Ruleflow into an EDS file Let s start by packaging the Ruleflow in Corticon Studio. 1. Open the tutorial_example.erf file. The Ruleflow has just one Rulesheet Cargo.ers which is renamed to tutorial_example in the Ruleflow. When you create an EDS file, the Ruleflow, the Rulesheet that it contains, and the Vocabulary all get compiled into a package that can later be deployed on Corticon Server. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 20

21 2. To package the Ruleflow, select Project > Package and Deploy Decision Services. 3. In the Deployment Target window, select Package and save for later deployment and click Next. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 21

22 4. In the Package Ruleflows screen: a. Select the tutorial_example Ruleflow. b. Retain the default directory or specify a different location to save the EDS file by clicking the Browse button. c. Click Next. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 22

EDS file and saved in the location you specified.

23 5. In the Additional Jar Files screen, click Finish. You should see a message indicating that the Ruleflow was successfully compiled into an EDS file and saved in the location you specified. You are now ready to deploy the EDS file to Corticon Server using the Web Console. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 23

The Web Console login page opens. Enter admin/admin in the User Name/Password fields and then click Log in. 3. On the Home Page, you can see various options.

24 Deploying the EDS file using the Web Console The Web Console is a tool that is used for administering and monitoring your Decision Services. Before you launch the Web Console, ensure that Corticon Server is started. 1. Launch the Web Console by selecting Start > All Programs > Progress > Corticon 5.6 > Corticon Web Console. 2. The Web Console login page opens. Enter admin/admin in the User Name/Password fields and then click Log in. 3. On the Home Page, you can see various options. Click on the Manage Decision Services icon. You can select the option from the main screen shown or from the top icon on the menu bar to your left. 4. Choose Manage Servers then enter the hostname and port (typically 80) of the running IIS server. It could be on your local machine. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 24

On the Add Decision Service pane: a. Specify the name in the Name field.

25 5. This screen lists all the running Decision Services. To add your Decision Service, click the Add Decision Service button on the top right. 6. Next, choose whether your Decision Service will be stand-alone or part of an application. In this case, select Add a single Decision Service and click OK. 7. On the Add Decision Service pane: a. Specify the name in the Name field. Since the Application will only have one Decision Service, it makes sense to choose an Application name that reflects the purpose of the Decision Service for example Cargo Shipment. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 25

26 b. In the Servers drop-down, choose your managed IIS server. 8. Click Save & Deploy to deploy the Decision Service to Corticon Server. If the Decision Service is successfully deployed, you will see a green checkmark next to the Application name. You have now successfully deployed the Ruleflow as a Decision Service on Corticon Server for.net. Your Decision Service can now be accessed either as a SOAP Web Service (using XML) or as a REST Service (using JSON). Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 26

27 Note: The Corticon Web Console automatically generates a WSDL file for the deployed Decision Service. You can access this WSDL file from WSDL tab. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 27

28 Testing the Decision Service After you deploy a Decision Service, you should test it to verify that it can be accessed as a Web Service and make sure that the Vocabulary has been properly prepared. The Corticon Web Console allows you to send a SOAP/XML or REST/JSON request, to invoke the deployed Decision Service. In this tutorial, we will use an XML request. 1. On your Decision Service details page, you will see additional options relating to that Decision Service. From the list of available options, select Test Execution. 2. This opens the Test Execution page. Choose SOAP/XML as the Request Type. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 28

29 3. Download and save the Sample.xml file. 4. Click Choose Request File on the Test Execution page. Navigate to the Sample.xml file and click Open. 5. The Request Section is now populated. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 29

30 6. Click Execute. The Response field is now populated with a SOAP message. Notice that the request and the response messages contain the terms Shipment and itemweight. This means that Corticon translated the Shipment and itemweight tags in the request message to Cargo and Cargo.weight in the Vocabulary and after processing, translated the results back to Shipment and itemweight respectively. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 30

31 You have now successfully tested the deployed Decision Service. Congratulations! You have completed this tutorial. You have prepared the Vocabulary for deployment, deployed the Ruleflow as a Decision Service to Corticon Server for.net on an IIS server, and confirmed that the Decision Service can be accessed as a Web Service. Tutorial: Deploying a Progress Corticon Decision Service as a Web Service for.net 31

Setting up IIS on Windows Server 2012, R1 and R2 (IIS 8.0 and 8.5)

Setting up IIS on Windows Server 2012, R1 and R2 (IIS 8.0 and 8.5) Setting up IIS on Windows Server 2012, R1 and R2 (IIS 8.0 The procedures in this topic apply to Windows Server 2012 (IIS 8.0) and Windows