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 [email protected]. 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 [email protected]. 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, [email protected], 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

42 26 Chapter 2 Configuring RMS and RMS Projects Table 4 Authentication Configuration Properties in the CDD File (Cont d) Property Notes LDAP Authentication Properties be.auth.ldap.host be.auth.ldap.port be.mm.auth.ldap.port be.auth.ldap.admindn be.auth.ldap.adminpassword Specifies the domain name of the host for LDAP authentication. Specifies the port for LDAP authentication. Specifies the base distinguished name (DN) for admin login. For example, cn=directory Administrators, dc=na, dc=tibco, dc=com. be.auth.ldap.basedn Specifies the password for the LDAP administrator DN. Specifies the base tree in LDAP under which users can be searched. For example, dc=na, dc=tibco, dc=com. be.auth.ldap.roleattr be.auth.ldap.uidattr Specifies the name of the attribute used by the LDAP server for role information of a user. Default value is nsroledn (for Oracle Directory Server). Specifies the name of the attribute used by the LDAP server for username information. Allowable values are as follows: uid for Oracle Directory Server cn for ActiveDirectory. Default value is uid.

43 Authentication Property Reference 27 Table 4 Authentication Configuration Properties in the CDD File (Cont d) Property Notes be.auth.ldap.useroledn be.auth.ldap.objectclass Set this property to true to use the fully qualified name of the attribute used by the LDAP server for role information of a user. Set this property to false to use only the name of the attribute, which is shown in the notes for the be.auth.ldap.uidattr property. Default value is true. be.auth.ldap.dnattr Specifies the ObjectClass attribute value for DS. Many object classes can exist, for example, inetorgperson on Oracle Directory Server, and user on Active Directory. If search should span all object classes, keep this value empty or specify an asterisk ("*"). be.auth.ldap.ssl Specifies the name of the attribute that contains the fully qualified name. Default value distinguishedname. Specifies a secure connection to the LDAP host is to be established. Default value false. Set the property to true to enable a secure connection.

44 28 Chapter 2 Configuring RMS and RMS Projects Configuring Access Control for a Project Access control is a core product feature. Access control is used by RMS projects and is available in the TIBCO BusinessEvents Extreme Decision Manager add-on and TIBCO BusinessEvents Extreme WebStudio. This section describes how the access control (user authorization) system works, the types of resource specifications that are permitted, and how to grant permissions to different users. Configuring Access Control Overview For each RMS project, you set up an access control file. In the access control file, you group the project resources as desired, giving each group (or individual resource) an ID. Then you use these IDs to assign permissions to each user role. Establishing the User Roles Access is defined using roles. If file-based authentication is used, roles are defined and assigned to users in the password file (by default called users.pwd). If LDAP-based authentication is used, roles are defined and assigned to users in the LDAP directory. You must use only the roles defined in the password file or LDAP directory (depending on authentication type used) when configuring the access control file. User role and username should not be same. Each username and role name should be unique. Guidelines for Configuring Access Control A project s access control file is an XML file named as follows: RMSProjectName.ac. The ACL file is stored in the directory specified by the RMS.cdd property ws.projects.acl.location. In the access control file resources element, you create resource elements to define groups of resources to suit your needs. You give each resource element an ID. In the entries element, you add one entry element for each user role to define the access permissions for that role, using the resource IDs and action elements. This brief summary is provided so you can understand the following guidelines. For full details. See Structure of the Access Control File on page 30.

45 Configuring Access Control for a Project 29 You can use two general approaches to setting permissions. The general aim is to simplify the setup, minimizing the number of permissions you have to set in the access control file. Allow everything and specify exceptions One approach is to grant wide permissions using large resource groupings, and then selectively deny permissions within those groupings. For example, suppose you define two resources as follows: <resource name="/concepts/*" id="allp" type="property"/> <resource name="/concepts/person/custid" id="cid" type="property"/> The first resource element defines a resource group consisting of all concept properties in the /Concepts project folder. The second element specifies one property in one concept. (The setup details are explained later in the chapter.) Then you define permissions using those resources. For example, for a role named CallCenter you might set up permissions as follows: <entry> <role name="callcenter"/> <permissions> <permission resourceref="#allp"> <action type="read">allow</action> </permission> <permission resourceref="#cid"> <action type="read">deny</action> </permission> </permissions> </entry> With these settings, you give users with the CallCenter role the read permission for all properties in the /Concepts directory except the custid property. An example of an access control file (CreditCardApplication.ac) giving all permissions available for the credit card application example, is located in the following directory: BE_HOME\rms\config\security Deny everything and specify exceptions Mixing these approaches Another approach is to deny all permissions (which is the default setting for all permissions) and then give permissions to specific resources or groups of resources as needed. You can mix these two approaches in one access control file. For example, you can give broad permissions to one project folder, and then specify exceptions within that folder. For another folder you might give permissions selectively.

46 30 Chapter 2 Configuring RMS and RMS Projects Structure of the Access Control File The access control file for a project is an XML file with the following elements: <resources> <resource id="id" type="resourcetype"/> <resource id="id" name="projectpath" type="resourcetype"/>... </resources> <entries> <entry> <role name="rolename"/> <permissions> <permission resourceref="#id"> <action type="actiontype">[allow DENY]</action> </permission>... </permissions> </entry>... </entries> </acl> The entries element contains one entry for each role. For each role, you define one set of permissions. Each permission has of the following attributes The resourceref attribute references a resource ID defined in the resources element. It identifies a resource or set of resources. The name attribute specifies the project path to the resource or resources. (The name attribute is not used when you specify permissions for an entire resource type.) The resource type attribute specifies what types of resources in the specified name attribute project path are included in the permission. The action type attribute specifies an action type, for example, create. This attribute determines the kind of action a user has permission to do, for the specified resource or resources. See Table 5, Resource Types and Their Allowable Action Types, on page 34.

47 Configuring Access Control for a Project 31 Permissions ALLOW and DENY The value of the action element is one of the key words ALLOW or DENY. It determines whether the specified permission is given denied. DENY is the default value. You only need to set the DENY value explicitly when you have given ALLOW permissions at a higher level, and want to make individual exceptions within that broad scope. The values ALLOW and DENY are case sensitive. Use all capitals. Working with Access Control Files Access control settings are created using XML files with the extension.ac. You can create or modify an RMSProjectName.ac file using any XML editor. This section explains the elements used to define access control, ways you can add or edit access control files, and where to place the files so they can be used by the RMS, Decision Manager components, and TIBCO BusinessEvents Extreme WebStudio. Examples shipped with the product contain access control files you can use as models. Required Location of Access Control Files The access control file for an RMS project must be placed in the location specified by the RMS server CDD property ws.projects.acl.location. An RMS project s ACL file must be named using the format RMSProjectName.ac. Specifying and Grouping Project Resources In the resources element, you group the project resources in whatever way supports the permissions you want to set. You give each grouping or individual resource an ID that is used when defining the permissions. Using Resource Type as a Filter How you specify the resource group is partly determined by the resource type attribute. The resource type can act as a filter. For example, suppose in the name attribute you specify a directory that includes events and concepts. If you set the type attribute to "CONCEPT" then the ID associated with this grouping is used to set permissions only on the concepts in that folder (and its subdirectories). You could create a second grouping whose type specifies "EVENT" so that you can set permissions on events in that folder branch separately.

