TIBCO BusinessEvents Extreme WebStudio User s Guide

Transcription

1 TIBCO BusinessEvents Extreme WebStudio User s Guide Software Release November 2013 Two-Second Advantage

2 Important Information SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE. USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME. This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc. TIBCO, The Power of Now, TIBCO ActiveMatrix, TIBCO ActiveMatrix BusinessWorks, TIBCO Administrator, TIBCO ActiveSpaces, TIBCO Designer, TIBCO Enterprise Message Service, TIBCO Hawk, TIBCO Runtime Agent, TIBCO Rendezvous, are either registered trademarks or trademarks of TIBCO Software Inc. in the United States and/or other countries. EJB, Java EE, J2EE, and all Java-based trademarks and logos are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. All other product and company names and marks mentioned in this document are the property of their respective owners and are mentioned for identification purposes only. THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT. THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES. This product is covered by U.S. Patent No. 7,472,101. U.S. Patent No. 8,219,852, and U.S Patent No. 8,407,723. Copyright TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

3 iii Contents Tables...vii Preface...ix Related Documentation...x TIBCO BusinessEvents Extreme Documentation....x Other TIBCO Product Documentation...xii Typographical Conventions...xiii Connecting with TIBCO Resources... xvi How to Join DevZone... xvi How to Access TIBCO Documentation.... xvi How to Contact TIBCO Support... xvi Chapter 1 Introduction to WebStudio...1 Introduction to TIBCO BusinessEvents Extreme WebStudio....2 Technical User Tasks...2 Business User Task...4 Introduction to Rules Management Server (RMS)...6 WebStudio and RMS User Workflow...7 Chapter 2 Configuring RMS and RMS Projects....9 RMS Project Directory Structure...10 Adding a Project to RMS...11 Configuring RMS Server Properties Configuring RMS Server Properties...12 Enabling Remote Connection to RMS from WebStudio...14 RMS Server Configuration Property Reference Configuring User Authentication...23 Authentication In Various Components Authentication Property Reference...25 CDD Properties Configuring Access Control for a Project Configuring Access Control Overview...28 Working with Access Control Files...31 Required Location of Access Control Files Specifying and Grouping Project Resources...31

4 iv Contents Defining Permissions...32 Resource Types and Corresponding Action Types...33 Chapter 3 Working With Projects in WebStudio Starting and Logging in to RMS...38 Status Check for RMS Connection...39 Checking Out a Project...40 Updating (Synchronizing) a Project Committing Artifacts for Approval...42 Chapter 4 Working with Decision Tables in WebStudio Working With Decision Tables...46 Create/Remove a Decision Table...46 Edit a Decision Table Export a Decision Table Import a Decision Table Understanding Columns and Rows (Rules) in a Decision Table Conditions and Actions...51 Regular and Custom Conditions and Actions...51 Working With Rows and Columns in WebStudio...53 Add Condition and Action Columns...53 Working with Columns...55 AddaRow...57 Setting Rule (Row) Priorities Filter Rows Remove Rows...59 Create Duplicate Rows (Rules) Supported Operators Using Operators in Tables...61 Analyze a Decision Table...62 Validate a Decision Table...64 Chapter 5 Business Rules Business Rules Overview...66 Working with Business Rules...67 Adding Business Rules...67 Export a Business Rule...70 Deleting Business Rules...70 Business Rule Operators...72

5 Contents v Chapter 6 Working with the Approval Workflow in RMS...77 Working with the Approval Workflow Overview Approval Status Values...78 Checking a Worklist and Taking Action...80 Chapter 7 Deployable Files Generation...83 Generating Deployable Files (EAR and Class Files)...84 Generating the Project EAR or All Project Class Files...85 Generating One Decision Table s Class File...86 Generating One Business Rule s Rule Template Instance File...87 Index...89

6 vi Contents

7 Tables vii Tables Table 1 General Typographical Conventions... xiii Table 2 Syntax Typographical Conventions... xiv Table 3 RMS Server Configuration Properties Table 4 Authentication Configuration Properties in the CDD File Table 5 Resource Types and Their Allowable Action Types Table 6 Supported Operators... 60

8 viii Tables

9 ix Preface TIBCO BusinessEvents Extreme WebStudio is an online tool that allows business users to create or manage business rules in a web browser. It allows the business user to define a business rule based on the rule template and rule template view defined by the developer in TIBCO BusinessEvents Extreme Studio. Similar to TIBCO BusinessEvents Extreme Decision Manager, a decision table in TIBCO BusinessEvents Extreme WebStudio is defined using a virtual rule function. Rule templates, rule template views, and virtual function are created in TIBCO BusinessEvents Extreme Studio. explains how to create business rules, view/edit decision tables, and configure TIBCO BusinessEvents WebStudio. TIBCO BusinessEvents Extreme The Power to Predict Topics Related Documentation, page x Typographical Conventions, page xiii Connecting with TIBCO Resources, page xvi TIBCO BusinessEvents WebStudio User s Guide

