Administration Guide - TIBCO Product Documentation Administration Guide Nimbus Control Administration Guide Chapter 3Security 3.1 Securing a Process Repository 69 Chapter 4Configuration

TIBCO Nimbus Control

Administration Guide

Software Release 8.1.509 May 2012

®

Important Information

Nimbus Control Administration Guide

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLEDTIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THELICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSEDBY 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 LICENSEAGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCHSEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCHSOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THELICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR 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 thisdocument may be reproduced in any form without the written authorization of TIBCO Software Inc.

TIBCO, The Power of Now and Nimbus Control are either registered trademarks or trademarks of TIBCO Software Inc. in the UnitedStates and/or other countries.

All other product and company names and marks mentioned in this document are the property of their respective owners and arementioned for identification purposes only.

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEMPLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THEAVAILABILITY 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, BUTNOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, ORNON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES AREPERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OFTHIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/ORTHE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME. THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHERDOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND"READ ME" FILES.

Copyright © 1997-2012 TIBCO Software Inc. ALL RIGHTS RESERVED. TIBCO Software Inc. Confidential Information

3Contents


Table of Contents

Chapter 1 Introduction................................................................................... 8About the Administration Guide1.1

................................................................................... 9About Nimbus Control1.2

................................................................................... 10New Features in this Release1.3

Chapter 2 Installation................................................................................... 13Planning2.1

.................................................................................................... 13Installation Planning

................................................................................... 14Licensing2.2

.................................................................................................... 14Nimbus Control Licensing

................................................................................... 15Upgrading from Previous Releases2.3

.................................................................................................... 15Important Notes on Upgrading

.................................................................................................... 16Upgrading a Process Repository

.................................................................................................... 19Migrating Web Server settings

................................................................................... 21Installing the Client2.4

................................................................................... 24Installing the Web Server2.5

................................................................................... 30Configuring Authentication2.6

.................................................................................................... 30Enabling Windows Integrated Authentication (WIA)

.................................................................................................... 33Enabling and Configuring LDAP Synchronization

.................................................................................................... 41Enabling and Configuring Netegrity SiteMinder Synchronization

................................................................................... 43Integrating Nimbus Control with SharePoint2.7

.................................................................................................... 44Configuring a SharePoint Integration

.................................................................................................... 55Upgrading a SharePoint Integration

.................................................................................................... 56Adding Control Web Parts to other SharePoint sites

.................................................................................................... 62Integrating with a SharePoint document library

................................................................................... 63Installing the Action Server2.8

................................................................................... 65Installing the Business Intelligence Server2.9

................................................................................... 66Installing the Nimbus Control PerformanceMonitor

2.10

................................................................................... 67Uninstalling Nimbus Control2.11

Administration Guide4


Chapter 3 Security................................................................................... 69Securing a Process Repository3.1

Chapter 4 Configuration................................................................................... 71Web Server Configuration4.1

.................................................................................................... 71Configuring the Web Server

.................................................................................................... 87Configuring the Welcome page

.................................................................................................... 87Configuring MIME mappings

.................................................................................................... 87Integrating with External Help

.................................................................................................... 88Configuring Web Server Logging

.................................................................................................... 88Configuring Page Hit Logging

.................................................................................................... 89Configuring Web Hit Logging

................................................................................... 92Action Server Configuration4.2

.................................................................................................... 92Configuring the Action Server

.................................................................................................... 93Configuring SMTP Email

.................................................................................................... 94Configuring SMTP Logging

.................................................................................................... 95Configuring LDAP Synchronization

.................................................................................................... 95Testing LDAP Synchronization

.................................................................................................... 96Configuring LDAP Synchronization Logging

................................................................................... 97Business Intelligence Server Configuration4.3

.................................................................................................... 97Configuring the Business Intelligence Server

.................................................................................................... 98Testing the Business Intelligence Server

.................................................................................................... 99Synchronizing the Business Intelligence Server

.................................................................................................... 99Configuring Business Intelligence Server Logging

Chapter 5 User Management................................................................................... 102Creating Users and User Groups5.1

................................................................................... 103Importing Resources5.2

................................................................................... 103Importing User Roles5.3

Chapter 6 Administration................................................................................... 106Exporting6.1

.................................................................................................... 106Exporting Diagrams as HTML

.................................................................................................... 107Exporting Diagrams as XML

.................................................................................................... 108Exporting Data to a Database

5Contents


................................................................................... 109Metric Configuration6.2

.................................................................................................... 109Updating Excel Macros

.................................................................................................... 109Creating SQL Queries

.................................................................................................... 111Scheduling and Updating SQL Queries

.................................................................................................... 112Integrating with SAP BW and SAP NetWeaver BI

.................................................................................................... 114Integrating with Microsoft Office Business Scorecard Manager

.................................................................................................... 114Integrating with Cognos Metrics Manager

.................................................................................................... 116Integrating with Microsoft Office PerformancePoint

.................................................................................................... 118Integrating with ActiveStrategy

................................................................................... 119Integrating with SAP NetWeaver6.3

................................................................................... 120Integrating with a Novell File Server6.4

................................................................................... 122Integrating with Generic Portals6.5

................................................................................... 124Integrating with Workflow Applications6.6

................................................................................... 125Registering with SAP Solution Manager6.7

................................................................................... 126Importing Data Tables6.8

................................................................................... 126Integrating with OpenText DocumentManagement

6.9

................................................................................... 126Integrating with tibbr6.10

Chapter 7 Backup

................................................................................... 129Automatically Backing Up a ProcessRepository

7.1

................................................................................... 133Manually Backing Up a Process Repository7.2

Chapter 8 Maintenance................................................................................... 136Recovering Deleted Maps and Diagrams8.1

................................................................................... 136Checking Performance8.2

................................................................................... 136Checking Maps8.3

................................................................................... 139Archiving Maps8.4

................................................................................... 140Managing Database Tables8.5

................................................................................... 142Synchronizing the Web Server8.6

................................................................................... 145Monitoring Web Server Performance8.7

................................................................................... 145Restarting, Stopping and Starting the WebServer

8.8

................................................................................... 146Managing Nimbus Control Services8.9

Administration Guide6


................................................................................... 147Replacing File Link Paths8.10

................................................................................... 147Enabling Administrator Access to allDiagrams

8.11

Chapter 9 Customization................................................................................... 149Customizing the Web Server9.1

Chapter 10Troubleshooting................................................................................... 151Troubleshooting the Client10.1

................................................................................... 151Troubleshooting the Web Server10.2

................................................................................... 152Troubleshooting the Action Server10.3

Chapter 11Support and Feedback

Introduction

Chapter 1

Administration GuideNimbus Control

Chapter 1 Introduction8


1.1 About the Administration Guide

This guide is designed to provide Nimbus Control administrators with information on performing thefollowing tasks:

· Installing components of the Nimbus Control suite, including migration of data from previousmajor versions

· Configuring components of the Nimbus Control suite

· Managing Nimbus Control users

· Administering the Nimbus Control suite

· Maintaining the Nimbus Control suite.

Audience The intended audience for this guide includes:

· IT staff responsible for providing the technical infrastructure in which the Nimbus Control suiteis deployed

· IT staff responsible for the setup of Nimbus Control

· The nominated Nimbus Control administrators responsible for the day-to-day management ofthe Nimbus Control suite.

About the Administration Guide 9


1.2 About Nimbus ControlNimbus Control is a software suite designed to enable organizations to capture, analyze andcommunicate a common set of processes that can be used to manage an organization. The suiteconsists of five primary components:

Desktop ClientThe Desktop Client is a Windows-based application that provides authors with the tools in which tocreate and manage process maps, supporting information and documents.

Web ServerThe Web Server allows users to access and collaborate on data, anywhere across the internet orcorporate intranet. It runs as a standalone application that interacts with IIS using a small ISAPIextension that serves to redirect the requests to the application. The Web Server can also beintegrated into a SharePoint solution.

Action ServerThe Action Server runs as five separate Windows-based services in the background - Email, Delete,Lock, Office Integration and LDAP services. The primary tasks are to act as the Nimbus ControlEmail Server by utilizing basic SMTP services to provide a gateway into a corporation's Emailsystem, and to integrate with Directory Services.

Business Intelligence ServerThe Business Intelligence Server provides the ability to send SMS text messages and Emailnotifications when defined measures are breached.

Windows Server Performance Monitor Plug-inThe Windows Server Performance Monitor Plug-in provides system administrators with the ability tomonitor the internal behaviour of the Web Server and allows all of the normal capabilities ofPerformance Monitor to be used.

How is data managed?Nimbus Control data is managed in three databases:

· Process RepositoryThe Process Repository is a folder in the file system that holds the process diagrams andall process-related information (resources, metadata, access rights). It consists of anumber of flat files and DBISAM database tables and index files.

· The Document RegistryThe Document Registry is a document management system that holds supporting filesrelated to processes (forms, media files, templates, spreadsheets, application links, policydocuments, etc).

· Business Intelligence RepositoryThe Business Intelligence Repository tracks trend data for the key metrics in order toproduce graphs and launch alerts.

Chapter 1 Introduction10


1.3 New Features in this Release

The following features and functionality have been added to this release:

Integratation with tibbr tibbr is a social networking tool, available from Tibco. Byintegrating Nimbus Control with tibbr, authors can create tibbrdiscussion subjects based on keywords and storyboard titles.In the Web, users can add posts to their tibbr Wall and alsosearch for tibbr discussions against associated keywords.

See Integrating with tibbr.

New Features in Nimbus Control v8.1.0:

Hide the Activities columnin the Statement Detailspage

If a statement is linked to a large number of activities, therespective Statement Link Details page can sometimes takea while to display. The Activities column can now be hidden.A new parameter - ActColOnStmtLinkPage - is included inthe Features section in the Web Server configuration file.

See Configuring the Web Server.

Replace metric link paths In the Admin Utility, when searching and replacing file linkpaths, a new option allows you to include metric links paths.

See Replacing File Link Paths.

New Features in Nimbus Control v8.0.0:

Generate diagram andinternal image attachmentsas PNG or GIF

Specify the format of the generation of diagram and internalimage attachments in the Web Server, as either PNG or GIF.Note that GIF images are restricted to 256 colors.

See Configuring the Web Server.

Updating Excel macros has anew parameter whenscheduling

A new parameter clears any read-only flags that may havebeen associated with a scorecard before running the macro.

See Updating Excel Macros.

Web Server SystemSynchronization Utilityupdates

When a user is removed from a user group that has beenassigned as a mandatory user fro diagrams, documents and/or storyboards, any pending acknowledgement requests arewithdrawn.

Old maps are permanently removed from the Deleted folder.

Redundant diagram links are removed.

http://www.tibco.com

New Features in this Release 11


Notification emails can be sent to nominated email addressesif any errors occur during any of the Web Serversynchronization operations.

See Synchronizing the Web Server.

Check backup data beforecompressing it

Run an application, batch file or script to check the databefore compressing when automatically backing up data.

See Automatically Backing Up a Process Repository.

Secure LDAP Nimbus Control now supports Secure LDAP.

See Enabling and Configuring LDAP Synchronization.

Multiple LDAP Servers Synchronize with multiple LDAP servers.

See Enabling and Configuring LDAP Synchronization.

Reset user passwords Allow users to reset their own passwords in the Web Server.

See Configuring the Web Server (specifically theForgotPasswordLink parameter in the Features section).

Send separate notificationemails to recipients.

Configure the Action Server to send separate emails torecipients instead of combining emails into a single email.

See Configuring SMTP Email for more information.

New Archive Utility Archived maps can be compressed and stored using the newArchive Utility. Old archives can be permanently removed ormoved to another location.

See Archiving Maps for more information.

Installation

Chapter 2


Planning 13


2.1 Planning

2.1.1 Installation Planning

For information on planning the installation of the Nimbus Control suite, including hardware andsoftware requirements, sizing requirements and deployment, please refer to the InstallationPlanning Guide that is included in the Documents folder on the CD.

Chapter 2 Installation14


2.2 Licensing

2.2.1 Nimbus Control Licensing

The licensing model used by Nimbus Control is based on the following principles:

· Per-named user licensingThis license is for users who participate in the process development. These users can useboth the Desktop Client and the Web Server through a browser (End Users must have theChange Module to access the Desktop Client). There are two types of license for namedusers:

Process Authors: this license type provides full access to the content capture functionalityprovided in the Nimbus Control Client. In addition, this license also applies to Nimbus Controladministrators.

End Users: this license type provides various access to the content and collaboration featureswithin the product, depending on the modules selected.

Note: A Process Author license can be used by an End User if required. For an Enterpriselicense deployment this allows all of the licenses to be issued as Author licenses and for theNimbus Control administrator to determine the mix of Process Authors and End Users.

Obtaining a License KeyA license key controls all access to the Nimbus Control Client and Web Server and is entered in theClient. There are three license types:

· Demo license

· Production Not Paid (PNP) license

· Production license

A license will define the number of process authors and end users. Your current license key must beprovided to Nimbus Help Desk in order to upgrade. In the Client, from the Help menu chooseRegistration. Copy the current code and paste it into an Email to Nimbus Help Desk ([email protected]). You will be provided with a new license code which must be pastedinto the Registration dialog to enable the number of process authors and end users.

mailto:[email protected]).

Licensing 15


The license details are stored as part of the Nimbus Control Process Repository database andshared between all Nimbus Control suite components and other Nimbus Control users sharing theProcess Repository. Users will require an unlock code if they have installed the Client locally andare not connected to the Process Repository via the network.

2.3 Upgrading from Previous ReleasesIf a previous major version of Nimbus Control is installed, i.e. Control 2007 7.0 or earlier, the datawithin the current Process Repository must be migrated to the latest version BEFORE installing theNimbus Control suite.

2.3.1 Important Notes on Upgrading

Before migrating a Process Repository the following points should be considered and the relevantactions taken, as required.

Installation of Nimbus Control 8.1To upgrade from a previous major version you must first migrate the existing Process Repositoryusing the migration tool by following one of the methods below. After the migration you can theninstall the Nimbus Control 8.1 suite.

Backing up your dataIt is advisable to back up your existing data before proceeding with the migration procedure. See Backup for more information.

Access to the old ClientYou must ensure that users cannot access the existing client. This can be achieved by eitherrenaming CTRL.exe to CTRL.OLD, or by completely renaming the Nimbus Control ProcessRepository. Once the migration utility is running, users will be restricted from accessing theProcess Repository.

Note: Installing over a previous installation is not recommended.



Deleted MapsThe Deleted Maps folder is emptied during migration. Please ensure that you backup anyrequired data in this folder before proceeding. The default location is:

Nimbus Control onwards:<Installation directory>\Nimbus Control\Process Repository\Deleted

Control 2007:<Installation directory>\Control\Process Repository\Deleted

control-ES 6.5 and previous versions:<Installation directory>\controlES6.x\Process Repository\Deleted

Cache FolderIf you are installing the Nimbus Control Web Server then you must delete the current cachefolder. The default locations are:

Nimbus Control onwards:<Installation directory>\Nimbus Control\Cache

Control 2007:<Installation directory>\Control\Cache

control-ES 6.5 and previous versions:<Installation directory>\controlES6.x\Cache

Archived MapsFollowing the migration of a process repository to the latest release, any archived map foldersthat exist in the process repository will be displayed in the Open and Manage window. Sincearchived maps are not migrated as part of the migration process, it is recommended that thesearchived folders are moved to a separate backup location outside of the process repositoryfollowing migration.

2.3.2 Upgrading a Process Repository

If a previous major version of Nimbus Control is installed, the data can be migrated to a 8.1.5Process Repository.

Please ensure that you have read Important Notes on Upgrading before proceedingwith migrating your data.

To upgrade from a previous release

1. Create a new folder in which to install the new version of Nimbus Control.

For example: C:\Nimbus Control

Before copying the Process Repository you must ensure that there are no userscurrently accessing it. In the Client, from the Tools menu choose Users and thenActive Users to view which users are currently active.

2. Copy the existing Process Repository, Scorecard Repository, Process RepositoryATTACH, and

Upgrading from Previous Releases 17


any other data folders that you've created into the folder created in Step 1. Copying themensures that the existing data is still available if a roll-back is required. It also provides access toexisting map archives.

3. Restrict the permission on the previous installation folder to allow only those users that requireaccess to access it.

4. Run the respective migration tool.

The migration tools are found in the Utilities folder on the CD:

Existing Version Migration Tool

Nimbus Control8.0.x

CtrlMigration80To81.exe

Control 2007 7.0.x CtrlMigration70To80.exe

Control 2007 6.5.x CtrlMigration65To70.exe

control-ES 6.4.x CtrlMigration64To65.exe




Note: When upgrading to v8.1, you will be presented with the option to change the location to save

archived maps to, and to set the default time zones for actions. If upgrading from 7.x or earlier,please take into consideration that these options will be presented at the final stage of the upgradeprocess before it can complete.

5. Select Upgrade Control Process Repository, then click Next.6. Click Browse and select the Process Repository that you copied in Step 2, then click Next.7. Enter the user name and password of a Control administrator, then click Next.8. Confirm you have backed up the Process Repository by clicking Next.9. Click Start to migrate the Process Repository.

Post Upgrade

Once you have migrated the Process Repository you can install the Nimbus Control suite.· Install the Client into the new folder structure created in Step 1.

· If access to the existing Web Server is still required, rename the IIS virtual directory name.

· Install the Web Server using the previous virtual directory name (by default this is Control).

· Install the Action Server.

· Inform all desktop Client users about the new shortcut required to access the Client.

Additional Notes:· Users will be able to access the new Web Server using the same URL as before; however,

users requiring access to the previous Web Server will require an updated URL.

· Client-based users will require a new Desktop shortcut.

· There is no requirement to re-license the suite as the license details are migrated as part of the



migration process.

To upgrade 6.3.x, 6.4.x, 6.5.x and 7.0.x packaged maps

1. Run CtrlMigration70To80.exe.2. Select Upgrade Packaged Maps, then click Next.3. Click Browse and select the CPK or CEP file to upgrade, then click Next.4. Click Start.

To upgrade 6.2 packaged maps

Packaged 6.2.x maps and templates can be upgraded to 8.0.x versions and then imported into thenew Process Repository.

1. Run CtrlMigration62To63.exe.2. Select Upgrade Packaged Maps, then click Next.3. Click Browse and select the CPK or CEP file to upgrade, then click Next.4. Click Start.5. Run CtrlMigration70To80.exe.6. Click Browse and select the CPK or CEP file that was upgraded in Steps 1-4.7. Click Start.

To upgrade 6.1 packaged maps

Packaged 6.1.x maps and templates can be upgraded to 8.0.x versions and then imported back intothe Process Repository.

1. Run CtrlMigration61To62.exe.2. Select Upgrade Packaged Maps, then click Next.3. Click Browse and select the CPK or CEP file to upgrade, then click Next.4. Click Start.5. Repeat Steps 1-4 on the same packaged map, first using CtrlMigration62To63.exe, then

CtrlMigration70To80.exe.

To upgrade 6.5 and 7.0.x packaged maps

Packaged 6.5.x and 7.0.x statement sets can be upgraded to 8.0.x versions and then imported backinto the Process Repository.

1. Run CtrlMigration70To80.exe.2. Select Upgrade Packaged Statement Set, then click Next.3. Click Browse and select the FPK file to upgrade, then click Next.4. Click Start.

To upgrade packaged storyboards

Packaged storyboards from previous versions can be upgraded to 8.0.x versions and then importedinto the Process Repository.

1. Run CtrlMigration70To80.2. Select Upgrade Packaged Storyboard, then click Next.3. Click Browse and select the SPK file to upgrade, then click Next.4. Click Start.



2.3.3 Migrating Web Server settings

You can migrate the settings - configuration settings, skins, localization files and the Home page text- from one Web Server to another. This is useful when installing a new version of the Web Server asyou can migrate the settings from an existing Web Server installation. The Nimbus Control WebServer Upgrade Utility can either be run before installing the new Web Server or after the WebServer has been installed.

Note: The old settings are backed up and stored in '...\Documents and Settings\<User>\TEMP\Nimbus Upgrade'. It is advisable to delete the old Cache folder when upgrading to a newversion of the Web Server. See Migrating a process repository for more information.

Migrating settings before installing a new Web Server

You can run the Nimbus Control Web Server Upgrade Utility before installing the new Web Server.This method will allow you to install the Web Server and migrate the settings from an existing WebServer in one operation.

1. Copy the Utilities and Web Server folders from the download image to a local drive.2. Run WebUpgradeUtil.exe.

Note: WebUpgradeUtil.exe is found in the Utilities folder.

3. Click Browse and select the current Web Server folder.4. Select any of the following Web Server configuration settings to migrate to the new Web Server:

Include Web Server configuration settings will merge any changes in the configurationsettings file.

Include Skin will merge any changes in the Skin.html. Note: Skin.html is found in ...\Control\Web Server\App, and controls various web appearance settings, such as various font colors,storyboard colors, menu appearance, etc.

Include Localizations will merge any changes in the localization files.

Include Home page sidebar will replace the MyPage.html (Home page text) file with the oldversion.

5. Click Next.

The Web Server installation setup will appear.

6. Follow the steps to install the Web Server.

For more information on installing the Web Server see Installing the Web Server.

Migrating settings after installing a new Web Server

If the new Web Server has already been installed you can still migrate the settings from an existingWeb Server using the Nimbus Control Web Server Upgrade Utility.

1. Copy WebUpgradeUtil.exe to a local folder.

Note: WebUpgradeUtil.exe is found in the Utilities folder on the download image.

2. Run WebUpgradeUtil.exe.3. Click Browse and select the current Web Server folder. This is the Web Server that you are

migrating settings from.4. Select any of the following Web Server configuration settings to migrate to the new Web Server:



Include Web Server configuration settings will merge any changes in the configurationsettings file.

Include Skin will merge any changes in the Skin.html. Note: Skin.html is found in ...\Control\Web Server\App, and controls various web appearance settings, such as various font colors,storyboard colors, menu appearance, etc.

Include Localizations will merge any changes in the localization files.

Include Home page sidebar will replace the MyPage.html (Home page text) file with the oldversion.

5. Click Next.

Note: You will receive a message stating that the current Web Server installer cannot befound.

6. Click Next.7. Click Browse and select the new Web Server folder, then click Next.



2.4 Installing the ClientThis topic describes how to install the Nimbus Control Client. For more information on the Client,including software and hardware requirements and sizing, see the Installation Planning Guide that isincluded in the Documents folder on the installation CD.

Note: iSCSI is not supported over TCP/IP.

Prerequisites

· 120MB of disk space· If upgrading from a previous version there must be no users currently using the old version.

You must also migrate the process repository before installing Nimbus Control. SeeUpgrading a Process Repository for more information.

· You must be logged in to the local machine as an administrator.· It is advised that you exit any other Windows applications that are currently running.· Please read the Installation Planning Guide (included on the CD) before proceeding. This

includes important information about disabling SMB2.x and Opportunistic Locking onWindows Server 2008/2008 R2 to avoid potential data corruption.

To install the Client

1. Do one of the following:

· Insert the CD and click Client Installation.

· If the CD installation does not automatically start, from the CD run Setup.exe and clickClient Installation.

2. [Welcome] If no other Windows applications are running, click Next. Otherwise, terminate theinstallation in order to exit the applications, then re-run the setup.

3. [Read Me File] If you are upgrading from a previous version of Control, read the warning andtake any necessary steps. Click Next to proceed.

4. [License Agreement] Ensure that you read the license agreement, then click Yes to accept itor No to terminate the installation.

5. [Setup Type] Select whether you want a standard installation, or a network client installation.

Standard - this will install the full program and should be selected for new installations orupgrades.

Network Client - this will create a shortcut for an existing installation. This shortcut canthen be distributed between users who will then have access to the Nimbus Control Clientover the network.

See the Installation Planning Guide for more information on deploying Nimbus Control.

6. [Choose Destination Folder] The location in which the Client is installed will default to<Installation directory>\Control. To change location, in the Destination Folder panel click Browseto select a location in which to install the Client. To change the location of the ProcessRepository, deselect Use default sub-folder for Process Repository and click Browse in theExisting Process Repository panel to specify a location to install the Process Repository in. Click Next to proceed.

7. [Select Program Manager Group] Select the Program Manager group that the Client will beadded to. Either select an existing group or accept/rename the default name to create a new



group. Click Next to proceed.8. [Start Installation] Click Next to install the Client.

Folder permission rights

Administrators and process authors will require Read and Modify access to the process repositoryand any associated data folders. End users require Read access only.

If you are planning to share the Process Repository then you must share a higher levelfolder and not the actual Process Repository folder, otherwise users may not be ableto access folders on the same level as the Process Repository, such as ProcessRepositoryATTACH and Process Repositorycred.

What Next...

Run the Client for the first time

Administrator AccountWhen you run the Nimbus Control author client for the first time you will be prompted to createan administrator account.

Note: If you plan to use LDAP then use the same account as the administrator account thatwill be created in the Nimbus Control Admin LDAP group, otherwise this account will bedeleted when synchronizing with LDAP.

License CodeIn order to create additional user accounts in Nimbus Control you must enter the license code.From the Help menu choose Registration. If you do not have a license code then pleasecontact Nimbus Support.

Secure the Process Repository

Securing the Process Repository will prevent users from editing or deleting any of the filestructure of the Process Repository through, for example, Windows Explorer.

See Security\Securing a Process Repository for more information.

Distribute the Client executable shortcut

If you are providing access to the Client over the network then you must create a copy of theexecutable shortcut and then distribute it to the users that require access to the Client. To createa network executable shortcut, follow the steps above but select Network Client in Step 5 [SetupType]. If the Client is to be installed locally, i.e. on each users' PC, then this is not required.

Install the Web Server

The Web Server provides end-user access to the information held within the Process Repositoryand defined external locations, including maps, documents, etc.

See Installation\Installing the Web Server for information on installing the Web Server.

Enable Single Sign-onSingle-sign On allows users to automatically log into the Client and Web Server without having toprovide their credentials once they are logged into their organization's network.

See Installation\Configuring Authentication for more information.

Installing the Client 23


Create User Accounts and User Groups

If you are not synchronizing your users and user groups via LDAP you must manually createthem.

See User Administration in the Administration section of the Client Help for moreinformation.

Related topics

Importing resources

Importing roles

User Management



2.5 Installing the Web ServerThis topic describes how to install the Nimbus Control Web Server. For more information on theWeb Server, including software and hardware requirements and sizing, see the InstallationPlanning Guide that is included in the Documents folder on the installation CD.

Internet Explorer 9Microsoft Internet Explorer 9 is not currently supported and issues may be experienced by users onIE9. To resolve these issues you must force IE8 rendering mode on the web site. For moreinformation please refer to the Installation Planning Guide (included in the Documents folder onthe installation image).

Summary

· Install the Web Server

· Modify DCOM security

· Modify Nimbus Control Host.exe COM+ object

· Modify folder and file access rights

· Allow the Web Server ISAPI extension

· Configure IIS

Migrating Web Server SettingsIf you have an existing version of the Web Server installed and you want to keep theconfiguration settings, you can install the Web Server and migrate the settings in a singleoperation. See Upgrading a Web Server for information.

Prerequisites

· 120MB of disk space· The Nimbus Control client is installed and the process repository is in a location that is

accessible to the web server.· A supported operating system is running and IIS has been installed and configured.· A Nimbus Control domain service account exists which has full access to all areas of the

process repository (see the Installation Planning Guide for more information).· IIS is installed and is running. The account under which the IIS process will run must have full

access to all areas of the process repository.· Please read the Installation Planning Guide (included on the CD) before proceeding.