48 32 Chapter 2 Configuring RMS and RMS Projects Specifying an Individual Resource To specify an individual resource, provide the project path to the resource in the name attribute. The project path is the folder path to the ontology entity, as seen in the Explorer panel. The example below shows how to specify an ID that is associated with the FirstName property of the Person concept: <resource name="/concepts/person/firstname" id="fn" type="property"/> Grouping Resources Using Wildcards You can associate groups of resources with an ID using the wildcard character in the project path. The asterisk (*) is used as the wildcard character. For example: <resource name="/somefolder/* "id="allp" type="property"/> Grouping Resources by Resource Type The broadest resource grouping is provided by setting permissions at the level of resource type. This method groups all resources of that type in the project. To set a resource type resource group, you associate an ID with a resource type, and you do not use the name attribute: <resource id="id" type="resourcetype"/> For example: <resource id="c" type="concept"/> See Table 5, Resource Types and Their Allowable Action Types, on page 34 for a list of resource types, and the action types that are valid for each resource type. Defining Permissions As explained in Specifying and Grouping Project Resources on page 31, you define a list of resource IDs according to the way you want to group resources and actions. All items included under one resource ID must be of the same resource type (or type of activity, such as checking out a project). For each user role you add a set of permissions. <role name="administrator"/> <permissions> <permission resourceref="#prj"> <action type="checkout">allow</action> </permission> </permissions>

49 Configuring Access Control for a Project 33 Each resourceref points to a resource ID. You create permissions using the actions available for the resource type specified for that ID, such as create, read, and modify. See Table 5, Resource Types and Their Allowable Action Types, on page 34 for the resource types and their available action types. By default, all permissions are denied. If a certain permission is not explicitly given to a role, then the role does not have the permission. This approach ensures unauthorized users do not accidentally gain access to restricted resources. Permissions are not hierarchical. That is, a create permission does not imply a modify permission or a read permission. All privileges are mutually exclusive. So, for example, if you want users to be able to modify some resources of a certain resource type, be sure to also give users the ability to view that resource type. Note that for use in TIBCO BusinessEvents Extreme Decision Manager, most TIBCO BusinessEvents Extreme project resources have only a read action type. Resource Types and Corresponding Action Types See Defining Permissions on page 32 to understand how to define permissions for a user role using the action types available for each resource type. If a resource ID specifies a set of resources, the permission applies to that set of resources only. If it specifies a resource type, then the permission applies to all resources of that resource type.

50 34 Chapter 2 Configuring RMS and RMS Projects Table 5 Resource Types and Their Allowable Action Types Resource Type Allowable Action Types (If action is ALLOW) Enables Users to... PROJECT checkout Check out TIBCO BusinessEvents Extreme project resources. Note Users can check out only those resources they are allowed to read. update gen_deploy commit approval Update TIBCO BusinessEvents Extreme project resources that were checked out earlier. Users can update only those resources they are allowed to read. Use the Generate Deployable RMS menu option for building EAR files or class files. Commit the modified/deleted TIBCO BusinessEvents Extreme project resources. Review the worklist items in a project. (WebStudio only) CATALOGFUNCTION invoke Invoke catalog functions in decision tables (RULEFUNCTIONIMPL resource type) that the users are allowed to modify. CHANNEL read View channels. CONCEPT read View concepts. DOMAIN read View domain models. create Create domain models. EVENT read View events. PROPERTY read View resource properties. If no resources are specified, then users can view properties of all resources that they are allowed to view (read). RULE read View rules (rule source code).

51 Configuring Access Control for a Project 35 Table 5 Resource Types and Their Allowable Action Types (Cont d) Resource Type Allowable Action Types (If action is ALLOW) Enables Users to... RULEFUNCTION read View rule functions (rule function source code). add_impl del_impl Add decision tables (RULEFUNCTIONIMPL resource type). If specific rule functions are not listed, then users can add decision tables to all rule functions they are allowed to view (read). (Other permissions that apply to decision tables are set on the resources used in the decision table.) Delete decision tables (RULEFUNCTIONIMPL resource type). RULEFUNCTIONIMPL read View decision tables (RULEFUNCTIONIMPL resource type). Add columns in the Condition area of the decision table. Add rows and modify cells in existing rows and columns. modify Add columns in the Action area of decision tables. WSDL read View WSDL files. XSD read View XSD files. WebStudio Only Permissions RULETEMPLATE read Checkout rule templates. RULETEMPLATEINSTANCE read View business rules. add_inst del_inst Create business rule for the rule template. Delete business rule. RULETEMPLATEVIEW read Checkout rule template views.

52 36 Chapter 2 Configuring RMS and RMS Projects

53 37 Chapter 3 Working With Projects in WebStudio This chapter explains how to work with projects, for example, creating projects and committing their resources for approval. Topics Starting and Logging in to RMS, page 38 Checking Out a Project, page 40 Updating (Synchronizing) a Project, page 41 Committing Artifacts for Approval, page 42

54 38 Chapter 3 Working With Projects in WebStudio Starting and Logging in to RMS To start RMS, do one of the following: Execute TIBCO_HOME/be/<version>/rms/bin/be-rms.exe (be-rms on Linux) with valid arguments. For example, on Windows you would open a command window in TIBCO_HOME/be/<version>/rms/bin/ and execute: be-rms.exe (Windows only) Select Start > All Programs > TIBCO > Tibco be-x> TIBCO BusinessEvents Extreme version > Start Rules Management Server. The server is ready when you see a message in the command window such as this: Info [HTTP-Channel-Startup] - [driver.http] Channel server for HTTP Channel [Port:5000] successfully started To Log in to RMS from WebStudio 1. Type the URL in a web browser. The default host is localhost and the default port is Host and port are configurable using properties in the RMS.cdd. Make sure that the RMS is running before logging to TIBCO BusinessEvents Extreme WebStudio. 2. Type the username and password for TIBCO BusinessEvents Extreme WebStudio. The default username is admin and the default password is admin. 3. Click Login to sign in to RMS. The application displays the TIBCO BusinessEvents Extreme WebStudio dashboard. The system restricts multiple simultaneous login of the same username. To Log out of RMS In TIBCO BusinessEvents Extreme WebStudio, click Sign out to log out. In the case of session timeout, the user is automatically logged out.

55 Starting and Logging in to RMS 39 Status Check for RMS Connection Once a TIBCO BusinessEvents Extreme Studio, a TIBCO BusinessEvents Extreme Decision Manager, or a TIBCO BusinessEvents Extreme WebStudio client logs in to RMS, a background activity on the dashboard page periodically polls the RMS server to refresh the Worklist items. You can configure the interval (in seconds) of these status checks by setting the following property in studio.tra: rms.heartbeat.delay By default, the delay is of two seconds. If the server goes down, the menu options for RMS are automatically disabled. However, if you are already performing an RMS operation and the server goes down, the operation fails. The login option is enabled when the server comes up again.

