TIBCO Nimbus Control - TIBCO Software

Classic Web Server Branding

TIBCO Nimbus Control ®

Software Release 8.1.409 January 2012

Important Information

Nimbus Control Classic Web Server Branding

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLEDTIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THELICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSEDBY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.

USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSEAGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCHSEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOADOR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCHSOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THELICENSE FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, ANDYOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.

This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of thisdocument may be reproduced in any form without the written authorization of TIBCO Software Inc.

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

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

THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEMPLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README FILE FOR THEAVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM. THIS DOCUMENT IS PROVIDED AS IS WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUTNOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, ORNON-INFRINGEMENT.

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

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

3Contents


Table of Contents

Scope 41

Introduction 42

Planning 43

Configuring the Look and Feel 54

4.1 General Appearance 5

4.2 Logo 9

4.3 My Searches 11

4.4 My Workspace 13

4.5 Storyboards 14

4.6 Home Page Text 17

4.7 Tabs 19

4.8 Languages 21

Restarting the Web Server 245

5.1 Restart the Web Server 24

Upgrading a Web Server to Version8.1.x 25

6

Classic Web Server Branding4


Scope1

The scope of this document is to provide information and detailed step-by-step instructions inorder to allow administrators to configure a Control Classic Web Server site. This guide coversNimbus Control; whilst some of the features described can be applied to previous versions ofcontrol-ES and Control, it is recommended that clients upgrade to the latest version.

Introduction2

So why brand a classic Web Server? It's a fact that adoption is increased if users within anorganization see little or no difference between Control and their intranet site, so configuringthe Web Server allows Control's web pages to integrate seamlessly into their intranet. Withthis in mind, it is also good practice to remove all references to Nimbus Control from the WebServer and replace it with the client's own brand, for example How To, Xplain, CogKnows,TWWW, Tardis, etc.

Please note that if you are a hosted customer, you must contact Support if you would like tobrand your Web Server. Also, if you are upgrading your Web Server from a previous version,there are some important steps to take to ensure that your branding works correctly. For moreinformation, see Upgrading to Nimbus Control v8.1.

Planning3

Before you proceed with making any configurations to the Web Server you should allocatesome time to planning the operation properly. You should be aware that extensive rebrandingrequires changes to a number of configuration files, thereby complicating any futureupgrades; it is not as simple as copying over the configuration files as this could easily renderthe system inoperable, therefore every change made must be replicated in an upgrade.

Many changes to the Web Server will be immediate, so it is strongly advised that any changesshould be tested in a test environment and not on a live product system. A full change controlprocedure may be required, depending upon the client's requirements.

Important Note: Whether you are using a live or test environment, ensure that you copyeach file before you make any changes; this allows you to roll back should you encounter anyproblems. A back-up strategy could save you a lot of time.

You will need the following from the client:

· Color References (RGB values)· Logo image· Text to display on the left-hand panel of My Workspace/My Searches.

If multiple Web Servers are required that provide different branding for different audiences,for example if an outsourcing company wants to provide a branded front end to each of theircustomers from the same Process Repository, multiple Web Server instances must be set up.Please contact Nimbus Support to discuss this.

Planning 5


Configuring the Look and Feel4

4.1 General Appearance

The general colors and fonts can be modified for the main menu, the top bar settings, the submenu arrows and menu ticks.

Note: If you are on a Nimbus Hosted Service, please contact Support if you would like tomodify any of your Web Server settings.

Method

1. Run WebColorConfig.exe.

The location of the web color configuration utility is:<Installation CD>\Utilities

2. In the top-right corner of the dialog click Browse and select the Control installationfolder that you want to modify. Choose Yes when prompted to load the existing values.

For example:<Installation folder>\Nimbus Control

3. Ensure that the General page (on the left) is selected, and modify any of the followingsettings, as required.

Top Bar Settings

The following options can be configured for the top bar, including the color of the quicklinks and the top bar image:



You can also specify the color of the inactive tabs for users' Home Page.

To-Dos Settings

The text color of past due (overdue) To-do items can be changed.

4. Select the Main Menu page (on the left) and modify any of the following settings, asrequired.

Sub Menu Arrows and Menu Ticks

You can change the colors of the sub-menu arrows and menu ticks:

Note: The highlight colors define the color of the sub-menu arrows and menu ticks whenusers hover their cursor over a particular menu option.

Main Menu

The following options can be configured for the main menu:





Modifying Colors

Selecting a color

To select a color for a particular option click Select Color that is adjacent tothe option that you want to modify.

This will open up the color palette, allowing you to select either basic predefinedcolors or you can define your own custom colors. If you want to use a customcolor then enter the RGB values (red, green and blue) into the respective boxes,or select a color in the color spectrum.

Picking up a color

