Administration Guide - TIBCO Product Documentation · About the Administration Guide 7 1.1 About the Administration Guide This guide is designed to provide TIBCO Nimbus™ 9 administrators

TIBCO Nimbus

Administration GuideSoftware Release 9.5.2October 2015

TM

Important Information

TIBCO Nimbus Administration Guide

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO

SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED

TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER

TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT

FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE

AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF

THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT

OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE LICENSE FILE(S) OF THE SOFTWARE. USE OF

THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF

AND AN AGREEMENT TO BE BOUND BY THE SAME.

This document contains confidential information that is subject to U.S. and international copyright law s and treaties. No part of this

document may be reproduced in any form w ithout the w ritten authorization of TIBCO Softw are Inc.

TIBCO, Tw o-Second Advantage and TIBCO Nimbus are either registered trademarks or trademarks of TIBCO Softw are Inc. in the

United States and/or other countries.

All other product and company names and marks mentioned in this document are the property of their respective ow ners and are

mentioned for identif ication purposes only.

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM

PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE RELEASE NOTE FOR THE

AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.

THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT

LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.

THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY

ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO

SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN

THIS DOCUMENT AT ANY TIME.

THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER

DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ

ME" FILES.

Copyright © 1997-2015 TIBCO Softw are Inc. ALL RIGHTS RESERVED.

TIBCO Softw are Inc. Confidential Information

3Contents


Table of Contents

Introduction.................................................................................................................... 7About the Administration Guide

.................................................................................................................... 8About TIBCO Nimbus

Installation.................................................................................................................... 12Planning

.............................................................................................................. 12Installation Planning

.................................................................................................................... 12Upgrading from Previous Releases

.............................................................................................................. 12Migrating data from a previous version

.............................................................................................................. 17Migrating Web Server settings

.................................................................................................................... 19Installing the Client

.................................................................................................................... 22Installing the Web Server

.................................................................................................................... 29Configuring Authentication

.............................................................................................................. 29Configuring LDAP Integration

.............................................................................................................. 39Configuring SSO via Windows Authentication (IWA)

.............................................................................................................. 41Configuring SSO via Netegrity SiteMinder Authentication

.................................................................................................................... 43Integrating TIBCO Nimbus with SharePoint

.............................................................................................................. 44Creating a SharePoint Integration

.............................................................................................................. 54Upgrading a SharePoint Integration

.............................................................................................................. 54Adding Web Parts to other SharePoint sites

.............................................................................................................. 61Integrating with a SharePoint document library

.................................................................................................................... 62Installing the Action Server

.................................................................................................................... 64Installing the Business Intelligence Server

.................................................................................................................... 65Installing the TIBCO Nimbus Performance Monitor

.................................................................................................................... 66Installing the TIBCO Nimbus Batch Server

.................................................................................................................... 66Uninstalling TIBCO Nimbus

Security.................................................................................................................... 68Securing a Process Repository

Configuration.................................................................................................................... 70Web Server Configuration

Administration Guide4


.............................................................................................................. 70Configuring the Web Server

.............................................................................................................. 84Configuring MIME mappings

.............................................................................................................. 84Configuring Web Server Logging

.............................................................................................................. 84Configuring Page Hit Logging

.............................................................................................................. 85Configuring Web Hit Logging

.................................................................................................................... 89Action Server Configuration

.............................................................................................................. 89Configuring the Action Server

.............................................................................................................. 90Configuring SMTP Email

.............................................................................................................. 91Configuring SMTP Logging

.............................................................................................................. 91Configuring LDAP Synchronization

.............................................................................................................. 91Testing LDAP Synchronization

.............................................................................................................. 92Configuring LDAP Synchronization Logging

.................................................................................................................... 94Business Intelligence Server Configuration

.............................................................................................................. 94Configuring the Business Intelligence Server

.............................................................................................................. 95Testing the Business Intelligence Server

.............................................................................................................. 95Synchronizing the Business Intelligence Server

.............................................................................................................. 96Configuring Business Intelligence Server Logging

User Management.................................................................................................................... 98Creating Users and User Groups

.................................................................................................................... 99Importing Resources

.................................................................................................................... 100Importing User Roles

Administration.................................................................................................................... 102Importing and Exporting Data

.............................................................................................................. 102Exporting Diagrams as XML

.............................................................................................................. 103Exporting Data to a Database

.............................................................................................................. 104Importing Data Tables

.................................................................................................................... 105Metric Configuration

.............................................................................................................. 105Updating Excel Macros

.............................................................................................................. 105Creating SQL Queries

.............................................................................................................. 107Scheduling and Updating SQL Queries

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

.............................................................................................................. 110Integrating with Cognos Metrics Manager

.................................................................................................................... 112Integrating with Third-party Applications

5Contents


.............................................................................................................. 112Integrating with SAP NetWeaver

.............................................................................................................. 113Integrating with Generic Portals

.............................................................................................................. 118Integrating with OpenText Document Management

.............................................................................................................. 118Integrating with tibbr

Maintenance.................................................................................................................... 120Recovering Deleted Maps and Diagrams

.................................................................................................................... 120Purging Deleted Content

.................................................................................................................... 120Checking Performance

.................................................................................................................... 121Checking Maps

.................................................................................................................... 124Backing Up Data

.............................................................................................................. 125TIBCO Nimbus Backup Utility

.............................................................................................................. 127Third-party Backup utilities

.................................................................................................................... 129Archiving Maps

.............................................................................................................. 132Creating Archives

.............................................................................................................. 133Restoring Archives

.................................................................................................................... 135Managing Database Tables

.................................................................................................................... 137Synchronizing the Web Server

.................................................................................................................... 140Monitoring Web Server Performance

.................................................................................................................... 140Restarting, Stopping and Starting the Web Server

.................................................................................................................... 141Managing TIBCO Nimbus Services

.................................................................................................................... 142Replacing File Link Paths

.................................................................................................................... 142Viewing Map Paths

.................................................................................................................... 142Enabling Administrator Access to all Diagrams

Customization.................................................................................................................... 145Customizing the Web Server

Support and Feedback

Introduction

Chapter 1

Administration GuideTIBCO Nimbus

About the Administration Guide 7


1.1 About the Administration Guide

This guide is designed to provide TIBCO Nimbus™ 9 administrators with information on performing thefollowing tasks:

Installing components of the TIBCO Nimbus suite, including migration of data from previous majorversions

Configuring components of the TIBCO Nimbus suite

Managing TIBCO Nimbus users

Administering the TIBCO Nimbus suite

Maintaining the TIBCO Nimbus suite.

Audience The intended audience for this guide includes:

IT staff responsible for providing the technical infrastructure in which the TIBCO Nimbus suite isdeployed

IT staff responsible for the setup of TIBCO Nimbus

The nominated TIBCO Nimbus administrators responsible for the day-to-day management of the TIBCONimbus suite.

Chapter 1 Introduction8


1.2 About TIBCO NimbusTIBCO Nimbus is a software suite designed to enable organizations to capture, analyze and communicate acommon set of processes that can be used to manage an organization. The suite consists of five primarycomponents:

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

Web ServerThe Web Server allows users to access and collaborate on data, anywhere across the internet or corporateintranet. It runs as a standalone application that interacts with IIS using a small ISAPI extension that serves toredirect the requests to the application. The Web Server can also be integrated into a SharePoint solution.

Action ServerThe Action Server runs as five separate Windows-based services in the background - Email, Lock, OfficeIntegration and LDAP services. The primary tasks are to act as the TIBCO Nimbus Email Server by utilizingbasic SMTP services to provide a gateway into a corporation's Email system, and to integrate with DirectoryServices.

Business Intelligence ServerThe Business Intelligence Server provides the ability to send SMS text messages and Email notifications whendefined measures are breached.

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

Batch ServerThe TIBCO Nimbus Batch Server is a separate utility that handles various operations outside of the AuthorClient, such as the promotion of draft content and assigning reviewers, requesting reviews, unlockingdiagrams and assigning diagram access rights in the web. This allows the processes to be streamlined andmanaged from a server instead of a user's PC. This method also safeguards data integrity as it prevents usersfrom terminating the operation midstream on their PC.

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

Process RepositoryThe process repository is a folder in the file system that holds the process diagrams and allprocess-related information (resources, metadata, access rights). It consists of a number of flatfiles and DBISAM database tables and index files. For more information see 'How is data stored'below.

About TIBCO Nimbus 9


The Document RegistryThe Document Registry is a document management system that holds supporting files related toprocesses (forms, media files, templates, spreadsheets, application links, policy documents, etc).

Business Intelligence RepositoryThe Business Intelligence Repository tracks trend data for the key metrics in order to producegraphs and launch alerts.

How is data stored?TIBCO Nimbus stores all data and process content generated by authors in the Process Repository folder inthe Windows file system. All tables and other files are organized in different sub-folders within the ProcessRepository folder. Note that the Process Repository folder can be secured by preventing unauthorized accessoutside of the software. Please refer Securing a Process Repository for more information.

The TIBCO Nimbus software uses the ElevateDB embedded database engine for the table, index and otherdatabase-related files. The system data, process content and other files are optimized for the TIBCO Nimbussoftware to help maximize performance based on the type of data that is stored and the access profile.

Each process map is stored in a separate folder inside the Maps folder in the Process Repository folder. Eachmap is uniquely identified via a 32 hexadecimal GUID code, for example C1661023902543058AF18DD1E9476326. A map's GUID is used as the name of the folder for where the mapis stored. This allows authors to easily rename the map without requiring changes to the folder structure inthe Process Repository. A number of ElevateDB table files and other data files are stored in each processmap folder. For example, the Diagrams files are the database files used for storing all diagrams within aprocess map.

To prevent exceeding character limits within the Windows file system, process map folders are strippedwithin sub-folders based on the first two characters of a map's GUID code. For example, if the map GUID isC1661023902543058AF18DD1E9476326 then it will be stored inside a sub-folder called 'C1' inside the Mapsfolder. The GUID for a process map can be viewed in the 'Physical Path' field in the 'Where Am I' dialog(accessible from the Map menu in the TIBCO Nimbus Author Client application. HistoryIn v9.0.0, v9.0.1 and v9.1.0 of TIBCO Nimbus the same folder structure was used, however the DBISAMembedded database engine was used for all the database table files. In TIBCO Nimbus v9.2.0, the embeddeddatabase engine was upgraded to ElevateDB, which fully supports Unicode and therefore allows for all multi-byte characters to be used throughout the generated process content. The TIBCO Nimbus 9.1 to 9.2 migrationutility automatically migrates all DBISAM database table files up to the ElevateDB database table format.

In v8.1.5 and earlier releases of the software the embedded DBISAM database engine component was usedand the process maps were stored in separate folders, however the folder names were based on the actualnames of process maps. This prevented process maps from being easily renamed because the folder namewould also need to be renamed, which required all files to be closed and not in use by any other instance ofthe TIBCO Nimbus software, including the TIBCO Nimbus Web Server application. This was too limiting inlarge deployments of the TIBCO Nimbus software. The TIBCO Nimbus 8.1 to 9.0 migration utilityautomatically restructures all process map folders in the Process Repository from being based on the actualname of the process map to be based on the GUID of the process map.

Advisory

Chapter 1 Introduction10


It is extremely important that no changes are made to the Process Repository files outside of the TIBCONimbus software. Any changes to the files may cause data corruption and potentially result in data loss andinstabilities in the TIBCO Nimbus software. The Admin Utility, supplied with the TIBCO Nimbus software,allows database tables and other files to be examined, repaired and potentially modified in some cases. Ifyou are planning on modifying any database tables and other files in this manner, please contact TIBCONimbus Support to provide assistance in all cases when using the TIBCO Nimbus Admin Utility.

Installation

Chapter 2


Chapter 2 Installation12


2.1 Planning

2.1.1 Installation Planning

For information on planning the installation of the TIBCO Nimbus suite, including hardware and softwarerequirements, sizing requirements and deployment options, please refer to the Installation Planning Guidethat can be downloaded from TIBCO's Documentation site (https://docs.tibco.com).

2.2 Upgrading from Previous ReleasesIf a previous major version of TIBCO Nimbus is installed, the data within the current process repository mustbe migrated to the latest version before it can be used with the TIBCO Nimbus suite.

2.2.1 Migrating data from a previous version

Before upgrading from a previous major version to the latest version, you must first migrate the processrepository. A process repository is essentially a data folder in the file system which holds process diagramsand other process-related information. During the migration process, the existing table structures in theprocess repository are converted in order to make them compatible with the latest release. Following themigration process the latest version can then be installed.

Archived MapsArchived maps will be converted to the new format as part of the migration process and will be accessibleto users as they were in the old version. However, any compressed static archived maps (.arc) will not beupgraded to the latest version. Instead you will be prompted to select a backup folder to automaticallymove these files into during the migration. Since .arc files cannot be upgraded, access to compressedarchived maps is only available by maintaining the old version of TIBCO Nimbus with the old processrepository.

Prerequisites

Before migrating a process repository, the following points should be considered and the relevant actionstaken:

Prevent users from accessing the process repositoryTo allow you to back up your process repository and migrate the data to the new format, all users must belogged out of the Author Client and the web server.

Author Client. You can view if any users are still active in the Author Client (from the Tools menuchoose Users, then Active Users). Web Server. To prevent users from accessing the web server, the web server must be stopped.See Restarting, Stopping and Starting the Web Server for information on stopping the TIBCONimbus web server.

Stop TIBCO Nimbus servicesIn order to ensure a consistent backup, all TIBCO Nimbus services must be stopped before running abackup. See Managing TIBCO Nimbus Services for information on stopping TIBCO Nimbus services.

https://docs.tibco.com

Upgrading from Previous Releases 13


Stop TIBCO Nimbus scheduled tasksNo scheduled tasks, such as the System Synchronization utility (ssync.exe) should be running on theprocess repository.

Back up your dataBefore proceeding with migrating your data, it is strongly advised to take a complete backup of yourexisting process repository. This allows you to roll-back if any problems occur. See Backing Up Data formore information on how to obtain a consistent copy of a process repository.

Note: The Deleted Maps folder is emptied during the migration process. If you wish to retain this datain the old version format, you must ensure that this folder is backed up too. The default location is<Process Repository directory>\Deleted.

Delete the cache folderTo ensure you have any improvements to the indexing of the web server's cache table, when upgrading tothe latest version it is advisable to delete the current Cache folder. The web server must be stopped first.When the web server is restarted, the Cache table will be rebuilt. The default location is <Installationdirectory>\Cache.

Migrating a process repositoryThe following steps detail how to migrate a process repository.

1. Download the latest version of TIBCO Nimbus.2. Create a new folder in which to install the new version of TIBCO Nimbus.

For example: C:\TIBCO Nimbus

Before copying the process repository you must ensure there are no users currently logged into either the Author Client or the web server. Please refer to the prerequisites above for moreinformation.

3. Copy the existing Process Repository, Scorecard Repository, Process RepositoryATTACH, and any otherdata folders that you've created, into the folder created in Step 2. Copying them ensures that the existingdata is still available if a roll-back is required.

4. Restrict the permission on the previous installation folder to allow only those users that require access toaccess it.

5. Run the appropriate migration tool.

The migration tools are found in the Utilities folder on the downloaded image:

Existing Version Migration Tool (to use)

TIBCO Nimbus 9.4.x CtrlMigration94To95.exe



Nimbus Control 9.1.x CtrlMigration91To92.exe





Notes: When migrating the process repository, you will be presented with the option to change the savelocation for archived maps and to set the default time zones for actions.

It should also be noted that from v8.1, acknowledgment requests are handled differently. If you aremigrating a process repository from 8.0 or earlier, an Acknowledgment Migration Impact Assessmentstep will require your action. The choice you make will be dependent on the extent to which you use andenforce acknowledgment requests. Click Help on the window for further information.

6. Select Upgrade TIBCO Nimbus Process Repository, then click Next.7. Click Browse and select the process repository that you copied in Step 3, then click Next.8. Enter the user name and password of a TIBCO Nimbus administrator, then click Next.9. Confirm you have backed up the process repository by clicking Next.10. Select whether to migrate any compressed and live non-compressed map archives, then click Next.

Note: This step only applies when migrating a v9.2 process repository and above.

11. Click Start to begin migrating the process repository. Each of the required tools will run consecutivelyuntil the data has been migrated to the latest version.

Post Migration

Once you have migrated the process repository you can install the TIBCO Nimbus suite.Install the Client into the new folder structure created in Step 2.

If access to the previous web server is still required, rename the IIS virtual directory name (e.g. to'TIBCONimbus900').

Install the web server using the previous virtual directory name (by default this is NimbusControl).

Install all other components and integrations, as required.

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

Remove scheduled tasks from Windows Task Scheduler on the server (see Windows Scheduled Tasksbelow for more information).

Windows Scheduled TasksFrom version 9.3, scheduled tasks will be managed by the Nimbus Batch Server. During migration, anyscheduled tasks that exist in the process repository will be copied to the Nimbus Batch Server. After themigration has finished, you can compare the timings of the scheduled reports in TIBCO Nimbus to thetimings in Windows Scheduled Tasks. If the timings match then the original tasks in Windows TaskScheduler can be removed from the server.

Additional Notes:Users will be able to access the new web server using the same URL as before; however users requiringaccess to the previous web server will require the updated URL using the renamed virtual directory.

Network client users will require a new desktop shortcut.

Usually there is no requirement to re-license the suite as the license details are migrated as part of themigration process. However, prior to the release of version 9, the license code format was different andtherefore migration from version 8 or earlier will require a new license code to be requested.



Upgrading Packaged MapsIf you have any packaged maps from v9.3.0 or earlier, they must be migrated to the latest release before youcan unpackage them into the migrated process repository.

1. Run the migration utility that matches the version the map was packaged in and choose UpgradePackaged Maps.

For example, if the packaged map was created in version 9.0.x, run CtrlMigration90To91.exe.

2. Next, run the subsequent migration utilities in order and up to the current migration utility.

For example, if you ran CtrlMigration90To91.exe in step 1, run CtrlMigration91To92, thenCtrlMigration92To93, then CtrlMigration93To94 and finally CtrlMigration94To95.

Note: As you work through the migration utilities, you will be requested to choose the default time zoneand specify where to get the time zone from (either from the current computer or from the old processrepository).

Upgrading Packaged Statement SetsPackaged statement sets from v9.3 are not required to be migrated to the latest version in order tounpackage them into the migrated process repository. However, if you have statement sets that werepackaged before v9.3 then you must upgrade them by following the relevant instructions below.

Upgrading v9.2 packaged statement sets

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


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


1. Run CtrlMigration90To91.exe.2. Select Upgrade Packaged Statement Sets, then click Next.3. Click Browse and select the SPK file to upgrade, then click Next.4. Click Start.5. Repeat steps 1 to 4 using CtrlMigration91To92.exe.

Upgrading Packaged StoryboardsIf you have any packaged storyboards from v9.3.0 or earlier, they must be migrated to the latest releasebefore you can unpackage them into the migrated process repository.

1. Run the migration utility that matches the version the storyboard was packaged in and choose UpgradePackaged Storyboards.



For example, if the storyboard package was created in version 9.0.x, run CtrlMigration90To91.exe.

2. Next, run the subsequent migration utilities in order and up to the current migration utility.

For example, if you ran CtrlMigration90To91.exe in step 1, run CtrlMigration91To92, thenCtrlMigration92To93, CtrlMigration93To94 and finally CtrlMigration94To95.



2.2.2 Migrating Web Server settings

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

Note: The old settings are backed up and stored in '...\Documents andSettings\<User>\TEMP\TIBCONimbus Upgrade'. It is advisable to delete the old Cache folder whenupgrading to a new version of the Web Server. See Migrating a process repository for more information.

Migrating settings before installing a new Web Server