56 40 Chapter 3 Working With Projects in WebStudio Checking Out a Project If RMS is used in your environment, then you must log into RMS and check out a project from RMS before you can work with the project resources in the TIBCO BusinessEvents Extreme WebStudio UI. When generating an EAR file using the Generate Deployable option, the project resources from the RMS repository and not from the workspace are used. Depending on your role or roles, you may not have permission to check out all resources or to do all of the documented tasks. For instructions on updating a project you already checked out, see Updating (Synchronizing) a Project on page 41. To Check Out a Project in WebStudio 1. Open the checkout window using any of the following methods: In the Dashboard tab, click the link in the My Projects section if no projects are checked out. In the My Workspace tab, click WebStudio, and from the pull-down menu, choose RMS > Checkout. In the RMS toolbar, click the checkout icon. 2. In the checkout window, select the project you want to checkout from the Project List drop-down. In TIBCO BusinessEvents Extreme WebStudio the checked out project is displayed under Group Contents and the project files are loaded to your workspace. The Group Contents section displays the artifacts based on the groups (Projects/Business Rules/Decision Tables) selected in the Groups section. The Business Rules and the Decision Tables group are selected by default after you check out a project. TIBCO BusinessEvents Extreme WebStudio displays the project files in the Group Contents section either as a list or in a tree structure. In the Group Contents section click the project view icon to select the Show items as tree or Show items as list option to toggle between the tree view ( )and the list view ( ). The list view is the default view.

57 Updating (Synchronizing) a Project 41 Updating (Synchronizing) a Project This section explains how to update the projects on your workspace with the most recent changes from the corresponding RMS projects. It is recommended that you log into the RMS server, and update (synchronize) your local copy of a project before continuing to work on it. Other users may have checked in changes, additions, and deletions that are now available for checkout. There may be other changes too. You can select what updates to accept. Changes and additions to individual decision tables and business rules are listed. To Update a Project in WebStudio 1. In the Group Contents section, select the artifact you need to synchronize. The synchronize command does not support multiple artifact selection using Shift or Ctrl key. Alternatively, select a folder/project to select all artifacts under that folder/project, when project files are displayed in a tree structure. 2. Open the synchronize window using any of the following methods: Click WebStudio, and from the pull-down menu, select RMS > Synchronize. In the Group Contents directory, right-click on the selected artifact and then select RMS > Synchronize. Click the synchronize icon in the RMS toolbar. 3. Select the checkboxes of the files you want to synchronize and click OK. Alternatively, select the header checkbox to synchronize all the listed project files and click OK. The selected artifacts are updated with the latest project files from RMS.

58 42 Chapter 3 Working With Projects in WebStudio Committing Artifacts for Approval After you complete the additions, changes, or deletions to a project you checked out of RMS, commit the artifacts for approval. You can make a commit request for a selection of artifacts, or all. Copies of submitted artifacts are saved in cache, with the names of the users who submitted them, version numbers, and the status Commited. A task is created for the Approver role to review the check-in requests. (see Chapter 6, Working with the Approval Workflow in RMS, on page 77). A Revision ID is assigned to each commit request. This ID is used in other dialogs to allow you to view the details on the request. Viewing the Audit Trail This feature is available only if the TIBCO BusinessEvents Extreme Decision Manager feature is installed. You can view the entire audit record of the previous status changes for a checkin. This is especially useful for the multi-stage approval process so that different reviewers actually share views on why a particular checkin was approved or rejected. To Commit Project Resources for Approval from WebStudio 1. In the Group Contents section, select the artifact you need to commit. The commit command does not support multiple artifact selection using the Shift or Ctrl key. Alternatively, select a folder/project to select all the artifacts under that folder/project, when the project files are displayed in a tree structure. 2. Open the commit window using any of the following methods: Click WebStudio, and from the pull-down menu, select RMS > Commit. Right-click on the selected artifact and select RMS > Commit. Click the commit icon in the RMS toolbar. 3. In the Commit window enter the revision description in the Comments text box. The Comments field is a mandatory field and system will not commit the changes to the repository if it is empty.

59 Committing Artifacts for Approval Click the checkboxes for the files you want to commit to the RMS project and click OK. Alternatively, click the header checkbox to select all the listed project files. 5. Click Finish after the system displays the checkin successful message with the revision ID.

60 44 Chapter 3 Working With Projects in WebStudio

61 45 Chapter 4 Working with Decision Tables in WebStudio This chapter explains how to work with decision tables, in TIBCO BusinessEvents Extreme WebStudio. Decision tables are available in TIBCO BusinessEvents Extreme WebStudio in edit mode only if you have the TIBCO BusinessEvents Extreme Decision Manager feature installed on your system. If you are creating/modifying the decision table for the first time, then generate the EAR files before creating/modifying decision tables. See Generating the Project EAR or All Project Class Files on page 85 on how to generate the EAR files for the project. Topics Working With Decision Tables, page 46 Understanding Columns and Rows (Rules) in a Decision Table, page 51 Working With Rows and Columns in WebStudio, page 53 Supported Operators, page 60 Analyze a Decision Table, page 62 Validate a Decision Table, page 64

62 46 Chapter 4 Working with Decision Tables in WebStudio Working With Decision Tables This section presents the process to perform various decision table operations in TIBCO BusinessEvents Extreme WebStudio. Create/Remove a Decision Table A decision table can only be created using a virtual rule function (VRF) in the BusinessEvents Extreme Studio interface. For instructions on adding a VRF, see TIBCO BusinessEventsExtreme Developer s Guide. If you are creating/modifying the decision table for the first time, then generate the EAR files before creating/modifying decision tables. See Generating the Project EAR or All Project Class Files on page 85 on how to generate the EAR files for the project. Once you have created a decision table, you can add it to a project using the TIBCO BusinessEvents Extreme WebStudio interface. You can also can delete decision tables after they have been created in BusinessEvents Extreme Studio. If the table you want to delete has been checked into the RMS project, then you must submit the deletion for approval. After approval, the deleted table is removed from the RMS project. To Add a Decision Table to a Project 1. Select the Projects group. 2. In the Group Contents section, right click the virtual rule function (VRF) you want to use and click New Decision Table. 3. Enter the decision table name in the Decision Table pop-up window and click OK. The new empty decision table is displayed in the work area. To Remove a Decision Table 1. Do one of the following: InGroup Contents, right-click the decision table name and select Delete. InGroup Contents, select the decision table name. Then click the delete icon in the Edit toolbar.

63 Working With Decision Tables If the table has been committed to the RMS project, select one of the following options as appropriate: Commit the project or the parent folder so that the RMS master copy of the table is also deleted. Synchronize the project to replace the deleted copy with the RMS project version of the table. Edit a Decision Table Open a decision table In the Group Contents section, double click the decision table you want to open. You can now edit, analyze, and export the open decision table. If you are creating/modifying the decision table for the first time, then generate the EAR files before creating/modifying decision tables. See Generating the Project EAR or All Project Class Files on page 85 on how to generate the EAR files for the project. Add Rows and Columns See Working With Rows and Columns in WebStudio on page 53 for more details on adding rows and columns to a decision table in TIBCO BusinessEvents Extreme WebStudio. Set Decision Table Properties To set properties of a new decision table, follow these steps:

64 48 Chapter 4 Working with Decision Tables in WebStudio 1. In the decision table work area, click the properties icon. The Properties view is displayed at the bottom of the work area. 2. In the Effective Date field, you can optionally define the date and time on which the decision table becomes valid in the runtime application. Click the calendar icon and use the Calendar dialog box to set the date and then edit the time as needed. 3. Similarly in the Expiry Date field, you can optionally define the date and time after which the decision table is no longer valid in the runtime application. 4. Select the Take Actions of One Row at Most check box if you want the decision table to stop after one row (rule) passes the condition tests. Only the actions of that one row are considered (until the next time the decision table s rule function is called). 5. In the Priority field, set a priority as desired. When a VRF has multiple implementations (decision tables), the decision table s Priority setting determines the order in which the decision tables executes. 6. Click the Save icon in the Edit toolbar to save the changes to the decision table. The decision table is still open for you to edit and changes are not applied to RMS unless you commit the changes to RMS. Export a Decision Table You can export decision tables from TIBCO BusinessEvents Extreme WebStudio to Microsoft Excel spreadsheets. See Figure 1.

65 Working With Decision Tables 49 Figure 1 Sample Exported Microsoft Excel Sheet: To Export the Decision Table 1. Open the decision table you want to export. 2. Execute the export command in either of the following ways: Click the export icon in the Tools toolbar. You see the Save As dialog box for the exported file. Right click the decision table in the Group Contents section and select Export. 3. Navigate to the directory in which you want to save the excel file and provide a file name. 4. Click Save. Import a Decision Table You can import correctly formatted Microsoft Excel file to create a decision table in TIBCO BusinessEvents Extreme WebStudio. Only import from Excel files is supported You cannot import from CSV (comma-separated values) files or tab-delimited text files. You can open such files in Excel and save as Excel format binary files.

66 50 Chapter 4 Working with Decision Tables in WebStudio To Import the Decision Table 1. Open the Import dialog box in either of the following ways: Select the virtual rule function and click the import icon in the Tools toolbar. Right click the virtual rule function in the Group Contents section and select Import. 2. Click Choose File in the Import dialog box. 3. Browse the excel file you want to import and click Open. 4. Enter the new decision table name and click OK.

67 Understanding Columns and Rows (Rules) in a Decision Table 51 Understanding Columns and Rows (Rules) in a Decision Table A decision table rule is a row in the decision table. It has one or more conditions and one or more actions. Each condition cell is equivalent to one condition (one line) in the TIBCO BusinessEvents Extreme rule editor condition area. Similarly each action cell is equivalent to one action (one line) in the TIBCO BusinessEvents Extreme rule editor action area (that is, one rule). Decision table rules are like business rules. The rule that calls the virtual rule function that implements the decision table participates in inferencing in the usual way. When the virtual rule function is called, the decision table rules are applied. Conditions and Actions The columns of a decision table are made up of condition columns on the left, and action columns on the right. Each column represents one condition or one action. A condition is a test that must evaluate to true before the action is executed. If a decision table rule uses multiple conditions, all the conditions for a row must evaluate to true for the action to execute. In each row (rule) you define the specific conditions and actions. For example, if a condition column is Age (using a concept property of that name), then each row can define a different age range. The action for each row would define what action to take if a given concept instance contains an age property within the specified range. If you add a second condition column called Income, then before the action is taken, a concept instance would be tested to see if both the age and the income are within the ranges specified in the rule s conditions. Conditions that are blank, contain an asterisk, or are disabled are ignored, and are treated as if they evaluate to true. Regular and Custom Conditions and Actions A regular condition is the value of an entity specified in the VRF scope, or a simple comparison with the value - is greater than, is less than, is greater than or equal to, is less than or equal to. A custom condition can use the rule language, standard functions, and data in the scope of the function at runtime (for example, scorecards and global variables). It can contain complex formulas. A regular action sets the value of an entity specified in the VRF scope.

68 52 Chapter 4 Working with Decision Tables in WebStudio A custom action can use the rule language, standard functions, and data in the scope of the function at runtime to do whatever is desired. For example, the action could be to send an event out to a different system for follow-up. Using non-literal values in a regular condition or regular action Suppose event A and event B are in scope, and event A has property ZZ, and event B has property YY. Both properties belong to the same data type. Suppose you then drag property ZZ to a condition or action column. In the cell, you can then specify a value as b.yy. The effect is different depending on the type of column: In a condition column, this means: compare the value of property ZZ with the value of property YY. In an action column this means: set the property ZZ to the value of YY.

69 Working With Rows and Columns in WebStudio 53 Working With Rows and Columns in WebStudio This section presents various operations you can perform as needed while working with rows and columns of a decision table in TIBCO BusinessEvents Extreme WebStudio. If you are creating/modifying the decision table for the first time, then generate the EAR files before creating/modifying decision tables. See Generating the Project EAR or All Project Class Files on page 85 on how to generate the EAR files for the project. Add Condition and Action Columns The columns of a decision table are made up of condition columns on the left, and action columns on the right. Each column represents one condition or one action. A condition is a test that must evaluate to true before the action is executed. If a decision table rule uses multiple conditions, all conditions for a row must evaluate to true in order for the action to execute. Add condition and action columns from arguments under the VRF scope or using the rule language, standard functions, and data in the scope of the function at runtime (for example, scorecards and global variables). To Add Condition and Action Columns from Arguments 1. Open the decision table you want to edit. 2. In the Group Contents section, right click the decision table and select Show Arguments.

70 54 Chapter 4 Working with Decision Tables in WebStudio A plus icon is displayed in front of the decision table for argument list expansion. 3. Click the plus icon to expand the arguments list. If needed, click the plus icons for concepts and rules as well. The decision table arguments are listed under the decision table. 4. Drag a property from the argument list to the decision table editor. A Create Column pop-up window appears to create the condition or action column.

71 Working With Rows and Columns in WebStudio Click the Condition or Action radio button and click OK to create a Condition or Action column. New Condition or Action column is added at the end of the Condition or Action column-sets respectively. To Add Custom Condition and Action Columns 1. Open the decision table you want to edit. 2. Click Custom in the decision table editor menu and select either of the following options: Select Add a custom Condition to insert a custom condition column at the end of condition column set. Select Add a custom Action to insert a custom action column at the end of action column set. Working with Columns You can perform actions on a column to resize, sort, associate to domain model, or remove from a decision table. Resize a column Perform any of the following actions to resize a column in the TIBCO BusinessEvents Extreme WebStudio: Drag the right boundary of a column to manually resize them.