Alternatively you can pick up a color from another application by clicking the

color picker and clicking a color, for example you could pick up the corporatecolors from a client's website.

Adding custom colors

If you've defined a custom color, either by defining the RGB values or by usingthe color picker, you can add it to your color palette by clicking Add to CustomColors.

Note: Custom colors are not saved and will need to be defined every time youuse the Web Colour Configuration utility.

Hints

· Ensure there is adequate contrast between background colors and the text.

· Avoid using conflicting combinations of colors, such as green text on a redbackground.

· If the client has not provided any preference of colors then experiment tofind colors that will enhance the visual experience for users. There aresome good resources on the internet; Google search "Web Color Schemes"or "Web Color Wheel" for example.

· Keep the Web Colour Configuration Utility open until you are satisfied withthe changes, otherwise any custom colors that you have added will be lost.You can view any changes made by clicking Apply in the Web ColourConfiguration Utility and refreshing the web browser.



4.2 Logo

The logo that appears in the top-left of the Web Server can be changed, for example to displaya client's corporate logo. The default (optimum) size for logos is either 24px or 48px.


Hint: Images can be resized in the majority of image editing software applications (Paint.NETis a free Windows-based application; Google search "Paint.NET").

24px or 48px

The default optimum size of supported logo images is 24px. If the client requiresthe logo to be 48px then you can configure the Web Server to allow the logo tobe displayed over two rows.

1. Open Config.ini in a text editor, such as Notepad.

Note: The location of Config.ini is <Installation folder>\Web Server\Config

2. In the [Menu] section edit the LogoOn2Rows parameter to equal '1'.

3. Save the file.

Method


The location of the web color configuration utility is:

<Installation CD>\Utilities


For example:

<Installation folder>\Nimbus Control

Note: There are five pages that have settings for General, My Searches andstoryboards. These can be accessed on the left-hand side of the dialog. Ensure thatyou are on the General page to modify the logo.



3. On the General page, in the Top Bar Settings panel click Select.

4. Browse to the location of the image and click Open.

5. Click Apply to update the change.

Logo Display

Large Logos

Sometimes a logo looks too small even at 48px. In this situation consider havingthe logo in the Home page text panel instead (see Home page Text below formore information).

Hiding Logos

If you do not want to display a logo on the top bar, for instance if the logo isused in a map template, replace the image with the 1x1.gif image that can befound in <Installation folder>\Nimbus Control\Web Server\Main\images.

Map Logos

When you add a client's logo to the top bar, users will see this on every page ofthe Web Server, so avoid duplicating their logo by removing the logo from alldiagrams and associated diagram templates.



4.3 My Searches

The headers, items and search button can be modified in users' My Searches.


Method


The location of the web color configuration utility is:

<Installation CD>\Utilities


For example:

<Installation folder>\Nimbus Control

Note: There are five pages that have settings for General, My Searches andstoryboards.

3. In the left-hand panel click My Searches to select it.

4. Change any of the following settings, as required. Click Apply to update the changes.

Header Settings

You can change the colors of the My Searches headers:



Item Settings

You can change the colors of the My Searches items:

Search Button Settings

You can modify the font, font size and font color of the My Searches Search button.



4.4 My Workspace

Any changes to My Searches are not reflected in users' My Workspace; the My Workspacestyles are defined in a CSS stylesheet.


Important Note: It is recommended that the stylesheet is backed up prior to making anyedits.

Method

1. Open default.css in a text editor, such as Notepad.

The location of the stylesheet is:

<Installation directory>\Web Server\Main\styles

2. Edit any of the style settings, as required, then save the file.

Please note that the stylesheet is not exclusive to the My Workspace style settings. Thediagram below shows which styles directly affect My Workspace.



4.5 Storyboards

There are two modes for the storyboard interface - Diagram Mode and Text Mode. Note thatonly the Text Mode can be modified. You can however configure the general appearance of thestoryboard interface for both modes. Note: If you are on a Nimbus Hosted Service, pleasecontact Support if you would like to modify any of your Web Server settings.

Method


The location of the web color configuration utility is:<Installation CD>\Utilities


For example:<Installation folder>\Nimbus Control

3. In the left-hand panel select either Storyboard Page or Storyboard Text View.

Storyboard PageConfigure the style of the user interface.



Storyboard Text ViewConfigure the style of Text Mode.

Title Bar Colors

Click Generate to select the top and bottom colors.

Hint: You can also use an existing image as the background for the title bars byclicking Select.



Business Control Colors

Note: You can also change the playback and step note colors of storyboards in the Client. Inthe Storyboard Management dialog, from the File menu choose Preferences. Click the Colortab to select it and modify any of the colors, as required.



4.6 Home Page Text