Setting up IIS

IIS is not installed on Windows Server 2003 or Windows Server 2008 by default. The Web Serverrequires IIS to work, therefore IIS needs to be installed first.

Windows Server 2003 (IIS6)

1. From the Add Remove Programs dialog in Control Panel, click Add or RemoveWindows Components.

2. Click Application Server to select it and click Next. This will install IIS6, including ISAPI

Installing the Web Server 25


Extensions.

Windows Server 2008 (IIS7)

1. On the Start menu, point to Administrative Tools, then click Server Manager. 2. In Roles Summary click Add Roles. 3. In the Add Roles Wizard, click Next, and then click to select the Web Server (IIS) check

box in the Roles list. Click Add Required Features when prompted, and then click Next. 4. Click Next, and then click to select the IIS Management Console and ISAPI Extensions

in the Roles services list. Click Next, and then click Install.

To install the Web Server

1. Do one of the following:

· Insert the CD and click Enterprise Server Installation.OR· If the CD installation does not automatically start, from the CD run Setup.exe and click

Enterprise Server Installation.

Note: If you are installing on a machine that is not a server you will receive a warningmessage. The Web Server can be installed on a non-server machine, however you willnot receive the benefits that a server has to offer. Click Yes to continue installing the WebServer on the machine.


3. [Choose Destination Folder] The location in which the Web Server is installed will default tothe location of the Client installation. To change location, in the Destination Folder panel clickBrowse to select a location in which to install the Web Server. To change the location of theProcess Repository, deselect Use default sub-folder for Process Repository and clickBrowse in the Existing Process Repository panel to locate the Process Repository.

Click Next to proceed.

4. [IIS Configuration Options] The Web Server must be mapped to an IIS virtual directory to allowusers to access it through their browsers.

Web Server Site - choose the site to install the Web Server to. If selecting a different Website from the default, you must ensure that the site is correctly configured.Virtual directory name - specify the virtual directory name. This is the name that users willsee in the browsers as the path of the application and the name that appears in IIS Manager.

Note: If the Web Server is being remoted for a SharePoint integration then IIS is notrequired, in which case disable Configure Nimbus Control for user via Internet InformationServer. See Integrating Nimbus Control with SharePoint for more information.

5. [Setup Program Manager Group] Select the Program Manager group that the Web Server willbe added to; either select an existing group or accept/rename the default name.


6. [Start Installation] Click Next to install the Web Server.



To configure DCOM

DCOM must be configured to allow the various components of the Web Server to communicate. Setthe following COM access rights:

Access Permissions - IWAM (IIS5) / Network Service (IIS6 and IIS7) requires Local Accessrights.

Launch and Activation Permissions - IWAM (IIS5) requires Local Launch rights and NetworkService (IIS6 and IIS7) requires Local Launch and Local Activation rights.



To modify the Nimbus Control Host.exe COM+ identity

The identity of the Control Host.exe container, which runs the Web Server, needs to be set to theNimbus Control domain service account.

To modify access to the Web Server folders and files

The access rights of all folders and files within <Installation Directory>\Control\Web Server\Mainneeds to be set to allow Read access for all Nimbus Control users. If LDAP is used it isrecommended that the Nimbus Control LDAP groups are used to provide this access. The Host.exeprocess must also have access to the following folders:

...\Nimbus Control\Process Repository\

...\Nimbus Control\Process Repository\Temp

...\Nimbus Control\Web Server\Reload

To allow the Host.exe process to access these folders, enable access for the Nimbus Controldomain service account, which the Host.exe process runs under.

To allow the Web Server ISAPI extension

Unless ISAPI extensions are enabled by default, you will have to add and allow the Nimbus Controlweb service extension. Note: The CtrlWebISAPI.dll is found in ...\Web Server\Main.

Windows Server 2003In IIS Manager, under Web Service Extensions, add CtrlWebISAPI.dll and set it to Allowed.

Windows Server 2008/2008 R2In IIS Manager, click the name of the server. In Features View, double-click ISAPI and CGIRestrictions. In the Actions pane, click Add. In the ISAPI or CGI path text box, enter the path ofthe CtrlWebISAPI.dll, or click Browse to select it. Check Allow extension path to execute andclick OK.



To configure IIS

In Windows Server 2003 and Windows Server 2008, IIS manages virtual directories in applicationpools. Each pool has its own properties that can be configured and single pools can host multiplevirtual directories. When Nimbus Control is installed it looks for an application pool called NimbusControl Pool. If it does not exist then it is created as part of the installation process. The NimbusControl virtual directory is created in the same way and is assigned to the Nimbus Controlapplication pool. The IUSR account must have anonymous access. Also, in Windows Server 2008R2, the application pool identity must be changed to Network Service.

The installation also requires two changes to the IIS configuration. WebDAV is disabled as part ofthe installation process. If enabled, the Front Page Server extensions must be disabled manually.For more information, refer to the Web Server Installation Planning section in the NimbusControl Installation Planning Guide (included on the installation CD).

Installing the Web Server on a different machine to the Process Repository

When the Web Server is installed, by default the local machine's IIS account is set to be usedfor anonymous access. This account does not have access to files on other machines,therefore the domain account that has access to the Process Repository must be usedinstead. Ensure that Enable anonymous access is enabled for the web site that is hosting theNimbus Control virtual directory and specify the domain service account details.

Nimbus Control Storyboard Player for iPhonesIf you intend for your users to make full use of the Nimbus Control Storyboard Player for the Apple



iPhone (downloadable from the Apple App Store), you must also add the MP4 (.mp4) extension asan additional MIME type when configuring IIS.

What Next...

Enable Single-sign OnTo allow users to log in to the Web Server automatically, i.e. without having to provide theircredentials once they are logged in to the network, WIA must be enabled. See Installation\Configuring Authentication for details.

Integrate the Web Server into a SharePoint instanceThe Web Server can be integrated into a SharePoint instance in order to provide Nimbus Controlfunctionality in a SharePoint environment. See Installation\Integrating Nimbus Control withSharePoint for details

Configure the Web ServerThere are many configuration options which define how the Web Server works. Theseparameters are defined in the Web Server configuration file. See Configuration\Web ServerConfiguration\Configuring the Web Server for details.

Schedule the synchronization of the Web ServerA number of tasks need to be updated regularly to ensure that users are accessing up-to-dateinformation. See Configuration\Web Server Configuration\Synchronizing the Web Server fordetails.

Customize the Web ServerThere are a number of ways in which to customize the look and feel of the Web Server. See Customization\Customizing the Web Server for details.

Related topics

Creating a Control Site in SharePoint

Upgrading a Web Server



2.6 Configuring AuthenticationWindows Integrated Authentication (WIA) enables single-sign on, negating the need for users toprovide log-in credentials once they are logged in to their organization's network. Whilst WIA doesnot require LDAP, implementing LDAP will ensure that user names match in both the activedirectory and in Nimbus Control. Nimbus Control can also integrate with Netegrity SiteMinder inorder to manage users and access to URLs.

Enabling Windows Integrated Authentication

Configuring LDAP synchronization

Configuring Netegrity SiteMinder

2.6.1 Enabling Windows Integrated Authentication (WIA)

All supported server platforms provide Windows Integrated Authentication, i.e. Single-sign On,assuming a suitable Microsoft domain architecture is provided. The Nimbus Control Web Serveralso supports WIA, allowing users to access Nimbus Control without having to provide credentialsonce they are logged in to their PCs.

Note: Integration with any directory service other than Microsoft's Active Directory may work but isnot supported by Nimbus. On Windows Server 2003, IE5 and IE5.5 are not supported for WIA. Ifsupport for viewers that do not exist in the domain is also required, another copy of the Web Servercan be installed and assigned to a different virtual directory, but pointing to the same ProcessRepository. This installation will use anonymous mode of interaction for viewers and non-domainusers.

Prerequisites

· The user account names in Nimbus Control must be identical to the user names on the domain(LDAP synchronization is recommended - see Enabling and Configuring LDAPSynchronization for more details).

· The Web Server has been installed and correctly configured with respect to DCOM security,the identity of the Control host.exe COM+ object has been defined and access rights to theWeb Server folders and files have been specified. See Installation\Installing the Web Serverfor more information.

· In Windows Server 2008, the Authentication role must be installed. In Server Manager, usethe Add Roles Wizard to add the Windows Authentication role. See IIS7 Component NotInstalled for more information.

To enable Windows Integrated Authentication (WIA) in Windows Server 2003

1. Run IIS Manager or IIS Virtual Directory Management Utility.2. Right-click the Control virtual directory and choose Properties.3. Click the Directory Security tab to select it.4. In the Authentication and access control panel click Edit.5. Deselect Enable anonymous access and select Integrated Windows authentication.

See Fig. 1.

6. Open config.ini (...\Nimbus Control\Web Server\Config) in a text editor, such as Notepad. In the

http://technet.microsoft.com/en-us/library/bb738113.aspx

http://technet.microsoft.com/en-us/library/bb738113.aspx

Configuring Authentication 31


[Authentication] section set the following two parameters:

UseIntegrated=1

IntegAuthType=0

7. Modify any of the other configuration parameters as required (described below), then save andexit config.ini.

To enable Windows Integrated Authentication (WIA) in Windows Server2008/2008 R2

1. Run IIS Manager and select the Nimbus Control application.2. In the IIS section select Authentication.3. Enable Windows Authentication and disable Anonymous Authentication.4. Open config.ini (...\Nimbus Control\Web Server\Config) in a text editor, such as Notepad. In the

[Authentication] section set the following two parameters:

UseIntegrated=1

IntegAuthType=0

5. Modify any of the other configuration parameters as required (described below), then save andexit config.ini.

[Authentication]

Parameter Description Value Function

UseIntegratedEnable or disable integratedauthentication. Note: Set this to '1'.

01

DisableEnable

RequiredDomain

Specify the domain name that must bematched in addition to the user loginname. Any domain matches if notspecified.

CaseSensitive

Specify case sensitivity when matchingthe domain name (user name matching isalways case insensitive).

0

1

Case insensitive

Case sensitive

IntegAuthType Specify the type of authentication used. Note: Set this to '0'.

0

1

2

Windows IntegratedAuthentication

Netegrity SiteMinder

SSO2 TicketAuthentication

IntegAutoLogonOnly Enable or disable automatic logon only, i.e. users cannot log out and access the LogOn page.

01

DisableEnable

IntegFailureURL Specify a URL to display when anunknown user account attempts to log in.If unspecified a built-in page is displayed.



[IsapiAuthentication]


AlwaysUseIISAuthInfo

Specify whether to use IIS' authenticationvariables even when the IIS version doesnot support Unicode authenticationdetails.

01

DisabledEnabled

To configure DCOM security

For all users requiring single-sign on access to Nimbus Control, DCOM security must be configuredto provide the IWAM or Network Service account with default Launch, Activation and Access rights.If LDAP is being used to synchronize Nimbus Control with a central directory service database thenprovide the four LDAP groups with this access.

Fig. 1 - Authentication Methods dialog



2.6.2 Enabling and Configuring LDAP Synchronization

LDAP (Lightweight Directory Access Protocol) enables Nimbus Control to integrate with a centraldirectory service database in order to manage user accounts and user groups, with passwordsbeing authenticated against the directory service. The LDAP service is installed as part of theAction Server (see Installation\Installing the Action Server).

LDAP integration works on the following principles:

1. Three user groups are predefined in the directory services environment. The groupnames can be set by the organization as configuration parameters.

2. Users are allocated to one of the following groups - Administrators, Authors, and EndUsers. However, users can be assigned to additional groups if the groups are set to bemanaged by LDAP.

3. Multiple LDAP servers can be synchronized with.4. Nimbus Control maintains an internal list of users and user groups. The Action Server

LDAP service synchronizes the internal list with the LDAP groups at defined intervals (setin the LDAP configuration file).

5. When synchronizing, if more users exist than are licensed for then not every user will beloaded into Nimbus Control and a notification Email will be sent.

6. User authentication is performed by the directory services server.7. There are a number of parameters that must be defined for LDAP synchronization to

work properly.

Important Security Notes

All desktop users and the security account that the Web Server host.exe process is running underrequire Read access to the LDAPconfig.ini file. However, this file needs to have operating systemfile permissions set so that general users cannot modify or delete this file. This is important asusers could remove the file and be able to access any account without passwords. It isrecommended that the Nimbus Control administrator accounts have local passwords in case thissituation should arise.

Nimbus Control supports Secure LDAP (SLDAP) if the port number in the LDAP configuration file isset to 636, or if the UseSecureChannel in the LDAPConfig.ini is set to '1' (i.e. enabled). Themachine in which the Client is installed must have the certificate as a trusted source; theapplication looks for the certificate in the standard certificate store, which can be managed by theMMC certificate snap-in.

It is recommended that SLDAP is used when connecting to a directory server environment otherthan Active Directory, since domain passwords will not be encrypted if ordinary LDAP is used.Note that Active Directory uses normal Windows authentication protocols.

When using the browser interface, HyperText Transfer Protocol Secure (HTTPS) should be usedas users' domain passwords are passed over the network to the Web Server in a readable format,therefore posing a significant security threat.



To enable and configure LDAP synchronization

1. Open LDAPconfig.ini (...\Nimbus Control\Process Repository\LDAP) in a text editor, such asNotepad. In the [MainSection] section set UseLDAP=1.

2. Modify any of the optional configuration parameters, as required.

Note: Some of the parameters will not be present in the configuration file until LDAPsynchronization has been run for the first time.

[MainSection]


UseLDAP Enable or disable LDAPsynchronization.

0 1

DisabledEnabled

UseSimpleBind Enable or disable Simple Bind. ForActive Directory it must be disabled(default), for other LDAP serversetups it must be enabled.

0 1

DisabledEnabled

AdminEmail The Email address of the personwho receives an Email whengenerated by the LDAP service.

PortNumber The port number that the LDAPserver communicates with (defaultis 389).

Server The name or IP address of theLDAP server. Note: To definemultiple LDAP servers, see below.

AdminsDN The distinguished name of the Nimbus Control administratorsgroup (default is Nimbus ControlAdmin).

AuthorsDN The distinguished name of the Nimbus Control process authorsgroup (default is Nimbus ControlAuthor).

EndUsersDN The distinguished name of the Nimbus Control end users group.

ChangeModuleUsersDN

The distinguished name of theNimbus Control end user ChangeModule end user account. Note:Users must also be defined in theEndUsersDN group.

ActionModuleUsersDN The distinguished name of theNimbus Control end user ActionModule end user account. Note:



Users must also be defined in theEndUsersDN group.

MobileModuleUsersDN The distinguished name of theNimbus Control end user MobileModule end user account. Note:Users must also be defined in theEndUsersDN group.

LoggingLevel The level of information that iswritten to the LDAP log file (defaultand recommended value is '1').

01234

See ConfiguringLDAPSynchronizationLogging for moreinformation

StartTime The start time that the LDAP servicewill run.

RepeatMins The time between LDAPsynchronization runs (in minutes).

ReportDuplicates Turn on or off duplicate logging inthe log file. If turned on then a logentry is recorded if two users withthe same name exist in differentLDAP groups.

0 1

DisabledEnabled

DupUserTypeOrder Specify the order of preference forwhich user account types to usewhen duplicate occur. The defaultis:

DupUserTypeOrder= 3,2,1

123

AdministratorProcess AuthorEnd User

DecodeAsUTF8 Enable or disable UTF-8 decoding(for LDAP v3 servers). See belowfor details.

0 1

DisabledEnabled

CallDelayMSecs Specify an optional delay (in msecs) after each call to the LDAP serverduring synchronization. See belowfor details.

0 1

DisabledEnabled

ThreadPriority Prioritize the synchronization threadin order to reduce CPU load duringlong synchronizations.

0123456

IdleLowestBelow NormalNormalAbove NormalHighestCritical

UseFullDN Enable or disable sending the fullDN for authentication. This isrequired for NDS and OpenLDAPbut is not required for ActiveDirectory.

0 1

DisabledEnabled



SystemEmail The Email address used by thesystem to send Emails (it is usefulto use a real address so thatbounced Emails are not received byusers).

ReportEmail The Email addresses of the peoplewho will receive completion reportsgenerated by the system. MultipleEmail addresses must be separatedby semi-colons.

Resume Select for synchronization to waituntil the next start time to run or torun at the next scheduled interval.This parameter is written followingthe first synchronization.

0 1

Wait for start timeRun on start

RunOnStart Specify whether to run thesynchronization immediately or towait for the start time.

0 1

Wait for start timeRun on start

SyncByAccountName

Specify to synchronize by the LDAPDN field or the Account Name field.See below for more information.

0 1

Synchronize by DNfieldSynchronize by AccountName

IncludeInitials Enable Users' Initial field to beincluded when synchronizing. Forexample, First name=John, Lastname=von Trap.

EncryptionType Specify the level of passwordencryption. The following values canbe used:

0

1

2

Password can bedecrypted by any PC

Password can only bedecrypted by the PC thatperformed the originalencryption

Password can only bedecrypted by the PC thatperformed the originalencryption and by thesame user

UserName The user name required toauthenticate with the LDAP server.For an Active Directory server thiscan be a user name or domainname and user name in the formDomain\User Name, for exampleNIMBUS_UK\JoSmith. For non-Active Directory LDAP servers this



usually needs to be the full user DNof the user account used forauthentication.

Password The password set by the client andis a base 64 encoded encryptedpassword. The level of encryptionused is set by the EncryptionTypesetting.

Anonymous Enable or disable anonymousaccess to the LDAP server.

0

1

Authenticated access

Unauthenticatedaccess

IncDisabledUsers Include or exclude disabled userswhen synchronizing with LDAP. Ifincluded, disabled users will appearas unassigned in Nimbus Control. Ifexcluded then disabled users willnot appear in Nimbus Control.

0

1

Exclude disabledusersInclude disabled users

UseSecureChannel Enable or disable secure LDAPauthentication (note that setting theport number to 636 will also enablesecure LDAP).

01

DisabledEnabled

IgnoreServerCertificateErrors

Ignore certificate errors (expired,incorrect domain, etc) during LDAPcalls. Note that UseSecureChannelmust also be set to '1'.

01

Don't ignoreIgnore

[AttrMapSection]

Parameter Function

UserNameThe unique name field that users are known by in the directory service, i.e. the name that the user logs in with.

FirstName The first name field for users.

LastName The last name field for users.

EmailName The Email address field for users.

MemberName The attribute used by a group to define the members within it (by defaultin most LDAP implementations this is 'member').

MobileName The mobile telephone number field for users.

ReportsTo The account name of the user's line manager. Note: This field is requiredto escalate users' To-do items.



Enabling and Disabling LDAP Management for Specific Users and User Groups

By default, if LDAP is enabled then user accounts will be automatically managed by LDAP. Usergroups are not managed by LDAP unless specifically flagged.

To enable or disable LDAP user management:In the User Accounts dialog in the Desktop Client, right-click the user and choose Properties.Select or deselect the This account is not to be managed via LDAP.

To enable or disable LDAP user group management:In the User Accounts dialog in the Desktop Client, right-click the user group and choose This groupis managed via LDAP. Enter the distinguised name (DN) for the user group (this must match thecorresponding directory server group name).

Note: LDAP group members that are not found will be skipped and not included as part of thesynchronized group.

To set the Ignore LDAP Flag (Admin Utility):The Admin Utility allows you to enable or disable the Ignore LDAP flag for specific user groups.This is useful if you want some groups to use a separate Control username and password to login to Control and some groups to be managed by LDAP.

Note: LDAP group members that are not found will be skipped and not included as part of thesynchronized group.

Run the Admin Utility (AdminUtil.exe, found in the Utilities folder on the CD) and from the Toolsmenu choose Toggle Ignore LDAP. Select to set the Ignore LDAP flag to On or Off, then selectthe checkboxes of your user groups and click Apply.

Authenticated LDAP Access

Most LDAP servers are set up to allow unauthenticated access. In most cases, access to the LDAPenvironment will not require authenticated access. However, certain sites require that any access toquery the LDAP environment will require a known user. You can configure the Action Server torequire authenticated access. This is achieved in the Client from the Administration menu, allowingthe user name and password to be stored in the LDAP configuration file.

The password is stored encrypted and can be encrypted to three different levels - standard, local tothe machine or local to the machine and user. The default, and recommended choice, is standard,which allows decryption on any machine.

1. In the Client, from the Administration menu choose Application Credentials and thenAction Server LDAP service.

2. Select Authenticated.3. From the Encryption Type drop-down list choose the type of encryption required.

Standard allows decryption on any PC (recommended)Current PC allows decryption only on the PC that originally performed the encryptionCurrent PC and current user allows decryption only by the PC that originally performed theencryption and when the same user is logged in.

4. Click OK.

The following parameters are written to the LDAP configuration file (LDAPConfig.ini):UserName - this needs to be set to the name required to authenticate with the LDAP server.For an Active Directory server this can be a user name or domain name and user name in theform Domain\User Name, for example NIMBUS_UK\JoSmith. For non-Active Directory LDAPservers this usually needs to be the full user DN of the user account used for authentication.



Password - this is set by the client and is a base 64 encoded encrypted password. The levelof encryption used is set by the EncryptionType setting.Encryption Type - this determines the level of password encryption. The following values canbe used:

0 = The password can be decrypted by any PC1 = The password can only be decrypted by the PC that performed the original encryption2 = The password can only be decrypted by the PC that performed the original encryptionand when logged in as the same user

Anonymous - set to '1' for anonymous access or '0' to not have anonymous access(anonymous access is assumed by default).

Synchronizing with Multiple LDAP Servers

Nimbus Control is capable of synchronizing with multiple LDAP servers, i.e. to allow for multipledomains. To define additional LDAP servers, add a new section for each additional server to theend of the LDAPconfig.ini called [Serverx], where x is the additional server number. Add the sameparameters in the table above and define them for each respective server.

Important

For each additional server you can define another set of [AttrMapSectionx] and [AttrValuesx],where x is the number of the additional server. For example, for [Server1] you would have[AttrMapSecion1] and [AttrValues1]. Both sections are optional and if not defined, the parametersfor the main server will be referenced.



LDAP Logging

See Logging LDAP Synchronization for more information.

Clearing Users' Distinguished Names

The Admin Utility allows you to clear all users' distinguished names (DNs) from the current processrepository (i.e. the Control Action Server). This could be useful, for example, if you are restructuringthe Active Server.

This option should be used with extreme caution.

The Admin Utility is found in the Utilities folder on the CD. Run AdminUtil.exe and from the Tools menu choose Clear All User DN's.

Further Information

The following provides more information on some of the LDAP configuration parameters, asdescribed above.

DecodeasUTF-8Certain LDAP v3 servers can use UTF-8 encoding when supplying data that has non-ASCIIcharacters in it and return this information in UTF-8 encoded UNICODE, therefore requiringconversion to ANSI characters using the current code page. Setting this value to '1' willenable UTF-8 decoding of all applicable received data. If Activity Directory is set, however,this value must be '0', i.e. disabled, as this converts non-ASCII text to ANSI before returningit, potentially causing misinterpretation of certain characters.

SyncByAccountNameWhen synchronizing with the LDAP server you can choose to synchronize by users' DN fieldor their Account Name field. If set to '0', which is the default, then the LDAP DN field is used.If set to '1', the Account Name field is used, which prevents users from being deleted andrecreated with a new user ID number in the synchronization process if their distinguishednames change.

CallDelayMSecsWhen synchronizing with the LDAP server you can specify a delay after each call, inmilliseconds. It works by calling the Windows Sleep API call which enables Windows toprocess other work. The maximum value is 1000 (1 second) but it is recommended that thevalue is set between 10 and 20 to reduce CPU load, then increased if necessary. If no valueis specified then it is disabled by default.

What Next...

Service SetupThe LDAP service must be run as a known domain account to allow it to access the LDAP serverand authenticate.

Test the LDAP SynchronizationFollowing the configuration of LDAP synchronization you can test the synchronization betweenthe Directory Service list of users and the Nimbus Control list. This is achieved through the LDAPUtility - see Testing an LDAP synchronization for more information.



2.6.3 Enabling and Configuring Netegrity SiteMinderSynchronization

Nimbus Control supports sites that are managed by Netegrity SiteMinder to manage Single-sign Onand access to URLs. The integration is based on the use of HTTP header variables that are set bythe Netegrity SiteMinder agent with the authenticated username stored within it.

Prerequisites

· The user account names in Nimbus Control must be identical to the user names on the domain(LDAP synchronization is recommended - see User Management\Configuring LDAPsynchronization for more details).

· The Web Server has been installed and correctly configured with respect to DCOM security,the identity of the Control host.exe COM+ object has been defined and access rights to theWeb Server folders and files has been specified. See Installation\Installation Procedures\Installing the Web Server for more information.

To configure the Web Server to integrate with Netegrity SiteMinder

1. Run IIS Manager or IIS Virtual Directory Management Utility.2. Right-click the Control virtual directory and choose Properties.3. Click the Directory Security tab to select it.4. In the Authentication and access control panel click Edit.5. Select Anonymous access (if not already selected).6. Click OK.7. Open the Web Server configuration file - config.ini (...\Nimbus Control\Web Server\Config) - in a

text editor, such as Notepad.8. In the [Authentication] section set UseIntegrated and IntegAuthType to '1', i.e.

UseInegrated=1

IntegAuthType=1

9. In the [Authentication] section modify any of the following optional parameters:

[Authentication]


RequiredDomain


CaseSensitive

Specify case sensitivity when matchingthe domain name (user name matchingis always case insensitive).

01

Case insensitiveCase sensitive

IntegAutoLogonOnly Enable or disable automatic logon only,i.e. users cannot log out and access theLog On page.

01

DisableEnable

IntegFailureURL Specify a URL to display when anunknown user account attempts to login. If unspecified a built-in page isdisplayed.



10.In the [SiteMinderAuthentication] section modify any of the following optional parameters:

[SiteMinderAuthentication]


HeaderFieldName

Specify the header field to obtain theauthenticated user name from.Assumed to be HTTP_SMUSER if notspecified.

PrimaryEncoding

Specify the primary encoding part of theSiteMinder HTTPHeaderEncodingSpecsetting.

01

No encodingUTF-8 encoding

SecondaryEncoding Specify the secondary encoding part ofthe SiteMinderHTTPHeaderEncodingSpec.

01

No encodingRFC-2047 encoding



2.7 Integrating Nimbus Control with SharePointNimbus Control can be integrated into Microsoft SharePoint, allowing users to access processinformation, such as processes, documents, To dos, storyboards, scorecards, etc, through aSharePoint interface.

There are two deployment methods for integrating Nimbus Control into SharePoint:

Local IntegrationLocal integrations allow the Nimbus Control Web Server to be installed on the same server asSharePoint.

Remote Integration

Nimbus provides a remoting solution that allows the Nimbus Control to be installed on a differentserver to SharePoint. Remoting allows one or more SharePoint servers to connect to a singleNimbus Control Web Server, and multiple remote Nimbus Control Web Servers can connect to asingle Process Repository. Remoting also allows the Web Server to be installed on a server thatdoes not have IIS installed.

SharePoint Farms

The Nimbus Control Web Server can also be run within a SharePoint farm using the Nimbusremoting solution.

· The remoting configuration changes to the SharePoint web.config file must be applied onevery SharePoint Front-end Web Server.

· The Nimbus Control Web Server must be configured for remoting.· Control.wsp only needs to be deployed on the machine in which the SharePoint Central

Administration site is installed, i.e. it is not necessary to manually deploy the file on everymachine within the farm.

Network Load Balancing

