RuleLab.Net Server Administrator Guide

 

VDE Technologies, LLC

 

July 2009

 

 

RuleLab.Net Server Installation

 

RuleLab.Net Server is a Microsoft .NET application that requires the following software:

 

Rules and other XML documents are stored in a database. You can choose between:

SQL Server 2005 Express Edition or SQL Server 2000 Desktop Engine (free versions of SQL Server)

 

For testing and evaluation, RuleLab.Net Server can be installed on a Windows XP workstation running the developer editions of IIS 6.0/5.* and SQL Server.

 

RuleLab.Net Server is distributed as an MSI package wrapped into an executable containing Microsoft Windows Installer. To install, launch the executable and follow the prompts. Once installed, RuleLab.Net Server can be uninstalled via Add/Remove Programs. Uninstalling will not remove custom setting files located in the LocalConfig subfolder.

 

RuleLab.Net Server must be configured via the Administrator Console that you can launch at http://<my-rulelab-site>/admin.aspx once files are installed. Changes made by the Console will not be lost if you reinstall or upgrade your RuleLab.Net Server.

 

Full installation includes the following tasks:

You must designate the installation web site when requested by the Install or before running the Install. The rest can be accomplished after the Install program is finished. This document contains instructions and recommendations for each of these steps.

 

RuleLab.Net Software License

 

Administrator Console main screen specifies the exact type of the Software License that you have purchased. See section titled “Your RuleLab.Net Software Licenses”. Please review it before using the installed Software. Licensing Agreements are accessible through the links next to the License type. If you are having trouble locating the License type or the Agreements please contact VDE Technologies immediately.

 

RuleLab.Net Web Site Setup

 

The setup package installs RuleLab.Net Server software into the Default Web Site of the IIS. If it is utilized by another application, please temporarily designate the Default Site for RuleLab.Net installation as follows:

  1. Create a directory anywhere on the hard drive. RuleLab.Net will be installed into this directory.
  2. Using IIS management Console, change the Default Web Site home to this new directory.
  3. Install RuleLab.Net by running Microsoft Windows Installer MSI package.
  4. Create the database and configure RuleLab.Net using its Administrator Console.
  5. Move RuleLab.Net to another site and restore the home directory path of your Default Web Site.

 

Once installed on a development box, the RuleLab.Net server can be copied to a production server without running the Install. There are no registry or other product specific system changes that the Setup applies. Note that you will not be able to remove the software via Add/Remove Programs if it was copied manually.

 

If you are installing on a development box (for testing) or on a dedicated intranet server, keep the default website pointing to the root folder where RuleLab.Net has been installed. Test via a link such as http://myserver/admin.aspx or http://localhost/admin.aspx.

 

RuleLab.Net must reside in a website root. If you are installing RuleLab.Net on the production IIS server supporting multiple sites, create a new site for it and add Host Header that resolves to the address of your server. For example, if you are adding “rulelab” Host Header to “mycompany.com” domain then the name of your RuleLab.Net site would be rulelab.mycompany.com. Test it by navigating to the console page at http://rulelab.mycompany.com/admin.aspx.

 

The following Microsoft article explains the use of Host Headers in IIS 6.0: Hosting Multiple Web Sites (IIS 6.0).

 

Directory Access

 

Using the IIS Management Console, make sure that ‘Log’ and ‘LocalConfig’ subfolders have the Write permission. If the “LocalConfig” folder does not allow the Write access then any attempt to submit changes through the Console will result into an “access denied” error (includes the instructions on how to resolve it).

 

 

Database Setup

 

The Administrator Console allows you to choose between the Embedded Database Engine (SQLite) and SQL Server. Click the radio button to make a selection, and then follow the corresponding procedure below.

 

 

Embedded Database Engine (SQLite)

 

In the Administrator Console, click the Create Database button to initialize the database file. It will be created in the LocalConfig subfolder.

 

The supplied sqlite3.exe tool allows you to make queries and administer the database. You can launch it via LocalConfig\SQLiteTools\ManageRuleLabSQLiteDB.bat. To learn more about SQLite go to http://www.sqlite.org.

 

 

SQL Server

 

Before trying to run the installed software, please create a database for your RuleLab.Net data. You will need to run the installed SQL script in order to initialize database tables. When database setup is complete, please configure RuleLab.Net software using the administrator console.

 

RuleLab.Net database must be manually created on SQL Server 2000 or 2005. The database should be accessible from IIS machine where you installed RuleLab.Net server software.

 

  1. Using the Enterprise Manager, create a new database named “RuleLabNet”.
  2. Under “security/logins”, add a new login or designate an existing login. Open “properties/database access” and allow access to the new database.
  3. Select “New Database User” under “users” and add a user with the designated login. Open “properties” of the new user and enable “db_owner” role.
  4. Using SQL script tool such as Query Analyzer, open the “RulelabDbSetup.sql” file located under “LocalConfig” folder of your RuleLab.Net root directory. Run this script on your RuleLab.Net database.

 

SQL Server Database Update

 

If you are upgrading to a newer version of RuleLab.Net Server, then instead of RulelabDbSetup.sql look for RulelabDbUpdate<ver>.sql. You need to run it to upgrade your database schema. Otherwise, you may get the database version mismatch error message when trying to log in to the system. Running this script is harmless to your database. It will not multiply changes that are already in place.

 

 

RuleLab.Net Server Configuration

 

Using the RuleLab.Net Administrator Console

 

RuleLab.Net software must be configured via the Administrator Console. The console includes database setup instructions, RuleLab.Net configuration interface, and the support links.

 