You can run the TIBCO Nimbus Web Server Upgrade Utility before installing the new Web Server. This methodwill allow you to install the Web Server and migrate the settings from an existing Web Server in oneoperation.

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 configuration settings file.

Include Skin will merge any changes in the Skin.html. Note: Skin.html is found in ...\TIBCONimbus\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 old version.

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 existing WebServer using the TIBCO Nimbus 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 configuration settings file.

Include Skin will merge any changes in the Skin.html. Note: Skin.html is found in ...\TIBCONimbus\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 old version.

5. Click Next.

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

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



2.3 Installing the ClientThis topic describes how to install the TIBCO Nimbus Client. For more information on the Client, includingsoftware and hardware requirements and sizing, see the Installation Planning Guide that is included in theDocuments folder on the installation CD.

Note: iSCSI is not supported over TCP/IP.

Prerequisites

120MB of disk spaceIf upgrading from a previous version there must be no users currently using the old version. You mustalso migrate the process repository before installing TIBCO Nimbus. See Upgrading a ProcessRepository 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 includesimportant information about disabling SMB2.x and Opportunistic Locking on Windows Server2008/2008 R2 to avoid potential data corruption.

Installing 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 click ClientInstallation.

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, read the warning and take any necessarysteps. Click Next to proceed.

4. [License Agreement] Ensure that you read the license agreement, then click Yes to accept it or No toterminate 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 can then bedistributed between users who will then have access to the TIBCO Nimbus Client over the network.

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

6. [Choose Destination Folder] The location in which the Client is installed will default to ...\TIBCO Nimbus.To change location, in the Destination Folder panel click Browse to select a location in which to installthe Client. To change the location of the process repository, deselect Use default sub-folder for ProcessRepository and click Browse in the Existing Process Repository panel to specify a location to install theprocess repository in. Click Next to proceed.

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



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 repository and anyassociated data folders. End users require Read access only.

If you are planning to share the process repository then you must share a higher level folderand not the actual process repository folder, otherwise users may not be able to access folderson the same level as the process repository, such as process repositoryATTACH and processrepositorycred.

What Next...

Run the Client for the first time

Administrator AccountWhen you run the TIBCO Nimbus author client for the first time you will be prompted to create anadministrator account.

Note: If you plan to use LDAP then use the same account as the administrator account that will becreated in the TIBCO Nimbus Admin LDAP group, otherwise this account will be deleted whensynchronizing with LDAP.

Secure the process repository

Securing the process repository will prevent users from editing or deleting any of the file structure of theprocess 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 the executableshortcut and then distribute it to the users that require access to the Client. To create a networkexecutable shortcut, follow the steps above but select Network Client in Step 5 [Setup Type]. If the Clientis 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 repository anddefined 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 to providetheir credentials once they are logged into their organization's network.

See Installation\Configuring Authentication for more information.

Create User Accounts and User Groups

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

See User Administration in the Administration section of the Client Help for more information.

Installing the Client 21


Related topics

Importing resources

Importing roles

User Management



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

Summary

Set up IIS

Install the Web Server

Modify DCOM permissions

Modify TIBCO Nimbus Host.exe COM+ object

Modify folder and file access rights

Allow the Web Server ISAPI extension

Configure IIS

Migrating Web Server SettingsThis section describes installing a new Web Server with default configuration settings. If you have anexisting version of the Web Server installed and you want to keep the configuration settings, you caninstall the Web Server and migrate the settings in a single operation. See Migrating Web Server settingsfor information on how to do this.

Prerequisites

The Installation Planning Guide has been read.120MB of disk space.The TIBCO Nimbus Author Client is installed and has been run against the process repository at leastonce. The process repository is in a location that is accessible to the Web Server.A TIBCO Nimbus domain service account has been created. This account is used to run all TIBCONimbus services and requires access to the various TIBCO Nimbus folders. The account does notrequire administration rights and the password should be set to 'never expire'. Further information oncreating a TIBCO Nimbus domain service account is available in the Installation Planning Guide(included on the CD and with the media image).

Installing the Web Server as a SharePoint solutionIf you integrating the Web Server into a SharePoint solution, please follow the instructions in IntegratingTIBCO Nimbus with SharePoint.

Setting up IIS

The Web Server requires IIS and ISAPI extensions (unless you are setting up a remote connection, for examplewhen integrating the Web Server with a remote SharePoint installation). IIS and ISAPI extensions are notinstalled on Windows Server 2003, Windows Server 2008 or Windows Server 2012 by default and thereforemust first be installed.

Installing the Web Server 23


Windows Server 2003

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

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

Windows Server 2008/R2 and 2012/R2

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.5. Click Next, and then click Install.

Note: The account under which the IIS process runs must have full access to all areas of the processrepository.

Installing the Web Server


If using physical media, insert the CD and click Enterprise Server Installation.OR

If using an electronic image, 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 warning message.The Web Server can be installed on a non-server machine, however you will not receive thebenefits that a server has to offer, such as being able to support multiple connectionssimultaneously.


3. [Choose Destination Folder] The location in which the Web Server is installed will default to the locationof the Client installation. To change location, in the Destination Folder panel click Browse to select alocation in which to install the Web Server. To change the location of the process repository at this stage,deselect Use default sub-folder for Process Repository and click Browse in the Existing ProcessRepository panel to locate the process repository.

Note: The path of the process repository can be changed at any time by editing the Web Serverconfiguration file (see Web Server Configuration for more information).

Click Next to proceed.

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

Web Server Site - choose the site to install the Web Server to. If selecting a different Web site fromthe default, you must ensure that the site is correctly configured.

Virtual directory name - specify the virtual directory name. This is the name that users will see in the



browsers as the path of the application and the name that appears in IIS Manager.5. [Setup Program Manager Group] Select the Program Manager group that the Web Server will be added

to; either select an existing group or accept/rename the default name.


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

Configuring DCOM security

DCOM permissions must be configured to allow the various components of the Web Server to communicate.The Network Service account requires Local Access permission rights and Local Launch and Local Activationpermission rights for both IIS 6 and IIS7/7.5.

Note: If you are implementing Single-sign On (Integrated Windows Authentication) you can use either theNetwork Service or IWAM account to provide default Launch, Activation and Access rights. If LDAP is beingused then you must provide the six default LDAP groups with this access.

Modifying the TIBCO Nimbus Host.exe COM+ identity

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

1. Run Component Services.2. Expand Computers>>My Computer>>DCOM Config.3. Right-click TIBCO Nimbus ES Web Server Host and choose Properties.4. Click the Identity tab.5. Select This user, then enter the TIBCO Nimbus domain service account details.



Modifying access to the Web Server folders and files

The access rights of all folders and files within C:\TIBCO Nimbus\Web Server\Main needs to be set to allow Read access for all TIBCO Nimbus users. If management of users via LDAP synchronization is used it isrecommended that the TIBCO Nimbus LDAP groups are used to provide this access.

Read/write access to the following folders must also be enabled for the TIBCO Nimbus domain serviceaccount, which the Host.exe process runs under:

...\TIBCO Nimbus\Process Repository\

...\TIBCO Nimbus\Process Repository\Temp

...\TIBCO Nimbus\Web Server\Reload

Allowing the Web Server ISAPI extension

Unless ISAPI extensions are enabled by default, you must add and allow the TIBCO Nimbus ISAPI extension tothe list of allowed executable extensions in IIS. Note: The CtrlWebISAPI.dll is found in {Installation}\WebServer\Main.

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

IIS7/7.5/8/8.5In IIS Manager, click the name of the server. In Features View, double-click ISAPI and CGI Restrictions. In theActions pane, click Add. In the ISAPI or CGI path text box, enter the path of the CtrlWebISAPI.dll, or clickBrowse to select it. Check Allow extension path to execute and click OK.

Configuring IIS

In Windows Server 2003, Windows Server 2008/R2 and Windows Server 2012/R2, IIS manages virtualdirectories in application pools. Each pool has its own properties that can be configured and single pools canhost multiple virtual directories. When TIBCO Nimbus is installed it looks for an application pool called TIBCONimbus Pool. If it does not exist then it is created as part of the installation process. The TIBCO Nimbusvirtual directory is created in the same way and is assigned to the TIBCO Nimbus application pool.

Note: The Network Service account must have anonymous access to the TIBCO Nimbus application pool (inWindows Server 2008 R2 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 of theinstallation process. If enabled, the Front Page Server extensions must be disabled manually. For moreinformation, refer to the Web Server Installation Planning section in the TIBCO Nimbus InstallationPlanning Guide (included on the installation CD).

How to configure access to the Web Server when the process repository resides on a differentserver

When installing the Web Server, the local machine's IIS IUSR account is set to be used for anonymousaccess by default. This account does not have access to files on other machines, therefore when theprocess repository is on a different server, the TIBCO Nimbus domain service account must be usedinstead. In IIS Manager, ensure that Enable anonymous access is enabled for the web site that ishosting the TIBCO Nimbus virtual directory and specify the TIBCO Nimbus domain service accountdetails.



Note: If you are implementing Single-sign On/Integrated Windows Authentication then you mustdisable Enable anonymous access and enable Integrated Windows authentication. See ConfiguringAuthentication for more information on enabling Single-sign On.



TIBCO Nimbus iPhone AppIf you intend for users to access video files through the TIBCO Nimbus Player iPhone Edition app(downloadable from the Apple App Store and available for the iPad, iPhone and iPod) then you must ensurethat the relevant MIME types are configured on the server (for example .mp4, .mov, .m4v, etc). MIME typesneed to be configured either on a per-site basis, or server-wide.

What Next...

Enable Single-sign OnTo allow users to log in to the Web Server automatically, i.e. without having to provide their credentialsonce they are logged in to the network, Windows Integrated Authentication must be enabled. See Configuring Authentication for more information.

Configure the Web ServerThere are many configuration options which define how the Web Server works. These parameters aredefined in the Web Server configuration file. See Configuring the Web Server for more information.

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 Synchronizing the Web Server for more information.

Customize the Web ServerThere are a number of ways in which to customize the look and feel of the Web Server. See Customizingthe Web Server for more information.

Related topics

Integrating TIBCO Nimbus with SharePoint



Configuring the Web Server

Configuring Authentication

Upgrading a Web Server



2.5 Configuring AuthenticationTIBCO Nimbus supports Integrated Windows Authentication (IWA) and Netegrity SiteMinder to provide Single-sign On (SSO). This allows users to automatically log in to TIBCO Nimbus without having to provide anycredentials once they are logged on to the network via their PC.

Lightweight Directory Access Protocol (LDAP) integration is also supported. Whilst not required by IWA, LDAPensures user names and passwords match in both the directory service and in TIBCO Nimbus.

2.5.1 Configuring LDAP Integration

TIBCO Nimbus can use Lightweight Directory Access Protocol (LDAP) to integrate with a central directoryservice database in order to manage user accounts and user groups, with passwords being authenticatedagainst the directory service.

Prerequisites

The LDAP Synchronization Service is installed. This is part of the Action Server (see Installing theAction Server for more information).Six user groups are predefined in the directory services environment (see TIBCO Nimbus DefaultSystem User Groups below for more information).

TIBCO Nimbus Default User Groups

There are six default user groups within TIBCO Nimbus and the corresponding groups must be defined in thedirectory services environment. These default groups can have any name, provided that the distinguishednames of the groups are configured correctly in the LDAP configuration file to match up with the directoryservices. These groups will define who has access to the TIBCO Nimbus environment and what their licensedrole is.

Main GroupsAll TIBCO Nimbus users must exist in one of the following three main system user groups:

Administrators (provides users with administrative functions and access to all areas of TIBCO Nimbus).Authors (provides users with the ability to create, edit and manage process content in a processrepository).End Users (provides users with access to the Web interface only, users cannot create or edit processcontent).

Module GroupsEnd users can be put into one or more module groups to grant them additional capabilities.

End User with Change Module (allows users to assist in change management, includingauthorizations, reviews, promotions, etc).End User with Action Module (allows users to access action management functionality, includingviewing actions, undertaking actions, creating and editing actions).End User with Mobile Module (allows users to download storyboards and attachments to their mobiledevices).



Notes: End Users assigned to one of the End User module groups (above) must also exist in the End Usergroup, otherwise they will not have access to TIBCO Nimbus.

End Users can be assigned to more than one module group.

ExampleIf Jo Bloggs is an End User who requires change management and action capabilities, she should be assignedto the End User, End User with Change Module and End User with Action Module user groups.

How does LDAP Integration in TIBCO Nimbus work?

Users must be allocated to one of the three main TIBCO Nimbus default system user groups, which must alsobe defined in the directory services environment.

At defined intervals, the LDAP Synchronization Utility synchronizes the internal list of users and user groupsthat are maintained by TIBCO Nimbus with the directory services groups. When synchronizing, only themaximum number of users that are licensed for will be synchronized, so if there are more users than licensesthen some users will not be synchronized. A notification email will be sent to a nominated user account (asset in the LDAP configuration file) in this event. User authentication is performed by the directory servicesserver.

Users can also be optionally assigned to additional directory services user groups and have this assignmentreflected inside TIBCO Nimbus. In this case, the user groups must also be defined in TIBCO Nimbus and setto be managed by LDAP through the Author Client (see Enabling and Disabling LDAP Management for SpecificUsers and User Groups below for more information). TIBCO Nimbus is capable of synchronizing with multipleLDAP servers, allowing users to be drawn from multiple domains (for more information see Synchronizing withMultiple LDAP Servers below).

Important Notes about Security

Access to the LDAP configuration fileAll TIBCO Nimbus Author Client users, and the TIBCO Nimbus domain service account that the Web Serverhost.exe process runs under, must have 'read' access to the LDAP configuration file. It is important, however,to set operating system file permissions on the LDAP configuration file in order to prevent non-administrativeusers from modifying or deleting the file, which could allow access to any user account without the need for apassword.

Secure Lightweight Directory Access Protocol (SLDAP)TIBCO Nimbus supports SLDAP. This is achieved by enabling the 'UseSecureChannel' parameter in the LDAPconfiguration file, and it is also automatically turned on when the port number specified in the LDAPconfiguration file is set to 636 (the default port used for secure LDAP). Each machine where the Author Clientis installed must have the certificate to verify it as a trusted source; the application looks for the certificate inthe standard certificate store, which can be managed by the MMC certificate snap-in.

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

HyperText Transfer Protocol Secure (HTTPS)When using LDAP integration, HTTPS should be used as users' domain passwords are passed over thenetwork to the Web Server in a readable format, therefore posing a significant security threat.

Configuring Authentication 31


Enabling and configuring LDAP synchronization

1. Open LDAPconfig.ini (...\TIBCO Nimbus\Process Repository\LDAP) in a text editor, such as Notepad. Inthe [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 LDAP synchronizationhas been run for the first time.

MainSection

UseLDAP Enable or disable LDAP synchronization.

0 = Disabled (default)

1 = Enabled

UseSimpleBind Enable or disable Simple Bind. For Active Directory it must be disabled(default), for other LDAP server setups it must be enabled.


1 = Enabled

AdminEmail The Email address of the person who receives a notification when generatedby the LDAP service.

PortNumber The port number used to communicate with the LDAP server (default is 389).

Server The name or IP address of the LDAP server. Note: To define multiple LDAPservers, see Synchronizing with Multiple LDAP Servers below for moreinformation.

Main User Groups - all users must belong to one of these groupsAdminsDN The Distinguished Name of the TIBCO Nimbus Administrators group (default is

TIBCO Nimbus Admin).

AuthorsDN The Distinguished Name of the TIBCO Nimbus Process Authors group (defaultis TIBCO Nimbus Author).

EndUsersDN The Distinguished Name of the TIBCO Nimbus End Users group.

Module Groups - end users can belong to one or more module groups in order to grant users additionalfunctionality. Note: Users must still exist in the EndUsersDN groupChangeModuleUsersDN The Distinguished Name of the TIBCO Nimbus End User Change Module group.

ActionModuleUsersDN The Distinguished Name of the TIBCO Nimbus End User Action Module group.

MobileModuleUsersDN The Distinguished Name of the TIBCO Nimbus End User Mobile Module group.

LoggingLevel The level of information that is written to the LDAP log file.

0 = None

1 = Low (default and recommended)

2 = Medium

3 = High

4 = Full

StartTime The start time that the LDAP service will run for the first time.

RepeatMins The time between LDAP synchronization runs (in minutes). Default is 1440, i.e.



one day.

ReportDuplicates Turn on/off duplicate user logging. If turned on then a log entry is recorded if auser with the same name exists in more than one of the three main LDAPgroups (Administrators, Authors or End Users).

0 = Disabled

1 = Enabled (default)

DupUserTypeOrder Specify the order of preference for the effective user account type if a user isduplicated across more than one of the main system user groups(Administrators, Authors, End Users and Connect Users).

1 = Administrator

2 = Author

3 = End User

The default is:

DupUserTypeOrder= 3,2,1 (this means, for example, that a user in both theAdministrators and Authors user groups has the permissions of an author bydefault, since the Author account type precedes the Administrator accounttype). The order can be changed, as required.

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


1 = Enabled

CallDelayMSecs Specify an optional delay (in msecs) after each call to the LDAP server duringsynchronization. See Further Information below for details.


1 - 1000 = Delay to use (in msecs)

ThreadPriority Prioritize the synchronization thread in order to reduce CPU load during longsynchronizations.

0 = Idle

1 = Lowest

2 = Below Normal

3 = Normal (default)

4 = Above Normal

5 = Highest

6 = Critical

UseFullDN Enable or disable sending the full DN for authentication. This is required forNDS and OpenLDAP but is not required for Active Directory.


1 = Enabled

This parameter is written following the first synchronization.

DeriveDomainFromDN When enabled, before the authentication request, the Users DN will be



dissected to extract the full domain. This is useful for sub domains whereauthentication cannot occur. If using this option it is recommend to disable theUserFullDN setting (if enabled).


1 = Enabled

SystemEmail The 'Sent As' address used by the LDAP service for outgoing Emails (it is usefulto use a real address so that bounced Emails are not received by users).

ReportEmail The Email addresses of the people who will receive completion reportsgenerated by the LDAP service. Multiple Email addresses must be separated bysemi-colons.


Resume Select for synchronization to wait until the next start time to run or to run atthe next scheduled interval.

0 = Wait for start time

1 = Run on start


RunOnStart Specify whether to run the synchronization immediately each time the serviceis started or to wait for the Start Time.

0 = Wait for start time (default)

1 = Run on start


SyncMethod Specify to method of synchronization. See Further Information below fordetails.

0 = Synchronize by distinguished name (default)

1 = Synchronize by Account Name

2 = Synchronize by Email Address


IncludeInitials Enable Users' Initial field to be included when synchronizing. For example, Firstname=John, Last name=von Trap.


EncryptionType Specify the level of password encryption.

0 = Password to be decrypted by any PC

1 = Password can only be decrypted by the PC that performed the originalencryption

2 = Password can only be decrypted by the PC that performed the originalencryption and by the same user


UserName The user name required to authenticate with the LDAP server. For an ActiveDirectory 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-ActiveDirectory LDAP servers this usually needs to be the full user DN of the user



account used for authentication.


Password The password set by the client and is a base 64 encoded encrypted password.The level of encryption used is set by the EncryptionType setting.


Anonymous Enable or disable anonymous access to the LDAP server. The UserName andPassword parameters above are used for authentication.

0 = Authenticated access (the UserName and Password parameters, asdescribed above, as used to authenticate with the LDAP server)

1 = Unauthenticated access (default)


IncDisabledUsers Include or exclude users marked as Disabled in Active Directory whensynchronizing with LDAP. If included, disabled users will appear as unassignedin TIBCO Nimbus. If excluded then disabled users will not appear in TIBCONimbus.

0 = Exclude disabled users (default)

1 = Include disabled users


UseSecureChannel Enable or disable secure LDAP authentication (note that setting the portnumber to 636 will also enable secure LDAP).


1 = Enabled


IgnoreServerCertificateErrors Ignore certificate errors (expired, incorrect domain, etc) during LDAP calls.Note that UseSecureChannel must also be set to '1'. (This parameter is writtenfollowing the first synchronization).

0 = Don't ignore (default)

1 = Ignore

AttrMapSection - these parameters are users' details that are integrated by LDAP

UserName The 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 default inmost LDAP implementations this is 'member').

MobileName The mobile telephone number field for users.

WorkPhone The work telephone number field for users.

StreetName The street field for users.



CityName The city field for users.

StateName The state field for users.

ZipCode The zip/postal code field for users.

Country The country field for users.

Description The description field for users.

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

GUID The object GUID.

DTx Data table field names associated with user accounts. For example:

DT1=site-group-id

DT2=unit-id

DT3=division-id

...etc

Further Information

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

DecodeasUTF-8Certain LDAP v3 servers can use UTF-8 encoding when supplying data that has non-ASCII characters in it andreturn this information in UTF-8 encoded UNICODE, therefore requiring conversion to ANSI characters usingthe current code page. Setting this value to '1' will enable UTF-8 decoding of all applicable received data. IfActivity Directory is in use, however, this value must be '0', i.e. disabled, as this converts non-ASCII text toANSI before returning it, potentially causing misinterpretation of certain characters.

SyncMethodWhen synchronizing with the LDAP server you can choose to synchronize either by users' distinguished name,account name or by email address. 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 and recreated with a new userID number in the synchronization process if their distinguished names change. If set to '2', the Email Addressfield is used.

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

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. User groups arenot 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 ordeselect the This account is not to be managed via LDAP.



To enable or disable LDAP user group management:To enable LDAP management for a user group, in the User Accounts dialog in the Desktop Client, right-clickthe user group and select This group is managed via LDAP. Enter the distinguised name (DN) for the usergroup (this must match the corresponding directory server group name). To disable LDAP management,deselect This group is managed via LDAP (note that if LDAP is enabled you cannot disable LDAPmanagement for the main user group roles).

Note: LDAP group members that are not found will be skipped and will not be 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 isuseful if you want some groups to use a separate TIBCO Nimbus username and password to log in toTIBCO Nimbus 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 Tools menuchoose Toggle Ignore LDAP. Select to set the Ignore LDAP flag to On or Off, then select the checkboxes ofyour 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 to querythe LDAP environment will require a known user. The Action Server can be configured to requireauthenticated access. This is achieved through the Author Client by allowing the user name and password tobe stored in the LDAP configuration file.

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

1. In the Client, from the Administration menu choose Application Credentials and then Action ServerLDAP 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):