There are issues when using load balancing between a remoted SharePoint server and multipleback-end Nimbus Control web servers. For more information please refer to Deployment/ComplexDeployment in the Installation Planning Guide.

In this chapter:

· Integrating Nimbus Control with SharePoint

· Upgrading an existing Nimbus Control SharePoint integration

· Adding Nimbus Control Web Parts to non-Control SharePoint sites

· Integrating Nimbus Control with a SharePoint document library

Note: This guide assumes the user is adept with SharePoint and the administration of SharePointsites.



2.7.1 Configuring a SharePoint Integration

This topic describes how to configure the integration of the Nimbus Control Web Server withSharePoint, either locally or as a remote integration.

Prerequisites

Software requirements:

· Windows Server 2003 or 2008 with Windows SharePoint Server or Microsoft Office SharePointServer. Nimbus supports both SharePoint 2007 and SharePoint 2010.

· In Windows Server 2008, the IIS 6 Metabase Compatibility role must be installed (in ServerManager, use the Add Role Services Wizard to add the IIS Metabase Compatibility role).

· The Nimbus Control Web Server must be installed into either a new IIS site with a specifiedhost name (for example, NimbusControl), or installed into the default SharePoint-80 site. Note:Installing the Web Server into the SharePoint-80 site is not supported for SharePoint 2007 64-bit deployments, therefore a new site must be used in this case.

Note: The IIS site is selected in theIIS Configuration Options wheninstalling the Nimbus Control WebServer. Note that the Web Server canbe installed on a server without IIS bydeselecting Configure NimbusControl for use via InternetInformation Server. In this situationthe Web Server can only beaccessed using the remoting solution.If IIS is installed then a single WebServer installation can be used toserve both a remoted SharePointintegration and the Classic WebServer.

· The Nimbus Control Author Client is installed and has been run against the ProcessRepository at least once.

· (Remoting only) .NET 3.0 runtime (recommended .NET 3.0 Service Pack 1 or greater) isinstalled on the server that hosts the Web Server.

Additional requirements:

· If you are using Windows Integrated Authentication, it is advisable to ensure thatauthentication is working correctly via the Classic Web Server before configuring theSharePoint integration. Note: Nimbus Control does not need any specific authentication modeset in its configuration file as SharePoint requests are authenticated separately.

· (Remoting only) It is important to ensure that the user account that the remoting host serviceis running under, as specified in the service properties, has launch permission rights over theControl server COM object. The same user account also requires default COM access rightsso that the Control server COM object can communicate back to the service. See Installing theWeb Server for DCOM information.

Integrating Nimbus Control with SharePoint 45


What if the Nimbus Control Web Server has already been installed as a standardweb site?

You can configure the integration of the Nimbus Control Web Server into SharePoint if theClassic Web Server has already been installed. Please note that these steps apply only if you areconfiguring a local integration. For remote integrations there are no precursor steps.

To configure a local integration1. Install Windows SharePoint Services (if it has not already been installed).

Note: The default Nimbus Control web site service will be stopped following the installation ofWSS.

2. Follow the steps according to which server you are using:Windows Server 2003

In IIS Manager, create a new virtual directory within the IIS site (for example, in theSharePoint - 80 site).

· The web site content directory is the Main folder in the Web Server folder (defaultlocation is C:\Nimbus Control\Web Server\Main).

· The access permissions of the virtual directory must be set to Read and Execute.Windows Server 2008

In IIS Manager, add a new Application. The physical path needs to point to the Mainfolder in the Web server folder and the application pool needs to be set to ControlPool.

To configure SharePoint to work with the Nimbus Control Web Server

Note: If you are configuring the integration of the Nimbus Control Web Server into a SharePointfarm then the following updates to the SharePoint configuration file must be applied to everySharePoint front-end Web Server.

1. Open SharePoint Web.config changes.txt (SharePoint folder on the CD) and web.config (...\Inetpub\wwwroot\wss\VirtualDirectories\80).

2. Copy the following Nimbus section group element from the SharePoint Web.config.changes.txt file and paste in the web.config file. This should be nested within the <configSections> tags,as shown in Fig.1. You do not need to copy the <configSections> tags as they already exist inthe SharePoint configuration (web.config) file.

<sectionGroup name="nimbus"><section name="general" type="Nimbus.web.Comm...><section name="Credentials" type="Nimbus.web.Comm...>

</sectionGroup>

3. Copy the following Nimbus configuration element from the SharePoint Web.config.changes.txtfile and paste in the web.config file. This should be nested within the <configuration> tags. SeeFig.2.

<nimbus><general>

<main defaultsiteurl="" serverConnectionMethod...>......etc

</nimbus>

4. Copy the following system serviceModel element from the SharePoint Web.config.changes.txtfile and paste in the web.config file. This should be nested within the <configuration> tags. SeeFig.3.



<system.serviceModel> <bindings> <netNamePipeBinding> ... ... </client></system.serviceModel>

5. In the web.config file, set the following parameters depending on what type of integration youare configuring:

Parameter Local Integration Remote Integration

defaultSiteURL N/A URL of the Nimbus Control SharePoint site.For example:

http://server1/sites/NimbusControl

serverConnectionMethod

COM WCF

comServerserverConfigFile

Path of the Nimbus Control WebServer configuration file.For example:

C:\Nimbus Control\WebServer\Config\config.ini

N/A

wcfServerclientIdentityType

N/A The user account used to make calls to theremote Control Web Server. There are twooptions:(1) SpecifiedUser (recommended). Ifselected you must set the wcfClientIdentityuserName credentials (see below).

(2) Process. This will use the account underwhich the SharePoint ASP.NET runs under(not the logged in user).

wcfServerendpointName

N/A The end point name used when connectingremotely. To specify a remote connection viaa TCP connection, set this to NimbusTcpEndpoint.

wcfClientIdentityuserNamedomainpassword

N/A If SpecifiedUser was selected as the ClientIdentity Type (above) you must define theidentity credentials (user name, domain andpassword).

Note: Since these credentials are in aseparate section to the general settings youcan encrypt them without affecting thegeneral settings. For more information seethe following links:

How to encrypt configuration sections in

http://msdn.microsoft.com/en-us/library/ms998280.aspx



ASP.NET using DPAPIHow to encrypt configuration sections inASP.NET using RSA

For an example of the 'nimbus.credentials'section see See Fig. 4.

endpoint address N/A Set this to the applicable protocol, server andport for each endpoint. There are twoendpoints specified. For remoting, the TCPbinding will be required and so theNimbusTcpEndpoint item must be updated.It is important to ensure the port matches thevalue specified in the NimbusServerHost.exe.config file (default location is C:\NimbusControl\Web Server\Remoting Server). SeeFig. 5.

6. (Local Integrations Only) In IIS Manager, create a new virtual directory called nimbus_controlin the IIS site where the Web Server is installed under (for example, in the SharePoint-80 site),within the _layouts virtual directory. Point it at the Web Server 'Main' installation folder andprovide Read access.

To install the Nimbus Control SharePoint solution

Note: If you are configuring a remote integration with SharePoint then these steps apply only to theCentral Administration Site on the SharePoint server.

7. Open a command-prompt window and navigate to one of the following directories:

SharePoint 2007: ...\Program Files\Common Files\Microsoft Shared\web server extensions\12\BIN


8. Run the following command:STSADM.exe -o addsolution -filename <path to NimbusControl.wsp>

For example:STSADM.exe -o addsolution -filename C:\Control\NimbusControl.wsp

Note: The NimbusControl.wsp file can be found in the SharePoint folder on the NimbusControl Installation CD.

To deploy the Nimbus Control site

9. Depending on what version of SharePoint you are using, access the following SharePoint page:

SharePoint 2007. Central Administration >> Operations tab >> Global Configurationsection >> SharePoint management page.SharePoint 2010. Central Administration >> System Settings >> Manage Farm Solutions.

Note: You must add the SharePoint Central Administration Web site to the list of localintranet sites in order to be able to deploy the Nimbus Control site.