10 x Related Documentation Related Documentation This section lists documentation resources you may find useful. TIBCO BusinessEvents Extreme Documentation The following diagram shows the main documents in the TIBCO BusinessEvents Extreme documentation set, The documentation set for TIBCO BusinessEvents Extreme is as follows. TIBCO BusinessEvents Extreme Installation: Read this manual for instructions on site preparation and installation. TIBCO BusinessEvents WebStudio User s Guide

11 Preface xi TIBCO BusinessEvents Extreme Getting Started: After the product is installed, use this manual to learn the basics of TIBCO BusinessEvents: project design and deployment. This guide explains the main ideas so you gain understanding as well as practical knowledge. TIBCO BusinessEvents Extreme Architect s Guide: Read this guide for overview and detailed technical information to guide your work. TIBCO BusinessEvents Extreme Application Architect s Guide: Read this guide for overview and detailed technical information to guide your work in developing an application. TIBCO BusinessEvents Extreme Application Developer s Guide: Use this guide when you implement a project design in TIBCO BusinessEvents Extreme Studio. It covers topics such as project-level tasks, resource-level tasks, and debugging, TIBCO BusinessEvents Extreme Java Developer s Guide: Use this guide to program TIBCO BusinessEvents in Java. TIBCO BusinessEvents Extreme Administration: This book explains how to configure, deploy, monitor, and manage a TIBCO BusinessEvents application and the data it generates using the TIBCO BusinessEvents Extreme Administrator utility and other utilities provided with the product. TIBCO BusinessEvents Extreme Sizing Guide: Read this guide for information on how to size systems for deploying TIBCO BusinessEvents applications. TIBCO BusinessEvents Extreme Tuning Guide: Read this guide for information about tuning your TIBCO BusinessEvents installation. TIBCO BusinessEvents Extreme Decision Manager User s Guide. Read this guide for information about using the TIBCO BusinessEventss Decision Manager product.. Read this book to learn how to use the TIBCO business Events Extreme WebStudio utility. TIBCO BusinessEvents Extreme Release Notes: Read the release notes for a list of new and changed features. This document also contains lists of known issues and closed issues for this release. Online References: TIBCO BusinessEvents Extreme Java API Reference: This online reference provides the Javadoc-based documentation for the TIBCO BusinessEvents API. TIBCO BusinessEvents WebStudio User s Guide

12 xii Related Documentation Other TIBCO Product Documentation You may find it useful to refer to the documentation for the following TIBCO products: TIBCO ActiveSpaces TIBCO ActiveSpaces Transactions TIBCO Hawk TIBCO Rendezvous TIBCO BusinessEvents WebStudio User s Guide

13 Preface xiii Typographical Conventions The following typographical conventions are used in this manual. Table 1 General Typographical Conventions Convention ENV_NAME TIBCO_HOME BEX_HOME code font bold code font Use TIBCO products are installed into an installation environment. A product installed into an installation environment does not access components in other installation environments. Incompatible products and multiple instances of the same product must be installed into different installation environments. An installation environment consists of the following properties: Name Identifies the installation environment. This name is referenced in documentation as ENV_NAME. On Microsoft Windows, the name is appended to the name of Windows services created by the installer and is a component of the path to the product shortcut in the Windows Start > All Programs menu. Path The folder into which the product is installed. This folder is referenced in documentation as TIBCO_HOME. TIBCO BusinessEvents Extreme installs into a directory within a TIBCO_HOME. This directory is referenced in documentation as BEX_HOME. The default value of BEX_HOME depends on the operating system. For example on Windows systems, the default value is C:\tibco\be-x\ Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example: Use MyCommand to start the foo process. Bold code font is used in the following ways: In procedures, to indicate what a user types. For example: Type admin. In large code samples, to indicate the parts of the sample that are of particular interest. In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable disable] TIBCO BusinessEvents WebStudio User s Guide

14 xiv Typographical Conventions Table 1 General Typographical Conventions (Cont d) Convention italic font Key combinations Use Italic font is used in the following ways: To indicate a document title. For example: See TIBCO ActiveMatrixBusinessWorks Concepts. To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal. To indicate a variable in a command or code syntax that you must replace. For example: MyCommand PathName Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C. Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q. The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances. The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result. The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken. Table 2 Syntax Typographical Conventions Convention Use [ ] An optional item in a command or code syntax. For example: MyCommand [optional_parameter] required_parameter A logical OR that separates multiple items of which only one may be chosen. For example, you can select only one of the following parameters: MyCommand param1 param2 param3 TIBCO BusinessEvents WebStudio User s Guide

15 Preface xv Table 2 Syntax Typographical Conventions Convention Use { } A logical group of items in a command. Other syntax notations may appear within each logical group. For example, the following command requires two parameters, which can be either the pair param1 and param2, or the pair param3 and param4. MyCommand {param1 param2} {param3 param4} In the next example, the command requires two parameters. The first parameter can be either param1 or param2 and the second can be either param3 or param4: MyCommand {param1 param2} {param3 param4} In the next example, the command can accept either two or three parameters. The first parameter must be param1. You can optionally include param2 as the second parameter. And the last parameter is either param3 or param4. MyCommand param1 [param2] {param3 param4} TIBCO BusinessEvents WebStudio User s Guide