Server xUserName 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 username in the form Domain\User Name, for example NIMBUS_UK\JoSmith. For non-Active Directory LDAP servers this usually needs to be the full user DN of the useraccount used for authentication.

Password This is set by the client and is a base 64 encoded encrypted password. The level of



encryption used is set by the EncryptionType setting.Encryption Type This determines the level of password encryption.

0 = The password can be decrypted by any PC1 = The password can only be decrypted by the PC that performed the originalencryption2 = The password can only be decrypted by the PC that performed the originalencryption and when logged in as the same user

Anonymous Set this for anonymous access (anonymous access is assumed by default).

0 = Non-anonymous access1 = Anonymous access

Synchronizing with Multiple LDAP Servers

TIBCO Nimbus is capable of synchronizing with multiple LDAP servers, i.e. to allow for multiple domains.To define additional LDAP servers, add a new section for each additional server to the end of theLDAPconfig.ini called [Serverx], where x is the additional server number. For each additional server you canalso define another set of [AttrMapSectionx] and [AttrValuesx] if required, where x is the number of theadditional server. For example, for [Server1] you would have [AttrMapSection1] and [AttrValues1].

Note: It is only necessary to define the parameters for additional LDAP servers if they are different fromthe parameters defined for the main LDAP server. The parameter settings for the main server will bereferenced for any parameters that are not defined.

[Server1]Server=LDAPServer1PortNumber=636[AttrMapSection1]...[Server2]Server=LDAPServer2PortNumber=8765[AttrMapSection2]...

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 process repository(i.e. the TIBCO Nimbus Action Server). This could be useful, for example, if you are restructuring the ActiveServer.

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 menuchoose Clear All User DN's.



What Next...

Test the LDAP SynchronizationFollowing the configuration of LDAP synchronization you can test the synchronization between theDirectory Service list of users and the TIBCO Nimbus list. This is achieved through the LDAP Utility - seeTesting an LDAP synchronization for more information.



2.5.2 Configuring SSO via Windows Authentication (IWA)

The TIBCO Nimbus Web Server supports Integrated Windows Authentication (IWA), allowing users to accessTIBCO Nimbus without having to provide additional user credentials once they are logged in to their PCs. Theserver platforms supported for use with TIBCO Nimbus all provide Windows authentication (Single-sign On),assuming a suitable Microsoft domain architecture is in use.

Notes: Integration with any directory service other than Microsoft's Active Directory may work but is notsupported by TIBCO Nimbus. Internet Explorer 5 and 5.5 are not supported for IWA. If support 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 can be configured to use the anonymous mode of interaction for viewersand non-domain users.

Prerequisites

The user account names in TIBCO Nimbus must be identical to the user names on the domain (LDAPsynchronization is recommended - see Enabling and Configuring LDAP Synchronization for more details).The Web Server has been installed and correctly configured:

DCOM security is configured.

The TIBCO Nimbus host.exe COM+ object identity has been defined.

Access rights to the Web Server folders and files have been defined.

For more information on installing and configuring the Web Server, see Installing the Web Server.

If the Web Server is running on Windows Server 2008 or later, the Authentication role must be installed.In Server Manager, use the Add Roles Wizard to add the Windows Authentication role. See IIS7Component Not Installed for more information.

Enabling IWA in Windows Server 2003

1. Run IIS Manager or IIS Virtual Directory Management Utility.2. Right-click the virtual directory used by TIBCO Nimbus 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.6. Open config.ini (...\TIBCO Nimbus\Web Server\Config) in a text editor, such as Notepad. In the

[Authentication] section set the following two parameters:

UseIntegrated=1IntegAuthType=0

7. Modify any of the other configuration parameters as required (see Configuring AuthenticationParameters below for more details).

8. Save and exit config.ini.

Enabling IWA in Windows Server 2008/2008 R2

1. Run IIS Manager and select the TIBCO Nimbus application.

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

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



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

[Authentication] section set the following two parameters:UseIntegrated=1IntegAuthType=0

5. Modify any of the other configuration parameters as required (see Configuring AuthenticationParameters below for more details).

6. Save and exit config.ini.

Configuring Authentication Parameters

AuthenticationUseIntegrated Enable/disable integrated authentication (set this to '1', i.e. enabled)RequiredDomain (Optional) Specify the domain name that must be matched in addition to the user

login name. Any domain matches if not specified.CaseSensitive Specify case sensitivity when matching the domain name (user name matching is

always case sensitive)0=Case insensitive1=Case sensitive (default)

IntegAuthType Specify the type of authentication used (set this to '0', i.e. Integrated WindowsAuthentication)

ISAPI AuthenticationAlwaysUseIISAuthInfo Specify whether to use IIS' authentication variables even when the IIS version does

not support Unicode authentication details.0=Disable (default)1=Enable



2.5.3 Configuring SSO via Netegrity SiteMinder Authentication

TIBCO Nimbus supports sites that are managed by Netegrity SiteMinder to manage Single-sign On and accessto URLs. The integration is based on the use of HTTP header variables that are set by the NetegritySiteMinder agent with the authenticated username stored within it.

Prerequisites

The user account names in TIBCO Nimbus must be identical to the user names on the domain (LDAPsynchronization is recommended - see User Management\Configuring LDAP synchronization for moredetails).The Web Server has been installed and correctly configured with respect to DCOM security, the identityof the TIBCO Nimbus host.exe COM+ object has been defined and access rights to the Web Serverfolders and files has been specified. See Installation\Installation Procedures\Installing the WebServer for more information.

Configuring the Web Server to integrate with Netegrity SiteMinder

1. Run IIS Manager or IIS Virtual Directory Management Utility.2. Right-click the TIBCO Nimbus 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 (...\TIBCO Nimbus\Web Server\Config) - in a text

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

UseInegrated=1IntegAuthType=1

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

AuthenticationRequiredDomain Specify the domain name that must be matched in addition to the user login

name. Any domain matches if not specified.

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

0 = Case insensitive

1 = Case sensitive (default)

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


1 = Enabled

IntegFailureURL Specify a URL to display when an unknown user account attempts to log in. Ifunspecified a built-in page is displayed.

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



SiteMinderAuthenticationHeaderFieldName Specify the header field to obtain the authenticated user name from. Assumed to

be HTTP_SMUSER if not specified.

PrimaryEncoding Specify the primary encoding part of the SiteMinder HTTPHeaderEncodingSpecsetting.

0 = No encoding (default)

1 = UTF-8 encoding

SecondaryEncoding Specify the secondary encoding part of the SiteMinder HTTPHeaderEncodingSpec.


1 = RFC-2047 encoding



2.6 Integrating TIBCO Nimbus with SharePointTIBCO Nimbus can be integrated into Microsoft SharePoint, allowing users to access process information,such as processes, documents, To dos, storyboards, scorecards, etc, through a SharePoint interface.

There are two deployment methods for integrating TIBCO Nimbus into SharePoint and both use the WCFmethod.

Local IntegrationLocal integrations involve the TIBCO Nimbus Web Server being installed on the same server as SharePoint.

Remote Integration

Remoting allows the TIBCO Nimbus Web Server to be installed on a different server to SharePoint. One ormore SharePoint servers can connect to a single TIBCO Nimbus Web Server instance, and multiple remoteTIBCO Nimbus Web Servers can connect to a single process repository.

SharePoint Farms

The TIBCO Nimbus Web Server can also be run within a SharePoint farm using the TIBCO Nimbus remotingsolution.

The remoting configuration changes to the SharePoint web.config file must be applied on everySharePoint Front-end Web Server.The TIBCO Nimbus Web Server must be configured for remoting.NimbusControl.wsp only needs to be deployed on the machine in which the SharePoint CentralAdministration site is installed, i.e. it is not necessary to manually deploy the file on every machinewithin the farm.

Network Load Balancing

Network Load Balancing is not currently supported.

In this chapter:

Creating a SharePoint Integration

Upgrading a SharePoint Integration

Adding TIBCO Nimbus Web Parts to other SharePoint sites

Integrating TIBCO Nimbus with a SharePoint document library

Note: This guide assumes the user is experienced with SharePoint and the administration of SharePoint sites.



2.6.1 Creating a SharePoint Integration

This topic describes how to configure the integration of the TIBCO Nimbus Web Server with SharePoint, eitherlocally or as a remote integration using WCF.

Prerequisites

Software requirements:

Windows Server 2003, 2008 or 2012 with Windows SharePoint Server or Microsoft Office SharePointServer.

The TIBCO Nimbus Author Client is installed and has been run against the process repository at leastonce.

.NET 3.0 runtime (recommended .NET 3.0 Service Pack 1 or greater) is installed on the server that hoststhe Web Server.

Additional requirements:

If you are using Windows Integrated Authentication, it is advisable to ensure that authentication isworking correctly via the standard Web Server before configuring the SharePoint integration. Note:TIBCO Nimbus does not need any specific authentication mode set in its configuration file asSharePoint requests are authenticated separately.

What if the TIBCO Nimbus Web Server has already been installed as a standard web site?

You can configure the integration of the TIBCO Nimbus Web Server into SharePoint if the standard WebServer has already been installed. If you are configuring a remote installation then there are no precursorsteps. For local integrations, you must install Windows SharePoint Services (if it is not already installed). Note: The default TIBCO Nimbus web site service will be stopped following the installation of WSS.

Integrating TIBCO Nimbus with SharePoint 45


Installing the Web Server


If using physical media, insert the CD and click Enterprise Server Installation.OR

If using an electronic image, 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 warning message.The Web Server can be installed on a non-server machine, however you will not receive thebenefits that a server has to offer, such as being able to support multiple connectionssimultaneously.


3. [Choose Destination Folder] The location in which the Web Server is installed will default to the locationof the Author Client installation. To change location, in the Destination Folder panel click Browse toselect a location in which to install the Web Server. To change the location of the process repository atthis stage, deselect Use default sub-folder for Process Repository and click Browse in the ExistingProcess Repository panel to locate the process repository.

Note: The path of the process repository can be changed at any time by editing the Web Serverconfiguration file (see Web Server Configuration for more information).


4. [IIS Configuration Options] Deselect Configure TIBCO Nimbus for use via Internet Information Server,and then click Next.

5. [Setup Program Manager Group] Select the Program Manager group that the Web Server will be addedto; either select an existing group or accept/rename the default name. Click Next to proceed.

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

Modifying the TIBCO Nimbus Host.exe COM+ identity

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

1. Run Component Services.2. Expand Computers>>My Computer>>DCOM Config.3. Right-click TIBCO Nimbus ES Web Server Host and choose Properties.4. Click the Identity tab.5. Select This user, then enter the TIBCO Nimbus domain service account details.

Modifying access to the Web Server folders and files

The access rights of all folders and files within \TIBCO Nimbus\Web Server\Main need to be set to allowRead access for all TIBCO Nimbus users. If management of users via LDAP synchronization is used it isrecommended that the TIBCO Nimbus LDAP groups are used to provide this access. Read/write access to thefollowing folders must also be enabled for the TIBCO Nimbus domain service account, which the Host.exeprocess runs under:

...\TIBCO Nimbus\Process Repository\

...\TIBCO Nimbus\Process Repository\Temp

...\TIBCO Nimbus\Web Server\Reload



Configuring SharePoint

Note: If you are configuring the integration of the TIBCO Nimbus Web Server into a SharePoint farm then thefollowing updates to the SharePoint configuration file must be applied to every SharePoint front-end WebServer.

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 andpaste 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 these already exist in the 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.txt file andpaste in the web.config file. This should be nested within the <configuration> tags. See Fig.2.

<nimbus><general>

<main defaultsiteurl="" serverConnectionMethod...>

...

etc</nimbus>

4. Copy the following system serviceModel element from the SharePoint Web.config.changes.txt file andpaste in the web.config file. This should be nested within the <configuration> tags. See Fig.3.

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

5. In the web.config file, set the following parameters:

Parameter Definition

defaultSiteURL URL of the TIBCO Nimbus SharePoint site.For example:

http://server1/sites/TIBCONimbus

serverConnectionMethod WCF

wcfServer clientIdentityType The user account used to make calls to the remote TIBCO Nimbus WebServer. There are two options:(1) SpecifiedUser (recommended). If selected you must set thewcfClientIdentity userName credentials (see below).

(2) Process. This will use the account under which the SharePoint ASP.NETruns under (not the logged in user).



wcfServer endpointName The end point name used when connecting remotely. To specify a remoteconnection via a TCP connection, set this to NimbusTcpEndpoint.

wcfClientIdentity userNamedomain password

If SpecifiedUser was selected as the Client Identity Type (above) you mustdefine the identity credentials (user name, domain and password).

Note: Since these credentials are in a separate section to the generalsettings you can encrypt them without affecting the general settings. Formore information see the following links:

How to encrypt configuration sections in ASP.NET using DPAPIHow to encrypt configuration sections in ASP.NET using RSA

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

endpoint address Set this to the applicable protocol, server and port for each endpoint. Thereare two endpoints specified. For remoting, the TCP binding will be requiredand so the NimbusTcpEndpoint item must be updated. It is important toensure the port matches the value specified in theNimbusServerHost.exe.config file (default location is C:\TIBCO Nimbus\WebServer\Remoting Server). See Fig. 5.

Note: Please do not edit the 'maxPoolConnections', 'maxConnectionWait' or 'connectionWaitCheckMSecs'default values unless explicitly instructed to by TIBCO Nimbus Support. Incorrect values can cause errors orintermittent failures. These parameters should only be changed if you are experiencing problems and onlywhen advised by TIBCO Nimbus Support.

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

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



Installing the SharePoint solution

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

1. Open a command-prompt window and navigate to one of the following directories (depending on theversion of SharePoint you have installed):

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



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

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

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

Deploying the TIBCO Nimbus site

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

SharePoint 2007: Central Administration > Operations tab > Global Configuration section >Solution Management.SharePoint 2010: Central Administration > System Settings > Manage Farm Solutions.SharePoint 2013: Central Administration > System Settings > Manage Farm Solutions.

Note: You must add the SharePoint Central Administration Web site to the list of local intranetsites in order to be able to deploy the TIBCO Nimbus site.