10.Click NimbusControl.wsp, then click Deploy Solution and choose to deploy to the same webapplication (http://servername). See Fig.6.

11.Recycle the SharePoint Central Administration Pool.



To create a Nimbus Control site in SharePoint

12.In the SharePoint Central Administration console select the Application Management tab.13.On the Central Administration site, in the Application Management section, click Create site

collection. See Fig.7.

If you are integrating the Nimbus Control Web Server locally then you have finished.Otherwise, to complete a remote integration please follow the additional steps below.

To finalize the configuration of the Nimbus Control Web Server for remoting

This method describes the configuration of the Nimbus Control Web Server to enable remoting,once the SharePoint configuration described above is complete.1. Run NimbusServerHost.exe.

NimbusServerHost.exe is found in ...\Nimbus Control\Web Server\Remoting Server. Ashortcut is also added to the Nimbus Control Program Group in the Start Menu.

The application can be run as either a Windows service or manually, i.e. interactively. Theinteractive mode is designed for initial configuration testing. To install the application to run as aservice you must have administrative rights. Note that only one instance can be run on a singleserver.

For Windows Vista and Windows Server 2008 you must elevate your administrativerights. To do this, right-click NimbusServerHost.exe, or right-click the shortcut, andselect Run as administrator.

2. Click Install service.3. Open NimbusServerHost.exe.config (...\Nimbus Control\Web Server\Remoting Server) in a

text editor and define the following values:

Parameter Description

<add key="Caller.UserName" value="" />

The user account used to connect and make requests to the ControlWeb Server from the SharePoint server. Note: If a user is not specifiedthen any user is permitted to connect to the remoting service to makerequests.

<add key="Caller.Domain=" value="" />

The domain of the user account specified above.

<addbaseAddress="net.tcp://localhost:52000/controlweb" />

The location and port of the remoting host service.

Notes: · A TCP/IP request can be denied access by the server itself before the request is sent to the

NimbusServerHost.exe process, therefore ensure that the user account is known and that it hasthe applicable rights to the server that is hosting the Control Web Server.

· The WebServer.CLSID value is a unique identifier that is set during the installation of theWeb Server and should not be changed unless manual changes to this value are madeelsewhere.

4. Start the remoting service in Windows Services.



What Next...

Grant Access to UsersUsers must be provided with access to use the site. From the Site Settings page (accessed fromSite Actions), authenticated users should be added by default, unless specific user access isrequired, in which case the appropriate users should be granted permission. The minimum accessrequirement for the site is 'Team Site Visitor' (read only).

Related Images

Fig. 1. Fig. 2.



Fig. 3.



DPAPI

<nimbus> <credentials configProtectionProvider="DataProtectionConfigurationProvider"> <EncryptedData> <CipherData> <CipherValue>AQAAANCMnd8BFdERjHoAwE/Cl+sBAAAAMqrxJKRmxkGBamO56i/6ngQAAAACAAAAAAADZgAAqAAAABAAAAAgJC1QthpcY3d/dujEXQu+AAAAAASAAACgAAAAEAAAACTF8TKQl6zW39WVPtCJrxvoAAAAbbwIsiqnfNwy+iYP96M5Sa4R4TivVv7sblP/TJ6cpIPYjZfXJfbN+jDkaSuMvjYF7hFIsLngB4Xn/94WSPiiNhHC5pskguotH23DuzmjBaZo6LoK5EYuRY/B6Cy9PwM9JpAPaKVmxRDXuRgSYVh1fX/bKgRkj26LfXluKejf4eGxChEj2oBH/TakRxHUQRgz487jUP+Yb+TqyG/6Piy8+UWTJFF10QJJSTgbfBfswnG5KHXPZTnkDLVN+DpIshLjXIQM0eKl95wNuw8e87k854dgohPfJEWJLgCUKxQJkPi/PRMvtTJanhQAAADXhzzASs/FL/BwChKOWDLlTc4fmg==</CipherValue> </CipherData> </EncryptedData> </credentials></nimbus>

RSA

<nimbus> <credentials configProtectionProvider="RsaProtectedConfigurationProvider"> <EncryptedData Type="http://www.w3.org/2001/04/xmlenc#Element" xmlns="http://www.w3.org/2001/04/xmlenc#"> <EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#tripledes-cbc" /> <KeyInfo xmlns="http://www.w3.org/2000/09/xmldsig#"> <EncryptedKey xmlns="http://www.w3.org/2001/04/xmlenc#"> <EncryptionMethod Algorithm="http://www.w3.org/2001/04/xmlenc#rsa-1_5" /> <KeyInfo xmlns="http://www.w3.org/2000/09/xmldsig#"> <KeyName>Rsa Key</KeyName> </KeyInfo> <CipherData> <CipherValue>PQBY4HFpkps+FY1C8+EsRZtH//8HnCdbOm5VD/ypBjpg7djg+vnAuzmKqOhIkbN4kx1s6fykmXBXPJ4HC7WGHYqvlg3XK1G4mKylPY3CLHVzGh0AX0GQ0+AsoxZj3k3aCnp+N6sTmhpA3SQQ66NWc16HGm7R+Y/zTlk740p2mMU=</CipherValue> </CipherData> </EncryptedKey> </KeyInfo> <CipherData> <CipherValue>iyZGy3vUKELvm/8xgAq8nqKdYNLKjL6cyv/SfEUqO9guOho96w1XvDszFZB2V/gO7MKyfgI5XLTDMihEUAOENwOUVS9rVguc8ALrN9ey8IdJerrSiB0Z67FRGmBDNNqW9vMVZFDj94DZbF6T8VgQQ1BqgTr/xPnsQ0GJ/VqrHKo=</CipherValue>

Fig. 4. Example Nimbus Credentials



Fig. 5. Endpoint address

Fig. 6.



Fig. 7.



2.7.2 Upgrading a SharePoint Integration

This topic describes how to upgrade an existing Nimbus Control SharePoint integration.

Prerequisites

· Nimbus Control 6.5.2 Service Pack 1 (or higher) with the Web Server integrated into aSharePoint instance. See SharePoint Integration for more information.

· Windows Integrated Authentication must be enabled for Nimbus Control version 6.5.2 SP1,however from version 6.5.2 SP2 this is not required as SharePoint authentication requests arehandled separately.

· (Remoting only) The latest Nimbus Control remoting host service has been installed andconfigured.

To upgrade a Nimbus Control SharePoint integration

If you are upgrading a remote SharePoint integration proceed from Step 3.

1. (Local only) Open web.config in a text editor, such as Notepad, and update the "comServerserverConfigFile" value with the path of the Web Server configuration file from the newinstallation (for example, C:\Nimbus Control\Web Server\Config\config.ini).

web.config:...\inetpub\wwwroot\wss\VirtualDirectories\80

2. (Local only) In IIS Manager, open the properties for the _layouts/nimbus_control virtualdirectory for the IIS site that the Web Server is installed under and update the Local path of theWeb Server (if required).

3. From a command prompt, navigate to:



Run the following command:STSADM.exe -o upgradesolution -name Control.wsp -filename NimbusControl.wsp-immediate -allowgacdeployment

For example:STSADM.exe -o upgradesolution -name NimbusControl.wsp -filename "C:\NimbusControl\NimbusControl.wsp" -immediate -allowgacdeployment

Note: The NimbusControl.wsp file can be found in the SharePoint directory on the NimbusControl installation CD.

Note: If the Windows SharePoint Services Administration service is not running, an errormessage will prompt you to run the following command:

STSADM.exe –o execadmsvcjobs

4. Recycle the SharePoint Central Administration Pool.

Important NoteUpon completion of the upgrade you must create a new Nimbus Control site collection,otherwise some of the new pages may not work. It is also recommended that you remove the oldsite collection.



2.7.3 Adding Control Web Parts to other SharePoint sites

A number of Nimbus Control Web Parts exist, which can be imported into other (non-Control)SharePoint sites.

The Web Parts available include:

Favorites - ListOfFavorites.webpart

To Dos - ToDos.webpart

My Searches - MyTopics.webpart

My Searches Results - MyTopicsResult.webpart

Diagram Search Results - SearchDiagramsResult.webpart

Document Search - Documents.webpart

Recently Viewed Items - ListOfRecentlyViewed.webpart

Action List - ListOfActions.webpart

To import and activate the Nimbus Control Web Parts

If a Nimbus Control SharePoint solution has not been deployed on a particular server, you must firstimport and activate the Nimbus Control Web Parts in order to use them in other SharePoint sites.After installing the Nimbus Control Web Server, the various Web Parts can be imported from thefollowing location:

SharePoint 2007: ...\Program Files\Common Files\Microsoft Shared\web server extensions\12\TEMPLATE\FEATURES\NimbusControlWebParts

SharePoint 2010: ...\Program Files\Common Files\Microsoft Shared\web server extensions\14\TEMPLATE\FEATURES\NimbusControlWebParts

You must also activate the Web Parts in the site that you want to use them in:

1. Click Site Actions and choose Site Settings.2. Under Site Collection Administration click Site collection features.3. Click Activate for the Nimbus Control Web Parts option.

The Control Web Parts are now ready to be added to the site.

Nimbus Control Web Parts' URLs

When adding Nimbus Control Web Parts to other SharePoint sites, the Web Parts must referencea Nimbus Control site in order to retrieve information. Each Web Part can be assigned a specificURL, or a default URL can be defined for the SharePoint site.

In the Miscellaneous properties for a particular Nimbus Control Web Part, deselect This is aNimbus Control site and enter the URL of the Control site in the text box above it.

Specifying a default Nimbus Control site URL

You can also define a default Control URL in the SharePoint configuration file. If a Control site URLis not specified for a particular Control Web Part then this default will be used.

1. Open SharePoint Web.config changes.txt and web.config.SharePoint Web.config.changes.txt:



The SharePoint folder on the Installation CD.

SharePoint Configuration File (web.config):

...\Inetpub\wwwroot\wss\VirtualDirectories\802. Copy the following Nimbus section group element from the SharePoint Web.config.changes.

txt file and paste in the web.config file. <sectionGroup name="nimbus">

<section name="general" type="Nimbus.web.Comm...><section name="Credentials" type="Nimbus.web.Comm...>

</sectionGroup>

This should be nested within the <configSections> tags (see Fig.1.). You do not need to copythe <configSections> tags as they already exist in the SharePoint configuration (web.config)file.

3. Copy the following Nimbus configuration element from the SharePoint Web.config.changes.txtfile and paste in the web.config file.

<nimbus><general>

<main defaultsiteurl="" serverConnectionMethod...>......etc

</nimbus>This should be nested within the <configuration> tags (Fig.2.).

4. In the web.config file, specify the main defaultSiteURL parameter in the <nimbus>configuration parameters, for example:

main defaultSiteUrl="http://www.<server_name>/sites/control"

Favorites Web PartThe Favorites Web Part can be configured to display or hidecertain elements. In the Miscellaneous properties, select ordeselect any of the checkboxes, as required.

1. Click Site Actions and then Edit Page.2. On the Favorites Web Part click edit.3. Expand Miscellaneous and select or deselect any of the

elements.4. Click OK.

To include Nimbus Control searches in the SharePoint Enterprise Search page

The SharePoint Enterprise Search facility can be configured to search for processes, storyboards



and documents, based on users' associated keywords or free text.

Note: This applies to Microsoft Office SharePoint Server (MOSS) only as the EnterpriseSearch page is not available in Windows SharePoint Services (WSS).

1. Import the Nimbus Control My Searches and the Nimbus Control My Processes Search WebParts into the SharePoint site (see To add Nimbus Control Web Parts into non-Control sitesabove).

Nimbus Control Processes Search displays a list of process diagrams based on a freetext search.

Nimbus Control My Searches displays a list of storyboards, documents and processdiagrams based on a user's My Topics keyword search.

2. Navigate to the Enterprise Search page for the SharePoint site and conduct a search.

Note: This step is required to access the Search Results page in the Enterprise Search,therefore it is not important what results are returned.

3. Click Site Actions and then Edit Page.4. Click Add a Web Part in the Bottom Zone.5. In the Suggested Web Parts to Bottom Zone, select Nimbus Control My Searches and

Nimbus Control My Processes Search, then click Add.6. Click Edit on the respective Web Parts that you have just added.7. In the properties of the Web Part, expand Miscellaneous and select what content to display

when users conduct a search. See Fig.3.8. Deselect This is a Nimbus Control site, then specify the site above (for example (http://[site]/

Nimbus Control).9. Click OK.

To add a process search tab to the Enterprise Search page

You can add a tab to the Enterprise Search page that provides users with the ability to run free textsearches for processes only.

Note: This applies to Microsoft Office SharePoint Server (MOSS) only as the EnterpriseSearch page is not available in Windows SharePoint Services (WSS).

Creating the Process Search PagesFirst you will create the Search and Search Results pages.1. Open the Search Center site in a browser, click the Site Actions menu, then click Create Page.

Search page: http://[Site]/SearchCenter/Pages/default.aspx



Enter a title (for example, Processes).

Enter a URL name for the page in the URLName field (for example, Processes).

Select (Welcome Page) Search Page as thepage layout.

Click Create to create the page.

2. Repeat Step 1 to create the Processes Search Results page.

In the URL Name field enter a different URL name (for example, ProcessResults).

For the layout, select (Welcome Page) Search Results Page.

Configuring the Process Search PagesNow you will configure the pages that you have created.

3. Navigate to the page that you created in Step 1.

For example: http://[Site]/SearchCenter/Pages/Processes.aspx

4. Click the Site Actions menu, then click Edit Page5. Click edit on the Search Box Web Part, then choose Modify Shared Web Part.6. In the Search Box Web Part properties, expand Miscellaneous and in the Target search

results page URL field enter the page URL that you created in Step 2. For example,ProcessResults.aspx.

7. Under Miscellaneous, deselect Display advanced search link. Click OK to finish.

This will remove the Advanced Search facility from the Search options, as Nimbus Control WebParts are not compatible with advanced searching.

8. Navigate to the page that you created in Step 2, click the Site Actions menu, then click EditPage.

For example: http://[Site]/SearchCenter/Pages/ProcessResults.aspx

9. Repeat steps 4 - 6 to modify the Search Box Web Part. Use the same target search results pageURL as you did for Step 6.

10.Remove all other Web Parts except the Search Box Web Part.11. In the Bottom Zone click Add Web Part. Select Nimbus Control Processes Search, then click

Add.12.On the Nimbus Control Processes Search Web Part click edit, then Modify Shared Web Part.13. In the Nimbus Control Processes Search Web Part properties, expand Miscellaneous and

deselect This is a Nimbus Control site. In the field above this option, specify the URL of theNimbus Control site.

For example: http://[Site]/sites/nimbus control



14.Expand Appearance and from the Chrome Type drop-down list choose None.

This will hide the title of the Web Part to users.

15.(Optional) Under Miscellaneous you can select Show details. This option will display returnedresults in greater detail.

16.Click OK to apply the changes to the Web Part, then click Publish to update the page.

Creating the Tabs for the Process Search PagesFinally, you will create a new tab in the Search Center and Search Results pages.

17.In your browser, navigate to the Windows SharePoint Services list for the SearchCenter tabcontrol:

For example: http://[Site]/SearchCenter/SearchCenter/AllItems.aspx

18.In the List toolbar click New item.

Enter a tab name.

In the Page field enter the page you createdin Step 1 (for example, Processes.aspx).

Click OK to create the new tab.

19.Repeat Step 18 to create a new tab in the Search Results page:

For example: http://[Site]/SearchCenter/SearchResults/AllItems.aspx

Note: In the Page field, enter the results page created in Step 2 (for example,ProcessResults.aspx).

Topic Images



Fig.1. web.config Fig.2. web.config

Fig.3. Web PartProperties



2.7.4 Integrating with a SharePoint document library

Nimbus Control can be integrated with a SharePoint Document Library in a specified MicrosoftSharePoint environment. This allows users to register SharePoint document links in Nimbus Control,and to add documents directly into SharePoint through the Nimbus Control Document Registry.

SharePoint document links are stored in:...Process RepositoryATTACH\SharePoint Links\Draft...Process RepositoryATTACH\SharePoint Links\Master

To integrate with a SharePoint document library

1. Run AdminUtil.exe (found in the Utilities folder on the installation CD).2. Select the Process Repository that you are configuring.3. Choose an administrator account, enter the password and click Next.4. From the Configure menu choose Microsoft SharePoint Document Library.5. Select Enable SharePoint document library integration.

Automatically store new documents in the default document library will automaticallyupload documents into the default SharePoint document library when a document isregistered in the Nimbus Control Document Registry.

6. Click Add to add a SharePoint document site library.7. In the SharePoint Connection Details panel, enter the following details:

Site Name is the name of the site that hosts the document libraries that you want to link to.Site URL is the URL of the SharePoint site that holds the site library.User Name is the user name for an account that has administrative access rights to theSharePoint site.Password is the password for the user name specified above.Default site will automatically upload documents to this site when a document is registeredin the Nimbus Control Document Registry (when the Automatically store new documentsin the default document library option is enabled).

8. Click Refresh to display the list of available SharePoint document libraries.9. Select one or more available libraries.

Note: You must have a default library specified. To set a specific library as the defaultlibrary, click the library to select it and click Set as Default. This will automatically uploaddocuments into this library when a document is registered in the Nimbus ControlDocument Registry (when the Automatically store new documents in the defaultdocument library option is enabled).

10.Click OK.

Note: To change the default site, i.e. the SharePoint site that is used to automaticallyupload documents to, double-click the site and in the SharePoint Connection Detailspanel select Default site.



2.8 Installing the Action ServerThis topic describes how to install the Nimbus Control Action Server. For more information on theAction Server, including software and hardware requirements and sizing, see the InstallationPlanning Guide that is included in the Documents folder on the installation CD.

Please read the prerequisites and take the necessary actions before proceeding with theinstallation.

Prerequisites

· 5MB of disk space· The Nimbus Control Client is installed and the Process Repository is in a location that is

accessible to the Action Server.· It is important that you have read the Installation Planning Guide (included on the CD).

To install the Action Server

1. Do one of the following:· Insert the CD and click Action Server Installation.

· If the CD installation does not automatically start, from the CD run Setup.exe from theActionServer folder.


3. [Choose Destination Folder] The location in which the Action Server is installed will default tothe location of the Client installation. To change location, in the Destination Folder panel clickBrowse to select a folder in which to install the Action Server in. To change the location of theProcess Repository, deselect Use default sub-folder for Process Repository and clickBrowse in the Existing Process Repository panel to locate the Process Repository.

Click Next to proceed.4. [Choose Services for Installation] Select the Action Server services that you want to install.

Click Next to proceed.5. Depending upon which services you are installing, as selected in the previous step, you may be

required to enter specific details with respect to certain services.

[Email Service Configuration] Outgoing mail SMTP server - this is the name, or IP address, of the SMTP server.Non Delivery Report Recipient - this is the Email address that non-delivered Email reportsare sent to.

[Lock Service Configuration] Start Lock Time - this is the time that the Process Repository is locked to allow you to backit up.Stop Lock Time - this is the time that the Process Repository is unlocked.

[LDAP Synchronisation Service Configuration] Administrator's Email Address - this is the Email address that is notified if any problemswith the LDAP synchronization occur.

Email Address to user as from address for system Emails - this is the Email address



that is used to send system Emails from.LDAP Server Name - this is the name, or IP address, of the LDAP server.First run time - this is the time that the first synchronization is run.Repeat Interval - this is the time between synchronizations (by default this is 1440, i.e. 24hours).

Click Next to install the selected Action Server services, then click Finish when prompted.

To configure DCOM

In order for the Office Integration Service to be able to launch and access Excel, the DCOM accessand launch rights must be configured to allow launch and access rights for the MS Excel COMobject for the user account nominated to run the service.

Windows Server 2003 onwards1. Run the Component Services (from the Start Menu Run command prompt run dcomcnfg

).

2. Expand Console Root>Computers>My Computer>DCOM Config.

3. Right-click Microsoft Excel Application and choose Properties.

4. Click the Security tab to select it.

5. In the Launch and Activation Permissions panel click Customize, then click Edit.

6. Add the user account nominated to run the service and allow Local Launch rights.

7. Repeat steps 5-6 for Access Permissions, allowing Local Access rights.

What Next...

Configure the Action ServerThere are a number of configuration settings that can be defined for the respective Action Serverservices. See Configuring\Action Server Configuration\Configuring the Action Server for moreinformation.

Related topics

Troubleshooting the Action Server

Installing the Action Server 65


2.9 Installing the Business Intelligence ServerThis topic describes how to install the Nimbus Control Business Intelligence (BI) Server. For moreinformation on the Business Intelligence Server, including software and hardware requirements andsizing, see the Installation Planning Guide that is included in the Documents folder on theinstallation CD.

Please read the prerequisites and take the necessary actions before proceeding with theinstallation.

Prerequisites

· 3MB of disk space· The Nimbus Control Client is installed and the Process Repository is in a location that is

accessible to the Business Intelligence Server.· It is important that you have read the Installation Planning Guide (included on the CD).

To install the Business Intelligence Server

1. Do one of the following:· Insert the CD and click Business Intelligence Server Installation.

· If the CD installation does not automatically start, from the CD run Setup.exe from the BIServer folder.


3. [Choose Destination Folder] The location in which the BI Server is installed will default to thelocation of the Client installation. To change location, in the Destination Folder panel clickBrowse to select a folder in which to install the BI Server in. To change the location of theProcess Repository, deselect Use default sub-folder for Process Repository and clickBrowse in the Existing Process Repository panel to locate the Process Repository.


4. [Start Installation] Click Next to install the BI Server.5. [Installation Complete] Click Finish to exit the installation.

What Next...

Configure the Business Intelligence ServerThere are a number of configuration settings that can be defined for the Business IntelligenceServer. See Configuration\Business Intelligence Server Configuration\Configuring the BusinessIntelligence Server for more information.

Synchronize the Business Intelligence ServerThe Business Intelligence Server can be scheduled to run as a Windows Scheduled Task inorder to update metric data in Nimbus Control. See Configuration\Business Intelligence ServerConfiguration\Syncronizing the Business Intelligence Server for more information.



Related topics

Updating Excel Macros

Creating SQL Queries

Scheduling and Updating SQL Queries

Integrating with SAP BW and SAP NetWeaver BI

Integrating with Microsoft Office Business Scorecard Manager

Integrating with Cognos Metrics Manager

Integrating with ActiveStrategy

2.10 Installing the Nimbus Control Performance MonitorThis topic describes how to install the Nimbus Control Performance Monitor.

64-bit Versions of Windows Server

To use the Nimbus Control Performance Monitor in a 64-bit version of Windows Server (includingWindows Server 2003, Windows Server 2008 and Windows Server 2008 R2), you must run the32-bit version of the Windows Performance Monitor. To do this, run the following command:

mmc.exe /32 perfmon.msc

Prerequisites

· 10MB of disk space· The machine is running Windows 2000 Server, Windows Server 2003 or Windows Server

2008. Note: Windows 2000 Server is not supported from 7.0.2 onwards.

To install the Windows Server Performance Monitor plug-in

1. Run Setup.exe from the Performance Monitor folder on the Installation CD.2. [Welcome] If no other Windows applications are running, click Next. Otherwise, terminate the

installation in order to exit the applications, then re-run the setup.3. [Choose Destination Folder] The location in which the Performance Monitor is installed will

default to the location of the Client installation. To change location, in the Destination Folder panel click Browse to select a folder in which to install the Performance Monitor in.


4. Click Finish to exit the installation.

Related topics

Monitoring Web Server Performance

Configuring Web Server Logging

Uninstalling Nimbus Control 67


2.11 Uninstalling Nimbus ControlEach product must be uninstalled separately through the Add/Remove Programs in WindowsControl panel.

Security

Chapter 3


Securing a Process Repository 69


3.1 Securing a Process RepositorySince Nimbus Control requires users to have read, write and modify NTFS privileges against theProcess Repository folder, this poses a potential security loophole in that it allows users to modifyany of the Nimbus Control system files through normal file system capabilities (for example, throughWindows Explorer). To prevent this you can secure a Process Repository.

Nimbus Control switches back to users' identities when performing external file operations, such asHTML exporting, packaging, attaching files, registering files in the Document Registry, etc.

Note: For Windows Vista and Windows Server 2008 installations, Use Account Control (UAC) mustbe enabled. This is enabled by default but may have changed. See http://technet.microsoft.com/en-us/windowsvista/aa906022.aspx for more information. Also, before securing a ProcessRepository it is advisable to contact Nimbus Support.

Prerequisites

· Nimbus Control has been installed and an NTFS account that has read/write access to theProcess Repository must exist. This account must also be able to run the Nimbus Controlclient.

To secure a process repository

1. Run RepoCred.exe (found in the Utilities folder on the CD).2. Select the process repository that you want to secure and click OK.3. In the Security Settings for Process Repository dialog select one of the following:

· If you are logged on as the NTFS account that has read/write access to the processrepository then click OK.

· If you are not logged on as an NTFS account that has read/write access to the processrepository, select This account and enter the respective user account details.

Note: A new folder will be created at the same level as the Process Repository called<Process Repository folder name>cred. For example, in a default installation it will be<Installation directory>\Nimbus Control\Process Repository\cred. Within this folder is a filecalled cred.ini which contains the information required to access the Process Repository(including the password which is strongly encrypted).

4. Set the folder access rights on the <Process Repository>cred access rights to Read only for allusers of the Nimbus Control client.

5. Set the NTFS access rights for the process repository folder to Access Denied for all useraccounts except the NTFS account that has Read/Write access to the <ProcessRepository>cred folder. It is advisable to grant access to the system administrators.

http://technet.microsoft.com/en-us/windowsvista/aa906022.aspx

http://technet.microsoft.com/en-us/windowsvista/aa906022.aspx

Configuration

Chapter 4


Web Server Configuration 71


4.1 Web Server Configuration

4.1.1 Configuring the Web Server

There are a number of options that can be defined for the Web Server and this topic provides asummary of the available options. Some of these options are covered in more detail in other relatedtopics.

To configure the Web Server

1. Open config.ini (...\Nimbus Control\Web Server\Config) in a text editor, such as Notepad. Thefollowing configuration options can be defined:

[Installation]

Parameter Function

IGUID N/A

[Web Server]

Parameter Function

DefaultMapSpecify the full path of the default map for visitors only. The map must bea master version and accessible to viewers.

DefaultPageURL Specify a starting page for users (see below for more information).

CLSIDUnique identifier for the web server installation. Important: Do notchange this value.

SessionTimeout

Specify the number of minutes before a user's session times out - default=20, min=5, max=120.

Note: For values greater than 20 you must also set the application poolsession timeout through IIS to match the value set here.

MyPageOverrideURLOverride the MyPage URL, for example http://corporateportal/personal_home.aspx

ServerHTMLCheckInterval The interval, in seconds, between checks for changes to server-sideHTML files - -1=never re-check file for changes (default), 0=check everytime file is needed, 1 to 86400=number of seconds before a recheck is made.

MyPageHTMLCheckInterval

The interval, in seconds, between checks for changes to MyPage HTMLfile - -1=never re-check file for changes (default), 0=check every time file isneeded, 1 to 86400=number of seconds before a recheck is made.Note: Default is 60 seconds.

[tibbr]

Parameter Function

Chapter 4 Configuration72


WorkspaceHeightSpecify the maximum height of the tibbr Wall gadget in users' MyWorkspaces - default=600 pixels.

MySearchesDiscussionHeight

Specify the height of the tibbr Subject Messages gadget displayed inusers' My Searches - default=450 pixels.

HeaderPointsToCustomTab

Specify a custom Home page tab to open when users click the tibbrsection header in their My Workspace. For example, you could have acustom tab for the tibbr site that you want to link the section header to.For more information creating custom tabs, see Tabs below.

Note: If a custom tab is not specified then the tibbr site will open in a newwindow.

[HideMenuAndBarWhen]


ParentInDifferentDomain

Specify whether to display or hide themenu and quickstart bar if the parentwindow is in a different domain.

01

Display the menuHide the menu

ParentN

If hosted in iframe and the parentwindow URL includes ParentN string,the application will remove the menuand bar.

[HTTP]


ChunklfSupportedEnable or disable chunked HTTPresponses for supported browsers.

01

DisableEnable

[DataFolder]


Path

This is the path of the ProcessRepository that the Web Serveraccesses.

Note: The default location is<Installation directory>\Nimbus Control\Process Repository. You will only needto change this parameter if multipleProcess Repositories exist.

LockMode

Specify the lock mode that the WebServer utilizes when the ProcessRepository is backed up. If set to 0 thestandard lock service installed with theAction Server will be used. If set to 1,

0

1

Lock Service

Volume Shadow CopyService



the Volume Shadow Copy Service willbe used in conjunction with the BackupUtility.

Note: The Backup Utility can only beused in Windows Server 2003 andWindows Server 2008.

See Backup for more information.

[Cache]


Enabled

Enable or disable the image cache(recommended to be enabled).Enabling image caching provides userswith quicker access to diagrams in theWeb Server.

01

DisableEnable

Path

This is the location of the image cache,as setup during the Web Serverinstallation.

[Menu]

See below for more details on the following parameters.


OpenOnClickDefine how menus are accessed withthe mouse.

01

Roll-overClick to access

SmoothDisplay Define how menus open.01

InstantScroll

LogOn2RowsAllow large logos to be displayed on themenu bar (optimum max height 48px).

01

DisableEnable

[Welcome]


EnabledDisplay a Welcome page when userslog in.

01

DisableEnable

EnabledForViewers Enable the Welcome page for Viewers.01

DisableEnable

AuthorsFileName

Specify the Welcome page for Authors.The page must exist in the ...\WebServer\config folder.



UsersFileName Specify the Welcome page for Users.The page must exist in the ...\WebServer\config folder.

ViewersFileName Specify the Welcome page for Viewers.The page must exist in the ...\WebServer\config folder.

Configuring\Web Server Configuration\Configuring the Welcome Page

[Tabs]


Order

Define the order of the Home page tabs. Custom tabs will be added to theend, unless the order is specified. For example, Order=favorites,workspace,custom1,custom3,topics,rolesPlease note that favorites relates to My Workspace and My Searchestopics.

The following parameters are used to define custom tabs

Enabledn Enable a custom tab.01

DisableEnable

TextLocalisedn Enables custom tab text localization.01

DisableEnable

Textn Defines the title of the custom tab.

Imagen Defines the tab image. HTML-basedimages (http(s)://<image>) can bespecified, otherwise the images must berelative to the images folder(<Installation directory>\Nimbus Control\Web Server\images).

URLn Define the URL to link to when usersaccess the tab.

ShowAsHyperlinkn Define how to display the contents ofthe custom tab.

0

1

Display within the samewindowDisplay in a new browserwindow

See the Classic Web Server Branding document that is included in the Documents folderon the installation CD

[MyPage]

Parameter Function Value Function

ImageFileName

Display an image in the top-left ofusers' Home pages (below the menu).The image must be in the image folder,<Installation directory>\Nimbus Control



\Web Server\Main\images

TextFileName

Specify the name of the .html text filethat will be displayed on the left-handside in users' Home pages (below theimage specified in the ImageFileNameparameter above). The file must be inthe Config folder (...Web Server\Config).If no file is specified then nothing will bedisplayed.

ShowworkflowInNewWindow

Specify how workflows URLs arelaunched.

0

1

Display within the samewindowDisplay in a new browser

ShowTabIcons Show or hide the Home page tab icons. 01

Hide tab iconsDisplay tab icons


[E-learning]


EnabledEnable or disable further help from theHelp menu.

01

DisableEnable

UrlSpecify the URL to launch when furtherHelp is enabled.


[Diagram]


DefaultScale Specify the default display size ofdiagrams:

0123456

Reset Zoom Mode680x480800x6001024x7681152x8641280x10241600x1200

DefaultZoomToFit Enable or disable the option to allowusers to Zoom to Fit.

01

DisableEnable

ShowDraftBanner Display or hide the draft banner on draftdiagrams.

Note: The Show draft banner when indraft copy option must be enabled forspecific maps in the Client.

01

DisableEnable



DefaultFormat The format for the generation ofdiagrams and internal imageattachments.

Note: GIF images are restricted to 256colors.

pnggif

Margin Enable or disable diagram margins. 01

DisableEnable

LeftMargin Specify the left margin of diagrams (inpx).

TopMargin Specify the top margin of diagrams (inpx).

RightMargin Specify the right margin of diagrams (inpx).

BottomMargin Specify the bottom margin of diagrams(in px).

MaxWidth Specify the maximum width of diagramsin Reset Zoom mode (in px).

MaxHeight Specify the maximum height ofdiagrams in Reset Zoom mode (in px).

IntImageMargin Specify the margins of internal imagesin diagrams.

IntImageLeftMargin Specify the left margin of internalimages (in px).

IntImageTopMargin Specify the top margin internal images(in px).

IntImageRightMargin Specify the right margin internal images(in px).

IntImageBottomMargin Specify the bottom margin internalimages (in px).

IntImageMaxWidth Specify the maximum width of internalimages (px) in Reset Zoom mode.

IntImageMaxHeight Specify the maximum height of internalimages (px) in Reset Zoom mode.

[PrivateNotes]

Parameter Function

BackgroundColor Specify the background color of private notes. Default=white.

TextColor Specify the text color of private notes. Default=black.



TitlebarColor Specify the title bar color of private notes. Default=red.

Width Specify the width of private notes (in px). Default=200.

Height Specify the height of private notes (in px). Default=160.

[PublicNotes]

Parameter Function

BackgroundColor Specify the background color of public notes. Default=white.

TextColor Specify the text color of public notes. Default=black.

TitlebarColor Specify the title bar color of public notes. Default=blue.

Width Specify the width of public notes (in px). Default=200.

Height Specify the height of public notes (in px). Default=160.

[Features]


Documents Enable or disable document support.01

DisableEnable

Memos Enable or disable Memos.01

DisableEnable

ChangeReq Enable or disable Change Requests.01

DisableEnable

Logs Enable or disable Logs. 01

DisableEnable

AbbrRef Enable or disable Abbreviations andReferences.

01

DisableEnable

DataTableEdit Enable or disable Data Table Editing. 01

DisableEnable

MySearches Enable or disable My Searches(formerly My Topics).

01

DisableEnable

MyRoles Enable or disable My Roles.

Note: A user group permission (WebMy Roles), specified in the Client, isused to display or hide My Roles forspecific user groups. If the MyRolesoption is disabled, the user grouppermission will override this option andprovide access to user groups whohave been defined access to My Roles.

01

DisableEnable

MySearchesMoreOptions Enable or disable My Searches MoreOptions searching (formerly My Topics),

01

DisableEnable



allowing users to search againstadditional user group categories.

SplitCollabAndLogsView Show or hide the diagram when usersview associated memos, actions,change requests, reviews and logs.

01

Hide diagramDisplay diagram

StoryboardStepsList Display storyboard steps in the samewindow or a separate window (with thediagram IDs visible).

01

Show in same windowShow in separate window

QuickLinks Display or hide the Quick Links (Home,Maps, Docs, To-Dos - under the menu).

01

HideDisplay

ShowGraphLinks Link metric/measure graph icons withthe BI Server graph.

01

Link to diagramsLink to graphs

ForgotPasswordLink Allow users to reset their ownpasswords on the Login page.

Note: This feature does not work if useraccounts are managed via LDAP.

01

DisableEnable

ActColOnStmtLinkPageDisplay the Activity column in theStatement Details page.

01

DisableEnable

[Search]

Parameter Function

PageSizeSpecify the maximum number of items that are displayed on each page inthe Search page.

[Storage]

Parameter Function

TempPathThe location of the Web Server temporary folder (created in theinstallation process).

[Storyboard]


AvailableModes Specify whether to default the display ofstoryboards as Diagram or Text. Note:

Users can switch between modes whenviewing a storyboard.

Diagram displays the storyboardas a diagram.Text displays the storyboard astext.

[Excel]

Parameter Function

PollingMinutes Specify how often metric values are checked and refreshed (default is set



to check metric values every 10 mins - min. is 1 min, max. is 600 mins)

HostSpecify the name, or IP address, of the machine running the OfficeIntegration Service. By default this is localhost.

PortThe port number of the machine running the Office Integration Service.By default this is 51001.

[Authentication]


UseIntegratedEnable or disable integratedauthentication.

01

DisableEnable

RequiredDomain


CaseSensitive

Specify case sensitivity when matchingthe domain name (user name matchingis always case insensitive).

01

Case insensitiveCase sensitive

IntegAuthType Specify the type of authentication used. 0

1

2

Windows IntegratedAuthentication

Netegrity SiteMinder

SSO2 Ticket Authentication

IntegAutoLogonOnly Enable or disable automatic logon only,i.e. users cannot log out and access theLog On page.

01

DisableEnable

IntegFailureURL Specify a URL to display when anunknown user account attempts to login. If unspecified a built-in page isdisplayed.

[IsapiAuthentication]


AlwaysUseIISAuthInfo

Specify whether to use IIS'authentication variables even when theIIS version does not support Unicodeauthentication details.

01

DisableEnable

[SiteMinderAuthentication]


HeaderFieldNameSpecify the header field to obtain theauthenticated user name from.



Assumed to be HTTP_SMUSER if notspecified.

PrimaryEncoding

Specify the primary encoding part of theSiteMinder HTTPHeaderEncodingSpecsetting.

01

No encodingUTF-8 encoding

SecondaryEncoding Specify the secondary encoding part ofthe SiteMinderHTTPHeaderrEncodingSpec.

01

No encodingRFC-2047 encoding

Installation\Configuring Authentication\Configuring Netegrity SiteMinder

[SSO2TicketAuthentication]


CallMethod

Specify the call method to verify theSSO2 ticket.

Note: If using the Web service, theWebServiceURL parameter must alsobe specified below. If usingSSO2TicketCom, the SSO2TicketComCOM library must be correctly installed.

0

1

User the Web service toverify ticketUse SSO2TicketCom COMlibrary to verify the ticket

WebServiceUrl

Specify the URL for theCenterForSSO2Ticket Web service.

For example, http://{server name}/CenterForSSO2Ticket.asmx.

CookieName Specify the name of the cookie to useas the SSO2 ticket for authentication. Ifunspecified the cookie name will beMYSAPSSO2.

[WebLogging]


Enabled Enable or disable Web Server logging.01

DisableEnable

IsUnicodeEnable or disable Unicode Weblogging.

01

DisableEnable

OutputInterval

Specify the time (in milliseconds) thatinformation is cached before beingwritten to disk.

QueueSize Specify the maximum size of the queue.

WaitForLock Specify the time (in milliseconds) to wait



for a file lock to write to disk.

Configuration\Web Server Configuration\Configuring Page Hit Logging

[PathMapping]

Parameter Function

SourcePathn Specify the mapped drive path to be substituted by the Web Server.

DestPathn Specify the UNC path to use instead of the mapped drive path.

[Localisations]

Parameter Function

Locale Definition

Specify the localization files available to the Web Server (see the Classic

Web Server Branding document, included on the CD, for more informationon localizing the Web Server).

[Localisations-Help]

Parameter Function

Locale Specify any help file localizations available to the Web Server.

[Documents]


LocalisedDDownTitles Specify whether to use either thedocument drop-down titles as specifiedin the client, or the localized titles in aspecific localization file (see the Classic Web Server Branding document, included on the CD, formore information on localizing the WebServer).

0

1

Use client drop-downtitlesUse localized drop-downtitles

ShowFullPath Display or hide the file path ofdocuments when users view the detailsof documents in the DocumentRegistry.

0

1

Hide the file path ofdocumentsDisplay the file path ofdocuments

[DocumentList]

Specify how document searches are displayed. You can add, remove and reorder the columnsdisplayed and define how searches are sorted. The following document fields exist, with specificfield IDs:



Field ID Field1 Creator2 Creation Date3 Author4 Comment5 Document Number6 Language7 Owner8 Preparation Date9 Withdrawn10 User Reference11 Master Title12 Master Version13 Issue Date14 Review Date15 Draft Title16 Draft Version17 Draft Status18 Release Due19 Document Number Full20 Dropdown Code 121 Dropdown Code 222 Dropdown Code 323 Dropdown Code 424 Dropdown Code 525 Dropdown Code 626 Dropdown Code 727 Dropdown Name 128 Dropdown Name 229 Dropdown Name 330 Dropdown Name 431 Dropdown Name 532 Dropdown Name 633 Dropdown Name 7

Displaying FieldsTo display a particular field, use the following format:

FieldxxxTag=www

FieldxxxWidth=yyy

FieldxxxAlign=zzz

where

xxx is the position of the column of the fieldwww is the field ID (from the list above)yyy is the width in HTML style (e.g. 20% or 20)zzz is the alignment (0=Left, 1=Center, 2=Right).

For example, if you want to add a column to display the draft title of documents, you wouldinclude the following lines:

Field9Tag=15Field9Width=10%Field9Align=0

Sorting FieldsTo display a particular field, use the following format:



SortxxxTag=www

SortxxxAscend=yyy

where

xxx is the sorting order of the fieldwww is the field ID (from the list above)yyy is the sort direction, 0=descending, 1=ascending (default if not specified)

For example, if you want to display the master titles of documents, sorted in an ascendingdirection when users conduct a search, you would include the following lines:

Sort1Tag=11Sort1Ascend=1

Formatting Drop-down FieldsTo specify the number of characters to display for the drop-down labels and items, use thefollowing format:

FilterxxxLabChrs=www

FilterxxxItemChrs=www

where

xxx is the drop-down filter numberwww is the maximum number of characters to display

The example below will display up to 15 characters for the label of drop-down filter 1 and 20characters for the items associated with drop-down 1.

Filter1LabChrs=15Filter1ItemsChrs=20

[TalkFreely]

The Web Server supports integration with TalkFreely. Any web links that are made to TalkFreelywill have the the user ID, user name and document title parameters automatically appended to thelink.

For example:https://www.talkfreely.com/h/new.php

becomes

https://www.talkfreely.com/h/new.php&q000603=<userid>&q000604=<user name>.&q000601=<document title>&q000607=<author>&q000606=<owner>

Parameter Function

ControlServerThe URL of the server hosting the Web Server, e.g. https://www.<servername>.com

TalkFreelyUrl The TalkFreely URL, e.g. https://talkfreely.com/new.php.



[ActionList]

Specify how actions are displayed following a search. You can add, remove and reorder thecolumns displayed and define how searches are sorted. The following action fields exist:

Field ID Field

1 Action Group ID2 Subject Text3 Category Name4 Status Name5 Priority Name6 Owner Name7 Start Date8 Due Date9 Assignees10 Created11 Finish Date12 Throughput Time13 Has Attachments (image)14 Attachments (yes/no)15 Host Type Name16 Host Title17 DT018 DT119 DTn

Displaying FieldsTo display a particular field, use the following format:

FieldxxxTag=www

FieldxxxWidth=yyy

FieldxxxAlign=zzz

where

xxx is the position of the column of the fieldwww is the field ID (from the list above)yyy is the width in HTML style (e.g. 20% or 20)zzz is the alignment (0=Left, 1=Center, 2=Right).

For example, if you want to add a column to display the due date, you would include thefollowing lines:

Field8Tag=15Field8Width=10%Field8Align=0

Sorting FieldsTo display a particular field, use the following format:

SortxxxTag=www

SortxxxAscend=yyy

where

xxx is the sorting order of the field



www is the field ID (from the list above)yyy is the sort direction, 0=descending, 1=ascending (default if not specified)

For example, if you want to display the action group IDs, sorted in an ascending directionwhen users conduct a search, you would include the following lines:

Sort1Tag=1Sort1Ascend=1

Data Table FieldsYou can specify whether to display or hide data table fields:

HideAdditionalData=0 will display data table fields

HideAdditionalData=1 will hide data table fields

Further Information

The following provides more information on some of the Web Server configuration parameters, asdescribed above.

Default Starting PageThis option allows a relative or absolute URL to be defined that will automatically take users to a aspecific page after they have logged in to the Web Server. For example, you could automaticallynavigate users to the Documents page, the Scorecards page or the Storyboards page.

Note: This option is not applicable if a map is specified for the DefaultMAP option, or if Single-sign On is enabled.

Relative paths will have the Web Server's base URL and CtrlWebISAPI.dll appended to thestart of the text before launching the user into the URL, so for example if you specifyWebReports it will have http://<server>/<virtual directory>/CtrlWebISAPI.dll/ appended to thebeginning.

Important - URLs need to be correctly encoded, i.e. all parts need correct HTTP escaping andnon-ascii characters in the query parameters need UTF-8 encoding (which is then HTTPescaped with the whole query parameter).

Exampleshttp://<Server>/<Virtual directory>/CtrlWebISAPI.dll/?__id=WebStoryboards

http://<Server>/<Virtual directory>/CtrlWebISAPI.dll/?__id=WebScorecards

http://<Server>/<Virtual directory>/CtrlWebISAPI.dll/?__id=WebDocs

http://<Server>/<Virtual directory>/CtrlWebISAPI.dll/?__id=WebReports

Documents PageThere are a number of optional parameters that can be specified when setting the default pageURL to the Documents page. In the [Web Server] section modify the DefaultPageURLparameter.

Note: Query parameters must be prefixed with &.

FiltDocNum={numeric value} allows you to filter by a specific document numberFiltTitle={text value} allows you to filter by document title



FiltMultiDown1={numeric value - unique item ID} allows an item from the first category drop-down to be filteredFiltMultiDown2={numeric value - unique item ID} allows an item from the second categorydrop-down to be filtered....FiltMultiDown7={numeric value - unique item ID} allows an item from the seventh categorydrop-down to be filtered

Note: Multiple values can be specified for each drop-down item. The unique ID can be foundin the Drop Down List dialog for a given drop-down list - if the ID field is not visible, from the View menu choose Column Customizing and drag the ID field on to the existing group offield headers. See Defining category drop downs under Document Registry Administration inthe Nimbus Control Client Help for more information.

PageSize={numeric value} allows you to set the number of items to display on the pageFiltAuthStatus={numeric value} allows the authorization status to be filtered

0=All Authorized1=Own UnAuthorized2=All UnAuthorized3=Authorized & Own4=All Files (default if not specified)5=All Pending & Authorized

Note: A blank value may cause an error.

FiltWithdrawn={true or false} includes or excludes withdrawn documents in the filteredsearch

Note: False is the default if not specified. A blank value may cause an error.

Examplehttp://<Server>/<Virtual_directory>/CtrlWebIsapi.dll/?__id=WebDocs.ActUpdateFilter&FiltDocNum=&FiltTitle=&PageSize=15&FiltMultiDDown3=23&FiltMultiDDown3=21&FiltMultiDDown2=19&FiltMultiDDown2=64&FiltAuthStatus=4

The example URL above will search on documents with ID 23 or 21 in the third drop-downlist and items with 19 or 64 in the second drop-down list.

Home page URLYou can override the Home page URL so that when users access their Home page it will take themto a different URL. For example, http://corporateportal/personal_home.aspx.

In the [Web Server] section modify the MyPageOverrideURL parameter.



4.1.2 Configuring the Welcome page

When users first access the Web Server, it is possible to initially direct them to a Welcome page. Adifferent page can be specified for authors/administrators, users and viewers. When creating aWelcome page, it must be a .htm file and have HTML code that fits directly within the <Body> tags,i.e. it should not have any <Head> or <Body> tags and the file(s) should exist in the same directoryas the Web Server configuration file.

To change the Welcome page for a particular user group

1. Open config.ini (...\Nimbus Control\Web Server\Config) in a text editor, such as Notepad. In the[Welcome] section modify the following parameters:

Enabled - This must be set to '1' to enable the Welcome page for change managers andprocess authors (set to '0' to disable it).EnabledForViewers - This must be set to '1' to enable the Welcome page for generalviewers (set to '0' to disable it).

Specify the .htm file to use as the Welcome page for certain user types:AuthorsFileName=<Name of htm file> - Specify the .htm file to use for process authors.UsersFileName=<Name of htm file> - Specify the .htm file to use for end users.ViewersFileName=<Name of htm file> - Specify the .htm file to use for viewers.

4.1.3 Configuring MIME mappings

MIME (Multipurpose Internet Mail Extensions) can be configured. You can define the MIME handlingof file extensions and change the icon associated with a file extension when it is displayed in theWeb Server. You can also specify to download a particular file type when users access a file, oropen it using the application associated with that file extension.

To configure MIME mappings

1. Open mimemap.cfg (...Nimbus Control\Web Server\Config) in a text editor, such as Notepad,and make any edits to the file extensions as required.

Note: The fields are tab-delimited. The fifth (comma-delimited) column determines whether aparticular file type will open when users access it (this is the default value, 0, and is used if notspecified), or downloaded (if set to 1'). Icons are stored in <Installation directory>\Web Server\Main\images.

4.1.4 Integrating with External Help

Alternative Web-based help can be integrated within the Web Server. If enabled, an E-Learning linkwill appear in the Web Server Help menu, providing access to an external help system.

To integrate external help into the Web Server

1. Open config.ini (...Nimbus Control\Web Server\Config) in a text editor, such as Notepad. In the[E-Learning] section modify the following parameters:

Enabled=1 (enables external help, set it to '0' to disable it)

URL=<URL of external help>



4.1.5 Configuring Web Server Logging

Web Server logging can be enabled to debug any issues that may arise with the configuration of theWeb Server. There are two log files, one for the ISAPI extension, the other for the Web Serverapplication, and both use the Log4D component. If enabled, any errors and warnings will be loggedin the respective log file.

Note: ISAPI and Web Server logging is usually only necessary when requested by NimbusSupport in order to resolve any issues that you may have with a Web Server.

To enable ISAPI logging

1. Open isapilog.cfg (...\Nimbus Control\Web Server\Config) in a text editor, such as Notepad. Toenable ISAPI logging you must comment out the second line, i.e.:

#log4D.disable=INFO

The log file will be created in the Web Server Logs directory (default location is ...\NimbusControl\Web Server\Logs).

To enable Web Server logging

1. Open websvrlog.cfg (...\Nimbus Control\Web Server\Config) in a text editor, such as Notepad.To enable Web Server logging you must comment out the second line, i.e.:

#log4D.disable=INFO

The log file will be created in the Web Server Logs directory (default location is ...\NimbusControl\Web Server\Logs).

4.1.6 Configuring Page Hit Logging

Page hit logging will record a log of all pages accessed in the Web Server for each day. A new linewill be created for each entry and the log can be viewed by a text editor or in Excel, since the formatis tab delimited. Web logging is enabled in the Web Server configuration file.

To configure page hit logging

1. Open config.ini (...Nimbus Control\Web Server\Config) in a text editor, such as Notepad. In the[WebLogging] section modify the following parameters:

Enabled - Set this value to Enabled=1.

IsUnicode - Choose between Unicode=1 or Ansi=0.

OutputInterval - Specify how often a log is made, in milliseconds (default = 1000).

QueueSize - Specify the maximum number of log records to keep (default = 1000).

WaitForLock - Specify the duration that the Web Server should wait for exclusive access tothe log file, in milliseconds (default = 5000).

2. Save and close config.ini.

Log FilesGenerated log files - yyyymmdd.log - are stored in ...\Nimbus Control\Process Repository\System\Logs\Web. The structure of a log file includes Date, Time, User name, First name, Last name, WebServer machine name, Client IP address and page name. If the page is context-based the followinginformation is also included:



Diagram Folder structure, Map name, Map type, Diagram name and Diagramlevel.

Map Folder structure, Map name and Map type (the map types areempty, i.e. master, "Draft" or "Scenario": <Scenario name>".

Document Document number.

4.1.7 Configuring Web Hit Logging

The Web Log Utility provides a method for logging web page hits and either storing them in aspecified database or saving the data as a metric-related Excel or CVS data file. This task can berun as a Windows scheduled task.

Note: Page Hit Logging must be enabled; this is enabled by default. See Page Hit Logging formore information.

To save Web statistic as an Excel or CSV file

1. Run WebLogsUtility.exe (...Nimbus Control\Client\Utilities).2. Click the Web Statistics to Excel or CSV tab to select it.3. Click Browse to locate the Process Repository that you want to export web statistics from.4. In the Date Range panel, select a date range of the results that you want to export. For

example, you may want to export statistic for the last 3 weeks.

Custom Date Range allows you to specify a range of dates.

5. Select the page hit statistics that you want to export in the Common Export Options tab. Youcan also include a number of diagram page hit totals by clicking the By Diagram Options tab(diagram page hit totals will be included in a separate Excel sheet).

Total page hits for each day, week or month will display the total number of web serverpages accessed.Total page hits by map for each day, week or month will display the total number of webserver pages accessed for each map.Total page hits by user group for each day, week or month will display the total numberof pages accessed by each user group.Include Metrics Sheet (Excel only) will create a separate metrics data sheet for theselected web statistics.

There are also a number of options for exporting diagram, document and storyboard page hittotals. These can be accessed on the By Diagram, By Storyboard and By Document tabs(note that diagram, storyboard and document page hit totals will be included in separate Excelsheets).

Saving Settings

You can save the settings you have defined by clicking Save settings to WSE file. This fileis used when creating a Windows scheduled task and running the operation from thecommand line.

6. Click Export to file.

To export Web statistic to a database

The Web Log Utility allows you to export statistics to an existing database, such as MS SQL Server,



Microsoft Access and MySQL. If you do not have a database then this utility also allows a newODBC database to be created with associated table structures. See To create a ODBC database belowfor more information.

1. Run WebLogsUtility.exe (...Nimbus Control\Client\Utilities).2. Click Browse to locate the Process Repository that you want to export web statistics from.3. Click Build Connection String.

There are four tabs; click Help on the respective tab for further information.Provider

Select the relevant OLE DB provider.

Connection

Select the data source and enter a user name and password (if required).

Advanced

Select the data source and enter a user name and password (if required).

Blank password enables the specified provider to return a blank password in theconnection string.Allow saving password allows the password to be saved with the connection string. Ifsaved, the password is returned and saved unmasked and unencrypted.

All

Edit any initialization values for the data type.

4. Click OK.5. In the Table Name text box enter the name of the table that stores the web statistics.6. Click Get Fields to populate the field mapping drop-down lists.7. Choose the associated field mappings from the respective drop-down lists.

Steps 8-11 allow you to include user group information in the export, assuming appropriatetables exist in the database. If you do not want to include user group information then proceed toStep 12.

8. Select Include User Group details.9. In the User Group Names Table and User Group Members Table text boxes enter names for

the user group and user group tables, respectively.10.In the Group ID (on the left) and Group Name field mapping text boxes enter corresponding

field mapping names for the new user group table.11.In the Group ID (on the right) and User ID field mapping text boxes enter corresponding field

mapping names for the new user member table.

Saving Settings

You can save the settings you have defined by clicking Save settings to WLD file. This fileis used when creating a Windows scheduled task and running the operation from thecommand line.

12.Click OK.

To create a ODBC database

When exporting web statistics to a database, a ODBC database is required. If you do not have adatabase then you can create a new ODBC database with associated table structures with the WebLog Utility.



1. Run WebLogsUtility.exe (...Nimbus Control\Client\Utilities).2. Click Browse to locate the Process Repository that you want to export web statistics from.3. Click Build Connection String.

Click Help on the relevant tab. See Building Connection Strings above for moreinformation.

4. Click OK.5. In the Table Name text box enter the name of the table to store the web statistics.6. Choose the associated field mappings from the respective drop-down lists.

Steps 7-11 allow you to create two new tables to store user group information in. If you do notwant to include user group information then proceed to Step 12.

7. Select Include User Group details.8. In the User Group Names Table and User Group Members Table text boxes enter names for

the user group and user group tables, respectively.9. In the Group ID (on the left) and Group Name field mapping text boxes enter corresponding

field mapping names for the new user group table.10.In the Group ID (on the right) and User ID field mapping text boxes enter corresponding field

mapping names for the new user member table.11.Click Create New Table(s).12.Click OK.

To run the Web Log Utility from the command line

The Web Log Utility can be run from the command line, or as a Scheduled Windows Task, in orderto export web statistics to either a database or to file (Excel or CSV). A settings file must bereferenced, which is created using the Web Log Utility. WLD settings files define exporting to adatabase and WSE settings files define exporting to an Excel or CSV file. For more information oncreating settings files see the relevant section above.

When exporting web statistics to a database, a ODBC database is required. If you do not have adatabase then you can create a new ODBC database with associated table structures using theWeb Log Utility.

1. Use the following command lines:

Excel or CSV output<Location of Web Log Utility>.exe\ "<Location of Settings File>.wse"

Database output<Location of Web Log Utility>.exe\ "<Location of Settings File>.wld"

For example

"C:\Nimbus Control\Client\Utilities\WebLogsUtility.exe "<Installation directory>\Control\Client\WebLog WSE.wse"

Logging

When the Web Log Utility is run from the command line, a log file is created in a folder in thesame directory as the utility called Logs. Separate log files are created for each month.



4.2 Action Server Configuration

4.2.1 Configuring the Action Server

There are a number of configuration parameters that control the behaviour of the Action Server. Forinformation on Action Server errors that appear in the log files see Troubleshooting the ActionServer.

To configure the Action Server

1. Open config.ini (...\Nimbus Control\Action Server) in a text editor, such as Notepad. Modify thefollowing parameters:

[System]

Parameter Function

LoggingLevel The level of logging that is written to the Email log files

TempPath The location of the Temp folder (set during installation)

2. Save and exit Config.ini.

The following topics provide more information on the remaining Action Server configurationoptions:

Lock Service

Configure the start and stop times of the Process Repository lock to allow for the manualbacking up of data. See Manually backing up a Process Repository for more information.

LDAP

Configure Single-sign On via LDAP synchronization. See Configuring LDAP synchronization formore information.

SMTP

Configure notification Email settings. See Configuring SMTP Email for more information.

Office Integration Server

Configure the integration between Nimbus Control and Excel for metric-based data and Excel-based scorecards. See the Nimbus Control Office Integration Server PDF in the Documentsfolder on the CD for more information.

Related topics

Managing Nimbus Control Services

Action Server Configuration 93


4.2.2 Configuring SMTP Email

The Action Server's Email service can manage system Emails. HTML Emails are generated andsent to a designated SMTP server at times specified in the polling period. By default, access to theSMTP server is unauthenticated; you can allow authenticated access if required. For information onAction Server errors that appear in the log files see Troubleshooting the Action Server.

To set authenticated SMTP access

1. In the Client, from the Administration menu choose Application Credentials, then ActionServer Email Service.

2. Browse to the location of the Action Server and click OK.3. Select Authenticated.4. From the Encryption Type drop-down list choose the type of encryption required.

Standard allows decryption on any PC (recommended)Current PC allows decryption only on the PC that originally performed the encryptionCurrent PC and current user allows decryption only by the PC that originally performed theencryption and when the same user is logged in.

5. Enter the User name and password of the user account that has access to the Email server.6. Click OK.

To set Email options

1. Open config.ini (...\Nimbus Control\Action Server) in a text editor, such as Notepad. Modify anyof the following parameters, as required:

[Email]

Parameter Description

PollingPeriod The frequency that the Email queue is checked, in seconds

SystemType The Email system that is supported (currently only SMTP is supported)

PathThe path of the Process Repository. This is the location that the Emailqueue resides

NDRRecipient The Email address that non-delivery reports are sent to

SystemSender The Email address that sent Emails will appear from

SystemSubject The text that appears in the subject field of system-generated Emails

VerifyNames

The Nimbus Control Email Service willattempt to verify Email addressesagainst the mail server before sendingmessages (note: this option may bedisabled on some servers, in which caseyou may need to disable this option)

01

DisableEnable

MaxRetries The number of delivery attempts before an Email is deleted

Note: Once an Email fails to be sent after x number of times it is deletedand an entry is added to the log. A delivery failure attempt requiressuccessful connection to a SMTP service, meaning that the retry counts



are incremented when there is a network outage. If the value is set to '0' itwill retry indefinitely.

CombineEmails Send all emails to recipients in a singleEmail. If disabled, emails are sentseparately, with the notification titlesused as the subject of the emails.

01

DisableEnable

[SMTP]


HostThe name or IP address of the SMTPserver

PortThe listening port of the SMTP server(usually 25)

Verify Enable or disable the Verify command01

DisableEnable

UserName The user name required to authenticatewith the SMTP server using the AUTHLOGIN functionality

Password This is set by the Client and is a base 54encoded encrypted password.

EncryptionType Specify the level of password encryption 0

1

2

Password can bedecrypted by any PC

Password can only bedecrypted by the PC thatperformed the originalencryption

Password can only bedecrypted by the PC thatperformed the originalencryption and by the sameuser

Anonymous Anonymous access to the server can beenabled

01

Not anonymousAnonymous

Related topics

Troubleshooting the Action Server

4.2.3 Configuring SMTP Logging

The Email Service creates a log every time it is run. It is possible to set the logging level to providemore or less detail. For information on Action Server errors that appear in the log files see Troubleshooting the Action Server.

To enable SMTP logging



1. Open config.ini (...\Nimbus Control\Action Server) in a text editor, such as Notepad. 2. Set the LevelLogging parameter to one of the following:

0 None Startup, Shutdown

1 Low Startup, Shutdown. An entry for every polling period (no entries if anaction did not occur at a polling period) Note: Recommended settingwhen in production.

2 Medium Startup, Shutdown. An entry for every polling period

3 High Startup, Shutdown. An entry for every polling period. An entry for everyemail that is sent, including the email address, message contents and therelated item.

Note: Generated log files - yyyymmddx.log - are stored in ...\Nimbus Control\ActionServer\Logs\Email

4.2.4 Configuring LDAP Synchronization

For information on configuring LDAP synchronization, refer to the Enabling and Configuring LDAPsynchronization topic in the Installation section.

4.2.5 Testing LDAP Synchronization

Following the configuration of LDAP integration, it is recommended to test the synchronizationbetween the Directory Service list of users and the Nimbus Control list. The LDAP ConfigurationTool provides the ability to test an LDAP synchronization, as well as allowing you to create a newLDAP configuration file. When LDAP synchronization is tested, the results of the synchronization willbe displayed but no data will be written.

Note: Increasing the logging level in the LDAP configuration file will provide more details results

To test LDAP synchronization

1. Run LDAPUtility.exe (found in the Utilities folder on the installation CD).2. Click Load Config and select the LDAPConfig.ini.

Note: The default location of LDAPConfig.ini is ...\Nimbus Control\Process Repository\LDAP

3. Change any parameters in the configuration file, as required.4. Click Test Sync.

If the test fails you will receive the following message:<Data><Time>Connect to LDAP server <Server>:<Port> failed. Check the connectionsettings in the LDAPConfig.ini file

To test LDAP authentication

1. Click in the User Name and Password text boxes and enter a user name and password that hascurrent access to the directory service.

2. Click Authenticate.

To define a new LDAP configuration file

1. Click New Config.



2. Browse to a location to save the configuration file to, then click OK. to load the configurationparameters.

3. Click at the end of the parameters that you want to define and define the values.4. Click Save Config.

Scheduling

Testing a LDAP synchronization can be run from the command line, or as a Windows ScheduledTask. Run the following command:

<Path of LDAP Utility> <Path to Process Repository>For example:

"C:\Nimbus Control\Client\Utilities\LDAPUtility.exe" "C:\Nimbus Control\ProcessRepository"

4.2.6 Configuring LDAP Synchronization Logging

On start-up the LDAP Service creates a log file, which will report on any issues with thesynchronization. For information on Action Server errors that appear in the log files see Troubleshooting the Action Server.

To enable LDAP Synchronization logging

1. Open LDAPConfig.ini (...\Nimbus Control\Process Repository\LDAP) in a text editor, such asNotepad.

2. In the [MainSection] enter the desired logging level for the LoggingLevel parameter.

0 None Startup, Shutdown

1 Low Startup, Shutdown, Synchronization times

2 Medium Startup, Shutdown, Synchronization times, Added users, Removed users

3 High Startup, Shutdown, Synchronization times, All users added to each group,All users removed from each group, Duplicate users, Updates to userpreferences

4 Full Startup, Shutdown, All users added to each group, All users removedfrom each group, Properties retrieved for each user, Duplicate users,Updates to user preferences

Note: It is recommended to set the logging to low when in production. The log file - LDAP.log -is stored in ...\Nimbus Control\Action Server\Logs\LDAP.



4.3 Business Intelligence Server Configuration

4.3.1 Configuring the Business Intelligence Server

There are a number of configuration options that can be defined for the Business IntelligenceServer.

To configure the Business Intelligence Server

1. Open BiSvc.ini (...\Nimbus Control\BI Server) in a text editor, such as Notepad. Modify any ofthe parameters, as required.

[Data Folder ]

Parameter Function

Path The path of the Process Repository (this can be a UNC path name)

[Options ]

Parameter Function

RecordLimit The maximum number of records that will be stored for each measure

RetryPeriod The number of minutes between each retry after a failure to send anSMS message

RetryAttempts The number of retry attempts before aborting notification

[Text ]

Parameter Function

Up The text that is sent via Email and SMS when a value breaches athreshold value and is ascending. The text can include three substitutionparameters:

· Title (title of the measure)· Value (current value of the measure that breached the threshold)· Notes (any additional notes)

To insert these values include the '<' and '>' characters. For example, Up= Measure <TITLE> has increased to <VALUE>. <NOTES>.

Down The text that is sent via Email and SMS when a value breaches athreshold and is descending. For example, Down = Measure <TITLE>has decreased to <VALUE>. <NOTES>.

Url The diagram URL. For example, Url = Go to the diagram <URL>.

[Excel ]



Parameter Function

Host The machine that the Office Integration server is located on (machinename or IP address)

Port The listening port number of the Office Integration Server

PollingMinutes How often the metric value is checked (default is set to check metricvalues every 60 mins - min. is 10 mins, max. is 10080 mins)

[Email]

Parameter Function

Subject The text that appears in the subject setting of an Email

From The person that you want sent Emails to appear from. For example,Control Administrator.

[SMS ]

Where Short Message Service (SMS) is required, a SMS service provider is required to send thetext messages. More than one service providers can be specified but only one may be active atany one time. Contact Nimbus Support if you need to specify multiple SMS service providers.

Comment out the service provider parameters (the name of the service provider and then ClsID.

Parameter Function

Name The name of the service provider (by default Clickatell is specified)

ClsID This value should not be changed

IniFileName The location of the service provider specification data (it can be this file)

By default, Nimbus provides a service provider module for Clickatell. The parameter set forClickatell is as follows:

Note: A Clickatell account is required, which can be obtained from Clickatell.

[Clickatell]

Parameter Function

API_ID The Clickatell ID (provided by Clickatell)

User The Clickatell username

Password The Clickatell password

UseGet Set this value to '0'

UseSSL Default is on, '1'. Set this to '0' to turn SSL off.

4.3.2 Testing the Business Intelligence Server

The Business Intelligence Server can be tested to ensure it is running correctly.

http://www.clickatell.com

Business Intelligence Server Configuration 99


To test the Business Intelligence Server

1. Create a new map with an activity box containing an Excel metric link.2. Authorize and promote the map.

Note: Only authorized (master) maps are checked by the Business Intelligence Server.

3. Set the properties of the map so that it is included in the Web Search and when processingExcel metric link notifications (if necessary).

4. Run the SSync.exe (from the Nimbus Control program group on the Start menu).5. Log in to the Web Server and view the master version of the map you created in Step 1.6. Click on the metric link and view the graph.

Note: It may take a while for the results to be viewable, depending on what the polling periodis set to. This is 60 minutes by default but this value may have changed in the BiSvc.ini file.See Configuring the Business Intelligence Serverfor more information.

4.3.3 Synchronizing the Business Intelligence Server

Metric data is managed by the Business Intelligence Server, which requires a definition file. Thisdefinition file is created by running the System Synchronization Utility that is installed with the WebServer. Updating metric data in Nimbus Control can be scheduled as a Windows Scheduled Task.

Note: The System Synchronization Utility is also used to synchronize the Web Server, forexample to update flow line links, recurring reviews, the Search database, etc. See Synchronizing the Web Server for more information.

To schedule the synchronization of the Business Intelligence Server

Synchronizing the Business Intelligence Server can be run from the command line, or it can beautomatically scheduled using Windows Task Scheduler. The System Synchronization Utility can befound in ...\Nimbus Control\Web Server\Utilities.

Run the following command:

<path>/ssync.exe <path of ini file> [<path of log file>] -measure

For example:C:\Control\Web Server\Utilities\ssync.exe C:\Nimbus Control\Web Server\Utilities\SSyncResults.log] -measure

Note: If no path is defined then the utility will search for the configuration file in the localfolder. If no path to the log file is defined then it will use the local folder. It is advised thata Windows Scheduled Task is created, using the command above.

4.3.4 Configuring Business Intelligence Server Logging

Logging of the Business Intelligence Server, via the Log4D component, is configured through theBiSvcLog.cfg file.

Note: Business Intelligence Server logging is usually only necessary when requested by NimbusSupport in order to resolve any issues that you may have with the Business Intelligence Server.

To enable Business Intelligence Server logging

1. Open BiSvcLog.cfg (...\Nimbus Control\BI Server) in a text editor, such as Notepad. To enable



logging you must comment out the second line, i.e.:

#log4D.disable=INFO

2. Save and exit BiSvcLog.cfg.

Note: Generated log files - bisvr.log, bisms.log and biEmail.log - are stored in ...\NimbusControl\BI Server\Logs

User Management

Chapter 5


Chapter 5 User Management102


5.1 Creating Users and User Groups

Users and user groups are created in the Client; from the Tools menu choose Users and then User Accounts. For help on creating and modifying users and user groups see User Administrationunder Administration in the Nimbus Control Client Help (accessed from the Help menu in theClient, or for context-sensitive help, click the Help button on the dialog that you want help for).

User and User Group Creation

Nimbus Control users must exist in a user group. Four core user groups exist - Administrators,Authors and End Users, each group having different permission and access rights set. You can alsocreate additional groups with their own set of permission rights; however, a user must exist in one ofthe core user groups:

· AdministratorsThese users create and maintain user accounts and have access to all features within theAuthor Client and Web Server.

· Process AuthorsThese users create, edit and manage process content. They have access to both theAuthor Client and Web Server.

· End UsersThese users can contribute to content development, including reviews, authorizations,change requests, memos, content sign-offs, etc. These users cannot create or edit content.Further access rights are governed by which modules specific an end user has assigned tothem.

To create a user or user group, from the Tools menu in the Author Client choose Users and thenUser Accounts. To create a user, from the Member menu choose New User. To create a usergroup, from the Group menu choose New Group.

User Group Permissions

Nimbus Control comprises of a number of areas of features and functionality and each area can becontrolled for each user group. This is useful, for example, if you do not want one type of user groupto access an area of functionality until they have had training.

Note: User group permissions work in conjunction with users' settings, meaning that the usermust have a particular option enabled in their user settings and within the user group's settingsto be able to use that functionality.

By default, the <Everyone> group incorporates all Nimbus Control users and this allows globalaccess rights and permissions to be set. You can then assign access rights and permissions forspecific user groups, thereby allowing you to control user access by user group.

To change the permission of a group, from the Tools menu choose Users, then User Accounts.Right-click the group and choose Group Properties.

User Account System Options

There are a number of system configuration options that affect user accounts, such as theregistration of new user accounts, the incorrect password retry limit, automatic log on when accountnames match the network log on names, etc. These should be defined before creating useraccounts and in accordance with an organizations internal policies.

Creating Users and User Groups 103


The system options are accessed in the Client. From the Administration menu choose SystemOptions. Click the Users tab to view the system options relating to user accounts.

5.2 Importing Resources

Resources dictate who, or what, is responsible for completing a particular activity in a process. Central Library Resources can be imported, merged and updated from a file (note that localresources cannot be imported). There are two options for updating a Central Resource Library, thefirst will replace all central resources and delete any resources that are not in the data file. Thesecond method will update existing resources but it will not delete existing resources that are notspecified in the data file.

Resource File FormatThe format of the resource file is CSV and the following format is required:

Resource name,[Resource cost],[Field 1],[Field 2],[Group Name],[Display Name]For example

Printer,2,HP (Color),First Floor,Printers,HP Color Printer (First Floor)

Notes: 1. The only field that is mandatory is the Resource name field.2. A new line must exist for each resource.3. If the group does not already exist in Nimbus Control then the group name will be ignored.4. Resources can be imported, merged or updated in multiple groups. A new line must exist for

each group.

To import resources into the Central Resource library

1. Run ImportUtil.exe (found in the Utilities folder on the Installation CD).2. Click Browse to select the Process Repository that you want to import, merge and/or update

resources in.3. From the User Name drop-down list choose the administrator account to run the Import Utility,

enter the password and click Next.4. Select Resources, then click Next.5. Select one of the following rules:

· Update and merge resources from file will update all resources in the Central ResourceLibrary. Any Central Library resources not in the data file will remain in the library.

· Replace all existing resources from file will replace all resources in the Central ResourceLibrary. Any Central Library resources not in the data file will be deleted.

6. Click Browse to select the data file.7. Click Start to import the data.

5.3 Importing User Roles

Roles provide the ability to align people with what they do in a process and to make theirinvolvement visible. Users' roles in Nimbus Control can be imported from file.

Chapter 5 User Management104


Role File FormatThe format of the role file is CSV and the following format is required:

User name,Role

Notes: 1. A new line must exist for each role.2. If the role or user does not exist in the system then the role will be ignored.3. Multiple roles can be assigned to single users.

To import user roles

1. Run ImportUtil.exe (found in the Utilities folder on the Installation CD).2. Click Browse to select the Process Repository that you want to import, merge and/or update

user roles in.3. From the User Name drop-down list choose the administrator account to run the Import Utility,

enter the password and click Next.4. Select User Roles, then click Next.5. Click Browse to select the data file.6. Click Start to import the data.

Administration

Chapter 6


Chapter 6 Administration106


6.1 Exporting

6.1.1 Exporting Diagrams as HTML

A scope of diagrams can be exported as HTML from the command line and a number of optionscan be specified. This process can be automatically scripted and set up as a Windows scheduledtask.

Note: Exporting as HTML is available only if this option is included in your license.

To export diagrams as HTML

1. Run the following command, either from the command line or as a Windows Scheduled Task:<Path to Ctrl.exe> <Path to Process Repository> <Path to script (.csf) file>

For example:E:\Nimbus Control\Client\Ctrl.exe "E:\Nimbus Control\Process Repository""E:\Exported Maps\HTMLExport.csf"

Script (.csf) FilesA Nimbus Control script file defines the parameters to automate the export of diagrams in HTMLformat. To create a script file, create a new text file with a .csf extension. Include, as a minimum, thefollowing line:

HTML_EXPORT "<map path>" "<destination folder>" <max width> <max height>

The following optional parameters can be included:

Parameter Description/CopyAtts Copy attachments/Abbrvs Include abbreviations/Refs Include references/Changes Include change log/Keywords Include keywords/Memos Include memos/Scenarios Include scenarios/Draft Include drafts/ContPanel Include control panel/Text Includes searchable text/Convert Converts MS Word documents/NewWin Open attachment in new window/AtTop Place navigation buttons on the top/Storyboards Include storyboard links/Scope: <scope number> Scope of export (see below)/Diag <diagram GUID> GUID of starting diagram (see below)/Level: <level of diagram> Level of starting diagram (see below)

ScopeThe scope parameter can be:

0 = Current Process Map1 = Current Diagram and Lower Levels2 = Current Diagram

Note: If the option selected is 1 or 2, you must define the starting diagram by using the <Diag>

Exporting 107


or <Level> parameters.

For example:/Diag:3CA5EFDFF00840A5A39540394EC77BBF /Level:1.2.4

Example CommandAn example command (including optional parameters):

HTML_EXPORT "<<Installation directory>\Process Repository\Map1.MAP" "<Installationdirectory>\Exported Maps" 1024 768 /Scope:1 /Diag:3CA5EFDFF00840A5A39540394EC77BBF /Text /Draft /Memos /Changes

Logging

Any problems with the export will be logged in a log file. The log file uses the same name as thescript file and is created in the same location.

6.1.2 Exporting Diagrams as XML

A scope of diagrams can be exported as XML, achieved from the command line and a number ofoptions can be specified. This process can be automatically scripted and set up as a Windowsscheduled task.

To export diagrams automatically

1. Run the following command, either from the command line or as a Windows Scheduled Task:<Path to Ctrl.exe> <Path to Process Repository> <Path to script (.csf) file>

For example:C:\Nimbus Control\Client\Ctrl.exe "E:\Nimbus Control\Process Repository""C:\Exported Maps\XMLExport.csf"

Script (.csf) FilesA Nimbus Control script file defines the parameters to automate the export of diagrams in XMLformat. To create a script file, create a new text file with a .csf extension. Include, as a minimum,the following line:

XML_EXPORT "<map path>" "<destination folder>" <max width> <max height>

The following optional parameters can be included:

Parameter DescriptionStandard Standard XML export (see below)Simplified Simplified XML export (see below)LeafOnly Leaf diagrams only (see below)Audit Record export in diagram's history audit logScope: <scope number> Scope of export (see below)Diag <diagram GUID> GUID of starting diagram (see below)Level: <level of diagram> Level of starting diagram (see below)SeparateFiles Creates a single XML file per diagram

(Simplified export only)

Standard Standard XML export creates a single file and includes all diagrams (within the specified scope),drill downs, activities, resources, attachments (including data tables), costing information, activityinputs/outputs, commentary text, flow-line links, free text, change logs, authorizers, mandatoryusers, history and audit logs, acknowledgement logs, subscribers, memos and change requests.



SimplifiedSimplified XML export creates a single file and includes all diagrams (within the specified scope),diagram URLs, the parent folder structure, user access rights (default and specific), drill downs,activities, notes, activity inputs/outputs, commentary text, attachments (including data tables),statement links and statement data.

Leaf OnlyLeaf Only XML export creates a single file that includes all diagrams except diagrams that havedrill downs.

ScopeThe scope parameter can be:

0 = Current Process Map1 = Current Diagram and Lower Levels2 = Current Diagram

Note: If 1 or 2 is selected, you must define the starting diagram by specifying either the<Diag> or <Level> parameter.

For example:/Diag:3CA5EFDFF00840A5A39540394EC77BBF /Level:1.2.4

Example CommandAn example command (including optional parameters):

XML_EXPORT "C:\Nimbus Control\Process Repository\Map1.MAP" "C:\ExportedMaps" /Simplified /Scope:1 /Diag:3CA5EFDFF00840A5A39540394EC77BBF /Text /Draft /Memos /Changes

Logging

Any problems with the export will be logged in a log file. The log file uses the same name as thescript file and is created in the same location.

6.1.3 Exporting Data to a Database

The data that is held within a Process Repository can be exported to a nominated database, suchas SQL Server, using the Data Export Utility. The utility can be run as a scheduled task or it can berun manually. It is advised that the utility is run overnight, or when few users are logged into thesystem.

For further information and instructions on exporting data from a Process Repository to a nominateddatabase, please refer to the Exporting to a SQL Database PDF in the Documents folder on theInstallation CD.

Exporting 109


6.2 Metric Configuration

6.2.1 Updating Excel Macros

The Excel Macro Launcher utility allows you to run Excel macros. This can be run manually or as ascheduled Windows task.

To manually update Excel macros

1. Run ExcelMacroLauncher.exe (...\Nimbus Control\Client\Utilities).

2. Click Browse and select the Excel file that you want to launch.3. In the Macro text box enter the name of the macro that you want to launch.

Save will save the spreadsheet after running the macro.

4. Click Run.

Scheduling the Excel Macro Launcher

The Excel Macro Launcher can be scheduled to run, either from the command line or as a Windowsscheduled task.

Use the following command:<Path to ExcelMacroLauncher.exe> <File> <Save> <CLEARRO>

For example:"E:\Nimbus Control\Client\Utilities\ExcelMacroLauncher.exe" "E:\Excel1.xls" Macro1Save CLEARRO

Note: The Save parameter is optional; if included, the spreadsheet will be saved after themacro has been executed. The CLEARRO parameter will remove the read-only flag (if present)on the file before running the macro; the read-only flag is set if a user with read-only accessruns the scorecard in the Author Client.

Logging

A log file is created when the utility is run; these logs are written to a Logs folder from the location inwhich the utility was run from. Any errors will be recorded in the log file.

6.2.2 Creating SQL Queries

One method for retrieving data from an Excel spreadsheet is to go directly to a specific Excel file,sheet or cell in order to obtain the KPI value. However, an alternative option uses SQL queries toretrieve the data and this offers the following advantages:

· There are no performance overheads by continually communicating with Excel.

· If the KPI is moved to another cell then the link is maintained.

· If the Excel file is moved then you only need to update the SQL query as opposed to updatingevery metric link.

To retrieve Excel data using SQL queries you need to define some data ranges within thespreadsheet(s).



Defining Excel Data RangesSQL queries can reference data ranges in Excel spreadsheets. The advantage of ranged cells isthat even if they are moved, for example a new column is added to the spreadsheet, the rangeis maintained.

1. In the Excel spreadsheet select the cell, range of cells or non-adjacent selections that you wantto name.

Note: There must be a cell that will be used as the field name. In the example below the cellthat contains 'KPI' will be used as the field name.

2. Click in the Name box and enter a name for the data range. In the following example the datarange has been named KPIRange.

These ranges can then be referenced when creating SQL links in the AdminUtil.

To create a SQL query

1. Run AdminUtil.exe (found in ...\Nimbus Control\Client).2. Select the Process Repository that you are configuring.3. Choose an administrator account, enter the password and click Next.4. From the Configure menu choose SQL Query Manager.5. From the Connection menu choose New.6. Enter a title, and description if required, then click Build.7. From the list of OLE DB Providers click Microsoft OLE DB Provider for ODBC Drivers, then

click Next.8. On the Connection tab, from the Use data source name choose Excel Files, then enter the

path to the Excel file in the Enter the initial catalog to use field.9. On the All tab, modify any of the initialization properties, if required.10. On the Connection tab click Test Settings, then click OK upon successful test.11. On the Data Connection window click OK.12. From the Query menu choose New.13. Enter a title for the SQL query, and a description if required.14. From the Connection Configuration drop-down list choose the data connection that you have

just created, then click Next.15. In the SQL Statement tab enter the following SQL:

Select * from <Range Name>

Note: Substitute <Range Name> with the data range name in the Excel spreadsheet for thedata that you want to retrieve. See Defining Excel Data Ranges, above, for more information.

16. Click the Test Results tab to ensure that the SQL query works.17. Click Finish.

Metric Configuration 111


18. From the Query menu choose Get Data Now to populate the SQL staging table with therespective data.

Using SQL Queries

Following the creation of a SQL query, Process Authors will be able to use it as a data source whencreating metric links on activities and flow lines, and to retrieve activity costing data (volume andduration). See the Nimbus Control Client Help for more information.

6.2.3 Scheduling and Updating SQL Queries

Nimbus Control stores values that have been retrieved from SQL queries in a cache/staging table,which can be updated by scheduling the SQL2CtrlUpdate utility to run on a regular basis. Thefrequency that the utility is scheduled to run will depend on how often the KPIs are updated, but formost scenarios overnight scheduling is sufficient. Specific KPIs that require updating morefrequently can be achieved by updating an ID List file and creating a separate scheduled task. IDLists are created using the Admin Utility.

To create an ID List File

1. Run AdminUtil.exe (found in ...\Nimbus Control\Client).2. Select the Process Repository that you are configuring.3. Choose an administrator account, enter the password and click Next.4. From the Configure menu choose SQL Query Manager.5. Select the SQL queries that you want to add to the ID List file.

Note: Hold Ctrl to select multiple SQL queries.

6. Right-click a selected query and choose Create ID List.7. Enter a name for the ID List file and save it to an appropriate location.

Scheduling data retrieval from SQL queries

The SQL Query Update utility can be scheduled to run either from the command line or as aWindows scheduled task:

<Path to SQL2CtrlUpdate.exe <Process Repository> [<ID List File>]For example:

"E:\Nimbus Control\Client\Utilities\SQL2CtrlUpdate.exe" "E:\Nimbus Control\ProcessRepository" "E:\SQL Queries\SQLQueryList1.idl"

Note: The ID List file parameter is optional. If an ID List file is not specified then all stored SQLqueries will be updated.

Logging

A log file - SQL2CtrlUpdate.log - is written to whenever the utility is run. The log file is saved in thesame directory as where the utility is run from.



6.2.4 Integrating with SAP BW and SAP NetWeaver BI

Certified for SAPNetWeaver

Nimbus Control can be configured to integrate with SAP BW and SAP NetWeaver BI. ProcessAuthors can then link to SAP metric data in the Nimbus Control client and provide access to endusers from flow lines and activities. SAP reports can also be launched when users access SAPmetric links; these reports must be defined in the Admin Utility.

Note: If you are integrating with SAP NetWeaver BI, or if your server is not using the defaultweb service parameters, you must define the advanced connection settings. See AdvancedConfiguration Settings below for more information.

To configure the integration with SAP BW or SAP NetWeaver BI

1. Run AdminUtil.exe (found in ...\Nimbus Control\Client).2. Select the Process Repository that you are configuring.3. Choose an administrator account, enter the password and click Next.4. From the Configure menu choose SAP BW Integration.5. Select Enable integration with SAP BW.6. Click the Servers tab to select it.7. Click Add.8. In the Title text box enter a user-friendly title for the server connection.9. In the Base URL text box enter the URL and username/password credentials to allow

connection to the server.

Note: The base URL is usually the IP address of the server and the port for accessing SAP BWweb services.

Advanced Configuration SettingsYou may need to modify the server connection settings if you are integrating with SAPNetWeaver BI, or if your server is not set up to use the default web service parameters.

Click the Advanced tab and modify any settings, as appropriate.

Note: When the result is returned from SAP BW or SAP NetWeaver BI, the data is returned asXML. However, the data values can be returned with different tag names, which can bespecified in the XML Results Tag Name field.

10.Click OK.

To create a SQL query to retrieve metric data

1. In the SAP BW Integration dialog click the SAP BW Metrics tab to select it.2. Click Add.3. Click in the Title and Description text boxes and enter a title and description (optional).4. Choose the SAP server from the SAP BW Server drop-down list.5. Click Next.6. In the SQL Statement tab enter the SQL query that will return the metric data from the SAP BW

or SAP NetWeaver BI server.



For example: SELECT [Measures].MEMBERS ON AXIS(0) , NON EMPTY[0CALMONTH].[LEVEL01].MEMBERS ON AXIS(1)FROM[BSCUKIT/ZDEF_KPI_EITI_TBL]

Note: This query will need to be written by a SAP BW or SAP NetWeaver BI analyst who has agood understanding of the cube data within your system.

7. Click the Test Results tab to view the data that is retrieved by the query.

Note: Nimbus Control will use the first field from the first record as the value for the metric link,therefore the query may need to be modified to return the data that you want.

8. Click Finish.

The SQL query will now be available to Process Authors when creating SAP BW metric links.

To create a SAP BW report link

1. In the SAP BW Integration dialog click the SAP BW Reports tab to select it.2. Click Add.3. Click in the Title box and enter a title for the report.4. Choose the SAP server from the SAP BW Server drop-down list.5. Click in the SAP BW Report Code text box and enter the report code that you want to use.6. Click in the Description text box and enter a description (optional).7. Click OK.

The SAP report will now be available as a launch target to process authors when creating SAPBW metric links in the Client.

Scheduling data retrieval from SAP BW/NetWeaver BI

Nimbus Control holds metric data and scorecards that are retrieved from a SAP BW or SAPNetWeaver BI database in a cache/staging table. It is recommended that this table is updatedregularly. This can be achieved by either running it as a batch file from the command line, orautomatically scheduling it using Windows Task Scheduler.

Use the following command:<Path to SAPBW2CtrlUpdate.exe> <Process Repository>

For example:"E:\Nimbus Control\Client\Utilities\SAPBW2CtrlUpdate.exe" "E:\Nimbus Control\ProcessRepository"

Related topics

Integrating with SAP NetWeaver (to enable launching of SAP transaction links)

Registering with SAP Solution Manager



6.2.5 Integrating with Microsoft Office BusinessScorecard Manager

Nimbus Control can integrate with Microsoft Office Business Scorecard Manager in order to retrievemetric data.

To configure the integration with Microsoft Office Business Scorecard Manager

1. Run AdminUtil.exe (found in ...\Nimbus Control\Client).2. Select the Process Repository that you are configuring.3. Choose an administrator account, enter the password and click Next.4. From the Configure menu choose Microsoft Office Business Scorecard Manager

Integration.5. Select Enable integration with Microsoft Office Business Scorecard Manager.6. Click the Servers tab to select it.7. Click Add.8. In the Server Connection Name field enter a name for the connection.9. Click the Business Scorecard Server tab and in the Microsoft Office Business Scorecard Server

Connection Details panel enter the respective connection details for connecting to the MicrosoftOffice Business Scorecard server.

Scorecard Service URL is the URL of the Microsoft Office Business Scorecard Manager webservice.

For example:http://<server>:46786/pmservice.asmx

10.Click the Windows SharePoint Services Server tab and enter the respective details forconnecting to the Windows SharePoint Services server.

11.Click OK.

6.2.6 Integrating with Cognos Metrics Manager

Nimbus Control can integrate with Cognos Metrics Manager (CMM) in order to retrieve metric data.Metric data from a CMM database can then be associated with activities and flow lines as metriclinks in the Client.

To configure the integration with Cognos Metrics Manager

1. Run AdminUtil.exe (found in ...\Nimbus Control\Client).2. Select the Process Repository that you are configuring.3. Choose an administrator account, enter the password and click Next.4. From the Configure menu choose Cognos Integration.5. Select Enable integration with Cognos Metrics Manager.6. Click the Settings tab to select it.7. In the Cognos Metrics Manager Page URL field enter the base page URL for the Cognos

Metrics Manager.

For example:http://<server>/cmm/cgi-bin/cognos.cgi?app=cmm&path=/userui/en/page

8. Click Build.9. In the Provider tab select the database provider of the Cognos Metrics Manager database.



Note: This is usually Microsoft OLE DB Provider for SQL Server or Microsoft OLE DB Providerfor Oracle.

10.Click Next.11. In the Connection tab specify the data source connection details.

Note: It is recommended that you select Allow saving password if this option is enabled. ClickTest Connection to ensure that you can successfully connect to the data source.

12.Click the Advanced and All tabs and specify any additional settings, as required.13.Click OK.

Scheduling data retrieval from Cognos Metrics Manager

Nimbus Control holds metric data and scorecards that are retrieved from a Cognos Metrics Managerdatabase in a cache/staging table. Updating the data from Cognos Metrics Manager can be runfrom the command line, or it can be automatically scheduled using Windows Task Scheduler.

Use the following command:<Path to Cognos2CtrlUpdate.exe> <Process Repository>

For example:"E:\Nimbus Control\Client\Utilities\Cognos2CtrlUpdate.exe" "E:\Nimbus Control\ProcessRepository"

Manually updating data from Cognos Metrics Manager

The Cognos Metrics Manager cache/staging table can also be manually updated as and whenrequired.

1. Following the definition of the Cognos Metrics Manager connection, click the Metrics Data tab inthe CMM Connection Configuration dialog to select it.

Note: Follow steps 1-4 (above) to open the CMM Connection Configuration dialog.

2. Click Get Data Now.

Note: The data that is retrieved will be displayed in the dialog. This may take a short period oftime, depending upon the connection.

3. Click OK.



6.2.7 Integrating with Microsoft Office PerformancePoint

Nimbus Control can integrate with Microsoft Office PerformancePoint in order to retrieve metricdata. Metric data from a Microsoft Office PerformancePoint database can then be associated withactivities and flow lines as metric links in the Client.

Note: Microsoft Office PerformancePoint 2007 Service Pack 1 is required.

To configure the integration with Microsoft Office PerformancePoint

1. Run AdminUtil.exe.2. Select the Process Repository that you are configuring.3. Choose an administrator account, enter the password and click Next.4. From the Configure menu choose Microsoft Office PerformancePont Integration.5. Select Enable integration with Microsoft Office PerformancePoint 2007.6. Click the Servers tab to select it.7. Click Add.8. In the Server Connection Name field enter a name for the connection.9. In the PerformancePoint Server panel, enter the details required to connect to the Microsoft

PerformancePoint web services.

Note: Scorecard Service URL is the URL of the Microsoft PerformancePoint web service.

For example:http://<servername>:40000/WebService/pmservice.asmx

10.Click the Windows SharePoint Services Server tab to select it.11. In the Server URL field enter the base URL of the server.12.Click OK.13.Run IIS Manager and expand the following nodes:

14.Copy and paste NpDynamicView.aspx from the PerformancePoint folder on the Installation CDto the sub-folder in the Microsoft.Performance.Scorecards.WebParts folder.

15.Close IIS Manager.

Scheduling data retrieval from Microsoft Office PerformancePoint



Nimbus Control holds metric data and scorecards that are retrieved from a Microsoft OfficePerformancePoint database in a cache/staging table. Updating data from Microsoft OfficePerformancePoint can be run from the command line, or it can be automatically scheduled usingWindows Task Scheduler.

Use the following command:<Path to PerformancePoint2Ctrl.exe> <Process Repository>

For example:"E:\Nimbus Control\Client\Utilities\PerformancePoint2Ctrl.exe" "E:\Nimbus Control\Process Repository"

Manually updating data from Microsoft Office PerformancePoint

The Microsoft Office PerformancePoint cache/staging table can be updated manually as andwhen required.

1. Following the definition of the Microsoft Office PerformancePoint connection, click theData tab in the Microsoft Office PerformancePoint 2007 Integration dialog to select it.

Note: Follow steps 1-5 above to open the Microsoft PerformancePoint 2007 Integration dialog.

2. Click Get KPIs, Scorecards and Indicators Now.

Note: After a few moments the data will appear.

3. Click OK.



6.2.8 Integrating with ActiveStrategy

Nimbus Control can integrate with ActiveStrategy Enterprise in order to retrieve metric data, whichcan then be linked to activities and flow lines.

To configure the integration with ActiveStrategy

1. Run AdminUtil.exe (found in ...\Nimbus Control\Client).2. Select the Process Repository that you are configuring.3. Choose an administrator account, enter the password and click Next.4. From the Configure menu choose ActiveStrategy Integration.5. Select Enable integration with ActiveStrategy Enterprise.6. Click the Settings tab to select it.7. In the ActiveStrategy Enterprise URL field enter the base page URL for the ActiveStrategy.8. Click Build.9. Click the ActiveStrategy database provider to select it, then click Next.

Note: This is usually Microsoft OLE DB Provider for SQL Server or Microsoft OLE DB Providerfor Oracle.

10.In the Connection tab define the connection settings to connect to the ODBC database, thenclick OK.

Note: Click Test Connection to test the ODBC connection.

11.Click Test Database Connection to test the database connection details and SQL query.12.Click the Metrics Data tab and click Get Data Now to populate the ActiveStrategy cache/staging

table.13.Click OK to finish.

Scheduling data retrieval from ActiveStrategy

Nimbus Control holds metric data and scorecards that are retrieved from an ActiveStrategydatabase in a cache/staging table. It is recommended that this table is updated regularly as anautomated Windows scheduled task. Updating data from ActiveStrategy can be run from thecommand line, or it can be automatically scheduled using Windows Task Scheduler.

Use the following command:<Path to ASE2CtrlUpdate.exe> <Process Repository>

For example:"E:\Nimbus Control\Client\Utilities\ASE2CtrlUpdate.exe" "E:\Nimbus Control\ProcessRepository"



6.3 Integrating with SAP NetWeaver

Certified for SAP NetWeaver

Nimbus Control supports the integration with a SAP GUI environment and one or more SAP web-based environments. If both environments are enabled, SAP transaction links can be configured toallow users to choose which environment to launch the SAP transaction in (see the Client help formore information on creating SAP transaction links). User preferences also dictate if a specific usercan launch in one or both of the environments.

Note: SAP transaction launching is not supported if there is a mismatch of the librfc32 librarybetween a SAP server and SAP client environments, and when the librfc32 is v640.0.172 orolder.

To configure the integration with SAP NetWeaver

1. Run AdminUtil.exe (found in ...\Nimbus Control\Client).2. Select the Process Repository that you are configuring.3. Choose an administrator account, enter the password and click Next.4. From the Configure menu choose SAP NetWeaver Integration.5. Select one or both of the following options:

Integrate with SAP web interface This will open a SAP transaction link in a web browser when users access a transaction link fromeither the Author Client or Web Server.

Integrate with SAP using transaction launcher This will launch SAP transaction links in a SAP GUI system from either the Client and WebServer. When users access a transaction link the Launch SAP Transaction dialog is displayed,allowing users to create a session using credentials permitted to launch a remote function callwithin the SAP system (IFC permissions).

Launching into a SAP GUI system will require an Active X component to be installed whenusers access a transaction link for the first time from the Web Server. If the user chooses toinstall the component, a ctrlsaplauncher.cab file will be copied to the user's machine. Futureversions of Nimbus Control may require users to accept an updated ActiveX component.

The following ActiveX security measures ensure a safe ActiveX component:Session Expiration - each session is set to expire after 10 minutes and logging out of aNimbus Control Web Server session will force all sessions to expire.

Site Lock - only trusted zones and intranet sites are allowed to run the ActiveX component.

Buffer Overflow - checks that the buffer overflow technique is not being exploited.

Launching Restrictions - requires the user to run the ActiveX component, therebypreventing malicious scripts from running.

Domain Based Sessions - sessions are not interchangeable between domains, i.e. asession created on the local domain cannot be used to gain access from a differentdomain.

Note: The Microsoft Java Virtual Machine (MSJVM) may cause problems when installing theActive X component for the first time, for example the user may be directed to a web pagedisplaying an error, or the web page may simply close. To resolve this problem the Microsoft



Java Virtual Machine must be uninstalled. For instructions on how to remove the MSJVM,search the internet for 'Removing MSJVM'.

6. If you have selected to integrate with the SAP web interface, click the Base URLs tab and click Add to enter one or more base URLs to connect to.

For example, http://myserver:80057. Click OK.

Related topics

Integrating with SAP BW and SAP NetWeaver BI (to retrieve measures/metric data)

Registering with SAP Solution Manager

6.4 Integrating with a Novell File ServerNimbus Control provides support for accessing resources on a Novell file server. The NimbusControl applications that support the ability to access Novell file servers include:

Executable/DLL LocationActSvc.exe (4 services) ...\Nimbus Control\Action ServerAdminUtil.exe ...\Nimbus Control\ClientCtrlOffSvr.exe ...\Nimbus Control\Action ServerBiSvc.exe ...\Nimbus Control\BI ServerWebSvr.dll ...\Nimbus Control\Web Server\AppSSynch.exe ...\Nimbus Control\Web Server\UtilitiesCognos3CtrlUpdate.exe ...\Nimbus Control\Client\UtilitiesSQL2CtrlUpdate.exe ...\Nimbus Control\Client\UtilitiesASE2CtrlUpdate.exe ...\Nimbus Control\Client\UtilitiesSAPBQ2CtrlUpdate.exe ...\Nimbus Control\Client\UtilitiesExcelMacroLauncher.exe ...\Nimbus Control\Client\UtilitiesLDAPUtility.exe Utilities folder on the CDMaestro2CtrlUpdate.exe ...\Nimbus Control\Client\UtilitiesWebLogsUtility.exe ...\Nimbus Control\Client\Utilities

Note: If using the LDAP Utility, LDAPUtility.exe must be copied from the Utilities folder on theinstallation CD into the Client\Utilities folder.

To configure the integration with a Novell file server

1. Run NovellConfig.exe (found in the ...Utilities\Novell folder on the CD).2. Select the location of an existing Novell configuration file (Novell.ini) or select a location to create

a new one in.The Novell.ini configuration file should exist in one of two locations:

· In the same folder as Ctrl.exe (for example <Installation directory>\Control\Client)

· In a new folder called Common in the root directory of the Nimbus Control installation (forexample ...\Control\Common).

By placing the configuration file in the root directory of the Nimbus Control installation, a singlefile can be used for multi-application Nimbus Control installations (for example Ctrl.exe,AdminUtil.exe, SQL2CtrlUpdate.exe, etc).

Integrating with a Novell File Server 121


Note: · The file local to the executable always takes precedence if files are present at both

locations, thereby giving the capability to override the shared file if required.· If a configuration file already exists then the information will be overwritten.

3. Select Enable Logon to NDS and file servers and define the connectivity details to the Novellfile server:

General Tab

Password encryption Standard allows decryption by any PCSpecific to current PC allows decryption only by the PC that originally performed theencryption Specific to current PC and user allows decryption only by the PC that originallyperformed the encryption and when the same user is logged in

User name is the account required to log in to the Novell file serverPassword is the password of the user name required to log in to the Novell file serverTree is the NetWare Directory Services (NDS) tree to log in toContext is the NetWare Directory Services (NDS) context to log in to (for example, CS.FNB.CS.NCSU)Additional File Servers allows you to specify additional file servers to connect to, forexample ndsone.acme.

Advanced Tab

Define any logging required:

Level determines the level of logging

Log date and time logs the date and time of each event in the log file

Log to debug output logs events to the Windows debug output

4. Click OK.

To edit the configuration file manually

You can manually edit or create a Novell.ini file. The following parameters exist:

[General]

Parameter Function

LogDateTime

Logs the date and time of each event in the log file. Set this parameter to LogDateTime=1 to enable date and time logging (default if not specified),or LogDateTime=0 to disable it.

LogToDebugOutput

Logs events to the Windows debug output. Set this parameter to LogToDebugOutput=1 to enable logging to the Windows debug output, orLogToDebugOutput=0 to disable it (default if not specified).

LoggingLevel

Determines the level of logging. Set this parameter to LoggingLevel=1 toenable logging, or LoggingLevel=0 to disable logging (default if notspecified).



[LoginInfo]

Parameter Function

UserName The user account required to log in to the Novell file server.

Password The user account password required to log in to the Novell file server.

TreeName The NetWare Directory Services (NDS) tree to log in to.

UserContext The NetWare Directory Services (NDS) context to log in to (for example,CS.FNB.CS.NCSU).

Encryption The type of encryption to use. Set this parameter to Encryption=0 to allowdecryption by any PC (default if not specified), Encryption=1 to allowdecryption only by the PC that originally performed the encryption orEncryption=2 to allow decryption only by the PC that originally performedthe encryption and when the same user is logged in.

Anonymous Allows anonymous access to the Novell File Server. Set this parameter to Anonymous=1 to allow anonymous access (default if not specified) orAnonymous=0 to disable anonymous access.

[FileServers]

Specify any additional Novell file servers to connect to. Multiple file servers can be specifiedbut if no servers are specified then no connections will be made, although log-in will still becompleted.

Parameter Function

<Name of File Server>Specify a file server to connect to. For example, FileServer1=ndsone.acme.

<Name of File Server2> For example, FileServer2=ndsthree.acme.

6.5 Integrating with Generic PortalsIt is possible to provide access to areas of Nimbus Control from within a portal by accessing thespecific Web Parts. The following URLs can be referenced:

Control Web Part URL

Processeshttp://.../.../ctrlwebisapi.dll/webPart.Processeshttp://.../.../ctrlwebisapi.dll/webPart.1

Documentshttp://.../.../ctrlwebisapi.dll/webPart.Documentshttp://.../.../ctrlwebisapi.dll/webPart.2

Measureshttp://.../.../ctrlwebisapi.dll/webPart.Measureshttp://.../.../ctrlwebisapi.dll/webPart.3

Storyboardshttp://.../.../ctrlwebisapi.dll/webPart.Storyboardshttp://.../.../ctrlwebisapi.dll/webPart.4

Scorecardshttp://.../.../ctrlwebisapi.dll/webPart.Scorecardshttp://.../.../ctrlwebisapi.dll/webPart.5

Noteshttp://.../.../ctrlwebisapi.dll/webPart.Noteshttp://.../.../ctrlwebisapi.dll/webPart.6

Integrating with Generic Portals 123


To-Doshttp://.../.../ctrlwebisapi.dll/webPart.ToDoshttp://.../.../ctrlwebisapi.dll/webPart.7

Workflows http://.../.../ctrlwebisapi.dll/webPart.Workflowshttp://.../.../ctrlwebisapi.dll/webPart.8

Favoriteshttp://.../.../ctrlwebisapi.dll/webPart.Favoriteshttp://.../.../ctrlwebisapi.dll/webPart.9

Recently Viewedhttp://.../.../ctrlwebisapi.dll/webPart.RecentlyViewedhttp://.../.../ctrlwebisapi.dll/webPart.10

My Searcheshttp://.../.../ctrlwebisapi.dll/webPart.MyTopicsSearchhttp://.../.../ctrlwebisapi.dll/webPart.11

My Roleshttp://.../.../ctrlwebisapi.dll/webPart.MyRoleshttp://.../.../ctrlwebisapi.dll/webPart.12

Mapshttp://.../.../ctrlwebisapi.dll/webPart.Mapshttp://.../.../ctrlwebisapi.dll/webPart.13

Transactionshttp://.../.../ctrlwebisapi.dll/webPart.Transactionshttp://.../.../ctrlwebisapi.dll/webPart.14

Reports http://.../.../ctrlwebisapi.dll/webPart.Reportshttp://.../.../ctrlwebisapi.dll/webPart.15

Actions http://.../.../ctrlwebisapi.dll/webPart.Actionshttp://.../.../ctrlwebisapi.dll/webPart.16

Diagram Web Parts

Diagrams can also be used in generic portals by using the Diagram Web Part. To achieve this,substitute /?_id=webDiagram.show& with /diagram| in the diagram's Web Server URL. Anexample Diagram Web Part URL:

https://[server]/[site]/CtrlWebIsapi.dll/diagram|map=Processes%2FOperational+Processes&dgm=AF41FF3F80AF4896898FE1B25D48887B

The Menu and Quick Links can be hidden by setting the ParentInDifferentDomain parameter to '1'in the Web Server configuration file - see 4.1.1 Configuring the Web Server for more information.

Note: The Diagram Web Part cannot be used when Nimbus Control is installed into aSharePoint 80 site.

SharePoint

You can access the above Web Parts, without installing Control, by setting up links using the SiteAggregator Web Part in SharePoint.

Note: It may be necessary to modify the Site Aggregator Web Part settings to prevent a URLfrom being attached to the sites when they are accessed. To do this click Edit on the SiteAggregator Web Part and choose Modify Shared Web Part. Expand URL and remove the URLthat is defined in the URL to append to site text box.



Launching Storyboards based on Keywords

Storyboards can be launched via the Web Server, based on specific keywords, using the followingURL:

http://[server]/[site]/CtrlWebIsapi.dll/?__id=webStoryBoard.openByKeyword&k=Example%20Keyword

Notes:

The first storyboard that meets the keyword criteria will launch when the URL is used.

The following HTML character codes are permitted in the URL:

%20 = SPACE

%22 = "

%27 = '

To launch a storyboard with ALL tagged keywords in the URL, ensure that you include quotes (")around the keywords. For example, to launch a storyboard that has both 'Request' AND 'Leave'keywords tagged:

http://NimbusPartners/NimbusControl/CtrlWebIsapi.dll/?__id=webStoryBoard.openByKeyword&k="Request%20Leave"

If quotes are not applied then the first storyboard tagged with either 'Request' OR 'Leave' will belaunched.

Correct URL syntax:

http://website/CtrlWebISAPI.dll/?__id=webStoryBoard.openByKeyword&k=Example%20Keyword - launches the first storyboard that includes any of the specified keywords.

http://website/CtrlWebISAPI.dll/?__id=webStoryBoard.openByKeyword&k="Example%20Keyword" - launches the first storyboard that includes all specified keywords.

Incorrect URL syntax:

http://website/CtrlWebISAPI.dll/?__id=webStoryBoard.openByKeyword&k=%22Example%20Keyword%22

http://website/CtrlWebISAPI.dll/?__id=webStoryBoard.openByKeyword&k=%27Example%20Keyword%27

6.6 Integrating with Workflow ApplicationsNimbus Control can integrate with third party workflow management applications. Access toworkflows is from users' Home page. By default, the Workflows section is hidden but can bedisplayed through the Web Server options (accessed from the Administration menu in the WebServer).

Note: This feature will only work when single-sign on is enabled. There is a configuration optionin the [MyPage] section that specifies whether to display workflows in the same browser windowor in a new browser.

Integrating with Workflow Applications 125


Javascript

Third party applications must be configured to use a Javascript file which is designed to launch theNimbus Control Add to Favorites dialog. An example Javascript is shown below:

<html>

<script>

function addUrlToControl(title, url) {

if (typeof(encodeURIComponent) !='function') {

alert('encodeURIComponent not supported by your browser');

return false;

}

var url='http://NimbusControl/ctrlwebisapi.dll?_id=webAddFavorite.show&type=6&title='+

encodeURIComponent(title) + '&urltype=0&url=' + encodeURIComponent(url) + '&ret=' +

encodeURIComponent('http://www.Example.com');

window.open(url, "blank",

"width=600,height=400,location=0,menubar=0,resizable=0,scrollbars=0,status=0,titlebar=0,toolbar=0");

return true;

}

</script>

<body>

<a href="#" onclick="addUrlToControl('Example', 'http://www.example.com');return false;">Add example.com tofavorites</a>

</body>

</html>

6.7 Registering with SAP Solution ManagerData can be transferred between SAP Solution Manager and Nimbus Control. For this to beachieved, you must register Nimbus Control with SAP Solution Manager.

To register Nimbus Control with SAP Solution Manager

1. Run AdminUtil.exe (found in ...\Nimbus Control\Client).2. Select the Process Repository that you are configuring.3. Choose an administrator account, enter the password and click Next.3. From the Configure menu choose Register into SAP Solution Manager.4. Enter the respective connection details. 5. Click Browse to select the SAP XML file used for transferring data between SAP Solution

Manager and Nimbus Control.6. Click Register.

Related topics

Integrating with SAP BW and SAP NetWeaver BI (to retrieve measures/metric data)Integrating with SAP NetWeaver (to enable launching of SAP transaction links)



6.8 Importing Data TablesData tables can be updated, replaced and merged from file. The format of the data table file is CSVand the following format is required:

[Data table],[Data field],[Field type],[Comment]For example:

Data table 1,Department,A,,

Notes: 1. A new line must exist for each value.2. Field type is defined by a single letter and can be any of the following:

A (alphanumeric), I (integer), F (decimal), D (date), T (time), B (true/false), Y (yes/no) andO (on or off)

To update data tables

1. Run ImportUtil.exe (found in the Utilities folder on the CD).2. Click Browse to select the Process Repository that you want to import, merge and/or update

items in.3. From the User Name drop-down list choose the administrator account to run the Import Utility,

enter the password and click Next.4. Select Data Tables, then click Next.5. Select one of the following rules:

Update data tables from file will update existing data tables with the data tables from fileReplace all existing data tables from file will replace existing data tables with the datatables from fileMerge data tables from file will merge existing data tables with the data tables from file

6. Click Browse to select the data file.7. Click Start to import the data.

6.9 Integrating with OpenText Document ManagementA web service is available via the Nimbus Control Web Server that allows documents stored in OpenTextDocument Management to be formally acknowledged through the Nimbus Control Document Registry.This feature is supported in OpenText Document Management v9.7.1 onwards.

6.10 Integrating with tibbrNimbus Control can be integrated with the social networking tool tibbr (available from Tibco).Integrating tibbr with Nimbus Control allows authors to create tibbr subjects based on storyboardtitles and keywords. Web users will have access to their tibbr Wall through their My Workspace andcan search for tibbr discussions through My Searches.

Notes: (1) There is a user group permission that allows authors to create tibbr subjects fromstoryboard titles and keywords (this is found under tibbr in a user group's permissions). (2) The tibbrsection on users' My Workspaces is hidden by default for all user groups. To display the tibbrsection you must configure users' Home pages. (3) You can modify the size of the tibbr gadgets inthe Web Server and assign a custom Home page tab to the tibbr section header. For more

http://www.tibco.com

Integrating with tibbr 127


information see Configuring the Web Server.

To integrate Nimbus Control with tibbr

1. In the Author Client, open the system options and click tibbr in the left-hand pane.2. In the tibbr Domain panel, enter the domain for the tibbr installation (including the transfer

protocol, such as 'http' or 'https').3. Click Change Credentials and specify the domain service account details. This is the account

that is used to create the subjects in tibbr.4. To enable the integration of storyboards with tibbr subjects, select Enable tibbr integration

between storyboard titles and tibbr subjects.

(Optional) You can specify a parent subject title for storyboard discussions in the field below.Whenever a storyboard discussion is created it will be created under this parent subject.

Note: You must also manually create the parent subject in tibbr.

5. To enable the integration of keywords with tibbr subjects, select Enable tibbr integrationbetween keywords and tibbr subjects.

(Optional) You can specify a parent subject title for keyword discussions in the field below.Whenever a keyword discussion is created it will be created under this parent subject.

Note: You must also manually create the parent subject in tibbr.

6. Click OK.

Backup

Chapter 7


129


Backing up a Process Repository should be done in accordance with an organization's policies. It isadvised to backup the Process Repository, including the associated file system, as well as anylinked data that resides outside of the Process Repository file system (file and document links).Backing up a Process Repository and associated data can be achieved in two ways.

Automatic BackupThis is the recommended method if you are using Windows Server 2003 and Windows Server 2008as it combines the Nimbus Control Backup Utility with Microsoft's Volume Shadow Copy Service(VSS) to create a snapshot of the data, thereby minimizing the system downtime.

Manual BackupThis method describes how to use the Lock Service to lock the Process Repository in order to allowthe manual back up of the Process Repository and any associated data.

7.1 Automatically Backing Up a Process RepositoryThe following method describes how to back up a Process Repository and associated folders usingthe Backup Utility. If you are not using Windows 2003 Server or Windows Server 2008 you must usethe Lock facility that is installed with the Action Server and back up your data manually. See Manually backing up a Process Repository for more information.

The Process Repository should not be backed up whilst on-line, i.e. all connectionsfrom the Client and Web Server must be disconnected for the duration of the backup.

Windows Server 2003 and Windows Server 2008

A utility is provided that backs up a Process Repository and any associated file directories that areon the same drive (scorecard repository, Document Registry, etc). The Backup Utility supersedesthe previous Lock Service in version 6.5.1 and earlier.

Volume Shadow Copy Service (VSS)

VSS allows a snapshot of the Process Repository and any associated file directories to becreated in a few minutes, minimizing the downtime of the data for end users. The Backup Utilitywill set the Process Repository lock upon initiation. After the specified time (set in the WebServer configuration file) the Web Server will be locked. After 15 seconds the utility will request asnapshot of all folders set to be backed up through VSS. Upon completion of the snapshot, theProcess Repository and Web Server locks will be released. A folder will be created in thespecified backup location with a time and date stamp and a copy of all specified virtual folders, ora single zipped file of the data, will be saved. When the backup is complete, VSS will delete thesnapshot.

Running diagnostic checks before compressing data

It is possible to launch a diagnostic application, batch file or script on the backed-up data after asnapshot of the data has been taken and before it is compressed for storage. This is configuredin the [LaunchExternalApp] section in the configuration file. For example, you could run the mapdiagnostic check in the Admin Utility - see Checking Maps for more information.

Linked Data

Any linked files that do not reside within the Process Repository directory must be manually

Chapter 7 Backup130


backed up. To review all files that are linked to a Process Repository you can generate a reportfrom within the Client.

1. From the Tools menu choose Reports and select the following criteria:

Category - DiagramReport - File and Document LinksScope - Map Selection

2. In the Map Selector dialog, select the maps that you want to report on.Hint: Select Process Repository to select all maps within the current ProcessRepository.

3. Click OK.

To automatically back up a Process Repository

1. Copy CtrlBackupUtil.exe and BackupConfig.ini (from the Utilities folder on the CD) to a localor network drive.

2. Open and edit BackupConfig.ini, as required.


PathThe path of the Process Repository,specified by drive letter (not UNC).

Store The location to save the backup to.

LocationN

The path of additional folders toback up (must be on same drive asProcess Repository).

UseZip Zips the folders into a single file. 01

DisableEnable

MaxBackups The maximum number of backups tostore at any given time. When thisthreshold is exceeded, the oldestbackup will be deleted (default=7,unlimited=0).

LockPeriod The waiting period between applyingthe client lock and initiating thebackup, in minutes. Note: Aminimum of 5mins is recommendedto allow any long operations tocomplete.

SendWarningsTo The Email addresses that are usedfor notification if a backup fails. Note: This requires that the ActionServer is installed and running.Multiple email addresses must beseparated by semi-colons.

FixedTargetFolder Specify whether to use the samefolder for backups, i.e. 'Nimbus

0

1

Date and Time as foldername

Automatically Backing Up a Process Repository 131


Control Backup', or create a newfolder with the date and timeappended. Note: Folders arecreated automatically. If the samefolder is used for backups then anyexisting folders will be renamed toNimbus Control Backup n, where n isthe next available number.

'Nimbus Control Backup'as folder name

ExternalApp Specify an external application orscript to run after the data is movedto the backup location but before itis compressed (if UseZip isenabled). Note: If running a scriptyou must first specify the host for thescript, e.g. "wscript c:\script.js". Youcan also specify the target backupfolder to be provided to the externalapplication or script by adding the "<TARGET_FOLDER>" parameter,e.g. c:\script.js"<TARGET_FOLDER>". Note: Thetarget folder will be automaticallyreplaced with the correct path whenthe external application or script isrun.

LogReturnVal Specify whether to log the exit codeof the external application. Note:Any non-zero values are treated aserrors and an email notification (ifconfigured) will be sent.

01

Ignore exit codeLog exit code

TimeOutMins Specify the time, in minutes, to waitfor the external application tocomplete. If the application times outthen the data will not becompressed, and an emailnotification (if configured) will be sent(default=0, unlimited).

RetryPeriodSecs Specify the amount of time to waitafter a snapshot has been rejected(due to another snapshot being inprogress) until the operation isretired.

RetryLimit Specify the total amount of times toretry the operation.

3. Open the Web Server configuration file, config.ini, in a text editor (default location is ...\NimbusControl\Web Server\Config). In the [DataFolder] section set LockMode to '1'.

Chapter 7 Backup132


4. From a command prompt run the following command:<Path of CtrlBackupUtil.exe> <Path of BackupConfig.ini>

For example:"C:\Nimbus Control\CtrlBackupUtil.exe" "C:\Nimbus Control\BackupConfig.ini"

Automatically Backing Up a Process Repository 133


7.2 Manually Backing Up a Process RepositoryThe following method describes how to lock the Process Repository using the Lock Service in orderto allow you to back up the Process Repository and associated files. The Lock Service is optionallyinstalled as part of the Action Server. Backing up a Process Repository should be undertaken inaccordance with an organization's policies. It is advised to backup the Process Repository regularly,including the associated file system and any linked data that resides outside of the ProcessRepository file system, such as file and document links.

Note: If you are using Windows Server 2003 or Windows Server 2008 then it is advised that youuse the Backup Utility. See Automatically backing up a Process Repository for more information.

The Process Repository should not be backed up whilst on-line, i.e. all connectionsfrom the Client and Web Server must be disconnected for the duration of thebackup. Linked data should also not be modified during this time.

To specify the start and stop times of the Lock Service

The start and stop times of the Lock Service must be defined if they are not already. The LockService is installed as a service in the Action Server installation. See Installation\InstallationProcedures\Installing the Action Server for more information.

1. Open Config.ini. (found in ...\Nimbus Control\Action Server) in a text editor, such as Notepad.In the [LockTable] section modify the StartLock and StopLock parameters:

Parameter Function

StartLock The time at which the Process Repository is locked.

StopLockThe time at which the Process Repository is unlocked. Note:

If the times are the same then a lock will not be applied.

2. Save and exit Config.ini.

To back up data

Nimbus Control consists of two parts; the Process Repository and any linked data. It is thereforeimportant that you not only back up the Process Repository, which is the entire content of thespecified file system directory, but also all linked data. It is important to prevent any of the linkeddata from being modified during backing up. Since linked data can reside anywhere within the filesystem, it is important to be aware of all linked data when backing up.

Note: A report can be generated in the Client that will report on all existing file and documentlinks (linked data) in a particular Process Repository. In the Reports dialog (in the Client),choose Diagrams as the category and then choose File and Document Links.

Linked Data

Any linked files that do not reside within the Process Repository directory must be manuallybacked up. To review all files that are linked to a Process Repository you can generate a report

Chapter 7 Backup134


from within the Client.

1. From the Tools menu choose Reports and select the following criteria:

Category - Diagram

Report - File and Document Links

Scope - Map Selection2. In the Map Selector dialog, select the maps that you want to report on.

Hint: Select Process Repository to select all maps within the current ProcessRepository.

3. Click OK.

Once the Process Repository is locked the data can then be manually backed up.

Leave five minutes after the Process Repository is locked before initiating any backupsin order to allow for all processes to be disconnected from the Process Repository.

Maintenance

Chapter 8


Chapter 8 Maintenance136


8.1 Recovering Deleted Maps and DiagramsMaps and diagrams that are deleted through the Client are not completely removed from theProcess Repository as the data is moved into a Deleted folder, where it can be retrieved if required.

Note: Master and draft maps must be recovered separately. Diagrams that have been deletedby removing a drill-down from an activity will be restored as new maps. To reintegrate themback into a map you must then import them as a drill down.

To recover a deleted map or diagram

1. In the Nimbus Control Author Client, from the File menu choose Deletion Recovery Manager.2. Select the maps and diagrams that you want to recover.

Note: Hold Ctrl to select multiple maps and diagrams.

3. Click Recover and select a location to save them to.

8.2 Checking PerformancePerformance checking of a Process Repository will measure the speed of creating, reading andcopying tables and mark the overall results against a benchmark.

Note: If the performance is slow you can copy the results and Email them to Nimbus Help Desk.

To check the performance of a Process Repository

1. Run AdminUtil.exe (found in ...\Nimbus Control\Client).2. Click Browse and select the Process Repository that you want to check, then click Next.3. Enter an administrator's username and password, then click Next.4. From the File menu choose Diagnostics, then Performance Check.5. Click Start.

8.3 Checking MapsThe Admin Utility allows you to check the state of all maps within a Process Repository and anyissues will be logged. Some issues can be automatically fixed in the process, assuming you haveexclusive access to the Process Repository. Issues that cannot be automatically fixed can bereported to Nimbus Support in order to be resolved.

Maps· Required files exist in a .MAP folder for each map.· The DBISAM tables can be opened for each map.· The DBISAM tables are not corrupt.· All maps exist in the Maps table (not included in Standard mode).· (Fix) Missing maps are added to the Maps table.· A user groups table exists in each Map folder and can be opened.· A text table exists in each Map folder and can be opened.

Diagrams

Checking Maps 137


· Diagrams have entries in the Link table (not included in Standard mode).

· (Fix) Missing diagrams are added to the Link table.

· Missing drill downs.

· (Fix) Invalid levels are used as the missing drill downs if the title matches the object text, orthe drill down arrows are removed (for free text and bitmap objects the drill down referencesare removed).

To manually check process maps

1. Run AdminUtil.exe (found in ...\Nimbus Control\Client).2. Select the Process Repository that you are configuring.3. Choose an administrator account, enter the password and click Next.4. From the File menu choose Diagnostics, then Check Maps.5. Select to run a Standard Check or an Extended Check by selecting the relevant option.

Standard Check will run all of the checks and fixes (as described above) except it will notcheck that each map exists in a Maps table and that all diagrams have entries in the Linktable. Extended Check will run all checks and fixes.

Ignore Deleted Items will ignore all maps and diagrams in the Deleted folder.

Fix will fix any problems, if possible.

Logging

Generated diagnostic log files are stored in the following directory:<Process Repository>\System\Logs\Diagnostics

Results will be appended to the log file if it already exists. If running from the command line, orfrom a batch file, you can create a new log file for every run by adding the /N parameter. Thefollowing log messages may be encountered:

Log Message Description

Manually Cancelled By User User manually selects Stop when running a diagnostic check

File Missing One of the map files is missing, for example files pertaining to thediagram table, binary table, level table, keyword table, texts table,user groups table, etc

Can't Open Table Application fails to open a table, for example a diagram table, binarytable, level table, keyword table, texts table, user groups table, etc

Drill Down Diagram Missing A child diagram for a drill down object, free text object or imageobject is missing in the diagram table for it's child (using theChildGUID).

Drill Down Points to Invalid Level Drill down, free text or bitmap image points to an invalid diagramlevel *

Diagram not in Links Table A record for a diagram path and GUID is not present in the CentralLinks Table as part of its existing records.

Can't Access Map A diagram table cannot be opened in the Maps folder.

Map not in Central Maps Table A record is missing in the Central Maps table for a map and itsrelative folder as part of its existing records.



Diagnostic check started (Fix =True)

The Fix option was selected when running the diagnostic check.

Diagnostic check started (Fix =False)

The Fix option was not selected when running the diagnostic check.

Diagnostic check finished Diagnostic check complete.

Unable to start - Processrepository locked

Process Repository cannot be accessed as it's locked, for example ifit's currently in use or on a scheduled maintenance.

Error: Can't create map tables for The following tables cannot be created for a map (when trying tocreate a map for an extracted invalid level) - Diagram, Binary, Level,Keyword, Texts, User Groups.

Error: Can't create map A folder cannot be created for a map using the map path (whentrying to create a map for an extracted invalid level).

Error: Can't create new folder Any parts of a folder directory using the map path cannot be created(when trying to create a map for an extracted invalid level).

Error loading diagram A special case which occurs when the application tries to load adiagram based on the GUID code string but fails to find the matchingrecord in the Diagram Table, for example due to incorrectlyformatted data. An exception is also raised.

Error saving diagram Saving a diagram fails after a fix, such as 'replacing the file links' or'fixing a drill down', has been applied to a diagram.

Image not found in Binarys table GUID missing for an image as part of its existing records in theBinaries Table.

Fix: Drill Down Fixed Using InvalidLevel

A drill down is fixed with an invalid level (from the Invalid Level List)where the title matches the object text. In this instance the GUID ischanged to match the drill down (requires the Fix option to beselected).

Fix: Drill Down Fixed By RemovingObject

A drill down is removed to resolve a diagram issue (requires the Fixoption to be selected).

Fix: Drill Down Fixed By RemovingReference (free text object)

A reference from a Free Text object to it's child GUID is removed toresolve a diagram issue (requires the Fix option to be selected).

Fix: Drill Down Fixed By RemovingReference (image object)

A reference from an Image object to it's child GUID is removed toresolve a diagram issue.

Fix: Link Table Record Added A diagram's GUID and path are added to the Central Links Table aspart of a fix.

Fix: Map Added to Maps Table A map record is added to the Central Maps Table if it was previouslymissing.

Fix: Invalid Level Extracted A record is removed from the Diagrams Table and moved to a newtable in a new map. Each extracted level gets its own new map.

* Invalid diagram levels are usually the result of users copying and pasting whole maps, orsections of maps, rather than using drill downs (or the send to child functionality). Due to thecomplexity of the database tables, if the copy and paste operation is interrupted due to networkproblems or accessing the content over an unreliable wireless network, for example, then invalid

Checking Maps 139


levels may occur.

Scheduling

It is also possible to schedule the utility to run at defined intervals using the Windows TaskScheduler, or the utility can be run from the command line as a batch file:

<path>\adminutil.exe "<path of Process Repository>" [/D] [/F] [/I] [/N] [/E]

/D Check the Process Repository/F Fix any issues, if possible/N Create a new log file for every run (date and time stamped)/I Ignore deleted items/E Run in extended check mode

For example:"C:\Nimbus Control\adminutil.exe" "<Installation directory>\Nimbus Control\ProcessRepository" /D /F /N /I /E

Email Notifications

A list of Email addresses can be defined to notify users when the diagnostic check has been run.Any issues will be included in the body of the Email. In the Admin Utility, from the File menuchoose Diagnostics and then Email List. Click Add to add a new Email address.

Note: By default, the Nimbus Control Action Server is used to send out email notificationsafter running a diagnostic check. However, you can specify a different SMTP email server touse if required, and this is recommended if you are running diagnostic checks against anoffline process repository (for example, a backed up process repository). To specify adifferent SMTP email server, click the Email Server tab in the Diagnostic Check EmailConfiguration window and select Configure SMTP server separately. Enter the host andport of the SMTP server, then click Configure SMTP Credentials to specify theauthentication details (if required).

8.4 Archiving MapsThe Archiving Utility (CtrlArchives.exe) runs the following tasks:

Compresses archived maps

If the Store compressed static version of map archives system option is enabled, any mapfolders stored in the specified archive location will be compressed into archived packages (.arc).Archived packages are saved in the same location as the archived map folder.

Removes old archived maps

If the Automatically remove old archives system option is enabled, old archives are eitherpermanently deleted or moved to a specified location, depending on what system options are set.

Note: The options governing the behaviour of the Archiving Utility are found under DocumentControl/Archives in the system options.

To manually archive maps

1. From a command prompt run the following command:



<CtrlArchives.exe> <Process Repository>

For example:"C:\Nimbus Control\Client\Utilities\CtrlArchives.exe "C:\Nimbus Control\Process

Repository

Note: You can also change the output of the log file (by default it is stored in the samedirectory). For example:

C:\Nimbus Control\Client\Utilities\CtrlArchives.exe "C:\Nimbus Control\ProcessRepository" "C:\Logs\Archive.log"

Scheduling

It is advisable to schedule the utility to run at regular intervals using Windows Task Scheduler.The command lines (above) should be used when creating the task.

Logging

All logs, including any issues with archiving, are stored in a log file. Unless otherwise specified, thelog file is called ctrlarchives.log and is stored in the same directory as where the utility is run from.

8.5 Managing Database TablesThere are a number of tables that hold Nimbus Control data. If you are experiencing problems withany of these data tables then there are a number of options available.

Maintaining tables should be attempted by experienced users only. Please contact Nimbus Support before undertaking any actions.

To manage data tables

1. Run AdminUtil.exe (found in ...\Nimbus Control\Client).2. Click Browse and select the Process Repository that you want to check, then click Next.3. Enter an administrator's username and password, then click Next.4. From the Tables menu choose a table and then one of the available options.

Table Open Repair Email Create RebuildMaps

Links

Diagrams

Binarys

Levels

Texts

Document Registry

Action Server

Other System Tables:

Action

Managing Database Tables 141


Table Open Repair Email Create Rebuild

Attachments

BI Server

Data Table Attachments

Delete Recovery

Keyword

Recurring Review

Resource

Scorecard

Search

Statement

Storyboard

User Library

Open View the information within a table. Some tables can be edited, for example the Linkstable.

RepairRebuild the indexes and fix corrupted headers, where possible. Repair optionsshould not be run on a table unless the data in a table is corrupted.

Email Email the table to Nimbus Help Desk.

CreateCreate an empty table if a table does not already exist. If you are creating a Mapstable then you must rebuild it following its creation.

Rebuild Rebuild a table.

ExtractInvalidLevels

(Diagrams table only) Remove all invalid diagrams from the table. A new folder called<map>_invalid_levels is created, allowing maps to be recovered if required.



8.6 Synchronizing the Web ServerThe System Synchronization Utility updates the data that is presented to users through the WebServer. It should be run daily and can be run manually, from the command line or, ideally, as anautomated Windows scheduled task.

Note: The desktop client must have been run at least once before using this utility. The SystemSynchronization Utility is also used to synchronize the Business Intelligence Server to updatemetric data. See Synchronizing the Business Intelligence Server for information.

To synchronize the Web Server

1. Run SSync.exe (found in ...\Nimbus Control\Web Server\Utilities).

Note: The System Synchronization Utility can also be run from the Start menu:Program Files >Nimbus Control >Utilities >Synchronisation

Configuration File

The System Synchronization Utility has an associated configuration file config.ini (found in ...\Nimbus Control\Web Server\Utilities). The following parameters can be modified:

[Data Folder ]

Parameter Function

Path The path of the Process Repository (this can be a UNC path name)

[Text ]

Parameter Function

ReminderAckReminderAuthReminderRevReminderActOverdueAckOverdueAuthOverdueRevOverdueAct

This is the text that is sent to users in SMS notifications, which can bemodified if required.

For example, ReminderAck is the text sent to users to remind them of apending acknowledgement request. OverdueAck is the text sent to usersto inform them of an overdue acknowledgement request.

Synchronizing the Web Server 143


[SMS ]

A SMS service provide is required to send short messages. Multiple SMS service providers canbe specified, however only one may be active at any one time. Contact Nimbus Support forassistance on using multiple SMS service providers.

Parameter Function

Name The name of the service provider (by default Clickatell is specified)

ClsID This is the Web Server ID. Important: Do not change this value

IniFileName The location of the service provider specification data (this can be theSynchronization configuration file)

LogFileName The path and name of the log file that is created (defaults to smssync.logif not specified).

LogAppend Appends to the existing log if set to '1', otherwise it will overwrite theexisting log if set to '0'.

[Clickatell]

By default, Nimbus provides a service provider module for Clickatell. The parameter set forClickatell is as follows:

Note: A Clickatell account is required, which can be obtained from Clickatell.

Parameter Function

API_ID The Clickatell ID (provided by Clickatell)

User The Clickatell username

Password The Clickatell password

From The name that will appear as the sender of SMS notifications

UseGet Set this value to '0'

UseSSL Set this value to '1' to turn SSL on (default), or '0' to turn it off

[Notification]

Notifications can be sent to one or more nominated email addresses, via the Action Server, if anyerrors occur during any synchronization operations.

Parameter Function

Enabled Set this value to '1' to enable email notifications.

Email Specify the email address(es) to send notifications to. Note: Multiple emailaddresses must be separated by semi-colons.

ServerIdentifier Specify a name to identify the Web Server with; this text will appear inany notification emails that are sent out.

Scheduling

Synchronizing the Web Server can be run from the command line, or it can be automatically

http://www.clickatell.com



scheduled using Windows Task Scheduler. It is recommended to schedule this task daily.

Run the following command:<path>/ssync.exe <path of ini file> [<path of log file>] -[optional parameters]

Optional parameters:-search Updates the search database

-measure Updates metrics (measures)

-resources Updates resources in the My Roles page

-links Updates flow line linkage

-regusage Updates Document Registry item usage database

-reviews Updates recurring reviews

-mysearches Updates users' search database

-withdrawndocs Withdraws acknowledgement requests for withdrawndocuments

-reminders Sends out reminder notifications for past due (overdue)To-do items

-acktodos Withdraws acknowledgement requests for users thatare removed from any user groups that are assigned asmandatory users

-mapsclean Removes old maps from the Deleted folder (see notebelow)

-linksclean Removes redundant diagram links (see note below)

-recurringactions Triggers any pending recurring actions

-archiveactions Automatically archives completed actions (see notebelow)

For example:"...\Nimbus Control\Web Server\Utilities\SSync.exe" "...\Nimbus Control\Web Server\Utilities\config.ini" "...\Nimbus Control\Web Server\Utilities\SSyncResults.log" -search -resources -regusage -reviews -withdrawndocs

Note: If no optional parameters are specified then all tasks - except flow line links, DocumentRegistry items, deleted links and deleted maps - will be updated. If a path to the log file is notdefined then it will use the local folder.

Note: The -mapsclean and -linksclean parameters are not run by default. These tasks shouldbe scheduled separately to run on a weekly basis. Note that the maximum number of days tokeep deleted maps is specified in the Maps system options within the Author Client. For the -archiveactions parameter, the number of days before archiving completed actions is defined inthe Action Settings (within the system configuration options in the Author Client). If this is set to'0' then completed actions will not be archived.

Logging

A log file is written to whenever the System Synchronization Utility is run:<Installation directory>\Web Server\Utilities\SSyncResults.log

Synchronizing the Web Server 145


A configuration file allows the level of logging to be defined for maps and diagrams. Add thefollowing lines to the System Synchronization Utility configuration file (<Installation directory\WebServer\Utilities\config.ini):

MapLogging=n (if set to '1' then every map checked for the Search Index and the My SearchesIndex synchronization routine will be logged).

DiagLogging=n (if set to '1' then the GUID of every diagram loaded for the Search Indexsynchronization routine will be logged. Note: If this option is enabled then it will also enablemap logging.

8.7 Monitoring Web Server PerformanceThe Nimbus Control Performance Monitor provides the ability to access some of the internalcounters within the Web Server in order to monitor the behaviour of the application. The plug-inprovides a new counter set called Nimbus Control and contains six counters (Active Sessions,Image Execution Time, Images/Sec, Page Execution Time, Pages/Sec and Queue Length). See Installation\Installing Nimbus Control Performance Monitor for more information.

Related topics

Configuring Web Server Logging

8.8 Restarting, Stopping and Starting the Web ServerChanges to any localisation files and changes to some of the Web Server configuration settings file(e.g. changes to the Home page text and Tabs) will require a restart of the Web Server to updatethe changes. One method is to reset the Internet Information Services (IIS); however, resetting IISwill also reset any other web services that utilize IIS. A Web Server installation includes some Javascripts to restart, start and stop the Web Server.

Restarting a Web Server can be undertaken while users are still logged on; any server requestssubmitted by users will be queued and, since it only takes a moment to restart the server, users willnot really be affected.

To restart the Web Server

Double-click restart.js in the Web Server installation that you want to restart.

To stop the Web Server

Double-click stop.js in the Web Server installation that you want to restart.

To start the Web Server

Double-click start.js in the Web Server installation that you want to restart.

Note: The location of the javascript files is ...\Nimbus Control\Web Server\Reload.



8.9 Managing Nimbus Control ServicesThe Nimbus Control Service Installer allows the Nimbus Control services to be managed.

To manage Nimbus Control services

1. Run ServiceInstaller.exe (found in the Utilities folder on the CD).

There are two tabs:

Services By FolderThis tab displays all Nimbus Control services for a specific installation. Click Browse to select aNimbus Control folder (e.g. <C:Nimbus Control).

Note: If it is not a default installation, i.e. the Action Server is not installed in the Controlfolder, deselect Assume normal Control sub folders.

Currently Installed ServicesThis tab displays all services on the system. If you have multiple installations of Nimbus Controlon a single machine, this information is useful when performing upgrades.

Managing ServicesThe following actions can be executed:

Start and Stop services independently - Select the service and click either Start or Stop.

Uninstall a service - Select the service and click Uninstall.

Toggle the service startup between manual and automatic - Select the service and selecteither Automatic or Manual from the Select Start Options. Click Install/Update to update theselection.

Add a suffix to services - Select the service(s) and in the Enter an identifier to be added tothe service's names text box enter a suffix. Click Install/Update to update the selection.

Related topics

Configuring the Action Server

Managing Nimbus Control Services 147


8.10 Replacing File Link PathsFile link paths, including Excel-based metric links, can be replaced in all maps within a ProcessRepository, regardless of diagram access rights and authorization statuses. This is useful, forexample, if linked files are moved to a new location.

Replacing the paths of file links should be attempted by experienced users only.Document links are not updated as part of the process; links to documents in theDocument Registry can be updated in the Client.

To replace file link paths

1. Run AdminUtil.exe (found in ...\Nimbus Control\Client).2. Click Browse and select the Process Repository that you want to replace file link paths in,

then click Next.3. Enter an administrator's username and password, then click Next.4. From the Edit menu choose File Link Search and Replace.5. In the Search On box enter the path that you want to replace.6. In the Replace With box enter the path that you want to replace with.

Include Metric Links will search and replace file paths for any Excel-based metric links.7. Click OK.

8.11 Enabling Administrator Access to all DiagramsIt is possible for Administrators to be denied access to a diagram when the default permission rightsare set to Access Denied. You can grant access to administrators for all diagrams in the ProcessRepository by creating a .npdta file.

To enable administrator access to all diagrams

1. Create a file called AdminAll.npdta in the root of the Process Repository.

Note: This file can be created in Notepad. Ensure that the .txt extension is not added to the endof the file.

Customization

Chapter 9


Customizing the Web Server 149


9.1 Customizing the Web ServerThere are two documents that will assist you in customizing the Web Server; one concerns theClassic Web Server and the other a SharePoint integration.

Classic Web Server Branding

The Nimbus Control browser interface can be customized, including modifying the general look andfeel, changing the logo, customizing the look of storyboards, redefining the Home page text andadding and removing tabs. The Classic Web Server Branding PDF, that is included in theDocuments folder on the CD, provides information on modifying the interface to give it a corporatelook and feel.

SharePoint Customization Guide

The Nimbus Control site in a SharePoint interface integration can be customized. Most of thecustomization of a Nimbus Control site in SharePoint is configured within the SharePointAdministration environment. The SharePoint Customization Guide PDF, that is included in theDocuments folder on the CD, provides information on modifying the Nimbus Control site to ensure acorporate look and feel.

Troubleshooting

Chapter 10


Troubleshooting the Client 151


10.1 Troubleshooting the Client

Performance is slowCheck the performance of the Process Repository and then contact Nimbus Support. See Maintenance\Checking Performance for more information.

Tables are corruptRepair and rebuild the tables within a Process Repository. See Maintenance\ManagingDatabase Tables for more information.

Access Denied error is displayed when adding an Excel metric link to anactivity

This is usually caused by insufficient DCOM permissions and is normally seen on domaincontrollers, although it is also evident in Windows Server 2003 and in some cases Windows XP.

To rectify this, from a Start Menu run command type dcomcnfg and press Enter. Ensure that theINTERACTIVE user has default launch and access permissions.

10.2 Troubleshooting the Web Server

"You do not have a licence to use this product"This error may be received when users attempt to launch the Nimbus Control web environment.

· Do you have a licence to use the Web Server?In the Nimbus Control Client, from the Help menu choose About. In the LicenceInformation does it state Yes against Web Server? If it states No then you must contactNimbus Support to update your licence to include Web Server access.

· If you do have a licence then are your access permissions set up correctly?The domain user account used to run the Web Server must have access to the ProcessRepository. Ensure that the domain user account used to run the Web Server requires atleast 'modify' permissions on the Process Repository folder.

If using the IUSR and IWAM default accounts for running the Web Server, these will alsoneed at least 'modify' access rights to the Process Repository.

Note: The Web Server needs to be restarted after modifying access rights.

· Is the Control web service extension set to Allowed?You may have to set the CtrlWebISAPI.dll to Allowed. This can be done through IISManager. In the Web Service Extensions, add CtrlWebISAPI.dll (...\Nimbus Control\WebServer\Main) to the list of web service extensions and set it to Allowed.

"Access to the file denied by the file system"This error may be received when users attempt to launch a document in the Nimbus Control webenvironment.

· Are the files/documents stored on a different machine to the Web Server?The domain user account used to run the Web Server must have at least 'Modify' accessrights for the relevant folder(s) on the file server.

· Are the document links using drive mappings as opposed to UNC paths?

Chapter 10 Troubleshooting152


Users' setups might be using different drive mappings, meaning that the Web Server maybe unable to resolve a drive mapping that a specific user has set up. There are two waysaround this:

1. There is a system option that forces UNC paths to be used when files, metric linksand documents are added.

2. Set up path mapping in the Web Server. This means that a particular drive letterpoints to a specific location, allowing the Web Server to resolve the drive mappingto the correct location.

Note: The Web Server needs to be restarted after modifying access rights.

I've increased the session timeout to x minutes, but users are still logged outevery 20 minutesThe default timeout in IIS is 20 minutes, so you must update the Nimbus Control application poolsession timeout to match the value you have set in the Web Server configuration file.

PowerPoint presentations don't openIf Office XP or Office 2007 is installed then users may find that they cannot open somePowerPoint attachments. The only resolution is for users to save the PowerPoint attachment totheir local machine first and then to open it locally.

Remoting does not work as expectedThere are a number of variables that affect remoting the Web Server.

· Check that there are no firewalls or internet security applications that are blocking theconnection from the SharePoint server to the Control Web Server. If these applicationsare in use then check their log files for any applicable entries.

· Ensure that the user account used for the calls is trusted by the Control Web Serverremoting host machine.

· Ensure that the user account used for the NimbusServerHost.exe service, or the loggedon user if running interactively, has access rights to the Control Process Repositoryfolder.

HTTP Error "503 Service Unavailable"If the Web Server is installed on Windows Server 2008 64-Bit, and the RPC Over HTTPcomponent is installed, you may receive a HTTP error '503 Service Unavailable' error.

To rectify this you must edit the applicationHost.config file (System32/inetsrv/config). Find thefollowing line:

<add name="PasswordExpiryModule" image="C:\Windows\system32\RpcProxy\RpcProxy.dll" />

Add preCondition="bitness64" to the end, for example:<add name="PasswordExpiryModule" image="C:\Windows\system32\RpcProxy\RpcProxy.dll" preCondition="bitness64" />

10.3 Troubleshooting the Action Server

Email IssuesSMTP Email usually works without any problems. However, if there are problems it may benecessary to configure the Action Server to ensure that it works properly.

Troubleshooting the Action Server 153


Various scenariosThe following scenarios may require further configuration:

· The Nimbus Control Email service is configured to use the SMTP server, so specify smtp.acme.com in the Action Server configuration file.

· The IIS SMTP virtual server is used to deliver Email, so specify localhost in the ActionServer configuration file and specify the IIS SMTP server to relay localhost.

· The IIS SMTP virtual server is used to relay Email to another SMTP server, which actuallydelivers the Emails, so specify localhost in the Action Server configuration file and specifythe IIS SMTP server to relay localhost. Also, configure the IIS SMTP virtual server toMASQUERADE and use the relay SMTP server as the SMART HOST.

Mail delivery sequenceThe mail delivery sequence is as follows:

· Mail User Agent (Outlook, Eudora, Nimbus Control SMTP client) "passes" the Email to theMail Transport Agent (sendmail, procmail, Exchange) SMTP server for delivery.

· SMTP server optionally "passes" the Email to another SMTP server that will RELAY, i.e.deliver, the Email.

· SMTP Delivery server looks up the delivery address (DNS MX record for domain returnsmail servers for that domain), contacts the SMTP Recipient server and delivers the Email.

Common ProblemsThe following issues may prevent Emails from being delivered:

· If the Return address is not resolvable, i.e. the reverse DNS lookup for MX record for thedomain fails, the SMTP Recipient server will bounce the Email back.

· The From address is not one that the SMTP Delivery server will deliver Email for, unlessthe SMTP server is completely open to relaying Email or certain domains have beenspecified in the SMTP server as being relayable domain.

· When the IIS SMTP server attempts to deliver Email with an IP address that can have areverse DNS lookup performed on it then a significant number of SMTP servers will refuseit and bounce the Email back. This situation is further complicated if the server goesthrough a firewall which is running NAT. This is a common reason why IIS SMTP serverscannot send Email, particularly externally, as a DNS lookup may be performed on the LANbut not on the Internet. Larger organizations are less likely to perform DNS lookups as thisslows down Email servers.

· Firewalls are involved anywhere between the Nimbus Control Email service and the SMTPserver it is using, either directly or indirectly. This can often result in port redirection andNetwork Address Translation (NAT). It is therefore recommended to keep everything onthe same side of the firewall.

Metric IssuesThe Office Integration Service controls metrics in Nimbus Control.

"Metrics aren't appearing in the Web Server and there are multiple instances of Excel runningon the server box"

This is usually caused by the Nimbus Control domain account having launch permission rights butnot access permission rights in DCOM. The domain service account must have the correct access

Chapter 10 Troubleshooting154


rights to the Microsoft Excel Application within DCOM on the box that the Action Server is installedon.

See Installing the Action Server for information on setting DCOM access rights.

List of Action Server ErrorsThe following is a list of error messages that may appear in the Action Server's log files:

Your message did not reach some or all of the intended recipientsThis log entry appears when an email notification fails to send to all recipients.

Cannot connect to server <SMTP Host> (<Error>) This log entry appears when the Action Server is unable to connect to the specified SMTPserver.

The following user(s) could not be added due to exceeding license limitsThis log entry appears during the LDAP synchronization operation if there are more users to addthan available licenses in Nimbus Control.

The following user(s) could not have their user type changed due to exceeding licenselimitsThis log entry appears during the LDAP synchronization operation if there are insufficientlicenses available in Nimbus Control to change the type of existing user account, for examplewhen changing an end user to a process author.

The following user(s) could not be added due to blank last and/or account nameThis log entry appears if the LDAP synchronization operation tries to add a user account with ablank last name and/or account name field.

The following user(s) could not have their last name changed due to blank last nameThis log entry appears if the LDAP synchronization operation tries to update an existing useraccount to have a blank last name.

Incorrect process repository versionThis log entry appears if the Process Repository has been migrated to a new version but anolder version of the Action Server is still running. Or if a new version of Action Server is runningbut the Process Repository has not be updated.

Location of process repository not definedThis log entry appears if the location of the Process Repository has not been defined in theconfiguration file.

Process repository database files not createdThis log entry appears if the Process Repository database files have not yet been created in thespecified Process Repository. The Control Author Client application needs to have been run atleast once to establish all the necessary system tables in the Process Repository.

Connect to LDAP server <server> failedThis log entry appears if the Action Server is unable to connect to the specified LDAP server.

LDAP configuration file could not be foundThis log entry appears if the Action Server is unable to find the required LDAP configuration file.

Cannot load Netscape LDAP DLLThis log entry appears if there was a problem loading the core Netscape LDAP API libraryrequired for performing an LDAP synchronization with NDS.

Cannot load Microsoft LDAP DLLThis log entry appears if there has been a problem loading the core Microsoft LDAP API libraryrequired for performing an LDAP synchronization with NDS.

Troubleshooting the Action Server 155


Could not read version informationThis log entry appears if the version number of existing Action Server services could not bedetermined.

Internal Error <Error>These are general errors capturing issues with accessing database files in the ProcessRepository.

Support and Feedback

Chapter 11


157


Nimbus technical support is on hand to provide support in the planning, deployment, administrationand maintenance of Nimbus Control.

Nimbus Support Website

Alternatively, you can contact support by the following methods:

EMEA

Telephone +44 (0) 23 9241 0352Email [email protected]

07:30 - 20:00 UK Time

AMERICAS

Telephone +1 800 706 1196Email [email protected]

00:30 - 17:00 Pacific Time

CHINA

Telephone +86 10 8263 7807Email [email protected]

09:00 - 17:00 Beijing Time

Support Portal

The Nimbus Support Portal allows users to log direct cases (this is especially useful outside ofsupport hours). You can also request updates, view other cases raised by your company and searchthe Nimbus Knowledge Base.

Please contact Technical Support to request details of the Support Portal.

Feedback

Nimbus welcomes any feedback on supporting documentation; this helps us improve thedocumentation in future releases. Please be as descriptive as possible in your feedback. Click theimage below, or Email [email protected].

http://nimbuspartners.co.uk/services/support.html

http://www.nimbuspartners.com/services/support

mailto:[email protected]






INDEX158

Index- A -Action Server

Configuring LDAP sychronization 95

Configuring SMTP Email 93

Configuring the Action Server 92

DCOM configuration 63

Installation 63

LDAP synchronization logging 96

Managing services 146

Manually backing up data 133

Testing LDAP sychronization 95

Troubleshooting 152

ActiveStrategy integration

Integrating with ActiveStrategy 118

Updating ActiveStrategy metric data 118

Admin Utility

Email lists 136

Archiving maps 139

ASE2CtrlUpdate.exe 118

Authentication 30

LDAP configuration 33

Netegrity SiteMinder integration 41

Windows Integrated Authentication (WIA) 30

- B -Backing up

Automatically backing up data 129

Manually backing up adata 133

BackupConfig.ini 129

Business Intelligence Server

Configuring the Business Intelligence Server 97

Installation 65

Logging 99

Synchronizing 99

Testing 98

- C -Checking a Process Repository 136

Checking maps 136

Email lists 136

Scheduling 136

Client

Installation 21

Troubleshooting 151

Cognos Metrics Manager integration 114

Cognos2CtrlUpdate.exe 114

Configuration

DCOM 24

IIS 24

LDAP 33



Creating users and user groups 102

CtrlBackupUtil.exe 129

Customizing the Web Server 149

- D -Data

Automatically backing up data 129

Manually backing up data 133

Data tables

Importing 126

DCOM configuration

Action Server 63

Web Server 24

Deletion Recovery Manager 136

Directory service integration 30

Document Registry

Integrating with a SharePoint document library 62

- E -Email

SMTP configuration 93

Troubleshooting 152

Email lists 136

Enabling administrator access to all diagrams 147

Excel

Creating SQL queries 109, 111

Defining Excel data ranges 109, 111

Scheduling Excel macros 109

ExcelMacroLauncher.exe 109

Exporting

Exporting data to a database 108

Exporting diagrams as HTML 106

Exporting diagrams as XML 107

External help integration 87

- F -File link paths

Replacing 147

159INDEX

Fixing database tables 140

- G -Generic portal integration

Integrating with generic portals 122

- H -HTML

Exporting diagrams as HTML 106

- I -IIS configuration

Web Server 24

Importing

Importing data tables 126

Resources 103

User roles 103

Installation

Client 21

Installing the Action Server 63

Installing the Business Intelligence Server 65

Installing the Windows Server PerformanceMonitor Plug-in 66

Uninstalling Control 67

Web Server 24

- L -LDAP

Configuring LDAP synchronization 95


Testing LDAP synchronization 95

LDAP configuration 33

Licensing 14

Lock Service 133

Logging

Business Intelligence Server 99

LDAP synchronization 96

SMTP logging 94

Web hit logging 89

Web page hits 88

Web Server logging 88

- M -Managing database tables 140

Managing services 146

Metrics

Creating SQL queries 109

Defining SAP BW report links 112

Integrating with ActiveStrategy 118

Integrating with Cognos Metrics Manager 114

Integrating with Microsoft Office BusinessScorecard Manager 114

Integrating with Microsoft OfficePerformancePoint 116

Integrating with SAP BW 112

Integrating with SAP NetWeaver BI 112

Scheduling and updating SQL queries 111

Scheduling Excel macros 109

Updating ActiveStrategy metric data 118

Updating Cognos Metrics Manager data 114

Updating Microsoft Office PerformancePoint data 116

Updating SAP BW data 112

Updating SAP NetWeaver BI data 112

Microsoft Office Business Scorecard Managerintegration 114

Microsoft Office PerformancePoint integration 116

Migration 16

MIME mappings 87

Monitoring Web Server performance 145

- N -Netegrity SiteMinder 41

Notifications 136

Novell File Server integration

Integrating with a Novell File Server 120

- O -OpenText Document Management 126

OpenText LiveLink 126

- P -Page hit logging 88, 89

Performance checking 136

PerformancePoint2CtrlUpdate.exe 116

Process Repository

Sharing (Important Note) 21

- R -Recovering deleted maps and diagrams 136

Replacing file link paths 147

Resources

INDEX160

Resources

Importing 103

Restarting the Web Server 145

- S -SAP integration

Integrating with SAP BW 112

Integrating with SAP NetWeaver 119

Integrating with SAP NetWeaver BI 112

Registering SAP Solution Manager 125

Updating SAP metric data 112

SAP Solution Manager

Registering 125

SAPBW2CtrlUpdate.exe 112


Security


Service Installer 146

SharePoint

Adding Control Web Parts 56

Integrating with a document library 62

Upgrading a Control SharPoint user interfaceintegration 55

Single-sign on 30

Configuring LDAP synchronization 95

LDAP 33



Testing LDAP synchronization 95


SMTP Email configuration 93

SQL Query Manager 111

SQL2CtrlUpdate.exe 111

SSync.exe 99

Starting the Web Server 145

Stopping the Web Server 145

Synchronization Utility 99

Synchronizing

Synchronizing the Business Intelligence Server 99

- T -Testing


tibbr integration 126

Troubleshooting

Action Server 152

Client 151

Web Server 151

- U -Uninstalling Control 67

Upgrading 16

Important notes 15

Upgrading a Web Server 19

User roles

Importing 103

Users

Configuring LDAP sychronization 95

Creating users and user groups 102

Importing resources 103

Importing user roles 103

LDAP 33



Testing LDAP sychronization 95

User account system options 102

User group permissions 102


- W -Web hit logging 89

Web Server

Configuration 71

Configuring MIME mappings 87

Configuring the Welcome page 87

Customizing 149


IIS configuration 24

Installation 24

Integrating with External help 87

Monitoring performance 145

Page hit logging 88

Restarting, stopping and starting 145

Synchronizing 142

Troubleshooting 151

Upgrading 19

Web hit logging 89


Web Server configuration

LDAP 33



Web Server installation


IIS configuration 24


Welcome Page configuration 87

161INDEX


Windows Server Performance Monitor Plug-in 145

Installation 66

Workflows

Integrating with workflow applications 124

- X -XML

Exporting diagrams as XML 107