16 xvi Connecting with TIBCO Resources Connecting with TIBCO Resources This section provides links to helpful TIBCO resources. How to Join DevZone TIBCO DevZone is a developer-oriented community established for customers building applications with BusinessEvents Extreme and ActiveSpaces Transactions. To register, go to click the Contact Us link, and send an to devzone_admin@tibco.com. How to Access TIBCO Documentation You can access TIBCO documentation here: How to Contact TIBCO Support For comments or problems with this manual or the software it addresses, contact TIBCO Support as follows: For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site: If you already have a valid maintenance or support contract, visit this site: Entry to this site requires a user name and password. If you do not have a user name, you can request one. TIBCO BusinessEvents WebStudio User s Guide

17 1 Chapter 1 Introduction to WebStudio This chapter introduces the TIBCO BusinessEvents Extreme WebStudio application and its server component, Rules Management Server (RMS). Topics Introduction to TIBCO BusinessEvents Extreme WebStudio, page 2 Introduction to Rules Management Server (RMS), page 6 WebStudio and RMS User Workflow, page 7

18 2 Chapter 1 Introduction to WebStudio Introduction to TIBCO BusinessEvents Extreme WebStudio TIBCO BusinessEvents Extreme WebStudio is a TIBCO BusinessEvents Extreme online component consisting of a client, WebStudio, and a server the Rules Management Server (RMS). WebStudio Component TIBCO BusinessEvents Extreme WebStudio is an online component which allows business users to create/manage business rules in a web browser. In TIBCO BusinessEvents Extreme WebStudio the user defines an executable rule (business rule) based on the rule template and the rule template view defined by the developer in TIBCO BusinessEvents Extreme Studio. Similar to TIBCO BusinessEvents Extreme Decision Manager, a decision table in TIBCO BusinessEvents Extreme WebStudio is defined using virtual rule functions. Rule templates, rule template views, and virtual function are created in TIBCO BusinessEvents Extreme Studio by developers and stored in RMS repositories. The decision tables are available only if TIBCO BusinessEvents Extreme Decision Manager is installed. When you install TIBCO BusinessEvents Extreme, you are given the option of installing TIBCO BusinessEvents Extreme Decision Manager. Rules Management Server (RMS) Component Rules Management Server (RMS) is a server-based component that manages the lifecycle of WebStudio artifacts and WebStudio user access. Using a menu of options in TIBCO BusinessEvents Extreme WebStudio, RMS allows business users to check out projects and check them in, subject to an approval process that RMS also provides. You can customize the workflow process. For a more detailed overview see WebStudio and RMS User Workflow on page 7. Before you use RMS, you need some configuration, as explained in Introduction to Rules Management Server (RMS) on page 6. Technical User Tasks As a technical user you configure RMS and the TIBCO BusinessEvents Extreme WebStudio components, and set up project resources required for business users to create decision tables or business rules. You also deploy decision tables or business rules when they are ready for use, either in an enterprise archive (EAR)

19 Introduction to TIBCO BusinessEvents Extreme WebStudio 3 file, or as class files. You can deploy class files for use at startup, or hot deployed. You can also unload them from a running engine.you also define access control settings and can act as an approver to ensure that decision tables and business rules created by business users are appropriate for use. Virtual Rule Functions and Decision Tables At designtime, technical users add virtual rule functions (VRFs) to a TIBCO BusinessEvents Extreme project. A VRF has no body, similar to a Java interface. Its implementation is provided using decision tables authored in TIBCO BusinessEvents Extreme WebStudio. VRFs are used in the TIBCO BusinessEvents Extreme project like any other rule function; they can be called from rules or other rule functions. Here is a simple example: /** */ virtual void rulefunction Virtual_RF.Applicant_VirtualRuleFunction { attribute { validity = ACTION; } scope { Concepts.Applicantapplicant; Events.ApplicationReceivedapplicationreceived; } body { } } In TIBCO BusinessEvents Extreme WebStudio, business users add decision table resources to VRFs. The decision table provides the body to the VRF, also known as the VRF implementation. One VRF can have more than one decision table. If a VRF has more than one decision table, functions in TIBCO BusinessEvents Extreme determine how the tables are used. Rule Template and Business Rule At designtime users add a rule template to a TIBCO BusinessEvents Extreme project. A rule template is a specialized rule that contains a pre-conditions section which defines the pre-conditions which must be met in addition to the conditions defined by the business user in a business rule.