Launch the Administrator Console via http://<mysite>/admin.aspx link. Bookmark the Console web page. This is the only bookmark you will need to locate the documentation, the support email address, and the Rules Designer URL.

 

First time you run the Console, it requires you to create an admin password. This password is only required for running the Console in the future. Since it is not used for logging into the actual product, please do not share it with other RuleLab.Net users.

 

The Console stores its settings in the LocalConfig/RuleLabConfig.txt. All entries are encrypted. If you delete this file, you will reset the administrator password. Note that deleting this file will also disable the RuleLab.Net Server software. Please do not delete this file unless you loose the admin password. This file is not machine specific. You can copy it from your development machine to the production server.

 

Before logging into RuleLab.Net at the URL displayed in the Console, please accomplish the following:

  1. Create and test the database connection
  2. Add at least one Project Administrator User ID.
  3. Submit point-of-contact email address.

 

SQL Server Database Connection

 

RuleLab.Net server software has to have access to its database. The connection to the database requires the following 4 items:

 

Click the Submit button to save the connection parameters and to test the connection. Ensure that you receive the “Connection Successful” response.

 

RuleLab.Net Project Admin Users 

 

RuleLab.Net tags every project and every XML file stored in the RuleLab.Net database with the user ID. This ID is required for login, and it can be shared between team members. Additionally, project admin can create limited access login IDs associated with the project admin (the master) ID. Client hosted solution does not allow project admins to register/create an account themselves. Instead, the RuleLab.Net system admin is required to create master account(s) for them.

 

To add a project admin account/login ID, fill in the ID and password and click the “Add User” button. Users will have an option to change the password once they are logged in.

 

If users loose their password, you can reset it by clicking the “Reset Password” button.

 

If you have to erase an account, click the “Remove User” button. Note that all projects and files associated with this ID will be permanently deleted from the database. There are 2 warnings that you would have to acknowledge before this action is carried out.

 

Please note that the number of project admin logins is limited. See your RuleLab.Net Server Licensing Agreement (ServerEULA.rtf) for more information.

 

Secure Connection

 

As long as you have configured Secure Sockets Layer (SSL) for your RuleLab.Net web site, you can have RuleLab.Net redirect http requests to https. You will have to restart the site after changing the secure connection checkbox.

 

 

Software Registration/Activation

 

You have to register and activate the RuleLab.Net Server before trying to log into the system at myrules.aspx. Click the “register” link to go to the registration page at www.rulelab.net web site. Upon registration, you will be issued a Registration Identifier. Enter it into the ID box and click “Activate”. Record the ID in case you loose the local settings and have to re-configure the software.

 

If the computer does not have internet access, record the URL from the popup instance of the Internet Explorer. Go to this URL on another computer and write down the assigned identifier. Enter it into the ID box in the Console.

 

Technical Support

 

Unless you have a separate support contract with VDE Technologies LLC, there should be a designated point of contact within your company for RuleLab.Net support matters. Users should refer their questions to this person who in turn can contact VDE Technologies. Users reporting a bug can contact VDE Technologies directly.

 

Please enter the point of contact email address. It should be an address within your company, not VDE Technologies email address. Click the “Submit“ button to store this address in RuleLabConfig.txt.

 

To receive support from VDE Technologies email to the customer support at the address shown on the Console web page. Your Registration ID is required for receiving the support. You can look it up on the Console page.

 

 

Using RuleLab.Net Server

 

Launching RuleLab.Net

 

To run RuleLab.Net, go to myrules.aspx page located in the web site root. For example, if you installed RuleLab.Net under “rulelab.mysite.com” then the format of your startup URL will be: http://rulelab.mysite.com/myrules.aspx. When you follow this link, the login page will come up. Unless you have already updated this page, you will see a message about page customizing. After you customize the login page, you can give the RuleLab.Net URL to authorized users.

 

Login Page Customizing

 

Please customize the login page with company-specific information. Your login page must display the company name or logo as well others attributes, such as department/division - identifying you as a registered client of RuleLab.Net software. If you have specific terms of use that employees must adhere to please enter them there as well.

 

The customizations must be entered into CustomLoginFrame.htm page located in the “LocalConfig” folder. To test, just refresh the login page at myrules.aspx.

 

Although the customized page should not be overwritten by software updates, we recommend backing it up.

 

Error Logs and Problem Troubleshooting

 

If RuleLab.Net displays an error referring user to System Administrator, look for error logs under the “log” directory in RuleLab.Net website root. Unless you can troubleshoot the problem, submit the error log to VDE Technologies’s email address displayed on the Console web page.

 

If the problem cannot be resolved by sending the log, you may consider reproducing it on VDE Technologies’ RuleLab.Net website. Simply register for a Free Trial to setup a temporary account and upload the project files. You don’t have to upload your entire rule base, just enough data to demonstrate the error. Once you can reproduce the issue online, let us know the login and your test case details. If this turns out RuleLab.Net bug, we will fix it and send you software update.

 

 Product Updates

 

RuleLab.Net Server updates can be downloaded via the “check updates” link of the Console. The updates are tagged by version number. You can check your RuleLab.Net version number and compare it against the latest version by clicking the “Check for newer version” link at the top of the page. That link is also available to your RuleLab.Net Server users at login.

 

In addition, RuleLab.Net periodically checks for newer version on www.rulelab.net web site. The connection to the site is made asynchronously, without affecting users work. If the RuleLab.Net Server can access the www.rulelab.net site it will check to see if you are running the latest version. A newer version alert is displayed on the status bar where any logged in user can see it. During the connection to the www.rulelab.net site, the only information being uploaded is the version number and your registration identifier.