72 56 Chapter 4 Working with Decision Tables in WebStudio Open the column header menu using either of the following ways and click Auto Fit to resize the column to fit to the content size: Right click on the column header you want to resize. Move the mouse pointer to the column header to view the down-pointing triangle and click the triangle. Double click the right boundary of a column to make it auto fit to the content size. Open the column header menu using either of the above mentioned ways and click Auto Fit All Columns to resize all columns to fit their content size. Sort the decision table Sort the decision tables in TIBCO BusinessEvents Extreme WebStudio in one of the following ways: Click once on the column header to sort the table in ascending order of the column and click again on the column header to re-sort the table in descending order of the column. Open the column header menu using either of the following ways: Right click on the column header you want use for sorting. Move the mouse pointer to the column header to view the down-pointing triangle and click the triangle. Click Sort Ascending or Sort Descending to sort the table in ascending or descending order of the column. Sort options are not available for columns with boolean entry values and for custom condition and action columns.

73 Working With Rows and Columns in WebStudio 57 Associate and Remove Domain Association A domain model specifies the values that you may find useful for defining ontology item properties. For example, instead of typing text for a certain concept property, you can pick a value from a list, or enter a value within a predefined range. To associate a domain model, right click on the column and on the menu, click Associate Domain. The setting toggles to ON. To clear the domain association, click Associate Domain again. The setting toggles to OFF. Remove a Column Right click the column header and click Remove to remove the column from the decision table. You cannot remove the last condition column because a minimum of one condition column must exist if you have any action columns. Add a Row Each row in a decision table represents a separate business rule. You can control the order in which sets of rows are executed using the row priority setting, see Setting Rule (Row) Priorities on page 58. Set Row Priority in TIBCO BusinessEvents Extreme WebStudio To set the row priority, with ten as the lowest priority and one as the highest, do the following: 1. Select the row whose priority you want to set. 2. Click the Properties icon to display the Properties view. 3. Select the Properties view, and select the Rule side-tab. 4. In the Priority field, select the appropriate value.

74 58 Chapter 4 Working with Decision Tables in WebStudio 5. Click the Save icon in the Edit toolbar to save the changes to the decision table. Setting Rule (Row) Priorities Each row is like a separate business rule. You can control the order in which sets of rows are executed using the row priority setting. Rows with higher priorities are executed before those with lower priorities, as follows: 1. First, all conditions are checked for all rows that have the highest priority. (The checking order within a set of rows with the same priority is not determinate.) 2. Then the rule actions for all of those rows whose conditions evaluate to true are executed. (The execution order is not determinate. The runtime engine optimizes rule execution.) 3. The process is repeated for all rows with the next highest priority, and so on. To Set Row Priority Ten is the lowest priority and one is the highest. Five is the default priority. 1. Select the row whose priority you want to set. 2. Select the Properties view and then select the Rule side-tab. 3. In the Priority field, select the appropriate value and click Apply.

75 Working With Rows and Columns in WebStudio 59 Filter Rows Filtering rows helps you to focus on certain rows instead of entire table. Apply filters on multiple columns for more refined results. In TIBCO BusinessEvents Extreme WebStudio decision table filter makes only textual comparison between the row values and filter values. Click Filter > Decision Table in the decision table editor menu to enable the filter for the decision table. Enter the values in filter cells (above column header) to filter the table. To remove the filter click Filter > Remove in the decision table editor. Remove Rows Select the rows you need to remove and click Remove in the decision table editor. In the Remove Decision Table Record window, click OK to confirm the removal of the row. You can remove only one row at time. Create Duplicate Rows (Rules) Select the Decision Table rows that you want to duplicate and click Duplicate Row in the Decision Table editor to duplicate the selected rows. New rows are added, at the end of decision table, with the same conditions and actions of selected rows, but with a different ID. You can then edit the rows as needed.

76 60 Chapter 4 Working with Decision Tables in WebStudio Supported Operators Table 6 lists the operators supported by Decision Tables: Table 6 Supported Operators Operator Description == Equals to!= Does not equal to > Greater than >= Greater than or equals to < Less than <= Less than or equals to Logical OR && Logical AND + Addition or String concatenation (depending on context)! Logical NOT (only with boolean) - Subtraction * Don t Care (that is, ignore), or multiplication (depending on context) / Division = Assignment. Scope resolution () Operator precedence order or function call (depending on context) [] Array declaration or array indexing (depending on context) {} Block resolution or array Initialization (depending on context)?: Ternary conditional ++ Increment (used only with custom actions)

77 Supported Operators 61 Table 6 Supported Operators (Cont d) Operator Description -- Decrement (used only with custom actions) Using Operators in Tables Named or Scoped Conditions must Evaluate to Boolean For logical operators, named conditions will have to use them explicitly from the second operand onwards. For example, if the LHS of the condition is the column name, bankuser.age, the following are valid entries: 50 ==60, 40 && ==80, 20 >=80 Custom Conditions must evaluate to Boolean Same as above, except that you must specify the entire Boolean expression in the cell, including LHS. Actions or Custom Actions Named actions perform assignment of the cell expression to the column name property. Custom actions are treated as normal strings and can be anything that you would enter in the THEN section of rules (LHS included).

78 62 Chapter 4 Working with Decision Tables in WebStudio Analyze a Decision Table Table Analyzer will create a sparse matrix data structure representing an optimized form of the decision table in memory. In the Table Analyzer you can set example condition values and perform various validation checks on the currently displayed decision table. Table analyzer supports the Not Equal To (!=) operator. The table analyzer feature provides various tools that you can use to check the validity of your decision tables. To analyze a decision in the TIBCO BusinessEvents Extreme WebStudio, do the following: 1. Open the decision table you want to analyze. 2. Click the Decision Table Analyzer icon to view Table Analyzer. 3. In the Table Analyzer section, controls are created dynamically for setting values and ranges for each condition in the table. Enter or select the example values for which you want to analyze the table. For example, if the condition is a range, for instance < 40 or > 10 && < 100, then the corresponding control in the Table Analyzer section is a Slider that spans the range from the minimum value to the maximum value. You can then select a range of values within the range. 4. Click the Analyze icon to analyze the decision table based on the selected values.

79 Analyze a Decision Table 63 A pop-up window displays the count of any issues. The Problems section at the bottom displays more information on issues. Click the issue to highlight the row. You can click the Show Coverage icon all rows that meet the criteria. in the table analyzer section to highlight For example, if you select Male for Gender; true for Eligible; and for Income, clicking Show Coverage displays all rows that have Male, true, and an income between and

80 64 Chapter 4 Working with Decision Tables in WebStudio Validate a Decision Table In TIBCO BusinessEvents Extreme WebStudio, you can validate decision tables for the changes using the validate command. Select the decision table and click the Validate icon to validate the table. The Validate icon is activated when the decision table is opened in the editor. EAR file for the project should be present in the deploy location; otherwise, the validate command fails. If there are any access control violations or syntax errors in the tables, they are shown in the Problems View tab at the bottom of the application. New errors in syntax are added to these existing errors. Double-click errors to see the problematic view. Take any needed corrective actions and then validate the table again until all errors are resolved.

81 65 Chapter 5 Business Rules The Business Rules artifact allows non-technical business users to build complex business rules in TIBCO BusinessEvents Extreme WebStudio. Business Rules are created using the Rule templates developed in TIBCO BusinessEvents Extreme Studio. See TIBCO BusinessEvents Extreme Developer s Guide for details on how to create a rule template. This chapter explains business rules and how to create them. Topics Business Rules Overview, page 66 Working with Business Rules, page 67 Business Rule Operators, page 72