4. Click NimbusControl.wsp, and then click Deploy Solution. Choose to deploy to the same webapplication (http://servername).Note: If you are installing into SharePoint 2013, you must select 2010 from the Select experienceversion options.

5. Recycle the SharePoint Central Administration Pool.

Creating a TIBCO Nimbus site in SharePoint

6. In the SharePoint Central Administration console select the Application Management tab.7. Under SharePoint Site Management click Create site collection.

http://servername)



Configuring the Remoting Host Service

This method describes the configuration of the remoting service. Note that this is not required for localintegrations.1. Run NimbusServerHost.exe.

NimbusServerHost.exe is found in ...\TIBCO Nimbus\Web Server\Remoting Server. A shortcut isalso added to the TIBCO Nimbus Program Group in the Start Menu.

The application can be run as either a Windows service or manually, i.e. interactively. The interactivemode is designed for initial configuration testing. To install the application to run as a service you musthave administrative rights. Note that only one instance can be run on a single server.

For Windows Vista and Windows Server 2008 you must elevate your administrative rights. To dothis, right-click NimbusServerHost.exe, or right-click the shortcut, and select Run asadministrator.

2. Click Install service.3. Open NimbusServerHost.exe.config (...\TIBCO Nimbus\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 TIBCONimbus Web Server from the SharePoint server. Note: If a user is notspecified then any user is permitted to connect to the remotingservice to make requests.

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

The domain of the user account specified above.

<add baseAddress="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 theNimbusServerHost.exe process, therefore ensure that the user account is known and that it hasthe applicable rights to the server that is hosting the TIBCO Nimbus Web Server.The WebServer.CLSID value is a unique identifier that is set during the installation of the WebServer and should not be changed unless manual changes to this value are made elsewhere.

4. Provide the user account that the remoting host service is run under, as set in the service's Properties,with 'launch' and default COM access rights over the TIBCO Nimbus Web Server COM object.

Note: This needs to be set wherever the NimbusServerHost.exe is installed.

5. Start the remoting service in Windows Services.

Remoting Service Timing Out By default, Windows is set to time out if a service fails to start after 30 seconds. When using adomain service account to start a Nimbus service, it often requires longer than 30 seconds. If you arefinding that the remoting service times out when you attempt to start it, you can modify the WindowsSystem Registry to increase the timeout value. Note: Modifying the Windows Registry can causeserious problems if done incorrectly, therefore it is advisable to request support from your IT team



before carrying out the following procedure.

1. Click Start > Run.2. In the Run field, enter regedit and click OK.3. Locate the following key:

HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Control

4. In the right-hand pane, right-click ServicesPipeTimeout and choose Modify.

Note: If this entry does not exist then you must create it. Right-click in the right-hand pane andchoose New > DWORD value.

5. Set Value Data to '60000' and the Base as 'Decimal', and then click OK.

Note: The value is in milliseconds.

6. Restart the computer.

What Next...

Grant Access to UsersUsers must be provided with access to use the site. From the Site Settings page (accessed from Site Actions),authenticated users should be added by default, unless specific user access is required, in which case theappropriate users should be granted permission. The minimum access requirement for the site is 'Team SiteVisitor' (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



2.6.2 Upgrading a SharePoint Integration

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

Prerequisites

TIBCO Nimbus with the Web Server integrated into a SharePoint instance. See SharePoint Integration formore information.(Remoting only) The latest TIBCO Nimbus remoting host service has been installed and configured.

Upgrading a TIBCO Nimbus SharePoint integration

1. Stop the current remoting service.2. From a command prompt, navigate to:




3. 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:\TIBCONimbus\NimbusControl.wsp" -immediate -allowgacdeployment

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

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

STSADM.exe –o execadmsvcjobs

4. Recycle the SharePoint Central Administration Pool.5. Restart the remoting service.

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

2.6.3 Adding Web Parts to other SharePoint sites

TIBCO Nimbus provides a number of Web Parts which can be imported into any SharePoint site (includingsites not linked to TIBCO Nimbus) in order to provide users with access to specific TIBCO Nimbusfunctionality. The Web Parts available are:

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

Importing and activating the TIBCO Nimbus Web Parts

If a TIBCO Nimbus SharePoint solution has not been deployed on a particular server, you must first import andactivate the TIBCO Nimbus Web Parts in order to use them in other SharePoint sites. After installing theTIBCO Nimbus Web Server, the various Web Parts can be imported from the following location:

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

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

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 Web Parts option.

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

TIBCO Nimbus Web Parts

TIBCO Nimbus Web Parts retrieve data directly from a TIBCO Nimbus installation, either from a localinstallation using COM or from a remote installation using WCF. This requires that COM or WCF has beencorrectly configured on the local SharePoint server (see Configuring a SharePoint Integration for moreinformation).

TIBCO Nimbus Web Parts must also be linked to the main TIBCO Nimbus site in order for any hyperlinks towork. This can be achieved by either setting the default site URL in the SharePoint server's web.config file(see Specifying a default TIBCO Nimbus site URL below for more information) or by configuring each WebPart independently. To configure Web Parts independently, deselect This is a TIBCO Nimbus site under theMiscellaneous properties and enter the URL for the main TIBCO Nimbus site (for example, http://server1/sites/TIBCONimbus).



Specifying a default TIBCO Nimbus site URL

If you don't want to specify the TIBCO Nimbus site URL for each Web Part you can set a default site URL inthe SharePoint configuration file. Any TIBCO Nimbus Web Parts that do not have a URL set will assume thedefault URL.

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\80

2. Copy the following Nimbus section group element from the SharePoint Web.config.changes.txt file andpaste 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 copy the<configSections> tags as they already exist in the SharePoint configuration (web.config) file.

3. Copy the following TIBCO configuration element from the SharePoint Web.config.changes.txt file andpaste 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> configurationparameters, for example:

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



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.

Including TIBCO Nimbus searches in the SharePoint Enterprise Search page

The SharePoint Enterprise Search facility can be configured to search for processes, storyboards anddocuments, based on users' associated keywords or free text.

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

1. Import the TIBCO Nimbus My Searches and the TIBCO Nimbus My Processes Search Web Parts into theSharePoint site (see Importing and activating the TIBCO Nimbus Web Parts above).

TIBCO Nimbus Processes Search displays a list of process diagrams based on a free text search.

TIBCO Nimbus My Searches displays a list of storyboards, documents and process diagrams basedon 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, thereforeit 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 TIBCO Nimbus My Searches and TIBCO Nimbus 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.8. Deselect This is a TIBCO Nimbus site, then specify the site above (for example (http://[site]/TIBCO

Nimbus).9. Click OK.



Adding 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 text searchesfor processes only.

Note: This applies to Microsoft Office SharePoint Server (MOSS) only as the Enterprise Search page isnot 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 URL Name field(for example, Processes).

Select (Welcome Page) Search Page as the pagelayout.

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 (since TIBCO Nimbus Web Parts arenot compatible with advanced searching).

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

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 page URL asyou 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 TIBCO Nimbus Processes Search, then click Add.12. On the TIBCO Nimbus Processes Search Web Part click edit, then Modify Shared Web Part.13. In the TIBCO Nimbus Processes Search Web Part properties, expand Miscellaneous and deselect This is a

TIBCO Nimbus site. In the field above this option, specify the URL of the TIBCO Nimbus site.

For example: http://[Site]/sites/TIBCO Nimbus

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 returned results ingreater 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 tab control:

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 created inStep 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



2.6.4 Integrating with a SharePoint document library

TIBCO Nimbus can be integrated with a SharePoint Document Library in a specified Microsoft SharePointenvironment. This allows users to register SharePoint document links in TIBCO Nimbus, and to adddocuments directly into SharePoint through the TIBCO Nimbus Document Registry.

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

Integrating 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 automatically uploaddocuments into the default SharePoint document library when a document is registered in theTIBCO Nimbus 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 the SharePointsite.Password is the password for the user name specified above.Default site will automatically upload documents to this site when a document is registered in theTIBCO Nimbus Document Registry (when the Automatically store new documents in the defaultdocument 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 default library,click the library to select it and click Set as Default. This will automatically upload documents intothis library when a document is registered in the TIBCO Nimbus Document Registry (when the Automatically store new documents in the default document library option is enabled).

10. Click OK.

Note: To change the default site, i.e. the SharePoint site that is used to automatically uploaddocuments to, double-click the site and in the SharePoint Connection Details panel select Defaultsite.



2.7 Installing the Action ServerThis topic describes how to install the TIBCO Nimbus Action Server. For more information on the ActionServer, including software and hardware requirements and sizing, see the Installation Planning Guide that isincluded in the Documents folder on the installation CD.

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

Prerequisites

5MB of disk spaceThe TIBCO Nimbus Client is installed and the process repository is in a location that is accessible tothe Action Server.It is important that you have read the Installation Planning Guide (included on the CD).

Installing 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 to thelocation of the Client installation. To change location, in the Destination Folder panel click Browse toselect a folder in which to install the Action Server in. To change the location of the process repository,deselect Use default sub-folder for Process Repository and click Browse in the Existing ProcessRepository 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 reports are sentto.

[Lock Service Configuration] Start Lock Time - this is the time that the process repository is locked to allow you to back it 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 problems with theLDAP synchronization occur.

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

Installing the Action Server 63


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. 24 hours).

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

Configuring DCOM

In order for the Office Integration Service to be able to launch and access Excel, the DCOM access and launchrights must be configured to allow launch and access rights for the MS Excel COM object for the user accountnominated 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 Server services.See Configuring\Action Server Configuration\Configuring the Action Server for more information.

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

Related topics

Configuring LDAP IntegrationConfiguring SMTP Email



2.8 Installing the Business Intelligence ServerThis topic describes how to install the TIBCO Nimbus Business Intelligence (BI) Server. For more informationon the Business Intelligence Server, including software and hardware requirements and sizing, see the Installation Planning Guide that is included in the Documents folder on the installation CD.

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

Prerequisites

3MB of disk spaceThe TIBCO Nimbus Client is installed and the process repository is in a location that is accessible tothe Business Intelligence Server.It is important that you have read the Installation Planning Guide (included on the CD).

Installing 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 BI Serverfolder.


3. [Choose Destination Folder] The location in which the BI Server is installed will default to the location ofthe Client installation. To change location, in the Destination Folder panel click Browse to select a folderin which to install the BI Server in. To change the location of the process repository, deselect Use defaultsub-folder for Process Repository and click Browse in the Existing Process Repository panel to locatethe 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 Intelligence Server. SeeConfiguration\Business Intelligence Server Configuration\Configuring the Business Intelligence Server formore information.

Synchronize the Business Intelligence ServerThe Business Intelligence Server can be scheduled to run as a Windows Scheduled Task in order to updatemetric data in TIBCO Nimbus. See Configuration\Business Intelligence Server Configuration\Syncronizingthe Business Intelligence Server for more information.

Installing the Business Intelligence Server 65


Related topics

Updating Excel Macros

Creating SQL Queries

Scheduling and Updating SQL Queries

Integrating with SAP BW and SAP NetWeaver BI

Integrating with Cognos Metrics Manager

2.9 Installing the TIBCO Nimbus Performance MonitorThis topic describes how to install the TIBCO Nimbus Performance Monitor.

64-bit Versions of Windows Server

To use the TIBCO Nimbus Performance Monitor in a 64-bit version of Windows Server (including WindowsServer 2003, Windows Server 2008 and Windows Server 2008 R2), you must run the 32-bit version of theWindows Performance Monitor. To do this, run the following command:

mmc.exe /32 perfmon.msc

Prerequisites

10MB of disk spaceThe 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.

Installing TIBCO Nimbus Performance Monitor

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 toselect 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



2.10 Installing the TIBCO Nimbus Batch ServerThis topic describes how to install the TIBCO Nimbus Batch Server.

The TIBCO Nimbus Batch Server is a separate utility that handles various operations outside of the AuthorClient, such as the promotion of draft content and assigning reviewers, requesting reviews, unlockingdiagrams and assigning diagram access rights in the web. This allows the processes to be streamlined andmanaged from a server instead of a user's PC. This method also safeguards data integrity as it prevents usersfrom terminating the operation midstream on their PC.

Prerequisites

100MB of disk space

Installing TIBCO Nimbus Batch Server

1. Run Setup.exe from the Batch Server 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 Batch Server is installed will default to the

location of the Author Client installation. To change location, in the Destination Folder panel click Browseto select a location in which to install the Batch Server. To change the location of the process repositoryat this stage, deselect Use default sub-folder for Process Repository and click Browse in the ExistingProcess Repository panel to locate the process repository.


4. Click Finish to exit the installation.

2.11 Uninstalling TIBCO NimbusEach product must be uninstalled separately through the Add/Remove Programs in Windows Controlpanel.

Security

Chapter 3


Chapter 3 Security68


3.1 Securing a Process RepositorySince TIBCO Nimbus requires users to have read, write and modify NTFS privileges against the ProcessRepository folder, this poses a potential security loophole in that it allows users to modify any of the TIBCONimbus system files through normal file system capabilities (for example, through Windows Explorer). Toprevent users from doing this, TIBCO Nimbus recommends that you secure your process repository.

TIBCO Nimbus switches back to users' identities when performing external file operations, such aspackaging, attaching files, registering files in the Document Registry, etc.

Note: For Windows Vista, Windows Server 2008 and later versions of Windows that support User AccountControl, UAC must be enabled. UAC is enabled by default but may have been disabled. See http://technet.microsoft.com/en-us/windowsvista/aa906022.aspx for more information. Before securing a processrepository it is advisable to contact TIBCO Nimbus Support.

Prerequisites

TIBCO Nimbus has been installed and a user account that has NTFS read/write access to the processrepository must exist. This account must also be able to run the TIBCO Nimbus author client.

Securing 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 This account and specify the credentials of a

single Windows user account for TIBCO Nimbus to run under when accessing the process repository. Theaccount should not be an administrator account.

Note: A new folder will be created at the same level as the process repository called ProcessRepositorycred (for example, C:\TIBCO Nimbus\Process Repositorycred). Within this folder is a filecalled cred.ini which contains the credentials required to access the process repository (including thepassword which is strongly encrypted).

4. Set the NTFS access rights on the Process Repositorycred folder to Read only for all users of the TIBCONimbus author client.

5. Set the NTFS access rights on the Process Repository folder to Access Denied for all user accounts exceptthe nominated user account specified in step 3. It is also advisable to grant access to the systemadministrator(s).

Note: To return to an unsecured process repository, run RepoCred.exe and select Logged on user. Thisoption uses the identity of the Windows user who launches TIBCO Nimbus to access the processrepository. You must then also ensure that all users who require access to run TIBCO Nimbus have read/write access to the process repository.

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

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

Configuration

Chapter 4


Chapter 4 Configuration70


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 a summary ofthe available options. Some of these options are covered in more detail in other related topics.

Configuring the Web Server

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

InstallationIGUID Please do not change this value.WebServerDefaultMap Specify the full path of the default map for visitors only, for example Map1Folder\Map1.

The map must be a master version and accessible to viewers.DefaultPageURL Specify a starting page for users.

This option allows a relative or absolute URL to be defined that will automatically takeusers to a a specific page after they have logged in to the Web Server. For example, youcould automatically navigate users to the Documents page, the Scorecards page or theStoryboards page upon logging in.

Note: This option is not applicable if a map is specified for the DefaultMAP option(above), 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/ appendedto the beginning.

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

Examples

http://<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

Setting the Documents page

There are a number of optional parameters that can be specified when setting thedefault page URL to the Documents page.

Note: Query parameters must be prefixed with &.

FiltDocNum={numeric value} allows you to filter by a specific document number

Web Server Configuration 71


FiltTitle={text value} allows you to filter by document title

FiltMultiDown1={numeric value - unique item ID} allows an item from the firstcategory drop-down to be filtered

FiltMultiDown2={numeric value - unique item ID} allows an item from the secondcategory drop-down to be filtered

....

FiltMultiDown7={numeric value - unique item ID} allows an item from the seventhcategory drop-down to be filtered

Note: Multiple values can be specified for each drop-down item. The unique ID canbe found in the Drop Down List dialog for a given drop-down list - if the ID field is notvisible, from the View menu choose Column Customizing and drag the ID field on tothe existing group of field headers. See Defining category drop downs underDocument Registry Administration in the TIBCO Nimbus Client Help for moreinformation.

PageSize={numeric value} allows you to set the number of items to display on thepage

FiltAuthStatus={numeric value} allows the authorization status to be filtered

0=All Authorized

1=Own UnAuthorized

2=All UnAuthorized

3=Authorized & Own

4=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 thefiltered search

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

Example:

http://<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-down list and items with 19 or 64 in the second drop-down list.

CLSID Unique identifier for the web server installation. Important: Do not change this value.SessionTimeout Specify the number of minutes before a user's session times out.

Default=20, min=5, max=120Note: For values greater than 20 you must also set the application pool session timeoutthrough IIS to match the value set here.Note: The additional timeout for users that request it on the Web login screen will be thedefault value multiplied by 10. For example, if the value is set to 20 then users whoselect additional time to complete forms will receive 200 minutes before their session



times out.MyPageOverrideURL

Override the Home page URL, for example http://corporateportal/personal_home.aspx

ServerHTMLCheckInterval

The interval, in seconds, between checks for changes to server-side HTML files.-1 = Never re-check for changes (default)0 = Check every time file is needed1 - 86400 = Number of seconds before a recheck is made

BatchLastLoginUpdates

Enable or disable the batch updating of last log in times for users.

0 = Disable

1 = Enable (default)

MaxProcessingThreads

Set the maximum number of processing threads to use for handling HTTP requests (notethat this value should only be set when requested by TIBCO Nimbus Support.Default=40, max=64.

HelpRootURL This is the link to the online web help. If internet access is not available to users thenyou can download a local copy of help and replace this URL. Copies of the help can bedownloaded from https://docs.tibco.com/products/tibco-nimbus.

tibbrWorkspaceHeight Specify the maximum height of the tibbr Wall gadget in users' My Workspaces.

Note: Default is 600 pixels.

MySearchesDiscussion Height

Specify the height of the tibbr Subject Messages gadget displayed in the Keyword page.

Note: Default is 450 pixels.

HTTPChunklfSupported Enable or disable chunked HTTP responses for supported browsers.

0 = Disable


DataFolderPath This is the path of the process repository that the Web Server accesses.

Note: The default location is <Installation directory>\TIBCO Nimbus\Process Repository.You will only need to change this parameter if multiple Process Repositories exist.

LockMode Specify the lock mode that the Web Server utilizes when the process repository is backedup. If set to 0 the standard lock service installed with the Action Server will be used. If setto 1, the Volume Shadow Copy Service will be used in conjunction with the Backup Utility.

Note: The Backup Utility can only be used in Windows Server 2003 and Windows Server2008. See Backing Up a Process Repository for more information.

0 = Lock Service (default)

1 = Volume Shadow Copy Service

CacheEnabled Enable or disable the image cache (recommended to be enabled). Enabling image

caching provides quicker access to diagrams in the Web Server.

0 = Disable


Path This is the location of the image cache, as setup during the Web Server installation.

MapAccessCacheEnabled

Enable or disable cached map access rights.

https://docs.tibco.com/products/tibco-nimbus



0 = Disable


MapAccessCacheMaxItems

Set the maximum number of map access rights items to cache. The default is 100,000.

MapAccessCacheMaxAgeSecs

Set the maximum time to store cached map access rights items (in seconds). The default60.

DiagAccessCacheEnabled

Enable or disable cached diagram access rights.0 = Disable


DiagAccessCacheMaxItems

Set the maximum number of diagram access rights items to cache. The default is200,000.

DiagAccessCacheMaxAgeSecs

Set the maximum time to store cached diagram access rights items (in seconds). Thedefault 60.

BrowserMaxAge.DiagramThumbnail

Enable or disable image caching for diagram thumbnails on the client side.0 = Disable

n = Number of seconds to cache images (default is 86,400, i.e 24 hours, and will be usedif not set or disabled).

BrowserMaxAge.UserPhoto

Enable or disable image caching for user photo thumbnails on the client side.0 = Disable


BrowserMaxAge.StoryboardCover

Enable or disable image caching for storyboard cover thumbnails on the client side.0 = Disable


BrowserMaxAge.ScorecardCover

Enable or disable image caching for scorecard cover thumbnails on the client side.0 = Disable


BrowserMaxAge.KeywordCover

Enable or disable image caching for keyword cover thumbnails on the client side.0 = Disable


DiagramDefaultScale Specify the default display size of diagrams:

0 = Reset Zoom Mode

1 = 680x480

2 = 800x600

3 = 1024x768 (default)

4 = 1152x864

5 = 1280x1024



6 = 1600x1200

DefaultZoomToFit Enable or disable the option to allow users to Zoom to Fit.

0 = Disable (default)

1 = Enable

ShowDraftBanner Display or hide the draft banner on draft diagrams.

Note: The Show draft banner when in draft copy option must be enabled for specificmaps in the Author Client.


1 = Enable

DefaultFormat The format for the generation of diagrams and internal image attachments.

Note: GIF images are restricted to 256 colors.

png (default)

gif

Margin Enable or disable diagram margins.


1 = Enable

LeftMargin Specify the left margin of diagrams (in px).

TopMargin Specify the top margin of diagrams (in px).

RightMargin Specify the right margin of diagrams (in px).

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

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

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

IntImageMargin Specify the margins of internal images in diagrams.

IntImageLeftMargin

Specify the left margin of internal images (in px).

IntImageTopMargin

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

IntImageRightMargin

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

IntImageBottomMargin

Specify the bottom margin of internal images (in px).

IntImageMaxWidthSpecify the maximum width of internal images (px) in Reset Zoom mode.

IntImageMaxHeight

Specify the maximum height of internal images (px) in Reset Zoom mode.

FeaturesDocuments Enable or disable access to documents.

0 = Disable1 = Enable (default)

Memos Enable or disable access to memos.

0 = Disable




ChangeReq Enable or disable access to change requests.

0 = Disable


Logs Enable or disable access to logs.

0 = Disable


AbbrRef Enable or disable access to abbreviations and references.


1 = Enable

DataTableEdit Enable or disable data table editing.

0 = Disable


MySearches Enable or disable access to My Searches (SharePoint only).

0 = Disable


MyRoles Enable or disable access to My Roles.

Note: A user group permission (Web My Roles), specified in the Author Client, is used todisplay or hide My Roles for specific user groups. If the MyRoles option is disabled, theuser group permission will override this option and provide access to user groups whohave been defined access to My Roles.

0 = Disable


MySearchesMoreOptions

Enable or disable access to My Searches More Options searching, allowing users tosearch against additional user group categories (SharePoint only).

0 = Disable


SplitCollabAndLogsView

Show or hide the diagram when users view associated memos, actions, change requests,reviews and logs (SharePoint only)

0 = Hide diagram

1 = Display diagram (default)

StoryboardStepsList

Display storyboard steps in the same window or a separate window (with the diagramIDs visible).

0 = Show in same window (default)

1 = Show in separate window

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

0 = Hide

1 = Display (default)

ShowGraphLinks Link metric/measure graph icons with the BI Server graph.



0 = Link to diagrams

1 = Link to graphs (default)

ForgotPasswordLink

Allow users to reset their own passwords on the Login page.

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

0 = Disable


ActColOnStmtLinkPage

Display the Activity column in the Statement Details page.

0 = Disable


WebAuthoring Enable authors to edit and create diagrams via the web interface.


1 = Enable

Acknowledgements

IncDropDown1

...

IncDropDown7

Display a document's drop-down fields in users' acknowledgement To-Do lists.


1 = Enable

SearchPageSize Specify the maximum number of items that are displayed on each page in the Search

page.

StorageTempPath The location of the Web Server temporary folder (created in the installation process).

FileUploadPath Specify the location to store file attachments uploaded by users in the web.

StoryboardAvailableModes Specify whether to default the display of storyboards as Diagram or Text. Note: Users

can switch between modes when viewing a storyboard.

Diagram displays the storyboard as a diagram.

Text displays the storyboard as text.

ExcelPollingMinutes 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)

Host Specify the name, or IP address, of the machine running the Office Integration Service. Bydefault this is localhost.

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

Authentication More info...UseIntegrated Enable or disable integrated authentication.


1 = Enable

RequiredDomain Specify the domain name that must be matched in addition to the user login name. Anydomain matches if not specified.



CaseSensitive Specify case sensitivity when matching the domain name (user name matching is alwayscase insensitive).

0 = Case insensitive

1 = Case sensitive (default)

IntegAuthType Specify the type of authentication used.

0 = Windows Integrated Authentication (default)

1 = Netegrity SiteMinder

2 = SSO2 Ticket Authentication

IntegAutoLogonOnly

Enable or disable automatic logon only, i.e. users cannot log out and access the Log Onpage.


1 = Enable

IntegFailureURL Specify a URL to display when an unknown user account attempts to log in. If unspecifieda built-in page is displayed.

IsapiAuthenticationAlwaysUseIISAuthInfo

Specify whether to use IIS' authentication variables even when the IIS version does notsupport Unicode authentication details.


1 = Enable

SiteMinderAuthentication More info...HeaderFieldName Specify the header field to obtain the authenticated user name from. Assumed to be

HTTP_SMUSER if not specified.

PrimaryEncoding Specify the primary encoding part of the SiteMinder HTTPHeaderEncodingSpec setting.

0 = No encoding

1 = UTF-8 encoding (default)

SecondaryEncoding

Specify the secondary encoding part of the SiteMinder HTTPHeaderEncodingSpec.


1 = RFC-2047 encoding

SSO2TicketAuthenticationCallMethod Specify the call method to verify the SSO2 ticket.

Note: If using the Web service, the WebServiceURL parameter must also be specifiedbelow. If using SSO2TicketCom, the SSO2TicketCom COM library must be correctlyinstalled.

0 = Use the Web service to verify ticket (default)

1 = Use SSO2TicketCom COM library to verify ticket

WebServiceUrl Specify the URL for the CenterForSSO2Ticket Web service.

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

CookieName Specify the name of the cookie to use as the SSO2 ticket for authentication. If unspecifiedthe cookie name will be MYSAPSSO2.

WebLogging More info...



Enabled Enable or disable Web Server logging.

0 = Disable


IsUnicode Enable or disable Unicode Web logging.

0 = Disable


OutputInterval Specify the time (in milliseconds) that information is cached before being written 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.

PathMappingSourcePathn 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.

LocalisationsLocale Definition Specify the localization files available to the Web Server (for more information on

localizing the Web Server, please contact TIBCO Nimbus Support).

Localisations-HelpLocale Specify any help file localizations available to the Web Server.

DocumentsLocalisedDDownTitles

Specify whether to use either the document drop-down titles as specified in the client, orthe localized titles in a specific localization file.

0 = Use author client drop-down titles (default)

1 = Use localized drop-down titles

ShowFullPath Display or hide the file path of documents when users view the details of documents inthe Document Registry.

0 = Hide the file path of documents

1 = Display the file path of documents (default)

GarbageCollector

DrillDownGracePeriodHours

Specify the number of hours to allow deleted drill downs to be reinstated, i.e. to undo adeletion, before being permanently deleted. The default is 3 hours.

WebServices

APIEnabled Enable or disable the Web Services API.

0 = Disabled

1 = Enabled (default)

PublishWSDL Enable or disable the publishing of the WSDL document.


1 = Enabled

DocumentListSpecify how document searches are displayed. You can add, remove and reorder the columns displayed anddefine how searches are sorted. The following document fields exist, with specific field 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 Fields

To display a particular field, use the following format:

FieldxxxTag=wwwFieldxxxWidth=yyyFieldxxxAlign=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 would include thefollowing lines:

Field9Tag=15



Field9Width=10%Field9Align=0

Sorting Fields


SortxxxTag=wwwSortxxxAscend=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 ascending directionwhen users conduct a search, you would include the following lines:

Sort1Tag=11Sort1Ascend=1

Formatting Drop-down Fields

To specify the number of characters to display for the drop-down labels and items, use the following format:

FilterxxxLabChrs=wwwFilterxxxItemChrs=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 20 charactersfor the items associated with drop-down 1.

Filter1LabChrs=15Filter1ItemsChrs=20

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

Field ID Field1 Action Group ID2 Subject Text3 Category Name4 Status Name5 Priority Name6 Owner Name7 Start Date8 Due Date9 Assignees10 Created11 Finish Date12 Throughput Time



13 Has Attachments (image)14 Attachments (yes/no)15 Host Type Name16 Host Title17 DT018 DT119 DTn

Displaying Fields


FieldxxxTag=wwwFieldxxxWidth=yyyFieldxxxAlign=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 the following lines:Field8Tag=15Field8Width=10%Field8Align=0

Sorting Fields


SortxxxTag=wwwSortxxxAscend=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 action group IDs, sorted in an ascending direction when usersconduct a search, you would include the following lines:

Sort1Tag=1Sort1Ascend=1

Data Table Fields

You 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, as described



above.

Default Starting PageThis option allows a relative or absolute URL to be defined that will automatically take users to a a specificpage after they have logged in to the Web Server. For example, you could automatically navigate users to theDocuments 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 isenabled.

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

Important - URLs need to be correctly encoded, i.e. all parts need correct HTTP escaping and non-asciicharacters in the query parameters need UTF-8 encoding (which is then HTTP escaped with the wholequery parameter).

Examples

http://<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 page URL tothe Documents page. In the [Web Server] section modify the DefaultPageURL parameter.

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 tobe filteredFiltMultiDown2={numeric value - unique item ID} allows an item from the second category drop-downto be filtered....FiltMultiDown7={numeric value - unique item ID} allows an item from the seventh category drop-down to be filtered

Note: Multiple values can be specified for each drop-down item. The unique ID can be found in theDrop Down List dialog for a given drop-down list - if the ID field is not visible, from the View menuchoose Column Customizing and drag the ID field on to the existing group of field headers. SeeDefining category drop downs under Document Registry Administration in the TIBCO Nimbus ClientHelp 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 filtered search

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

Example

http://<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-down list anditems 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 them to adifferent URL. For example, http://corporateportal/personal_home.aspx.

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



4.1.2 Configuring MIME mappings

MIME (Multipurpose Internet Mail Extensions) can be configured. You can define the MIME handling of fileextensions and change the icon associated with a file extension when it is displayed in the Web Server. Youcan also specify to download a particular file type when users access a file, or open it using the applicationassociated with that file extension.

Configuring MIME mappings

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

Note: The fields are tab-delimited. The fifth (comma-delimited) column determines whether a particularfile type will open when users access it (this is the default value, 0, and is used if not specified), ordownloaded (if set to 1'). Icons are stored in ...\TIBCO Nimbus\Web Server\Main\images.

4.1.3 Configuring Web Server Logging

Web Server logging can be enabled to debug any issues that may arise with the configuration of the WebServer. There are two log files, one for the ISAPI extension, the other for the Web Server application, and bothuse the Log4D component. If enabled, any errors and warnings will be logged in the respective log file.

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

Enabling ISAPI logging

1. Open isapilog.cfg (...\TIBCO Nimbus\Web Server\Config) in a text editor, such as Notepad. To enableISAPI 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 ...\TIBCO Nimbus\WebServer\Logs).

Enabling Web Server logging

1. Open websvrlog.cfg (...\TIBCO Nimbus\Web Server\Config) in a text editor, such as Notepad. To enableWeb 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 ...\TIBCO Nimbus\WebServer\Logs).

4.1.4 Configuring Page Hit Logging

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

Configuring page hit logging



1. Open config.ini (...TIBCO Nimbus\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 to the logfile, in milliseconds (default = 5000).

2. Save and close config.ini.

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

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

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

Document Document number.

4.1.5 Configuring Web Hit Logging

The Web Log Utility provides a method for logging web page hits and either storing them in a specifieddatabase or saving the data as a metric-related Excel or CVS data file. This task can be run as a Windowsscheduled task.

Note: Page Hit Logging must be enabled; this is enabled by default. See Page Hit Logging for moreinformation.

Saving Web statistic as an Excel or CSV file

1. Run WebLogsUtility.exe (...TIBCO Nimbus\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.Total page hits for each day, week or month will display the total number of web server pagesaccessed.Total page hits by map for each day, week or month will display the total number of web serverpages accessed for each map.Total page hits by user group for each day, week or month will display the total number of pagesaccessed by each user group.Include Metrics Sheet (Excel only) will create a separate metrics data sheet for the selected webstatistics.



There are also a number of options to include total page hits for diagrams, documents and storyboards,and the total number of user logins. These can be accessed by selecting the respective tabs - ByDiagram, By Storyboard, By Document and Total Logins.

Saving Settings

You can save the settings you have defined by clicking Save settings to WSE file. This file is usedwhen creating a Windows scheduled task and running the operation from the command line.

6. Click Export to file.



Exporting Web statistics to a database

The Web Log Utility allows you to export statistics to an existing database, such as MS SQL Server, MicrosoftAccess and MySQL. If you do not have a database then this utility also allows a new ODBC database to becreated with associated table structures. See To create a ODBC database below for more information.

1. Run WebLogsUtility.exe (...TIBCO Nimbus\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 the connectionstring.Allow saving password allows the password to be saved with the connection string. If saved,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 appropriate tables exist inthe database. If you do not want to include user group information then proceed to Step 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 file is usedwhen creating a Windows scheduled task and running the operation from the command line.

12. Click OK.



Creating ODBC databases

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

1. Run WebLogsUtility.exe (...TIBCO Nimbus\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 more information.

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 not want toinclude 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.

Running 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 order to exportweb statistics to either a database or to file (Excel or CSV). A settings file must be referenced, which iscreated using the Web Log Utility. WLD settings files define exporting to a database and WSE settings filesdefine exporting to an Excel or CSV file. For more information on creating settings files see the relevantsection above.

When exporting web statistics to a database, a ODBC database is required. If you do not have a databasethen you can create a new ODBC database with associated table structures using the Web 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:\TIBCO Nimbus\Client\Utilities\WebLogsUtility.exe "C:\TIBCO Nimbus\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 the samedirectory 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 behavior of the Action Server.

Configuring the Action Server

1. Open config.ini (...\TIBCO Nimbus\Action Server) in a text editor, such as Notepad. Modify the followingparameters:

SystemLoggingLevel The level of logging that is written to the Email log filesTempPath 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 configuration options:

Lock Service

Configure the start and stop times of the process repository lock to allow for the manual backing up ofdata. See Third-party Backup Utilities for more information.

LDAP

Configure Single-sign On via LDAP synchronization. See Configuring LDAP synchronization for moreinformation.

SMTP

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

Office Integration Server

Configure the integration between TIBCO Nimbus and Excel for metric-based data and Excel-basedscorecards. See the TIBCO Nimbus Office Integration Server PDF in the Documents folder on the CD formore information.

Related topics

Managing TIBCO Nimbus Services



4.2.2 Configuring SMTP Email

The Action Server's Email service can manage system Emails. HTML Emails are generated and sent to adesignated SMTP server at times specified in the polling period. By default, access to the SMTP server isunauthenticated; you can allow authenticated access if required.

Setting authenticated SMTP access

1. In the Client, from the Administration menu choose Application Credentials, then Action Server EmailService.

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.

Setting Email options

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

EmailPollingPeriod The frequency that the Email queue is checked, in secondsSystemType The Email system that is supported (currently only SMTP is supported)Path The path of the process repository. This is the location that the Email queue residesNDRRecipient The Email address that non-delivery reports are sent toSystemSender The Email address that sent Emails will appear fromSystemSubject The text that appears in the subject field of system-generated EmailsVerifyNames The TIBCO Nimbus Email Service will attempt to verify Email addresses against the

mail server before sending messages (note: this option is not supported on mostservers, in which case you may need to disable this option). 0 = Disable (default), 1 = Enable

MaxRetries The number of delivery attempts before an Email is deletedNote: Once an Email fails to be sent after x number of times it is deleted and an entryis added to the log. A delivery failure attempt requires successful connection to aSMTP service, meaning that the retry counts are incremented when there is a networkoutage. If the value is set to 0 it will retry indefinitely.

CombineEmails Send all emails to recipients in a single Email. If disabled, emails are sent separately,with the notification titles used as the subject of the emails.0 = Disable, 1 = Enable (default)

MaxSMTPTime The maximum time (in msecs) that the email service will remain connected to theSMTP server in a single session.0 = Disable, 1 - x = Max connection time (in msecs)

MessagesPerHour The maximum number of emails that will be sent per hour. Note that the number ofemails sent per session is dependent on the polling period value (for example if the

Action Server Configuration 91


PollingPeriod is set to 600, i.e. emails are sent every 10mins, and theMessagesPerHour is set to 1000, then a maximum of 167 emails will be sent in eachsession).0 = Disable, 1 - x = Number of messages to send (per hour)

SMTPHost The name or IP address of the SMTP serverPort The listening port of the SMTP server (usually 25)Verify Enable or disable the Verify command

0 = Disable, 1 = Enable (default)UserName The user name required to authenticate with the SMTP server using the AUTH LOGIN

functionalityPassword This is set by the Client and is a base 54 encoded encrypted passwordEncryptionType Specify the level of password encryption

0 = Password can be decrypted by any PC

1 = Password can be decrypted only by the PC that performed the original encryption

2 = Password can be decrypted only by the PC and original user that performed theoriginal encryption

Anonymous Anonymous access to the server can be enabled0 = Not anonymous, 1 = Anonymous (default)

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 provide more orless detail.

Enabling SMTP logging

1. Open config.ini (...\TIBCO Nimbus\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 an action didnot occur at a polling period) Note: Recommended setting when 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 every email thatis sent, including the email address, message contents and the related item.

Note: Generated log files - yyyymmddx.log - are stored in ...\TIBCO Nimbus\Action Server\Logs\Email

4.2.4 Configuring LDAP Synchronization

For information on configuring LDAP synchronization, refer to the Configuring LDAP integration topic in theInstallation section.

4.2.5 Testing LDAP Synchronization

Following the configuration of LDAP integration, it is recommended to test the synchronization between theDirectory Service list of users and the TIBCO Nimbus list. The LDAP Configuration Tool provides the ability totest an LDAP synchronization, as well as allowing you to create a new LDAP configuration file. When LDAP



synchronization is tested, the results of the synchronization will be displayed but no data will be written.

Note: Increasing the logging level in the LDAP configuration file will provide more details results

Testing 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 ...\TIBCO Nimbus\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 connection settings inthe LDAPConfig.ini file

Testing LDAP authentication

1. Click in the User Name and Password text boxes and enter a user name and password that has currentaccess to the directory service.

2. Click Authenticate.

Defining 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 configuration parameters.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 Scheduled Task. Run thefollowing command:

<Path of LDAP Utility> <Path to process repository>For example:

"C:\TIBCO Nimbus\Client\Utilities\LDAPUtility.exe" "C:\TIBCO Nimbus\Process Repository"

4.2.6 Configuring LDAP Synchronization Logging

On start-up the LDAP Service creates a log file, which will report on any issues with the synchronization.

Enabling LDAP Synchronization logging

1. Open LDAPConfig.ini (...\TIBCO Nimbus\Process Repository\LDAP) in a text editor, such as Notepad. 2. In the [MainSection] enter the desired logging level for the LoggingLevel parameter.

0 None Startup, Shutdown1 Low Startup, Shutdown, Synchronization times2 Medium Startup, Shutdown, Synchronization times, Added users, Removed users3 High Startup, Shutdown, Synchronization times, All users added to each group, All

users removed from each group, Duplicate users, Updates to user preferences

Action Server Configuration 93


4 Full Startup, Shutdown, All users added to each group, All users removed from eachgroup, Properties retrieved for each user, Duplicate users, Updates to userpreferences

Note: It is recommended to set the logging to low when in production. The log file - LDAP.log - is storedin ...\TIBCO Nimbus\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 Intelligence Server.

Configuring the Business Intelligence Server

1. Open BiSvc.ini (...\TIBCO Nimbus\BI Server) in a text editor, such as Notepad. Modify any of theparameters, as required.

DATAFOLDER

Path The path of the process repository (this can be a UNC path name)

OPTIONS

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 an SMSmessage

RetryAttempts The number of retry attempts before aborting notification

TEXT

Up The text that is sent via Email and SMS when a value breaches a threshold valueand is ascending. The text can include three substitution parameters:

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 a threshold and isdescending. For example, Down = Measure <TITLE> has decreased to <VALUE>.<NOTES>.

Url The diagram URL. For example, Url = Go to the diagram <URL>.

EXCEL

Host The machine that the Office Integration server is located on (machine name or IPaddress)

Port The listening port number of the Office Integration Server

PollingMinutes How often the metric value is checked (default is set to check metric valuesevery 60 mins - min. is 10 mins, max. is 10080 mins)

EMAIL

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, TIBCONimbus Administrator.

Business Intelligence Server Configuration 95


SMSWhere Short Message Service (SMS) is required, a SMS service provider is required to send the textmessages. More than one service provider can be specified but only one may be active at any one time.Contact TIBCO 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).

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)

CLICKATELLBy default, TIBCO Nimbus provides a service provider module for Clickatell. Note: A Clickatell accountis required, which can be obtained from Clickatell.

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.

Testing 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 processing Excel metriclink notifications (if necessary).

4. Run the SSync.exe (from the TIBCO Nimbus 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 period is setto. 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. This definitionfile is created by running the System Synchronization Utility that is installed with the Web Server. Updatingmetric data in TIBCO Nimbus can be scheduled as a Windows Scheduled Task.

Note: The System Synchronization Utility is also used to synchronize the Web Server, for example toupdate flow line links, recurring reviews, the Search database, etc. See Synchronizing the Web Server formore information.

http://www.clickatell.com



Scheduling Business Intelligence Server synchronization

Synchronizing the Business Intelligence Server can be run from the command line, or it can be automaticallyscheduled using Windows Task Scheduler. The System Synchronization Utility can be found in ...\TIBCONimbus\Web Server\Utilities.

Run the following command:

<path>/ssync.exe <path of ini file> [<path of log file>] -measure

For example:C:\TIBCO Nimbus\Web Server\Utilities\ssync.exe C:\TIBCO Nimbus\WebServer\Utilities\SSyncResults.log] -measure

Note: If no path is defined then the utility will search for the configuration file in the local folder.If no path to the log file is defined then it will use the local folder. It is advised that a WindowsScheduled Task is created, using the command above. If set to run as a scheduled task, theSystem Synchronization Utility must not be running when a process repository backup is inprogress, as this can lead to inconsistent and corrupt data in the backup.

4.3.4 Configuring Business Intelligence Server Logging

Logging of the Business Intelligence Server, via the Log4D component, is configured through the BiSvcLog.cfgfile.

Note: Business Intelligence Server logging is usually only necessary when requested by TIBCO NimbusSupport in order to resolve any issues that you may have with the Business Intelligence Server.

Enabling Business Intelligence Server logging

1. Open BiSvcLog.cfg (...\TIBCO Nimbus\BI Server) in a text editor, such as Notepad. To enable logging youmust 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 ...\TIBCO Nimbus\BIServer\Logs

User Management

Chapter 5


Chapter 5 User Management98


5.1 Creating Users and User GroupsUsers 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 Administration under Administration inthe TIBCO Nimbus Author Client Help (accessed from the Help menu in the Client, or for context-sensitivehelp, click the Help button on the dialog that you want help for).

User and User Group Creation

TIBCO Nimbus users must exist in a user group. Three core user groups exist - Administrators, Authors andEnd Users, each group having different system permission and access rights set. You can also createadditional groups with their own set of permission rights; however, a user must exist in one of the core usergroups:

Administrators

These users create and maintain user accounts and have access to all features within the Author Clientand Web Server.

Process Authors

These users create, edit and manage process content. They have access to both the Author Client andWeb Server. These users are also entitled to use the TIBCO Nimbus Player Desktop Edition and theTIBCO Nimbus Player iPhone Edition.

End Users

These 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 aregoverned by which modules specific an end user has assigned to them.

To create a user or user group, from the Tools menu in the Author Client choose Users and then UserAccounts. To create a user, from the Member menu choose New User. To create a user group, from theGroup menu choose New Group.

User Group Permissions

TIBCO Nimbus comprises of a number of areas of features and functionality and each area can be controlledfor each user group. This is useful, for example, if you do not want one type of user group to access an areaof functionality until they have had training.

Note: User group permissions work in conjunction with users' settings, meaning that the user must havea particular option enabled in their user settings and within the user group's settings to be able to usethat functionality.

By default, the <Everyone> group incorporates all TIBCO Nimbus users and this allows global access rightsand permissions to be set. You can then assign access rights and permissions for specific 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 thegroup and choose Group Properties.

Creating Users and User Groups 99


User Account System Options

There are a number of system configuration options that affect user accounts, such as the registration of newuser accounts, the incorrect password retry limit, automatic log on when account names match the networklog on names, etc. These should be defined before creating user accounts and in accordance with anorganizations internal policies.

The system options are accessed in the Author 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. CentralLibrary Resources can be imported, merged and updated from a file (note that local resources cannot beimported). There are two options for updating a Central Resource Library, the first will replace all centralresources and delete any resources that are not in the data file. The second method will update existingresources but it will not delete existing resources that are not specified 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],[Display Name],[Group Name]For example

Printer,2,HP (Color),First Floor,HP Color Printer (First Floor),Printers

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 TIBCO Nimbus 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.

Importing 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 Resource Library.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 Resource Library.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.

Chapter 5 User Management100


5.3 Importing User Roles

Roles provide the ability to align people with what they do in a process and to make their involvement visible.Users' roles in TIBCO Nimbus can be imported from file.

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.

Importing 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 Administration102


6.1 Importing and Exporting Data

6.1.1 Exporting Diagrams as XML

A scope of diagrams can be exported as XML and a number of options can be specified. This process can beautomatically scripted and set up as a Windows scheduled task.

Exporting 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:\TIBCO Nimbus\Client\Ctrl.exe "E:\TIBCO Nimbus\Process Repository" "C:\ExportedMaps\XMLExport.csf"

Script (.csf) FilesA TIBCO Nimbus script file defines the parameters to automate the export of diagrams in XML format. Tocreate 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>"

Note: The map path can be copied from the Where Am I? window in the Author Client when viewing themap (from the Map menu choose Where Am I?).

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), drilldowns, activities, resources, attachments (including data tables), costing information, activity inputs/outputs, commentary text, flow-line links, free text, change logs, authorizers, acknowledgers, history andaudit logs, acknowledgement logs, subscribers, memos and change requests.

Simplified

Simplified XML export creates a single file and includes all diagrams (within the specified scope), diagramURLs, 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 andstatement data. Note: The Simplified XML export includes the respective TIBCO Nimbus Web Server URLs

Importing and Exporting Data 103


for the following attachment types - diagram links, internal WP documents, internal images, storyboardlinks, file/Document Registry links and scorecards. These URLs are useful, for example, when integratingwith external search systems if you want to include process content in search indexes. Data tableinformation is also included in the exported XML, including all field values.

Leaf Only

Leaf Only XML export creates a single file that includes all diagrams except diagrams that have drill 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 "Draft\Sales and Marketing" "C:\Exported Maps" /Simplified /Scope:1 /Diag:3CA5EFDFF00840A5A39540394EC77BBF /Text /Draft /Memos /Changes

An example command for a map in a folder:XML_EXPORT "Process Maps\Support Maps\Master\Customer Support" "C:\Exported Maps" /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 the script fileand is created in the same location.

6.1.2 Exporting Data to a Database

The data that is held within a process repository can be exported to a nominated database, such as SQLServer, using the Data Export Utility. The utility can be run as a scheduled task or it can be run manually. It isadvised that the utility is run overnight, or when few users are logged into the system.

For further information and instructions on exporting data from a process repository to a nominated database,please refer to the Exporting to a SQL Database PDF in the Documents folder on the Installation CD.



6.1.3 Importing Data Tables

Data tables can be updated, replaced and merged from file. The format of the data table file is CSV and thefollowing 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) and O (on oroff)

Updating 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 data tables fromfileMerge 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.

Importing and Exporting Data 105


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 a scheduledWindows task.

Manually updating Excel macros

1. Run ExcelMacroLauncher.exe (...\TIBCO Nimbus\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 Windows scheduledtask.

Use the following command:<Path to ExcelMacroLauncher.exe> <File> <Save> <CLEARRO>

For example:"E:\TIBCO Nimbus\Client\Utilities\ExcelMacroLauncher.exe" "E:\Excel1.xls" Macro1 Save CLEARRO

Note: The Save parameter is optional; if included, the spreadsheet will be saved after the macro hasbeen executed. The CLEARRO parameter will remove the read-only flag (if present) on the file beforerunning the macro; the read-only flag is set if a user with read-only access runs the scorecard in theAuthor Client.

Logging

A log file is created when the utility is run; these logs are written to a Logs folder from the location in whichthe 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 orcell in order to obtain the KPI value. However, an alternative option uses SQL queries to retrieve the data andthis 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 updating everymetric link.

To retrieve Excel data using SQL queries you need to define some data ranges within the spreadsheet(s).



Defining Excel Data RangesSQL queries can reference data ranges in Excel spreadsheets. The advantage of ranged cells is that evenif they are moved, for example a new column is added to the spreadsheet, the range is maintained.

1. In the Excel spreadsheet select the cell, range of cells or non-adjacent selections that you want toname.

Note: There must be a cell that will be used as the field name. In the example below the cell thatcontains '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 data range hasbeen named KPIRange.

These ranges can then be referenced when creating SQL links in the AdminUtil.

Creating SQL queries

1. Run AdminUtil.exe (found in ...\TIBCO Nimbus\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 the data thatyou 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 107


18. From the Query menu choose Get Data Now to populate the SQL staging table with the respective data.

Using SQL Queries

Following the creation of a SQL query, Process Authors will be able to use it as a data source when creatingmetric links on activities and flow lines, and to retrieve activity costing data (volume and duration). See theTIBCO Nimbus Client Help for more information.

6.2.3 Scheduling and Updating SQL Queries

TIBCO Nimbus stores values that have been retrieved from SQL queries in a cache/staging table, which canbe updated by scheduling the SQL2CtrlUpdate utility to run on a regular basis. The frequency that the utility isscheduled to run will depend on how often the KPIs are updated, but for most scenarios overnight schedulingis sufficient. Specific KPIs that require updating more frequently can be achieved by updating an ID List fileand creating a separate scheduled task. ID Lists are created using the Admin Utility.

Creating an ID List File

1. Run AdminUtil.exe (found in ...\TIBCO Nimbus\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 a Windowsscheduled task:

<Path to SQL2CtrlUpdate.exe <process repository> [<ID List File>]For example:

"E:\TIBCO Nimbus\Client\Utilities\SQL2CtrlUpdate.exe" "E:\TIBCO Nimbus\Process Repository" "E:\SQL Queries\SQLQueryList1.idl"

Note: The ID List file parameter is optional. If an ID List file is not specified then all stored SQL querieswill be updated.

Logging

A log file - SQL2CtrlUpdate.log - is written to whenever the utility is run. The log file is saved in the samedirectory as where the utility is run from.



6.2.4 Integrating with SAP BW and SAP NetWeaver BI

Certified for SAP NetWeaver

TIBCO Nimbus can be configured to integrate with SAP BW and SAP NetWeaver BI. Process Authors can thenlink to SAP metric data in the TIBCO Nimbus client and provide access to end users from flow lines andactivities. SAP reports can also be launched when users access SAP metric links; these reports must bedefined in the Admin Utility.

Notes: If you are integrating with SAP NetWeaver BI, or if your server is not using the default web serviceparameters, you must define the advanced connection settings. See Advanced Configuration Settingsbelow for more information.

If you are using a recent version of SAP BW, the integration will not work due to a change in the locationof the web services. In this case, you must override the system by creating a file calledSAPBWURLPart.npdta in the root of the Process Repository folder. In this file you should specify thelocation of the SAP BW web services; the first line of text within this file will be used as the mid-part ofthe URL that is constructed for accessing the web services in SAP BW.

Configuring the integration with SAP BW or SAP NetWeaver BI

1. Run AdminUtil.exe (found in ...\TIBCO Nimbus\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 BW webservices.

Advanced Configuration SettingsYou may need to modify the server connection settings if you are integrating with SAP NetWeaver BI, or ifyour 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 as XML.However, the data values can be returned with different tag names, which can be specified in the XMLResults Tag Name field.

10. Click OK.



Creating SQL queries 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].MEMBERSON 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 a goodunderstanding of the cube data within your system.

7. Click the Test Results tab to view the data that is retrieved by the query.

Note: TIBCO Nimbus will use the first field from the first record as the value for the metric link, thereforethe 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.

Creating 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 SAP BW metriclinks in the Client.

Scheduling data retrieval from SAP BW/NetWeaver BI

TIBCO Nimbus holds metric data and scorecards that are retrieved from a SAP BW or SAP NetWeaver BIdatabase in a cache/staging table. It is recommended that this table is updated regularly. This can beachieved by either running it as a batch file from the command line, or automatically scheduling it usingWindows Task Scheduler.

Use the following command:<Path to SAPBW2CtrlUpdate.exe> <process repository>

For example:"E:\TIBCO Nimbus\Client\Utilities\SAPBW2CtrlUpdate.exe" "E:\TIBCO Nimbus\Process Repository"

Related topics

Integrating with SAP NetWeaver (to enable launching of SAP transaction links)



6.2.5 Integrating with Cognos Metrics Manager

TIBCO Nimbus can integrate with Cognos Metrics Manager (CMM) in order to retrieve metric data. Metricdata from a CMM database can then be associated with activities and flow lines as metric links in the Client.

Configuring the integration with Cognos Metrics Manager

1. Run AdminUtil.exe (found in ...\TIBCO Nimbus\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 Provider for 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. Click TestConnection 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

TIBCO Nimbus holds metric data and scorecards that are retrieved from a Cognos Metrics Manager databasein a cache/staging table. Updating the data from Cognos Metrics Manager can be run from the commandline, or it can be automatically scheduled using Windows Task Scheduler.

Use the following command:<Path to Cognos2CtrlUpdate.exe> <process repository>

For example:"E:\TIBCO Nimbus\Client\Utilities\Cognos2CtrlUpdate.exe" "E:\TIBCO Nimbus\Process Repository"

Manually updating data from Cognos Metrics Manager

The Cognos Metrics Manager cache/staging table can also be manually updated as and when required.

1. Following the definition of the Cognos Metrics Manager connection, click the Metrics Data tab in theCMM 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 of time,



depending upon the connection.

3. Click OK.



6.3 Integrating with Third-party Applications

6.3.1 Integrating with SAP NetWeaver

Certified for SAP NetWeaver

TIBCO Nimbus supports the integration with a SAP GUI environment and one or more SAP web-basedenvironments. If both environments are enabled, SAP transaction links can be configured to allow users tochoose which environment to launch the SAP transaction in (see the Client help for more information oncreating SAP transaction links). User preferences also dictate if a specific user can launch in one or both ofthe environments.

Note: SAP transaction launching is not supported if there is a mismatch of the librfc32 library between aSAP server and SAP client environments, and when the librfc32 is v640.0.172 or older.

Configuring the integration with SAP NetWeaver

1. Run AdminUtil.exe (found in ...\TIBCO Nimbus\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 from eitherthe 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 Web Server. Whenusers access a transaction link the Launch SAP Transaction dialog is displayed, allowing users to create asession using credentials permitted to launch a remote function call within the SAP system (IFCpermissions).

Launching into a SAP GUI system will require an Active X component to be installed when users accessa transaction link for the first time from the Web Server. If the user chooses to install the component, a ctrlsaplauncher.cab file will be copied to the user's machine. Future versions of TIBCO Nimbus mayrequire 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 a TIBCONimbus 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, thereby preventingmalicious scripts from running.

Domain Based Sessions - sessions are not interchangeable between domains, i.e. a session createdon the local domain cannot be used to gain access from a different domain.

Note: The Microsoft Java Virtual Machine (MSJVM) may cause problems when installing the Active X

Integrating with Third-party Applications 113


component for the first time, for example the user may be directed to a web page displaying an error, orthe web page may simply close. To resolve this problem the Microsoft Java Virtual Machine must beuninstalled. 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 toenter 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)

6.3.2 Integrating with Generic Portals

You can add add Nimbus functionality to other web sites by embedding sections, or widgets, into web pages.

Embedding TIBCO Nimbus Functionality into General Web Sites

TIBCO Nimbus functionality can be added to any web site by adding widgets to the HTML.Note: For information on embedding functionality into SharePoint, click here.

1. Download jQuery 1.x (http://jquery.com/download) and copy it to your web site, for example C:\inetpub\wwwroot\website\nimbus.

2. Copy pagebus.js and tunnel.html from {Nimbus Installation}\WebServer\Main\ui\common\pagebus to the same location where you copied jQuery 1.x to.

3. Create a file called nimbus.widgets.js in the same directory as above. An example of the code thatshould be contained in this file is shown below, however you can modify this accordingly.

http://jquery.com/download



Adding the Javascript to HTML Pages4. Add the following code within the <body> tags of your site's index.html page, replacing the text in red

with your site's details:

<script src="http://server/virtual_directory/jquery-1.11.2.min.js"></script><script>

var tunnelConfig = {uri: 'http://server/virtual_directory/tunnel.html'}

</script><script src="http://server/virtual_directory/pagebus.js" type="text/javascript"></script><script src="http://server/virtual_directory/nimbus.widgets.js" type="text/javascript"></script>

Adding Widgets to HTML Pages

Once you have added the relevant Javascripts, you can add any of the following widgets to any of your webpages in your web site.



Widget URL ExtensionSearch /widgets/searchToDos /widgets/todosRecently Viewed Items /widgets/recentlyviewedProcess Favorites /widgets/diagramsDocument Favorites /widgets/documentsStoryboard Favorites /widgets/storyboardsMeasure Favorites /widgets/measuresKeyword Favorites /widgets/keywordsScorecard Favorites /widgets/scorecardsReport Favorites /widgets/reportsTransaction Favorites /widgets/transactionsEmbedded Diagram /widgets/diagram?map=<diag_guid>Embedded Diagram with Activity andDiagram Explorer

/widgets/diagram?with_extras&map=<diag_guid>

5. To add a widget to a web page, add the following code within the <body> tags, replacing the text in redwith your own details.

<div class="nimbus-async-webpart" data-src="http://webserver_URL/widgets/widget"></div>

Examples:<div class="nimbus-async-webpart" data-src="http://Server1/TIBCONimbus/CtrlWebISAPI.dll/widgets/search"></div>

<div class="nimbus-async-webpart" data-src="http://Server1/TIBCONimbus/CtrlWebISAPI.dll/widgets/todos"></div>

<div class="nimbus-async-webpart" data-src="http://Server1/TIBCONimbus/CtrlWebISAPI.dll/widgets/diagram?with_extras&map=0%3A21B02DF9E0394063816132C6A97F7093&dgm=DF7DADB680CB47EA9CEF7DBB45C2002C"></div>

<div class="nimbus-async-webpart" data-src="http://Server1/TIBCONimbus/CtrlWebISAPI.dll/widgets/diagram?map=0%3A366E87E868D04C488C1D00C0D2E8AA1D&dgm=05DD234A3E3349968B8BEB05EAC33D41"></div>

Note: A diagram's GUID can be found in the Author Client by clicking Map > Where Am I?



Example HTML pageA simplified HTML page displaying all available widgets is shown below as an example.

Embedding TIBCO Nimbus Functionality into SharePoint Pages

You can also embed widgets into SharePoint sites.

Note: To allow the widgets to work in your SharePoint site in the example provided here, you must ensurethe Minimal Download Strategy (MDS) feature is disabled. In the administration pages, choose Sitesettings > Manage site features and then deactivate the Minimal Download Strategy. You can allow thewidgets to work with MDS enabled by modifying the code. Please consult Microsoft SharePointdocumentation for further information.

1. In the _layouts\ folder of your SharePoint site, create a Nimbus folder (...\_layouts\Nimbus).2. Download jQuery 1.x (http://jquery.com/download) and copy it to the _layouts\Nimbus folder of the

SharePoint site.3. Copy pagebus.js and tunnel.html from {Nimbus Installation}\Web

Server\Main\ui\common\pagebus to the same _layouts\Nimbus folder.4. Create a file called nimbus.widgets.js in the _layouts directory. An example of the code that should be

contained in this file is shown above, however you can modify this accordingly.5. In the SharePoint site, click Edit Page.6. On the ribbon, click INSERT > Embed Code and add the following code:

<script src="http://sharepointserver_layouts/Nimbus/jquery-1.11.2.min.js"></script><script>

var tunnelConfig = {uri: 'http://sharepointserver_layouts/Nimbus/tunnel.html'}

</script>

http://jquery.com/download



<script src="http://sharepointserver_layouts/Nimbus/pagebus.js" type="text/javascript"></script><script src="http://sharepointserver_layouts/Nimbus/nimbus.widgets.js" type="text/javascript"></script>

7. Repeat step 5 to add a widget to a SharePoint page using the following code:

<div class="nimbus-async-webpart" data-src="http://webserver_URL/widgets/widget"></div>

Note: See Adding Widgets to HTML Pages above for information on adding widgets.

Launching Storyboards based on Keywords

Storyboards can be launched via the Web Server, based on specific keywords, using the following URL:

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 (") aroundthe keywords. For example, to launch a storyboard that has both 'Request' AND 'Leave' keywords tagged:

http://TIBCO Nimbus/TIBCONimbus/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.3.3 Integrating with OpenText Document Management

A web service is available via the TIBCO Nimbus Web Server that allows documents stored in OpenTextDocument Management to be formally acknowledged through the TIBCO Nimbus Document Registry. Thisfeature is supported in OpenText Document Management v9.7.1 onwards.

6.3.4 Integrating with tibbr

TIBCO Nimbus can be integrated with the social networking tool tibbr (available from TIBCO). Integratingtibbr with TIBCO Nimbus allows authors to create tibbr subjects based on storyboard titles and keywords.Web users will have access to their tibbr Wall through their My Workspace and can search for tibbrdiscussions through My Searches.

Notes: (1) There is a user group permission that allows authors to create tibbr subjects from storyboard titlesand keywords (this is found under tibbr in a user group's permissions). (2) The tibbr section on users' MyWorkspaces is hidden by default for all user groups. To display the tibbr section you must configure users'Home pages. (3) You can modify the size of the tibbr gadgets in the Web Server and assign a custom Homepage tab to the tibbr section header. For more information see Configuring the Web Server.

To integrate TIBCO Nimbus 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 astoryboard 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 integration betweenkeywords and tibbr subjects.

(Optional) You can specify a parent subject title for keyword discussions in the field below. Whenever akeyword 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.

http://www.tibco.com

Maintenance

Chapter 7


Chapter 7 Maintenance120


7.1 Recovering Deleted Maps and DiagramsMaps and diagrams that are deleted through the Client are not completely removed from the processrepository 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 deleted byremoving a drill-down from an activity will be restored as new maps. To reintegrate them back into a mapyou must then import them as a drill down.

Recovering a deleted map or diagram

1. In the TIBCO Nimbus 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.

7.2 Purging Deleted ContentYou can purge all deleted content from a process repository, including all maps in the Deletion RecoveryManager, all related map table records, links table records, statement link records and data table attachmentlink records.

Note: All users must be logged out of the system before proceeding with this operation.

Purging all Deleted Content

1. Run AdminUtil.exe (found in {Installation}\Client\).2. Click Browse and select the process repository that you want to purge deleted content from, and then

click Next.3. Enter an administrator's username and password, and then click Next.4. From the Tables menu, choose Other System Tables > Delete Recovery Table > Purge.

7.3 Checking PerformancePerformance checking of a process repository will measure the speed of creating, reading and copying tablesand mark the overall results against a benchmark.

Note: If the performance is slow you can copy the results and Email them to TIBCO Nimbus Support.

Checking the performance of a process repository

1. Run AdminUtil.exe (found in ...\TIBCO Nimbus\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.

Checking Maps 121


7.4 Checking MapsThe Admin Utility allows you to check the state of all maps within a process repository and any issues will belogged. Some issues can be automatically fixed in the process, assuming you have exclusive access to theprocess repository. Issues that cannot be automatically fixed can be reported to TIBCO Nimbus Support inorder to be resolved.

The following diagnostic checks and fixes are made:

Maps(Check) Required files exist in a .MAP folder for each map.(Check) The DBISAM tables can be opened for each map.(Check) The DBISAM tables are not corrupt.(Check) All maps exist in the Maps table (not included in Standard mode).(Fix) Missing maps are added to the Maps table.(Check) A user groups table exists in each Map folder and can be opened.(Check) A text table exists in each Map folder and can be opened.

Diagrams(Check) Diagrams have entries in the Link table (not included in Standard mode).

(Fix) Missing diagrams are added to the Link table.

(Check) Missing drill downs.

(Fix) Invalid levels are used as the missing drill downs if the title matches the object text, or the drilldown arrows are removed (for free text and bitmap objects the drill down references are removed).

Manually checking a process map

1. Run AdminUtil.exe (found in ...\TIBCO Nimbus\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 not check thateach map exists in a Maps table and that all diagrams have entries in the Link table. Extended Checkwill 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, or from abatch file, you can create a new log file for every run by adding the /N parameter. The following logmessages 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, usergroups 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 image object ismissing in the diagram table for it's child (using the ChildGUID).

Drill Down Points to Invalid Level Drill down, free text or bitmap image points to an invalid diagram level *

Diagram not in Links Table A record for a diagram path and GUID is not present in the Central LinksTable 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 its relativefolder 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 - Process repositorylocked

Process Repository cannot be accessed as it's locked, for example if it'scurrently 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 to createa 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 (when trying tocreate 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 a diagrambased on the GUID code string but fails to find the matching record in theDiagram Table, for example due to incorrectly formatted data. Anexception is also raised.

Error saving diagram Saving a diagram fails after a fix, such as 'replacing the file links' or 'fixinga 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 the BinariesTable.

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 be selected).

Fix: Drill Down Fixed By RemovingObject

A drill down is removed to resolve a diagram issue (requires the Fixoption to be selected).

Checking Maps 123


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 to resolvea diagram issue.

Fix: Link Table Record Added A diagram's GUID and path are added to the Central Links Table as part ofa 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 new tablein 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, or sections ofmaps, rather than using drill downs (or the send to child functionality). Due to the complexity of thedatabase tables, if the copy and paste operation is interrupted due to network problems or accessing thecontent over an unreliable wireless network, for example, then invalid levels may occur.

Scheduling

It is also possible to schedule the utility to run at defined intervals using the Windows Task Scheduler, orthe 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:\TIBCO Nimbus\adminutil.exe" "E:\TIBCO Nimbus\Process Repository" /D /F /N /I /E

Email Notifications

A list of email addresses can be specified to notify selected users after the diagnostic check has been run.Any issues will be included in the body of the Email. In the Admin Utility, from the File menu chooseDiagnostics and then Email List. Click Add to add a new email address.

Note: By default, the TIBCO Nimbus Action Server is used to send out email notifications afterrunning a diagnostic check. However, you can specify a different SMTP email server to use if required,and this is recommended if you are running diagnostic checks against an offline process repository(for example, a backed up process repository). To specify a different SMTP email server, click the Email Server tab in the Diagnostic Check Email Configuration window and select Configure SMTPserver separately. Enter the host and port of the SMTP server, then click Configure SMTP Credentialsto specify the authentication details (if required).



7.5 Backing Up DataIt is advised to backup the process repository regularly, at a frequency in accordance with your organization'sdata retention policies. Backing up should include the associated file system and any linked data that residesoutside of the process repository file system (such as file and document links). Backing up a processrepository and associated data can be achieved either using the TIBCO Nimbus Backup Utility, or a third-partybackup utility. One of these approaches must be chosen and implemented or a consistent backup of the datamay not be available when required.

Important

The process repository should not be backed up whilst on-line, i.e. all connections from the Author Clientand Web Server must be disconnected for the duration of the backup. Scheduled tasks or other processeswhich affect the data (for example SSync.exe, LDAP Sync, Reports, etc) should not be set to run during thisperiod as any changes may result in an inconsistent and unusable backup. Linked data (such as file anddocument links) should also not be modified during this time.

The TIBCO Nimbus Backup Utility

This is the recommended method if you are using Windows Server 2003 or later. TIBCO Nimbus provides autility called the Backup Utility which utilizes Microsoft's Volume Shadow Copy Service (or Shadow Copy).Shadow Copy technology is included in Microsoft Windows and it allows snapshots of data to be taken atregular intervals, to any local, removable or network drive. Snapshots are essentially read-only copies of avolume of data, taken at a specific point in time. By creating a snapshot, the TIBCO Nimbus Backup Utilitywill then create a backup of the snapshot data, avoiding issues with file locks and file editing interfering withthe process. The benefit of this method is that system availability downtime of data is minimized for endusers.

How does it work?

The TIBCO Nimbus Backup Utility locks the process repository upon initiation. After a set time the Web Serveris then also locked (the default is 15mins but this can be changed in the Backup Utility configuration file).After 15 seconds, the utility will request a shadow copy snapshot of all folders set to be backed up. Uponcompletion of the snapshot, both the process repository and Web Server locks will be released. The backupthat is created will be in the form of either a folder, with a time and date stamp and a copy of all specifiedvirtual folders, or a single zipped file, saved to a selected location. Upon completion of the backup thesnapshot will then be deleted by Shadow Copy.

What about linked data?

If any linked data is held on the same drive as the process repository file system then the TIBCO NimbusBackup Utility can be configured to include these folders when backing up (see Backing Up Using The TIBCONimbus Backup Utility for more information). The File and Document Links report (available in the Diagramreport category in the Author Client) provides information on the locations of all linked data. Any linked filesthat reside on different drives must be backed up separately.

Third-party Backup Utilities

Shadow Copy is not available in Windows 2000 Server, or you may have your own third-party backup utility. ALock Service is provided as part of the Action Server installation and this must be used with any third-party

Backing Up Data 125


backup utility in order to ensure that the process repository copy is internally consistent and valid.

How does it work?

The Lock Service locks down a process repository and prevents end users from modifying any of the files. Thestart and stop times for the lock service are defined in the Action Server's configuration file. During thelockdown of the process repository, a stable backup of the process repository file system can be taken,therefore the period over which the lock service runs should be set to the duration of the backup process.

What about linked data?

Any linked files that reside outside of the process repository file structure should also be backed up at thesame time. The File and Document Links report (available in the Diagram report category in the AuthorClient) provides information on the locations of all linked data. These locations should then be included aspart of the third-party backup configuration.

7.5.1 TIBCO Nimbus Backup Utility

The following method describes how to back up a process repository and associated folders using the TIBCONimbus Backup Utility and Volume Shadow Copy Service (Shadow Copy). Note that Shadow Copy is onlyavailable in Windows Server 2003 and later.

Setting the Lock Mode

The first thing you must do, if it has not already been set, is to set the lock mode in the Web Serverconfiguration file.

1. Open the Web server configuration file in a text editor, such as Notepad (default location is C:\TIBCONimbus\Web Server\Config\config.ini).

2. In the [DataFolder] section, set the LockMode parameter to '1'.3. Save and exit config.ini.

Configuring the Backup Utility

There are a number of configuration settings for the Backup Utility which should be reviewed and configuredif required before running the Backup Utility for the first time. Note that in a multi-server configuration, theBackup Utility must be set to run on the server which hosts the process repository.

1. Copy CtrlBackupUtil.exe and BackupConfig.ini (from the Utilities folder on the CD) to a local or networkdrive.

2. Open and edit BackupConfig.ini, as required, then save it.

Path The 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 to back up (must be on same drive as process

repository).UseZip Compresses the backup folder into a single zip file upon completion of the backup

process.0 = Disable (default)1 = Enable

TempFolderForZip The temporary folder for compressing backup folders into a single zip (using the



UseZip option) before transferring to the backup location. This option is useful ifthe backup destination is a network share as it reduces network traffic and speedsup the backup process due to only transferring a single file. Once the file transferis complete the temporary folder will be deleted.

MaxBackups The maximum number of backups to store at any given time. When this threshold isexceeded, the oldest backup will be deleted.0 = Unlimited (default = 7)

LockPeriod The waiting period between applying the client lock and initiating the backup, inminutes. Note: A minimum of 5mins is recommended to allow any long operationsto complete.

SendWarningsTo The Email addresses that are used for notification if a backup fails. Note: Thisrequires that the Action Server is installed and running. Multiple email addressesmust be separated by semi-colons.

FixedTargetFolder Specify whether to use the same folder for backups, i.e. 'TIBCO Nimbus Backup', orcreate a new folder with the date and time appended. Note: Folders are createdautomatically. If the same folder is used for backups then any existing folders willbe renamed to TIBCO Nimbus Backup n, where n is the next available number.0 = Date and Time as folder name (default)1 = 'TIBCO Nimbus Backup' as folder name

ExternalApp Specify an external application or script to run after the data is moved to thebackup location but before it is compressed (if UseZip is enabled). Note: If runninga script you must first specify the host for the script, e.g. "wscript C:\script.js". Youcan also specify the target backup folder to be provided to the external applicationor script by adding the "<TARGET_FOLDER>" parameter, e.g. C:\script.js"<TARGET_FOLDER>". Note: The target folder will be automatically replaced withthe correct path when the external application or script is run. See DiagnosticChecking below for more information.0 = Disable (default)1 = Enable

LongReturnVal Specify whether to log the exit code of the external application. Note: Any non-zerovalues are treated as errors and an email notification (if configured) will be sent.0 = Ignore exit code (default)1 = Log exit code

TimeOutMins Specify the time, in minutes, to wait for the external application to complete. If theapplication times out then the data will not be compressed, and an emailnotification (if configured) will be sent (default=0, unlimited).

RetryPeriodSecs Specify the amount of time to wait after a snapshot has been rejected (due toanother snapshot being in progress) until the operation is retried.

RetryLimit Specify the total amount of times to retry the operation.ErrorEmailSub Override the subject of the email sent to users when an error occurs.SendSuccessTo Define a list of email addresses (separated by semi-colons) to send the email to

when a backup has successfully completed.SuccessEmailSub Override the subject of the email sent to users when a backup has successfully

completed.

Backing Up Data 127


Scheduling the Backup Utility

After configuring the Backup Utility you can create a scheduled task to run the Backup Utility at set timesusing Windows Task Scheduler. Use the following command to create a batch file:

<Path of CtrlBackupUtil.exe> <Path of BackupConfig.ini>

For example:

"C:\TIBCO Nimbus\CtrlBackupUtil.exe" "C:\TIBCO Nimbus\BackupConfig.ini"

Diagnostic Checking

It is possible to launch a diagnostic application, batch file or script on the backed-up data after a snapshotof the data has been taken and before it is compressed for storage. This is configured in the [ExternalApp]section in the configuration file. For example, you could run the map diagnostic check in the Admin Utility -see Checking Maps for more information.

7.5.2 Third-party Backup utilities

The following method describes how to lock the process repository using the Lock Service in order to allowyou to back up the process repository and associated files.

Important

If the Lock Service is not used when backing up your data, files could be modified during the backup processwhich could result in a backup that is not internally consistent and therefore invalid. For the same reason,scheduled tasks (such as SSync, LDAP synchronization, Reports, etc) should not be scheduled to run duringthe backup period.

Setting the Lock Mode

Ensure that the LockMode parameter is set to '0' in the Web Server's configuration file.

1. Open the Web server configuration file in a text editor, such as Notepad (default location is C:\TIBCONimbus\Web Server\Config\config.ini).

2. In the [DataFolder] section, set the LockMode parameter to '0'.3. Save and exit config.ini.

Specifying the start and stop times of the Lock Service

The start and stop times for when to lock and release the process repository must be defined.

1. Open Config.ini. (found in C:\TIBCO Nimbus\Action Server) in a text editor, such as Notepad.2. In the [LockTable] section modify the StartLock and StopLock parameters:

LockTableStartLock The time at which to lock the process repository.StopLock The time at which to unlock the process repository. Note: If the times are the same

then a lock will not be applied.3. Save and exit Config.ini.

Scheduling your third-party backup utility



Once the start and stop times of the Lock Service have been set, you can schedule your backup utility to runbetween the lock period. It is important to leave 5 minutes after the process repository has been lockedbefore starting the backup process as this allows time for any processes that are already running to becompleted.

Backing Up Data 129


7.6 Archiving Maps

What is an archive?

An archive is a complete copy of an entire process map from the top level (level 1) diagram down to thelowest levels. It essentially provides a snapshot in time of the process map so that it can be viewed, forexample for audit or comparison purposes, and also provides a method for restoring data from older versionsif required.

Depending on what system options are set, archived maps are stored as compressed copies of the map,which includes all document attachments and file links at the time of archiving. An uncompressed copy of thearchive is also taken to allow the instant access to the content. Uncompressed copies are only maintained fora certain period of time, as set in the system options.

Archiving applies to snapshots of entire process maps, i.e., it is not possible to archive sub-sections of a map.TIBCO Nimbus therefore advises that several maps are maintained based on different business divisionswithin an organization rather than a single map that covers the entire enterprise. This allows for moremanageable archiving and scheduling of draft promotion operations without impacting other work that maybe in progress on other areas of a map.

It is important to realize that archives should not be substituted for taking regular backups of data. A backupis a complete snapshot copy of all the data within a process repository, including maps, documents, systemfiles, user files, database tables and configuration files. See Backing Up Data for information on backing upan entire process repository.

Compressed versus Uncompressed ArchivesArchives are created by the TIBCO Nimbus Author Client software via the TIBCO Nimbus Batch Server duringscheduled draft promotion operations. When an archive is created it will be created as an uncompressedcopy of the map. This saves time during large draft promotions. Users can easily access uncompressedarchives in the Author Client and in the web interface.

Compressed archives can be stored for longer periods. If only a compressed archive version of a map existsthen it will not be available for quick viewing through the Author Client or web interface unless it is firstrestored.

Documents LinksIn most installations the Document Registry is used to store process documents and these are linked torelevant activity boxes throughout process diagrams. When process maps are archived, any linked documentswill remain unaffected and the links to those documents in the Document Registry will be maintained. Thismeans that when users click a document link in a 'live' uncompressed archive, it will link through to the latestversion in the Document Registry in the same way as if the document is accessed from the current master ordraft version of the map.

For compressed map archives a copy of the current version of the linked document is included in the archive.This provides a snapshot not only of the process but all linked documents at the time the archive was taken.Copies of linked documents are stored inside the \Process RepositoryATTACH folder inside the archive (.arc)file. Note that archive files are zip-compatible. When a compressed archive is restored then all archived



documents will also be restored and the document links in the restored map will point to the old documents.To prevent overwriting the current versions of documents in the Document Registry, old linked documents arerestored into a new folder within the Process RepositoryATTACH folder, i.e. outside of the Document Registry.

The folder structure that is created in the \Process RepositoryATTACH folder is based on the folder structureof where the archive is stored and the last folder name from the document's original file path. For example, ifthe last folder name is 'Test Files' from the original C:\Temp\Test Files\ location, a sub-folder called 'TestFiles' is created inside an Archive\<archives folder>\ location. The document links throughout the diagrams inthe restored archive map are automatically updated as file links to the old (restored) versions of thedocuments. Note that relative file paths are used when linking to documents in the ProcessRepositoryATTACH folder.

If there is a need to revert to using an old version of a document which has been restored from an archivedmap, i.e., if the current version of a document in the Document Registry needs to be replaced by the oldversion, the restored version should be copied from the \Process Repository\ATTACH folder into the locationwhere the current version of the draft version is located. In this case, the version number for the documentrecord in the Document Registry should be updated and a comment should be added to the documentrecord's change log to note that the document has been reverted back to an older version.

TIBCO Nimbus Archiving Utility

The TIBCO Nimbus Archiving Utility (CtrlArchives.exe), which is installed as part of the Author Clientinstallation, performs the following tasks:

Compresses archived maps

If the Store compressed static version of map archives system option is enabled, any map foldersstored in the specified archive location will be automatically compressed into archived packages

Archiving Maps 131


(.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.

It is recommended that the TIBCO Nimbus Archiving Utility is scheduled to run once a week during a period oflow activity in the system, for example every Saturday night.

System Options

There are a number of other system options that govern how your archives are managed by the TIBCONimbus Archiving Utility. For more information on all system options relating to archiving, please refer to theAuthor Client Help - Administration/System Options/Document Control/Archives.

Managing Archives

As many hundreds of archives can build up over time, which requires increasing disk space, there are anumber of system options that can be set in the TIBCO Nimbus Author Client to help to manage yourarchives. These include options to specify how many uncompressed archives to keep for a map at any onetime, or how long to keep them for, and whether to remove old archives or move them to a specific location.These choices will be determined by your data retention requirements.

By default, archived data is stored in a number of 'Archive' sub-folders within the Process Repository folder.This can significantly increase the amount of disk space required for the process repository data andpotentially cause challenges for your daily backup strategy, therefore it is advised to specify a differentstorage location for archives (in the Archives system options this can be set via the Storage location formap archives option). Please note that if you specify a different location for storing map archives it must beaccessible to the TIBCO Nimbus web server and to TIBCO Nimbus users (or a domain account defined for theprocess repository if the software is configured to run in secure repository access mode), otherwise archivescannot be created or accessed.

The storage location for map archives can be on a different drive or just a different folder outside of theprocess repository on the same drive. This facilitates the management of daily backups of the processrepository folder and allows system administrators to adopt a different backup strategy for the archived dataif required.

Note: If the location for storing archives (via the Storage location for map archives) is changed then theTIBCO Nimbus software will need to move all archive data to the new location. This operation may take sometime to complete if there is a large amount of archives that exist. When changing this option you will beprompted to choose whether to move all existing data to the new location.



Choosing Yes will move the data to the new location. Choosing No will save the new system option but thedata will not be moved to the new location. In this case the system administrator should manually move thedata from the \Process Repository\Archive\ folder to the new location. The complete structure should bemoved across to maintain data integrity of the archives.

For more information on the archiving system options, please refer to the Author Client Help - Administration/System Configuration/Document Control/Archives.

7.6.1 Creating Archives

Depending on the system options, process maps can be set to be automatically archived whenever draftcontent is updated and promoted. The existing master map is first archived before being overwritten with theupdated draft content. Automatic archiving is how the vast majority of archives will be generated in TIBCONimbus. However, it is possible to manually create an archive at any time through the Author Client.

Note: Archives can also be taken of draft and scenario maps using the method below.

To manually archive a map (from the Author Client)

1. Open the map that you want to create an archive copy of.2. From the File menu choose Archive Manager.3. In the Archive Manager window, from the File menu choose Archive Current Map.4. Select Yes when prompted to confirm the operation.

To schedule the automatic archiving of a mapIt is advisable to schedule the archiving utility to run at regular intervals using Windows Task Scheduler.The command line below should be used when creating the task.

<CtrlArchives.exe> <process repository>

For example:"C:\TIBCO Nimbus\Client\Utilities\CtrlArchives.exe" "C:\TIBCO Nimbus\Process Repository"

Note: You can also change the output of the log file (by default it is stored in the same directory). Forexample:

C:\TIBCO Nimbus\Client\Utilities\CtrlArchives.exe "C:\TIBCO Nimbus\Process Repository" "C:

Archiving Maps 133


\Logs\Archive.log"

All logs, including any issues with the archiving process, are stored in a log file. Unless otherwise specified,the log file is called ctrlarchives.log and is stored in the same directory as where the utility is run from. Youcan change the output of the log file within the command line. For example:

C:\TIBCO Nimbus\Client\Utilities\CtrlArchives.exe "C:\TIBCO Nimbus\Process Repository" "C:\Logs\Archive.log"

7.6.2 Restoring Archives

Both compressed and non-compressed archives can be restored back into a live process repository.

Restoring Non-compressed Live Archived Maps

To restore a non-compressed archived map

1. Open the map.

2. From the <Draft>/<Master> drop-down, access the archive that you want to restore.

3. Navigate to the parent diagram of the diagram that you want to restore.

4. Right-click on the parent activity and from the Drill Down options choose Export.

5. Enter an appropriate name for the export and then choose a folder in the Process Repository for theexport.

6. Click OK.

The child diagram and all its lower-level diagrams will be copied as a new map. This new map willassume the name of the specified export and will exist in the folder selected for the export.

7. Close the archive.

8. From the File menu choose Open/Manage.

9. Find the folder used for the export above and double-click the map to open it.

Once the content has been restored it can be reviewed in isolation from the current live version of the map.Selected content can then be imported or copied back into the current live draft version of the map asrequired.

Note: This functionality is not supported in versions 9.0, 9.0.1, 9.1, 9.1.1 and 9.1.2.

Restoring Compressed Archived Maps

Compressed archives can be restored back into a live repository via the Archive Manager within the TIBCONimbus Author Client.

To restore a compressed archived map

1. In the Author Client, from the File menu choose Archive Manager.

2. Right-click the map that you want to restore and choose Restore Archive. Alternatively, select the mapand click Restore.



Once the compressed archived map has been restored it can be opened via the Open/Manage window(accessed from the File menu). The map can be reviewed in isolation from the current live version of the map.Selected content can then be imported or copied back into the current live draft version of the map asrequired.

Note: The restore functionality only works if there is a compressed archive of a map. If an expectedcompressed archive version does not exist then check that the system options are set correctly and that theArchiving Utility is scheduled to run as required.

What about old archives?

If your system is set to move old compressed archives to a specified location after x months then those oldarchives will not be available to view from within the Author Client or web interface and they will not belisted in the Archive Manager in the Author Client. This is useful for maintaining the performance of thesystem and managing an ever-growing volume of archive data but it means that an extra step is required ifyou want to restore old archives. To restore an old archive you must first copy the data back into the locationwhere the live/recent archived maps are located. By default this is the \Process Repository\Archive folder, orit may be another folder as specified in the Storage location for map archives system option. The originalarchive folder structure for a particular map archive and all contents within that folder must be copied to thearchive location.

Once the structure has been copied back into the live current archive folder location the Archive Manager willautomatically list the map archives. To restore the compressed archive to the process repository you mustfollow the instructions for restoring compressed archives above. It is recommended that you discuss anyplans to restore old archives with the TIBCO Nimbus Support team before proceeding.

Archiving Maps 135


7.7 Managing Database TablesThere are a number of tables that hold TIBCO Nimbus data. If you are experiencing problems with any ofthese data tables then there are a number of options available.

Maintaining tables should be attempted by experienced users only. Please contact TIBCONimbus Support before undertaking any actions.

Managing data tables

1. Run AdminUtil.exe (found in ...\TIBCO Nimbus\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 Create RebuildMaps

Maps Folder

Links

Diagrams

Binarys

Levels

Language Variants

Document Registry

Action Server

Other System Tables:Action

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.

Repair Rebuild the indexes and fix corrupted headers, where possible. Repair options should notbe run on a table unless the data in a table is corrupted.

Create Create an empty table if a table does not already exist. If you are creating a Maps tablethen 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.

Managing Database Tables 137


7.8 Synchronizing the Web ServerThe System Synchronization Utility updates the data that is presented to users through the Web Server. Itshould be run daily and can be run manually, from the command line or, ideally, as an automated Windowsscheduled 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 update metric data.See Synchronizing the Business Intelligence Server for information. If set to run as a scheduled task, theSystem Synchronization Utility must not be running when a process repository backup is in progress, asthis can lead to inconsistent and corrupt data in the backup.

Synchronizing the Web Server

1. Run SSync.exe (found in ...\TIBCO Nimbus\Web Server\Utilities).

Note: The System Synchronization Utility can also be run from the Start menu:Program Files >TIBCO Nimbus >Utilities >Synchronisation

Configuration File

The System Synchronization Utility has an associated configuration file config.ini (found in ...\TIBCONimbus\Web Server\Utilities). The following parameters can be modified:

DATA FOLDER

Path The path of the process repository (this can be a UNC path name)

TEXT

ReminderAckReminderAuthReminderRevReminderActOverdueAckOverdueAuthOverdueRevOverdueAct

This is the text that is sent to users in SMS notifications, which can be modified ifrequired.For example, ReminderAck is the text sent to users to remind them of a pendingacknowledgement request. OverdueAck is the text sent to users to inform them ofan overdue acknowledgement request.

SMSWhere Short Message Service (SMS) is required, a SMS service provider is required to send the textmessages. More than one service providers can be specified but only one may be active at any one time.Contact TIBCO 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).

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)

LogFileName The path and name of the log file that is created (defaults to smssync.log if notspecified).

LogAppend Appends to the existing log if set to '1', otherwise it will overwrite the existing log



if set to '0'.

CLICKATELLBy default, TIBCO Nimbus provides a service provider module for Clickatell. Note: A Clickatell account isrequired, which can be obtained from Clickatell.

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 Default is on, '1'. Set this to '0' to turn SSL off.

NOTIFICATIONNotifications can be sent to one or more nominated email addresses, via the Action Server, if any errorsoccur during any synchronization operations.

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 in anynotification emails that are sent out.

Scheduling Web Server synchronization

Synchronizing the Web Server can be run from the command line, or it can be automatically scheduled usingWindows 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 that areremoved from any user groups that are assigned asacknowledgers

-mapsclean Removes old maps from the Deleted folder (see note below)

http://www.clickatell.com

Synchronizing the Web Server 139


-linksclean Removes redundant diagram links (see note below)

-recurringactions Triggers any pending recurring actions

-archiveactions Automatically archives completed actions (see note below)

-sbintegrity Checks integrity of storyboards and sends out notificationsto assigned primary email contacts if issues are found

-storysnap Updates access rights for folders, maps, diagrams andattachments in storyboard snapshots

-sbrebuild Checks and fixes all storyboards for integrity issues

For example:"C:\TIBCO Nimbus\Web Server\Utilities\SSync.exe" "C:\TIBCO Nimbus\Web Server\Utilities\config.ini" "C:\TIBCO Nimbus\Web Server\Utilities\SSyncResults.log" -search -resources -regusage -reviews -withdrawndocs

Note: If no optional parameters are specified then all tasks - except flow line links, Document Registryitems, deleted links and deleted maps - will be updated. If a path to the log file is not defined then it willuse the local folder.

Note: The -mapsclean and -linksclean parameters are not run by default. These tasks should bescheduled separately to run on a weekly basis. Note that the maximum number of days to keep deletedmaps is specified in the Maps system options within the Author Client. For the -archiveactionsparameter, the number of days before archiving completed actions is defined in the Action Settings(within the system configuration options in the Author Client). If this is set to '0' then completed actionswill not be archived.

Logging

A log file is written to whenever the System Synchronization Utility is run:C:\TIBCO Nimbus\Web Server\Utilities\SSyncResults.log

In the Synchronization Configuration file, the level of logging can be defined (default location of configurationfile is C:\TIBCO Nimbus\Web Server\Utilities\config.ini).

LoggingLevel0 No logging1 Low2 Medium (logs all maps that are checked in the Search and My Searches index operation)3 High (logs all maps and diagrams that are checked in the Search index operation and all maps

checked in the My Searches index operation. It also logs the GUIDs of all diagrams for additionaloperations).

4 Max (includes all high-level logging, but also includes additional information, such as the logging ofall entries that were deleted from the Document Registry item usage table via the -regusageoperation and redundant diagram link entries that were removed via the -linksclean operation).



7.9 Monitoring Web Server PerformanceThe TIBCO Nimbus Performance Monitor provides the ability to access some of the internal counters withinthe Web Server in order to monitor the behaviour of the application. The plug-in provides a new counter setcalled TIBCO Nimbus and contains six counters (Active Sessions, Image Execution Time, Images/Sec, PageExecution Time, Pages/Sec and Queue Length). See Installation\Installing TIBCO Nimbus PerformanceMonitor for more information.

Related topics

Configuring Web Server Logging

7.10 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 update the changes. Onemethod is to reset the Internet Information Services (IIS); however, resetting IIS will also reset any other webservices that utilize IIS. A Web Server installation includes some Java scripts to restart, start and stop theWeb Server.

Restarting a Web Server can be undertaken while users are still logged on; any server requests submitted byusers will be queued and, since it only takes a moment to restart the server, users will not really be affected.

Restarting the Web Server

Double-click restart.js in the Web Server installation that you want to restart.

Stopping the Web Server

Double-click stop.js in the Web Server installation that you want to restart.

Starting 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 ...\TIBCO Nimbus\Web Server\Reload.

Restarting, Stopping and Starting the Web Server 141


7.11 Managing TIBCO Nimbus ServicesThe TIBCO Nimbus Service Installer allows the TIBCO Nimbus Action Server services to be managed.

Managing TIBCO Nimbus services

1. Run ServiceInstaller.exe (found in the Utilities folder on the CD).

There are two tabs:

Services By FolderThis tab displays all TIBCO Nimbus services for a specific installation. Click Browse to select a TIBCONimbus folder (e.g. C:\TIBCO Nimbus).

Note: If it is not a default installation, i.e. the Action Server is not installed in the TIBCO Nimbusfolder, deselect Assume normal Control sub folders.

Currently Installed ServicesThis tab displays all services on the system. If you have multiple installations of TIBCO Nimbus on asingle 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 select eitherAutomatic or Manual from the Select Start Options. Click Install/Update to update the selection.

Add a suffix to services - Select the service(s) and in the Enter an identifier to be added to theservice's names text box enter a suffix. Click Install/Update to update the selection.

Select Service Type allows you to run each service as independent processes, or as a single process.Running all services as one process can help reduce the consumption of resources on servers hostingmultiple author clients.

Related topics

Configuring the Action Server



7.12 Replacing File Link PathsFile link paths, including Excel-based metric links, can be replaced in all maps within a process repository,regardless of diagram access rights and authorization statuses. This is useful, for example, if linked filesare moved to a new location.

Replacing the paths of file links should be attempted by experienced users only. Documentlinks are not updated as part of the process; links to documents in the Document Registrycan be updated in the Client.

Replacing file link paths

1. Run AdminUtil.exe (found in ...\TIBCO Nimbus\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.

7.13 Viewing Map PathsThe physical paths of all maps in a process repository can be checked and the information can be exportedto Excel.

Viewing map paths

1. Run AdminUtil.exe (found in ...\TIBCO Nimbus\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 Tools menu choose Map Paths Viewer.

Note: To export the list of maps in the process repository to a file, from the File menu choose Export GridAs Shown To and then choose a file format.

7.14 Enabling Administrator Access to all DiagramsIt is possible for Administrators to be denied access to a diagram when the default permission rights are setto Access Denied. You can grant access to administrators for all diagrams in the process repository bycreating a .npdta file.

Enabling administrator access to all diagrams

Enabling Administrator Access to all Diagrams 143


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 end of thefile.

Customization

Chapter 8


Customizing the Web Server 145


8.1 Customizing the Web ServerThere are two documents that will assist you in customizing the Web Server; one concerns the Classic WebServer and the other a SharePoint integration.

Classic Web Server Branding

The TIBCO Nimbus browser interface can be customized, including modifying the general look and feel,changing the logo, customizing the look of storyboards, redefining the Home page text and adding andremoving tabs. The Classic Web Server Branding PDF, that is included in the Documents folder on the CD,provides information on modifying the interface to give it a corporate look and feel.

SharePoint Customization Guide

The TIBCO Nimbus site in a SharePoint interface integration can be customized. Most of the customization ofa TIBCO Nimbus site in SharePoint is configured within the SharePoint Administration environment. The SharePoint Customization Guide PDF, that is included in the Documents folder on the CD, providesinformation on modifying the TIBCO Nimbus site to ensure a corporate look and feel.

Support and Feedback

Chapter 9


147


Our specialized team are on hand to provide assistance with the TIBCO Nimbus product. TIBCO SupportCentral (TSC) is an online resource where you can log cases directly, 24 hours a day, 7 days a week. Youcan also view updates on current cases and search the TIBCO Nimbus Knowledge Base.

To access the relevant service, please use the links in the table below.

Requirement Contact Details

To register for a TIBCO Support Central account. Request an account for TIBCO Support Central

To log in to TIBCO Support Central. support.tibco.com

If your support issue is urgent and you have notyet registered for an account please email.

[email protected]

For phone numbers and further information onservice level agreements.

TIBCO Support Services

Feedback

TIBCO Nimbus welcomes any feedback on our supporting documentation as it helps us to improve thedocumentation in future releases. Please email [email protected].

https://support.tibco.com/um/newuser.jsp?rs=lp

https://support.tibco.com

mailto:[email protected]

http://www.tibco.co.uk/services/support

mailto:[email protected]

INDEX148

Index- A -Action Server

Configuring LDAP sychronization 91

Configuring SMTP Email 90

Configuring the Action Server 89

DCOM configuration 62

Installation 62

LDAP synchronization logging 92

Managing services 141

Manually backing up data 127

Testing LDAP sychronization 91

Admin Utility

Email lists 121

Archiving maps 129

Authentication 29

LDAP configuration 29

Netegrity SiteMinder integration 41

Windows Integrated Authentication (WIA) 39

- B -Backing up

Automatically backing up data 125

Manually backing up adata 127

BackupConfig.ini 125

Business Intelligence Server

Configuring the Business Intelligence Server 94

Installation 64

Logging 96

Synchronizing 95

Testing 95

- C -Checking a Process Repository 120

Checking maps 121

Email lists 121

Scheduling 121

Client

Installation 19

Cognos Metrics Manager integration 110

Cognos2CtrlUpdate.exe 110

Configuration

DCOM 22

IIS 22

LDAP 29



Creating users and user groups 98

CtrlBackupUtil.exe 125

Customizing the Web Server 145

- D -Data

Automatically backing up data 125

Manually backing up data 127

Data tables

Importing 104

DCOM configuration

Action Server 62

Web Server 22

Deletion Recovery Manager 120

Directory service integration 39

Document Registry

Integrating with a SharePoint document library 61

- E -Email

SMTP configuration 90

Email lists 121

Enabling administrator access to all diagrams 142

Excel

Creating SQL queries 105, 107

Defining Excel data ranges 105, 107

Scheduling Excel macros 105

ExcelMacroLauncher.exe 105

Exporting

Exporting data to a database 103

Exporting diagrams as XML 102

- F -File link paths

Replacing 142

Fixing database tables 135

- I -IIS configuration

Web Server 22

Importing

Importing data tables 104

Resources 99

149INDEX

Importing

User roles 100

Installation

Client 19

Installing the Action Server 62

Installing the Business Intelligence Server 64

Installing the Windows Server PerformanceMonitor Plug-in 65

Uninstalling Control 66

Web Server 22

- L -LDAP

Configuring LDAP synchronization 91


Testing LDAP synchronization 91

LDAP configuration 29

Lock Service 127

Logging

Business Intelligence Server 96

LDAP synchronization 92

SMTP logging 91

Web hit logging 85

Web page hits 84

Web Server logging 84

- M -Managing database tables 135

Managing services 141

Metrics

Creating SQL queries 105

Defining SAP BW report links 108

Integrating with Cognos Metrics Manager 110

Integrating with SAP BW 108

Integrating with SAP NetWeaver BI 108

Scheduling and updating SQL queries 107

Scheduling Excel macros 105

Updating Cognos Metrics Manager data 110

Updating SAP BW data 108

Updating SAP NetWeaver BI data 108

Migration 12

MIME mappings 84

Monitoring Web Server performance 140

- N -Netegrity SiteMinder 41

Notifications 121

- O -OpenText Document Management 118

OpenText LiveLink 118

- P -Page hit logging 84, 85

Performance checking 120

Process Repository

Migrating 12

Securing a Process Repository 68

Sharing (Important Note) 19

Purging Deleted Content 120

- R -Recovering deleted maps and diagrams 120

Replacing file link paths 142

Resources

Importing 99

Restarting the Web Server 140

- S -SAP integration

Integrating with SAP BW 108

Integrating with SAP NetWeaver 112

Integrating with SAP NetWeaver BI 108

Updating SAP metric data 108

SAPBW2CtrlUpdate.exe 108


Security


Service Installer 141

SharePoint

Adding Control Web Parts 54

Integrating with a document library 61

Upgrading a Control SharPoint user interfaceintegration 54

Single-sign on 29

Configuring LDAP synchronization 91

LDAP 29



Testing LDAP synchronization 91


SMTP Email configuration 90

SQL Query Manager 107

INDEX150

SQL2CtrlUpdate.exe 107

SSync.exe 95

Starting the Web Server 140

Stopping the Web Server 140

Storyboards

Launching storyboards using keywords 113

Synchronization Utility 95

Synchronizing

Synchronizing the Business Intelligence Server 95

- T -Testing


tibbr integration 118

- U -Uninstalling Control 66

Upgrading 12

Upgrading a Web Server 17

User roles

Importing 100

Users

Configuring LDAP sychronization 91

Creating users and user groups 98

Importing resources 99

Importing user roles 100

LDAP 29



Testing LDAP sychronization 91

User account system options 98

User group permissions 98


- V -Viewing map paths 142

- W -Web hit logging 85

Web Server 22

Configuration 70

Configuring MIME mappings 84

Customizing 145


IIS configuration 22

Installation 22

Monitoring performance 140

Page hit logging 84

Restarting, stopping and starting 140

Synchronizing 137

Upgrading 17

Web hit logging 85


Web Server configuration

LDAP 29



Web Server installation


IIS configuration 22



Windows Server Performance Monitor Plug-in 140

Installation 65

- X -XML

Exporting diagrams as XML 102