20 4 Chapter 1 Introduction to WebStudio The Action Context section of a rule template defines all possible actions that can be taken by a business rule (after all conditions are met). Only the action context statements that the WebStudio user selects and defines as commands in the business rules are actually taken (depending on the rule evaluation at runtime). For a business rule execution to succeed, a business rule definition must include all Actions and the order should be maintained. Completing the definition of an action is a WebStudio user task. If bindings are used (and a view) then in WebStudio, the business rule writer has to enter only the binding values to complete the definition. Action context statements are of three types: create, modify, and call, plus arbitrary actions. Business User Task Rule Building with Business Rules As a business user, you check out projects from RMS, build business rules, and submit them for approval. Business rules provide a rule builder or a user-friendly HTML form to build rules. In a builder you specify the conditions in the when section and the actions in the then section. You can use artifacts and supported operators for building conditions and actions. In the user-friendly HTML form, you fill up the values for the conditions and actions. Rule Building with Decision Tables As a business user, you check out projects from RMS, build decision tables, and submit them for approval. Decision tables are also available in TIBCO BusinessEvents Extreme WebStudio in edit mode, if you have installed TIBCO BusinessEvents Extreme Decision Manager. When you install TIBCO BusinessEvents Extreme, you have the option to install TIBCO BusinessEvents Extreme Decision Manager. Decision tables provide a graphical way to build complex business rules. You create table columns by dragging and dropping predefined properties onto the decision table framework. The properties belong to ontology resources defined in the TIBCO BusinessEvents Extreme project. However, you can only use the properties specified in the VRF. Columns can be created in other ways too. You then define threshold values (conditions) and actions in the cells of the table. Each row can be thought of as one rule in a table made up of many rules. The individual rules are often straightforward, as in the following examples.

21 Introduction to TIBCO BusinessEvents Extreme WebStudio 5 Three Rule Conditions Three Rule Actions Person.age < Max(20, Parent.age) Person.creditscore >= Math.function(...) Person.gender == "female" Application.status = "ACCEPTED" Application.credit = 4000 sendnotification() However, one decision table can consist of hundreds, even thousands of rules each of which is executed only when its specific conditions are satisfied. Exception Tables Each decision table can optionally have another table known as an exception table. The purpose of the exception table is purely organizational: it enables you to separate the business logic of the main decision table (added by business users) from any non-business logic (generally added by technical users). For example, in the exception table, you could capture situations where fields are blank or contain invalid values, and define actions that send notifications or set return values. The rows of a decision table along with the rows of its exception table are considered in an RTC. If you prefer, you can put non-business logic in the main table instead of using an exception table. Table Analyzer The Table Analyzer feature analyzes decision tables and reports problems, such as uncovered ranges for conditions, uncovered domain entries, different set of actions for identical conditions. Table Analyzer creates a sparse matrix data structure representing an optimized form of decision tables in memory.

22 6 Chapter 1 Introduction to WebStudio Introduction to Rules Management Server (RMS) RMS is a lightweight rules management server component for managing the repository of TIBCO BusinessEvents Extreme projects. RMS provides an easy, secure, and scripted deployment lifecycle. RMS is supported on all platforms that support TIBCO BusinessEvents Extreme. Users can access RMS remotely. RMS does not have to be installed on users machines. Under certain circumstances, the use of RMS is optional. (see TIBCO BusinessEvents Extreme Decision Manager User s Guide). You may require some basic configuration before you use RMS. You also set up an RMS project for each TIBCO BusinessEvents Extreme project that includes decision tables or business rules. See Chapter 2, Configuring RMS and RMS Projects, on page 9. RMS enables business users to check out projects. The necessary project resources are loaded into the cache. If you have the TIBCO BusinessEvents Extreme Decision Manager feature installed, then the artifacts are also copied into the client s machine. When users are finished working with the projects, they submit the business rules and/or decision tables to RMS for approval. (See WebStudio and RMS User Workflow on page 7 for a more detailed overview.) RMS enables technical users to do the following: Configure authentication and access control as needed. Approve or reject commit requests from Decision Manager and TIBCO BusinessEvents Extreme WebStudio users, check on the status of all such requests, keep track of all project versions, and view audit trails of status changes during workflow execution. Chapter 6, Working with the Approval Workflow in RMS, on page 77. Generate project Enterprise Archive (EAR) files or individual decision table classes or rule template instance file for business rule and for deployment and then deploy them. Chapter 7, Deployable Files Generation, on page 83. RMS is implemented using TIBCO BusinessEvents Extreme. Knowledgeable TIBCO BusinessEvents Extreme users can customize it. The default location for RMS projects is the TIBCO_HOME/be/5.1/examples/standard/WebStudio directory. Note that documentation is provided for the product as it is shipped. If you customize RMS some documentation may not apply.

23 WebStudio and RMS User Workflow 7 WebStudio and RMS User Workflow This section describes how rules authored in TIBCO BusinessEvents Extreme WebStudio are made available to a TIBCO BusinessEvents Extreme application. Step 1: TIBCO BusinessEvents Extreme Designtime A TIBCO BusinessEvents Extreme user creates a TIBCO BusinessEvents Extreme project, adding the ontology, and writing rules that make use of virtual rule functions (VRFs) and Rule Templates. At designtime, VRFs have a signature but no body. RMS Project Setup The TIBCO BusinessEvents Extreme project for RMS is stored at the location defined by a property in the RMS server configuration. The RMS project requires an access control file. The RMS server must be running so that the login and workflow actions are available in the TIBCO BusinessEvents Extreme WebStudio component. Step 2: TIBCO BusinessEvents Extreme WebStudio A business user starts the TIBCO BusinessEvents Extreme WebStudio component, logs on to RMS, and checks out the project. The business user creates one or more decision tables or business rules and saves the modified project locally, then commits them for approval. If the business user is creating/modifying the decision table for the first time, then the user generates EAR files before creating/modifying decision tables. Step 3: Approval An RMS user working in TIBCO BusinessEvents Extreme WebStudio receives the request and reviews the checked-in artifacts and then approves or rejects them. The approved artifacts are available for subsequent checkouts or updates. Step 4: Generating Deployable Files An RMS user generates deployable files for resources that are ready for deployment. You can generate EAR files or class files.