82 66 Chapter 5 Business Rules Business Rules Overview Business rules are defined inside TIBCO BusinessEvents Extreme WebStudio, and are intended to be used by non-technical users. TIBCO BusinessEvents Extreme WebStudio users complete the definition of the rule instance using one of the following types of user interface: A form where users can provide values for bindings defined in TIBCO BusinessEvents Extreme Studio. The form interface is the visual presentation of the rule template defined by rule template views. See TIBCO BusinessEvents Extreme Developer s Guide for more details on rule template views. A builder style of user interface where users can build conditions and actions using various operators. A builder based user interface is presented to the user only if there is no view associated with the rule template. Business Rule Builder The builder for business rule in the TIBCO BusinessEvents Extreme WebStudio consists of two sections: When section - condition builder When section lets the user define additional conditions that must be met, in addition to the pre-condition defined in the Rule Template. The builder determines the scope of the rule template, and allows the user to define individual conditional clauses based on that scope. Each conditional clause has one or more sub-clause, and a match operator determines whether the conditional clause is true when all sub-clause are true, or any one sub-clause is true, or none of the sub-clauses evaluate to true. Then section - command builder Then section defines additional actions to be taken based on the conditions defined. The builder lets the user define actions based on the statements defined in the Action Context section of the rule template. Ensure that all the actions in the business rule are defined and the order should match that of the rule template. Otherwise, the business rule will be invalid.

83 Working with Business Rules 67 Working with Business Rules In TIBCO BusinessEvents Extreme WebStudio, you can create, modify, or delete business rules. Any modification after commit goes through the RMS approval process (see Chapter 6, Working with the Approval Workflow in RMS, on page 77). A business rule in a project is identified by the.ruletemplateinstance file extension. The rule template instance file is generated when the BuildAndDeploy option is selected for the business rule in approvals. See Generating One Business Rule s Rule Template Instance File on page 87 for more details. Adding Business Rules In TIBCO BusinessEvents Extreme WebStudio, a business rule is created using a rule template defined in TIBCO BusinessEvents Extreme Studio. If a rule template view is associated for the rule template, the business rule has an easy-to-use form based interface to specify conditions and actions; otherwise, conditions and actions are added using the builder. See TIBCO BusinessEvents Extreme Developer s Guide for overview on rule template, and rule template view. See Chapter 3, Working With Projects in WebStudio, on page 37 for more details on starting and logging into RMS, and checking out project resources. To add a business rule 1. In TIBCO BusinessEvents Extreme WebStudio, under the Group Contents section, right click the rule template you want to use and select Create Business Rule. 2. Type the business rule name in the dialogue box and click OK. 3. If the rule template view is defined for the rule template, then the HTML form is presented in the business rule editor. Then follow the steps as in To add a business rule using an HTML form on page 68 to create a business rule. 4. Otherwise, if the view is not associated with the rule template, a builder interface opens up in the editor. Perform the steps in the following sections to create a business rule: To add a conditional clause using a builder on page 68 To add an action using builder on page 69

84 68 Chapter 5 Business Rules To add a business rule using an HTML form 1. In WebStudio, enter the threshold values in the input fields of the HTML form. 2. Click the Save icon to save updates to the business rule. To add a conditional clause using a builder 1. In the business rule editor, under the When section, click the artifact-name link and select the artifact you require. 2. Click the operator-name link to select another operator, or a child artifact of the previously selected artifact, as you require. See Condition Builder Operators on page 72 for list of supported operators. 3. Enter the conditional value for the artifact in the empty box. 4. Click the Add icon to add another condition to the conditional clause, or click the Remove icon to remove the existing condition from the conditional clause, if you want. 5. Click the Add Sub-clause icon to add a conditional sub-clause to the conditional clause, if you want.

85 Working with Business Rules Click the match-operator link to select the matching condition for which the conditional clause evaluates to true. The values are: Match Any Conditional clause is true if any of the condition evaluates to true Match All Conditional clause is true only if all of the conditions evaluates to true Match None Conditional clause is true only if none of the conditions evaluates to true. 7. Click the Save icon to save updates to the business rule. To add an action using builder 1. In the business rule editor, under the Then section, click the Action drop-down list to select the actions available for the rule template. 2. Click the artifact-name link and select the artifact you want modify. 3. Click the operator-name link and select the command for the artifact. See Action Builder Operators on page 74 for list of available on operators. 4. Type the value, you want to set for the artifact, in the empty box. 5. Click the Add icon to add another parameter for the action, or click the Remove icon to remove the parameter for action, if you want. 6. Click the Save icon to save updates to the business rule.

86 70 Chapter 5 Business Rules Export a Business Rule You can export business rules fromtibco BusinessEvents Extreme WebStudio to rule template instance file. Sample exported rule template instance file content: <?xml version="1.0" encoding="utf-8"?> <RuleTemplateInstance id="738cd4ea aa86-fb88a89bf0a3" implementspath="/rule_templates/applicant_prescreen"> <actions/> <binding id="minimumincome" value="5000"/> <binding id="minimumage" value="25"/> <binding id="credittype"/> </RuleTemplateInstance> To Export the Business Rule 1. Open the Export dialog box in either of the following ways: Select the business rule and in the Tools tool bar, click the Export icon. Right click the business rule in the Group Contents section and select Export. 2. Navigate to the directory in which you want to save the rule template instance file and provide a file name. 3. Click Save. Deleting Business Rules If the business rule you want to delete has been checked into the RMS project, then you must submit the deletion for approval. After approval, the deleted table is removed from the RMS project, but it is not removed from the user s workspace. If you are not sure whether a table you deleted was committed to the RMS project in a prior action, click WebStudio, and form the pull-down menu, select Project > Commit. If the deleted table does not appear in the Changes Made panel, then it is a local table. To Delete a Business Rule 1. Do one of the following: InGroup Contents, right-click the business rule name and select Delete. InGroup Contents, select the business rule name. Then click the Delete icon in the Edit toolbar.

87 Working with Business Rules If the business rule has been committed to the RMS project, select one of the following options as appropriate: Commit the project or the parent folder so that the RMS master copy of the business rule is also deleted (see To Commit Project Resources for Approval from WebStudio on page 42). OR Synchronize the project to replace the deleted copy with the RMS project version of the business rule (see To Update a Project in WebStudio on page 41). 3. Do one of the following: InStudio Explorer, right-click the business rule name and select Delete. In Studio Explorer, select the business rule name. Then select File > Delete. 4. If the business rule has been committed to the RMS project, select one of the following options as appropriate: Select Project > Commit so that the RMS master copy of the table is also deleted. Select Project > Synchronize to replace the local deleted copy with the RMS project version of the table. When an artifact deletion is approved, the artifact is permanently deleted from the RMS project. However, When Decision Manager or WebStudio users update their projects, the deleted artifacts do not appear in the list of changes. Users who have already checked out the project must manually delete their local copy of the artifact.