The Home page text appears on the left-hand side of users' Home pages (specifically, the MySearches and My Workspace tabs). Unless you are performing a demo for the first time, it isrecommended that the text and logo are modified to reflect the client's requirements.

Note: You must restart the Web Server for any changes to be applied. See Restarting theWeb Server for more information. If you are on a Nimbus Hosted Service, please contactSupport if you would like to modify any of your Web Server settings.

Method

1. Open Mypagetext.htm in a text editor, such as Notepad.

The location of Mypagetext.htm is:

<Installation folder>\Web Server\Config

Important Note: Do not use a HTML editor or Microsoft Word to edit this file.

2. Edit the text, as required.



Editing HTML

Creating paragraphs

 denotes the start of a new paragraph and ends a paragraph. Enterthe text that you want to appear within these tags.

This is one paragraphThis is another paragraph...and so on.

Hint: Edit the current text and delete or add paragraphs, as required.

Modifying the style of text

You can change the style of the text for a particular paragraph within theopening tag. For example:



The above style will apply a left and right margin of 20px and use a blue verdanafont for the text within the paragraph tag.

Defining hyperlinked text

You can also hyperlink any text within paragraph tags. For example:

<a href="http://www.nimbuspartners.com/" target="blank" style="color:#00BEDA">Find out more</a>

This example will add the text Find out more and link it to the Nimbus Partnerswebsite.

3. Change the image by editing the first four lines, as shown below:

4. Save the file and restart the Web Server to apply the changes.



4.7 Tabs

Additional (custom) tabs can be added to users' Home page, the order of tabs can be modifiedand it is also possible to hide existing tabs from users.

Note: You must restart the Web Server for any changes to the tabs to be applied. SeeRestarting the Web Server for more information. If you are on a Nimbus Hosted Service,please contact Support if you would like to modify any of your Web Server settings.

Method

1. Open Config.ini in a text editor, such as Notepad.

The location of Config.ini is:

<Installation folder>\Web Server\Config

Important Note: Do not use a HTML editor or Microsoft Word to edit this file.

2. Modify any of the following parameters, as required.

Adding custom tabs

In the [Tabs] section add an entry to define the custom tab, for example:

Enabled=1 (displays the tab, set it to 0 to hide it)TextLocalised1=1 (localizes the tab title, set it to 0 to use the specified Textparameter, below)Text1=<tab label> (this is the title of the tab).Image1=<tab icon> (this is the icon to use on the tab, for example, http://www.examplesite.com/myicon.gif)URL1=<URL> (this is the URL to access when users click the tab, for example,http://www.examplesite.com)ShowAsHyperlink=1 (displays the contents in a new browser window, set it to 0 todisplay it within the Web Server)

By default, custom tabs will appear after the default tabs.

Reordering tabs

In the [Tabs] section edit the Order parameter, for example:

Order=topics,favorites,roles,<custom1>,<custom2>,actionTracker

(Please note that topics refers to My Searches and favorites refers to MyWorkspace)

Renaming tabs

Renaming tabs is achieved by editing the specific localization file that the Web Serveris using. See the Language section below for more details.



Displaying and hiding tabs

In the [Features] section you can display or hide a default tab by setting the value to1 or 0, for example:

MyRoles=0 (this will hide the MyRoles tab on users' Home page).

To display a tab again change the value to 1.

Displaying and hiding tab icons

In the [Home page] section you can display or hide tab icons by setting the value to 1or 0, for example:

ShowTabIcons=0 (this will hide all tab icons on users' Home page).



4.8 Languages

Practically every piece of fixed text in the Web Server is defined in a localization file. Byediting a localization file you can change such things as the Home page tab titles, menu items,page fields, etc.

The Web Server is also designed to support any language, which is achieved by editing anexisting localization file, or creating a new one, and therefore the Web Server can beconfigured by locale. By default, UK English, American English, German, Spanish, Dutch,Swedish, French and Japanese are supported; additional translations may be provided by oneof Nimbus' resellers, otherwise you must define your own translations. You can edit thelocalization files using a text editor such as Notepad (do not use Word or any other rich-texteditor). However, the safest method is to use the LocalisationTextEd utility to assist you inmodifying existing locale files or creating new ones.

There are two files that support a specific language - a language text file and a languageformat file. A number of locale format files are supplied that support a number of languageformats and these can be found in the Web Server\Localisations\Formats folder on the CD. Touse these predefined localization format files you must rename the file to LocaleFormat.<countrycode>. For example, to use the Danish localization format file you must rename itfrom Danish - LocaleFormat.da-dk to LocaleFormat.da-dk. Then copy the file to theLocalisations folder (<Installation folder>\Web Server\App\Localisations).

The following pre-defined localization text files are supplied in the ...\Web Server\App\Localisations folder:

· French (.fr)· Finnish (.fi)· Dutch (.nl)· Italian (.it)· Swedish (.sv-se)· Turkish (.tr)

Note: Please contact Nimbus Support for more information on supporting multiple languages,or if you are on a Nimbus Hosted Server.

Note: You must restart the Web Server for any changes to be updated. See Restarting theWeb Server for more information.

Important Note: Changing any localization strings may require a considerable amount ofwork, depending on what you are changing. For example, if you are changing My Searchesyou may have to edit both sets of English localization files, i.e. UK and US, plus any otherlanguages that are used. You will also need to modify a number of on-screen messages thatrefer to My Searches. Any modifications will also need to be repeated for every upgrade too.

Method

1. Run the Localisation Text Editor utility (LocalisationTextEd.exe).

The location of the Localisation Text Editor is:<Installation CD>\Utilities

2. Click Browse to select the base localization text file, which is LocaleText.en-gb. Inthe Destination file extension, enter the file extension for the language that you wantto specify, then click OK.



Note: You can update two additional language files by selecting the Additional fileextensions checkbox. If the locale text file already exists then any edits you make willupdate that specific file, otherwise specifying a new extension will create a new localetext file.

3. Double-click the text field IDs in the Translated column to modify the respective values.

Hint: You can search and replace text in any of the open language files - from the Editmenu choose Replace.

4. Click Save to save the localization file to the Localisation folder. You must restart theWeb Server for the changes to be implemented.



Removing support for certain languages

Do you really need to cover all languages?

Probably not. In the Web Server configuration file (config.ini) the [Localisations] section defines the language sets supported in the webbrowser.

; en-us=en,$09;en-us,$409;; US English is included in the application with the following mappingen-us=en,$09;en-us, $409

; UK Englishen-gb=en-gb,$809

; Frenchfr=fr,$0C

; Germande=de,$07

; Spanishes=es,$0A

etc...

An active entry in this section will allow a user's PC to show the locale languagevariant of the Web Server strings if their PC is localized to that language. If thereis no active entry for the user's PC locale the system will default to US English.So to limit the extent to which you need to translate locale files you can disablethose languages that you do not want to support by commenting out the code inthe config.ini file.

For example, to remove Turkish as a supported language:

; Turkish; tr=tr,$1F

Note the addition of a semi-colon (;) in the second line. Any user that usesTurkish as their locale will default to US English.



Restarting the Web Server5

5.1 Restart the Web Server

Changes to any localisation files and the Web Server configuration file (i.e. changes to theHome 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 alsoreset any other web services that utilize IIS. A Web Server installation includes some Javascripts to restart, start and stop the Web Server.

Restarting a Web Server can be undertaken while users are still logged on; any serverrequests submitted by users will be queued and, since it only takes a moment to restart theserver, users will not be noticeably affected.


Method

1. Double-click the restart.js file for the Web Server installation that you want to restart.

The location of the restart.js file is:

<Installation folder>\Web Server\Reload

Note: To stop the Web Server without automatically restarting it, double-click stop.js.To start it again, double-click start.js.

Restarting the Web Server 25


Upgrading a Web Server to Version 8.1.x6

A number of changes have been made to the Web Server in version 8.1. If you are upgradingfrom a previous version, and the old mypagetext.htm is copied to the new Web Server, anumber issues may arise with your corporate branding. Follow the steps below to resolvethese issues.

Method

1. Open mypagetext.htm (...Web Server/Config) in a text editor, such as notepad, andperform the following actions:

Remove the Javascript

Delete the following Javascript (as highlighted in blue).

Insert Style Tags

Insert the following style and span tags (as highlighted in blue) in order to format the textcorrectly.



Insert 'qualifyImage' Function

Add the 'qualifyImage' function to the image logo reference in order to ensure that thelogo is displayed in the Web Server.

The font color on the Web Server tabs defaults to black, which can be an issue with certainbranding. If this is the case you will need to edit WSkin.html.

2. Open WSkin.html (.../Web Server/App) in a text editor, such as Notepad, and edit thefollowing code:

Change:.my-tab-container li, .my-tab-container li div { font-family: <%= skinBarFontName %>, sans-serif;

Upgrading a Web Server to Version 8.1.x 27


font-weight: <%= skinBarFontWeight %>; font-size: <%= skinBarFontSize %>; color: <%= skinBarTextNorm %>; }

To this:.my-tab-container li, .my-tab-container li div, .my-tab-container li div a { font-family: <%= skinBarFontName %>, sans-serif; font-weight: <%= skinBarFontWeight %>; font-size: <%= skinBarFontSize %>; color: <%= skinBarTextNorm %>; }

Example:

Date post:	25-Oct-2021
Category:	Documents
Upload:	others
View:	16 times
Download:	0 times

TIBCO Nimbus Control - TIBCO Software

Documents