24 8 Chapter 1 Introduction to WebStudio Step 5: Deployment EAR files are deployed in the usual way, as explained in TIBCO BusinessEvents Extreme Administration. Class files for decision tables and rule template instance files for business rules are deployed by placing them in a configured location recognized by the TIBCO BusinessEvents Extreme engines at startup. They can also be hot-deployed.

25 9 Chapter 2 Configuring RMS and RMS Projects This chapter explains the directory structure of the Rules Management Server (RMS), and also explains how to set up user authentication and access control for RMS projects. The chapter also explains the configuration tasks for RMS, for RMS projects, and for TIBCO BusinessEvents Extreme WebStudio. Topics RMS Project Directory Structure, page 10 Configuring RMS Server Properties, page 12 RMS Server Configuration Property Reference, page 15 Configuring User Authentication, page 23 Authentication Property Reference, page 25 Configuring Access Control for a Project, page 28

26 10 Chapter 2 Configuring RMS and RMS Projects RMS Project Directory Structure All RMS projects exist in a repository under a root location directory and their ACL files exist under an RMS config location. The root location and RMS config location are configurable using the ws.scs.rooturl and ws.projects.acl.location properties in the RMS.cdd file. The rms.cdd file is located in the TIBCO_HOME/be/5.1/rms/bin directory. Root Location After initial installation, the default location for RMS projects is TIBCO_HOME/be/5.1/examples/standard/WebStudio. The ws.scs.rooturl property in the RMS.cdd file specifies: <property name="ws.scs.rooturl" type="string" value="c:/tibco_home/be/5.1/examples/standard/webstudio"/> TIBCO_HOME/be/5.1/examples/standard/WebStudio If you want to use another location, create the location and then change the ws.scs.rooturl property to point to that location. ACL File The ws.projects.acl.location property in the rms.cdd file specifies the location of security authorization files for all RMS projects. The RMS config location is TIBCO_HOME/be/5.1/rms/config/security as shipped: <property name="ws.projects.acl.location" type="string" value="c:tibco_home/be/5.1/rms/config/security"/> To be able to work with a project in WebStudio, you must provide an ACL file (.ac file) for the project, in the TIBCO_HOME/be/5.1/rms/config/security directory. For example, for a project called MyRMSProject, the ACL file would be MyRMSProject.ac. For more information on access control files, see Configuring Access Control for a Project, page 28.

27 RMS Project Directory Structure 11 Adding a Project to RMS You can create a project in TIBCO BusinessEvents Extreme Studio and follow the following steps to add the TIBCO BusinessEvents Extreme project to RMS: 1. Under the RMS project root location directory, create a directory with a name appropriate for the project. The root location is configurable. See Configuring RMS Server Properties on page Copy the TIBCO BusinessEvents Extreme Studio project contents that will be used in the Decision Manager feature or in TIBCO BusinessEvents Extreme WebStudio to the project directory. 3. If the project contains custom functions, create the lib directory under the project directory and then place the custom function jars under it. 4. Go to the TIBCO_HOME/be/5.1/rms/config/security directory and locate an existing ACL file. 5. Make a copy of the ACL file and rename it to indicate the project name for the project you want to manage using TIBCO BusinessEvents Extreme WebStudio. The RMS config location is configurable. See Configuring RMS Server Properties on page 12.

28 12 Chapter 2 Configuring RMS and RMS Projects Configuring RMS Server Properties RMS works out of the box on a local machine. Configuration is required to enable access by remote TIBCO BusinessEvents Extreme WebStudio and the Decision Manager clients. You may need to make other changes to the server configuration. For example, if you change the server location or the location of the RMS project repository, you must update the RMS server properties accordingly. Configuring RMS Server Properties To configure the RMS server properties, edit the RMS.cdd file. You cannot edit a CDD file in TIBCO BusinessEvents Extreme Studio outside of its project context. To edit the CDD in TIBCO BusinessEvents Extreme Studio, import the BRMS project into your workspace. After that, copy the RMS.cdd file to its installed locations, as described in the following sections. Whenever you change the RMS.cdd file you must restart the RMS server so that it uses the updated values. To Configure RMS Server Properties See RMS Server Configuration Property Reference on page 15 for information about each property. For information about properties that relate to the RMS project directory structure, see RMS Project Directory Structure, page 10. As with any procedure that changes files, first back up any files that could be affected. The RMS.cdd file is located in two places, in the product as shipped: TIBCO_HOME/be/5.1/rms/project/BRMS/Deployment/RMS.cdd TIBCO_HOME/be/5.1/rms/bin/RMS.cdd After you update the RMS.cdd file in your workspace, overwrite the existing files with the updated ones, in the above locations (or the ones currently in use, if different). Ensure that the CDD files in the BRMS project and the RMS startup directory are kept in sync.