88 72 Chapter 5 Business Rules Business Rule Operators This section lists the operators supported in the business rules builder. RTI builder operators consists of the conditional clause operators and the action builder operators. The operator list changes as per the parent entity type in the builder. Condition Builder Operators Parent Type Concept / Event Operator Value on WebStudio Client Matches Other Field Differs From Field Is Null Is not Null Operator Value on RMS Server == <field>!= <field> == null!= null Data / Time / Datetime Matches Other Field Differs From Field Is Null Is not Null == <field>!= <field> == null!= null Integer / Float Matches Other Field Differs From Field Is Null Is not Null == <field>!= <field> == null!= null Greater Than > Greater Than Field > <field>

89 Business Rule Operators 73 Parent Type Operator Value on WebStudio Client Greater Than Equal To >= Operator Value on RMS Server Greater Than Equal To Field >= <field> Less Than < Less Than Field < <field> Less Than Equal To <= Less Than Equal To Field <= <field> Equals == Not Equals!= Text / String Matches Other Field Differs From Field Is Null Is not Null == <field>!= <field> == null!= null Equals == Not Equals!= Boolean Equals == Not Equals!= Matches Other Field Differs From Field == <field>!= <field>

90 74 Chapter 5 Business Rules Action Builder Operators Parent Type Concept / Event Operator Value on WebStudio Client Operator Value on RMS Server Set To = Set To Field Set To Null = <field> = null Data / Time / Datetime Set To = Set To Field Set To Null = <field> = null Integer / Float Set To = Set To Field = <field> Increment By += Increment By Field += <field> Decrement By -= Decrement By Field -= <field> Text / String Set To = Set To Field Set To Null = <field> = null Boolean Set To True Set To False = true = false

91 Business Rule Operators 75 Parent Type Operator Value on WebStudio Client Set To Field Operator Value on RMS Server = <field>

92 76 Chapter 5 Business Rules

93 77 Chapter 6 Working with the Approval Workflow in RMS This chapter explains the approval workflow of decision tables or business rules. Topics Working with the Approval Workflow Overview, page 78 Checking a Worklist and Taking Action, page 80

94 78 Chapter 6 Working with the Approval Workflow in RMS Working with the Approval Workflow Overview When business users have finished working with artifacts (decision tables or business rules), they submit them for approval. All business user actions, such as committing or deleting artifacts are committed to the RMS project only when a user whose role gives permission to do so approves the requests. The approval permissions are set at the project level using the ACL file for the project. Allow the approval action type for the user role in the ACL file to the grant approval permission. This section explains the provided workflow for approving and rejecting business users commit requests. This manual documents the behavior of the product as shipped. The workflow, the roles used, and the permissions granted to the roles are all configurable. However, the general flow is likely to be similar to that described in this guide. With this release, the approval can only be done in TIBCO BusinessEvents Extreme WebStudio. Use of RMS and therefore the approval process is required when TIBCO BusinessEvents Extreme WebStudio is used. See Committing Artifacts for Approval on page 42 for business user procedures. See Checking a Worklist and Taking Action on page 80 for approver procedures. Who Can Approve or Reject Commit Requests In TIBCO BusinessEvents Extreme WebStudio users with Administrator role permissions can approve or reject commit requests, or delegate approval. They can also delegate the task of approving or rejecting commit requests to any specified user role and not to a specific user. In this case, the approval or rejection requests will be sent to all the users in that role. See To Delegate a Workitem on page 80. Approval Status Values COMMITED When a user commits one or more resources for approval, the status of the request is set to Commited. The approver then sets the status as appropriate.

95 Working with the Approval Workflow Overview 79 APPROVE The request was approved. If the submission request was to add or change an artifact, that artifact is copied to the RMS project. If the submission request was to delete an approved artifact, that artifact is deleted from the RMS project. REJECT The change was rejected. If the submission request was to add or change an artifact, that artifact is not copied to the RMS project. If the submission request was to delete an approved artifact, that artifact is not deleted. It is up to the business user to make changes in their local project accordingly. BUILDANDDEPLOY The artifact is built and ready to be deployed. The artifact after approval is built and kept ready to be deployed at the location specified by a property in the RMS.cdd file. See RMS Server Configuration Property Reference on page 15 for more details on property.

96 80 Chapter 6 Working with the Approval Workflow in RMS Checking a Worklist and Taking Action Approval requests are handled in the Worklist window in TIBCO BusinessEvents Extreme WebStudio. To Check Your Worklist and Take Action 1. Open the worklist window using any of the following methods: Click WebStudio, and from the pull-down menu, select RMS > Show Worklist. Right-click any artifact and select RMS > Show Worklist. Click the Show Worklist icon in the RMS toolbar. The worklist window displays all the requests submitted for approval. 2. To view the artifacts submitted for approval, click the triangle in front of the Revision ID. To examine the artifact before taking an action, double-click the artifact. The decision table or business rule displays in the editor. 3. To take action on an artifact, click the Commited status under the Status column, and select a value from the status drop-down menu: Approve Reject A message field displays the error messages in the event of a problem. 4. Click anywhere outside the drop-down menu and click Ok. To Delegate a Workitem A user in the Administrator role can delegate a workitem to one or more roles. Users belonging to any of those roles see the workitem in their worklist. Users in the role specified by the RMS global variable property tibco.clientvar.rms/approval/adminrole have Administrator role privileges. See Configuring RMS Server Properties, page 12.

97 Checking a Worklist and Taking Action Open the worklist window using any of the following methods: Click WebStudio, and from the pull-down menu, select RMS > Show Worklist. Right-click any artifact and select RMS > Show Worklist. Click the Show Worklist icon in the RMS toolbar. The worklist window displays all the requests submitted for approval. 2. Select the checkbox for one or more Revision IDs you need to delegate. 3. Select one or more user roles from the DelegateTo drop down list and click Apply. You see all roles that you do not belong to, and that have permission to approve or reject the artifact. The workitem disappears from your worklist. It can be seen in the worklist of the users in the roles you selected in step 3.

98 82 Chapter 6 Working with the Approval Workflow in RMS

99 83 Chapter 7 Deployable Files Generation This chapter explains the configuration and the procedures for generating EAR files, decision table classes, and business rule s rule template instance file. Topics Generating Deployable Files (EAR and Class Files), page 84

100 84 Chapter 7 Deployable Files Generation Generating Deployable Files (EAR and Class Files) Deployable files are generated using the TIBCO BusinessEvents Extreme Studio project files, located in the RMS project s folder. The deployable files are of two types: EAR files and class files. EAR files are generated in Decision Manager and TIBCO BusinessEvents Extreme WebStudio UI. You can generate class files using Decision Manager and the TIBCO BusinessEvents Extreme WebStudio UI, or at the command line. You can generate an entire project s class files, one decision table s class file, or one business rule s rule template instance file. If you generate an entire project s class files, a property in the CDD file enables you to exclude unwanted packages. You can generate one decision table s class file and business rule s rule template instance file, using TIBCO BusinessEvents Extreme WebStudio only. Location of Generated Files Location of generated files can be configured using deploy location properties in the RMS.cdd file. See RMS Server Configuration Property Reference on page 15 for more details on deploy location properties. Below are the locations of the generated files as per the preconfigured locations in the shipped product. EAR files are saved in the RMS project directory in the RMS s shared directory. For example, the EAR file for the CreditCardApplication project (CreditCardApplication.ear) is stored at TIBCO_HOME/be/5.1/rms/shared/CreditCardApplication A project s class files are saved in the Codegen subdirectory under the RMS project directory in the RMS s shared directory. For example, class files for the CreditCardApplication project (CreditCardApplication.ear) are stored at TIBCO_HOME/be/5.1/rms/shared/CreditCardApplication/Codegen Individual decision table s class file and business rule s rule template instance are saved in the RMS project directory in the RMS s shared directory.