29 Configuring RMS Server Properties In TIBCO BusinessEvents Extreme Studio, choose File > Import > Existing TIBCO BusinessEvents Project. 2. Ensure the Copy the projects into workspace check box is selected. 3. Select the following project: TIBCO_HOME/be/5.1/rms/project/BRMS 4. In Studio Explorer, double-click RMS.cdd to open it in the CDD editor. 5. In the CDD editor Cluster tab, click Properties. In the Configuration panel on the right, expand groups to see the individual properties. Complete the values as explained in RMS Server Configuration Property Reference on page 15. Enabling Remote Connection to RMS from WebStudio, page 14 RMS Server Configuration Property Reference, page To edit the source directly, click the Source tab. This opens the rms.cdd file for editing. 7. Review the settings for the ws.scs.rooturl property and modify them if necessary. This property specifies the URL used to start the WebStudio interface. For details on this setting see Root Location on page Review the settings for the ws.projects.acl.location property and make sure that they are correct. For details on this setting see ACL File on page Review the settings for the other properties in the WS property group and make sure they are correct. 10. When you have finished editing, save the RMS.cdd file. 11. In the file system, copy the RMS.cdd file from your workspace to the BRMS project and to the RMS server startup location: TIBCO_HOME/be/5.1/rms/project/BRMS/Deployment/RMS.cdd TIBCO_HOME/be/5.1/rms/bin/RMS.cdd 12. Make sure that you have an ACL file for the project in the TIBCO_HOME/be/5.1/rms/config/security directory. See Adding a Project to RMS on page 11 for details on providing an ACL file (.ac file). 13. Restart the RMS server. You will now be able to start TIBCO BusinessEvents Extreme WebStudio and use it to edit the project settings.

30 14 Chapter 2 Configuring RMS and RMS Projects Enabling Remote Connection to RMS from WebStudio As shipped, the tibco.clientvar.webstudio/hostname property is set to localhost. This setting enables the product to be used on a single machine. For production settings do the following to ensure that TIBCO BusinessEvents Extreme WebStudio users can connect to RMS from remote machines. To Define the Location of the RMS Server Host for WebStudio If you have not already done so, specify the RMS server hostname and port as follows: 1. Import the BRMS project into your workspace and open the RMS.cdd file for editing. See To Configure RMS Server Properties on page 12 for details. 2. In the Deployment folder, double click rms.cdd to open the rms.cdd file for editing. 3. Locate the following lines: <property name="tibco.clientvar.webstudio/hostname" type="string" value="localhost"/> <property name="tibco.clientvar.webstudio/port" type="integer" value="8090"/>that reads <property-group comment="" name="ws">. 4. Edit the lines that specify the TIBCO BusinessEvents Extreme WebStudio hostname and port using the following properties: tibco.clientvar.webstudio/"hostname" tibco.clientvar.webstudio/"port" where hostname is the hostname of the RMS server host and port is the port number that is running the host (the default is port 8090) 5. Save the RMS.cdd file. 6. In the file system, copy the RMS.cdd file from your workspace to the BRMS project and to the RMS server startup location: TIBCO_HOME/be/5.1/rms/project/BRMS/Deployment/RMS.cdd TIBCO_HOME/be/5.1/rms/bin/RMS.cdd 7. Restart the RMS server.

31 RMS Server Configuration Property Reference 15 RMS Server Configuration Property Reference See Configuring RMS Server Properties on page 12 for the related procedure. Properties not documented in this table are either for internal use or are for other types of configuration explained elsewhere in the documentation. Table 3 RMS Server Configuration Properties Property Notes WS-RMS-Common Property Group ws.scs.rooturl Specifies the location of the directory which contains the repository of RMS projects. This is the root location for RMS project directories. Default value (as shipped) is TIBCO_HOME/be/5.1/examples/standard/WebStudio See RMS Project Directory Structure on page 10 for information on this setting. rms.checkin.revisionid.initvalue ws.artifact.deploy.location be.codegen.rootdirectory Initial value of the revision number to use for project check in. Default is Name of the directory for storing EAR files generated for deployment. Separate directory for each project is created, where EAR files for the project are stored. See also be.codegen.rootdirectory below. Default is TIBCO_HOME/be/<version>/rms/shared Name of the directory for storing class files generated by the Generate Deployable menu option. The directory location is relative to the ws.artifact.deploy.location directory. If this property is not present, files are stored in the deployment directory. If this property is present but has no value, a directory is created with the default name Codegen.