101 Generating Deployable Files (EAR and Class Files) 85 Generating the Project EAR or All Project Class Files You can generate deployable EAR files only if you have the permission to check out all the required project resources (ACLs may limit what you can check out). If you have created/modified the decision table for the first time and did not generate the EAR files before creating/modifying decision tables, then you receive an error while generating the deployables: EAR for projects: <project_name> either not present or not in sync at deploy location. To Generate the Project EAR or All Project Class Files in WebStudio 1. Open the Generate Deployable window using any of the following methods: Click WebStudio, and from the pull-down menu, select RMS > Deploy Artifacts. Right-click on any artifact and select RMS > Deploy Artifacts. Click the Generate Deployable icon in the RMS toolbar. The Generate Deployable window is displayed. 2. Do one of the following: To generate class files, select the Generate Classes Only checkbox. To generate EAR files, do not select the Generate Classes Only checkbox. 3. From the drop-down list, select the project for which you want to generate the deployable files. 4. (For EAR files only.) If you want to generate the debug information, select the Generate Debug Info checkbox. 5. (For EAR files only.) If you want to include all service-level global variables, select the Include all service level global variables checkbox. 6. Click OK. Files are saved to the preconfigured location (see Location of Generated Files on page 84). Any existing files are overwritten.

102 86 Chapter 7 Deployable Files Generation Generating One Decision Table s Class File In TIBCO BusinessEvents Extreme WebStudio, the BuildAndDeploy status menu option in the Worklist window generates the class file for only the selected decision tables. You can generate a decision table s class file only after it is approved. See Checking a Worklist and Taking Action on page 80 on how to approve a commit request. You can generate one decision table s class file using TIBCO BusinessEvents Extreme WebStudio only. If you have created/modified the decision table for the first time and did not generated the EAR files before creating/modifying decision tables, then you receive error while generating the deployables: EAR for projects: <project_name> either not present or not in sync at deploy location. To Generate One Decision Table Class File 1. Open the worklist window using any of the following methods: Click WebStudio, with the down pointing triangle in front of it, and select RMS > Show Worklist. Right-click any artifact and select RMS > Show Worklist. Click the Show Worklist icon in the RMS toolbar. The worklist window displays all the requests submitted for approval as well as approved requests. 2. To view the approved decision tables, click the triangle in front of the Revision ID. To examine the decision table before taking an action, double-click the table. The decision table displays in the editor. 3. To generate classes for the decision table, click the Approved status under the Status column, and select BuildAndDeploy from the status drop-down menu. The project EAR must already be created. A message field displays error messages in the event of a problem. 4. To start generating classes click anywhere outside the drop-down menu and click Ok.

103 Generating Deployable Files (EAR and Class Files) 87 Generating One Business Rule s Rule Template Instance File In TIBCO BusinessEvents Extreme WebStudio, the BuildAndDeploy status menu option in the Worklist window generates the rule template instance file for just selected business rules. You can generate a business rule s rule template instance file only after it is approved. See Checking a Worklist and Taking Action on page 80 on how to approve a commited request. To Generate One Rule Template Instance File 1. Open the worklist window using any of the following methods: Click WebStudio, with the down pointing triangle in front of it, and select RMS > Show Worklist. Right-click any artifact and select RMS > Show Worklist. Click the Show Worklist icon in the RMS toolbar. The worklist window displays all the requests submitted for approval as well approved requests. 2. To view the approved business rules, click the triangle in front of the Revision ID. To examine the business rule before taking an action, double-click the rule. The business rule displays in the editor. 3. To generate rule template instance file for the business rule, click the Approved status under the Status column, and select BuildAndDeploy from the status drop-down menu. A message field displays error messages in the event of a problem. 4. To start generating rule template instance file, click anywhere outside the drop-down menu and click Ok.

104 88 Chapter 7 Deployable Files Generation

105 89 Index A Active Directory 24 Adding a Project to RMS 11 Adding Business Rules 67 Approval Status Values 78 Approving and Rejecting Commit Requests 78 Authentication Property Reference 25 Configuring Basic RMS Server Properties 12 Configuring for Deployment of Decision Table Classes 84 Configuring RMS Server Properties 12 Configuring User Authentication 23 Create/Remove a Decision Table 46 Creating a Rule Management Server Project Update a Project 41 customer support xvi B BE_HOME xiii be.auth.file.location 25 be.auth.ldap.admindn 26 be.auth.ldap.adminpassword 26 be.auth.ldap.basedn 26 be.auth.ldap.dnattr 27 be.auth.ldap.host 26 be.auth.ldap.objectclass 27 be.auth.ldap.port 26 be.auth.ldap.roleattr 26, 26, 27, 27 be.auth.ldap.ssl 27 be.auth.type 23, 25 be.mm.auth.ldap.port 26 Business rule builder command builder 66 condition builder 66 D Decision Manager and RMS Basic Workflow 7 Defining Permissions 32 Deleting Business Rules 70 E Edit a Decision Table 47 Notification Property Group 21 Enabling Remote Connection to RMS 14 ENV_HOME xiii Establishing the User Roles 28 Exception Tables 5 Export a Business Rule 70 Export a Decision Table 48 C Checking a Worklist and Taking Action 80 Checking Out a Project 40 Committing Artifacts for Approval 42 Conditions and Actions 51 Configuring Access Control Overview 28 G Generating Deployable Files 84 Guidelines for Configuring Access Control 28

106 90 Index I Import a Decision Table 49 Introduction to Decision Manager 2 Introduction to Rules Management Server (RMS) 2, 10 T Table Analyzer 5 technical support xvi TIBCO BusinessEvents Virtual Rule Functions and Decision Tables 3 TIBCO_HOME xiii J java.security.auth.login.config 25 P Permissions ALLOW and DENY 31 R Regular and Custom Conditions and Actions 51 Required Location of Access Control Files 31 Resource Types and Corresponding Action Types 33 RMS Server Configuration Property Reference 15 Rule Building with Decision Tables 4 rule template 66 U Updating (Refreshing) a Project 41 userprincipalname 24 W Workflow 7 Working with Access Control Files 31 Working With Decision Tables 46 S Set Decision Table Properties 47 Specifying and Grouping Project Resources 31 Specifying Permissions Action Types 33 Specifying Resources 31 Starting and Logging in to RMS 38 Status Check for RMS Connection 39 Structure of the Access Control File 30 support, contacting xvi