32 16 Chapter 2 Configuring RMS and RMS Projects Table 3 RMS Server Configuration Properties (Cont d) Property Notes RMS Property Group rms.project.workspace rms.project.decisiondata rms.project.deployment Not used in this release Default is workspace Not used in this release Default is decisiondata Not used in this release Default is deployment rms.workflowstages.config.file Not used in this release Default is TIBCO_HOME/be/5.1/rms/config/RoleWorkflowStages.xml rms.lockworkflowstages.config.file Not used in this release Default is TIBCO_HOME/be/5.1/rms/config/LockWorkflowStages.xml rms.roleartifacttypes.config.file Not used in this release Default is TIBCO_HOME/be/5.1/rms/config/RoleApplicableArtifactTypesConfig.x ml rms.external.entities.autodetect Used internally. Do not change the value.

33 RMS Server Configuration Property Reference 17 Table 3 RMS Server Configuration Properties (Cont d) Property Authentication and Authorization (ACL) Properties be.auth.type Notes Specifies the authentication mechanism used, file or ldap. Additional configuration is required. be.auth.file.location Location of the authentication file used for file-based authentication. The default location is TIBCO_HOME/be/5.1/rms/config/security/users.pwd java.security.auth.login.config Location of the JAAS login configuration file. You can substitute a different implementation of the JAAS login module than the one provided. The default location is: TIBCO_HOME/be/5.1/rms/config/security/jaas-config.config. ws.projects.acl.location Location of the directory used for all ACL (authorization) files. Files must be named using the format RMSProjectName.ac. The default location is TIBCO_HOME/be/5.1/rms/config/security

34 18 Chapter 2 Configuring RMS and RMS Projects Table 3 RMS Server Configuration Properties (Cont d) Property RMS-GVs Property Group This group of properties override the values of global variables provided in the TIBCO BusinessEvents Extreme Studio BRMS project. They are made available as global variables so that they can be overridden at runtime, as needed. You can override the default global variable values in the RMS.cdd file (as shown below) for command-line startup. For defining and using global variables in TIBCO BusinessEvents Extreme Studio projects, see TIBCO BusinessEvents Extreme Developer s Guide. tibco.clientvar.rms/hostname tibco.clientvar.rms/port Specifies the host name or IP address of the machine where RMS is hosted. Remote clients can connect to the server at this location. Default is localhost. Specifies the port number of the machine where RMS hosted. This port is used for listening to client requests. See notes for tibco.clientvar.rms/hostname. Default is tibco.clientvar.rms/approval/adminrole WS Property Group Notes The value specified here has Administrator role permissions. When you change the default value, the Administrator role still has Administrator permissions. Default is Administrator. tibco.clientvar.webstudio/wardir Path to the Web archive for the client side representation of the TIBCO BusinessEvents Extreme WebStudio. Default is rms/bin/webstudio.war.

35 RMS Server Configuration Property Reference 19 Table 3 RMS Server Configuration Properties (Cont d) Property Notes tibco.clientvar.webstudio/hostname tibco.clientvar.webstudio/port Specifies the host name or IP address of the machine where RMS server is hosted for WebStudio. Default is localhost. Specifies the port number of the machine where RMS server is hosted for WebStudio. This port is used for listening to client requests. See notes for tibco.clientvar.rms/hostname. Default is tibco.clientvar.webstudio/connection/timeout Timeout interval for the HTTP channel. This value is in milliseconds. Default is tibco.clientvar.webstudio/sessiontimeout ws.validatedt.temp.dir Time interval for which an inactive user session will be valid. This value is in minutes. Default is 30. Directory which is used as an interim storage of Decision Table contents during the validation process. Default is rms/temp-dir. Global Variable Properties for One-Way SSL Between RMS Server and Decision Manager Clients See RMS Server Configuration Property Reference on page 15 for the procedure. tibco.clientvar.rms/security/secureport The port to be used for secure HTTP communication. Default is 443.

36 20 Chapter 2 Configuring RMS and RMS Projects Table 3 RMS Server Configuration Properties (Cont d) Property Notes tibco.clientvar.rms/security/sslcertificatestore Absolute path of the JKS keystore which contains the RMS server's public/private keys. If the certificate used is CA signed, include the CA's certificate. tibco.clientvar.rms/security/sslcertificatestorepassword The password for the keystore. Properties for One-Way SSL Between LDAP Server, RMS Server, and Decision Manager Clients Note For one-way SSL between LDAP server and RMS server, you must also change the value of be.auth.ldap.port. For one-way SSL between RMS server and Decision Manager clients, you must also set the value of be.auth.ldap.port. See RMS Server Configuration Property Reference on page 15 for the procedure. be.auth.ldap.usessl javax.net.ssl.truststore javax.net.ssl.truststorepassword javax.net.ssl.truststoretype If set to true, enables SSL between the RMS server and the LDAP server If set to false or not set, the LDAP authentication uses a non-secure channel. The absolute path of the keystore containing the LDAP server certificate chain. The password for the keystore. The keystore type for keystores other than JKS type, for example, PKCS12.

37 RMS Server Configuration Property Reference 21 Table 3 RMS Server Configuration Properties (Cont d) Property Notification Property Group notification properties are used to send notification when an artifact (business rule / decision table) undergoes a status change in approval workflow, such as, on artifact commit and on artifact reviews (Approve, Reject, BuildAndDeploy). In addition to these properties, you may have to define any SMTP protocol specific properties (mail.smtps.auth, mail.smtps.ssl.enable), depending on the mail server configuration. These properties should be defined with a prefix ws.notify.prop, for example, ws.notify.prop.mail.smtps.auth, ws.notify.prop.mail.smtps.ssl.enable. ws.notify.enabled Notes ws.notify.mail.domain ws.notify.prop.mail_protocol ws.notify.prop.mail_server_host ws.notify.prop.mail_server_port ws.notify.prop.sender_ If set to true, send notification. If set to false, do not send notification. Default is false. Specifies the domain on the . This is used with the RMS username to construct the address to which the notification is to be sent. For example, if RMS username is admin and the property is set to tibco.com, the address for the notification is admin@tibco.com. Specifies the protocol to be used to send the . SMTP and SMTPS are valid values. Default is SMTPS. Specifies the host name of the server. Specifies the port at which the mail server is listening. Specifies the address to be used for sending the notification .

38 22 Chapter 2 Configuring RMS and RMS Projects Table 3 RMS Server Configuration Properties (Cont d) Property Notes ws.notify.prop.sender_username ws.notify.prop.sender_password Specifies the sender s username for authentication to server. Specifies the sender s password for authentication to server.

39 Configuring User Authentication 23 Configuring User Authentication You can choose between the following options for user authentication. File Based Authentication This method authenticates a user against user data stored in a file based repository. This method is not recommended for production purposes. In file-based authentication, you define a list of user names, passwords, and roles in a the file called (by default) users.pwd file. This file is commonly referred to as the password file. LDAP Authentication This method authenticates users against a directory server using LDAP as a protocol. TIBCO BusinessEvents Extreme applications can leverage this information to authenticate users. The role information is configured through an LDAP attribute like the nsroledn attribute in Oracle Directory Server. The LDAP attribute differs in different directory server products. The details of configuring LDAP authentication are beyond the scope of this documentation. Consult your LDAP product documentation. Authentication In Various Components. TIBCO BusinessEvents Extreme Decision Manager RMS Component File-based authentication is enabled by default for the TIBCO BusinessEvents Extreme Decision Manager RMS component and LDAP authentication is supported. This component also uses authorization. Authorization details are provided in the following section of this chapter: Configuring Access Control for a Project, page 28. To Enable Authentication and Select File or LDAP Authentication Type 1. In TIBCO BusinessEvents Extreme Studio, import and open the relevant project and open the CDD file, or TIBCO BusinessEvents Extreme Decision Manager, as follows: BE_HOME/rms/project/BRMS > RMS.cdd > Cluster properties > RMS property group 2. In the CDD file add the following property if it is not present and specify the value as desired: be.auth.type=[file ldap]

40 24 Chapter 2 Configuring RMS and RMS Projects 3. Do one of the following: To configure LDAP authentication, add and configure the LDAP properties shown in Table 4, Authentication Configuration Properties in the CDD File, on page 25. Familiarity with LDAP is required. Details are not provided in this guide. To configure file-based authentication, see To Configure File-Based Authentication on page 24. For Active Directory Configuration For authentication, Active Directory requires the domain name, for example, abc@acme.com, and not distinguished name (which is used with Oracle Directory Server). If you are using Active Directory for authentication, ensure that the userprincipalname attribute is set on AD server. To Configure File-Based Authentication This procedure continues the instructions in To Enable Authentication and Select File or LDAP Authentication Type on page In the CDD file, add (or configure) the property be.auth.file.location and set the value to the location of your password file. 2. Locate and open the password file. Its location is specified in the CDD file. See step 1 for default location details. 3. Add each user on a separate line using this format: Username:password:role,role,role; Do not use spaces. For example here are some entries that might be used in TIBCO BusinessEvents Extreme Decision Manager: Mark:A31405D272B94E5D12E9A52A665D3BFE:BUSINESS_USER,APPROVER; James:21232f297a57a5a743894a0e4a801fc3:RULE_ADMINISTRATOR;

41 Authentication Property Reference 25 Authentication Property Reference CDD Properties Add these to the appropriate CDD file. See To Enable Authentication and Select File or LDAP Authentication Type on page 23 for more details Table 4 Authentication Configuration Properties in the CDD File Property Notes Common Authentication Properties java.security.auth.login.config be.auth.type be.auth.file.location Provides the absolute location for the login module configuration used by JAAS. Only advanced users should change this value (additional configuration is also needed). The locations of the provided files are as follows: TIBCO BusinessEvents Extreme Decision Manager: BE_HOME/rms/config/security/jaas-config.config Specifies the authentication mechanism. Allowable values are as follows: file: File-based authentication. Uses a password file. ldap: LDAP-based authentication Uses a pre-existing LDAP setup in use in your environment. Add and configure the properties shown in the LDAP Authentication Properties section of this table to work with your LDAP setup. Default is file Specifies the absolute filepath to and name of the password file. This file is used for file-based authentication. Each project can have a different file. The locations of the provided files are as follows: TIBCO BusinessEvents Extreme Decision Manager: BE_HOME/rms/config/security/users.pwd