TIBCO® Openspace Customization Guide€¦ · add-on functionality) of the licensed tibco software....

Two-Second Adv

TIBCO® Openspace

Customization GuideSoftware Release 2.1February 2013

antage®

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.TIBCO, The Power of Now, TIBCO ActiveMatrix and TIBCO Business Studio are either registered trademarks or trademarks of TIBCO Software 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 owners and are mentioned for identification purposes only.THIS SOFTWARE MAY BE AVAILABLE ON MULTIPLE OPERATING SYSTEMS. HOWEVER, NOT ALL OPERATING SYSTEM PLATFORMS FOR A SPECIFIC SOFTWARE VERSION ARE RELEASED AT THE SAME TIME. SEE THE README.TXT FILE FOR THE AVAILABILITY OF THIS SOFTWARE VERSION ON A SPECIFIC OPERATING SYSTEM PLATFORM.THIS DOCUMENT IS PROVIDED “AS IS” WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESS OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT.THIS DOCUMENT COULD INCLUDE TECHNICAL INACCURACIES OR TYPOGRAPHICAL ERRORS. CHANGES ARE PERIODICALLY ADDED TO THE INFORMATION HEREIN; THESE CHANGES WILL BE INCORPORATED IN NEW EDITIONS OF THIS DOCUMENT. TIBCO SOFTWARE INC. MAY MAKE IMPROVEMENTS AND/OR CHANGES IN THE PRODUCT(S) AND/OR THE PROGRAM(S) DESCRIBED IN THIS DOCUMENT AT ANY TIME.THE CONTENTS OF THIS DOCUMENT MAY BE MODIFIED AND/OR QUALIFIED, DIRECTLY OR INDIRECTLY, BY OTHER DOCUMENTATION WHICH ACCOMPANIES THIS SOFTWARE, INCLUDING BUT NOT LIMITED TO ANY RELEASE NOTES AND "READ ME" FILES.Copyright © 2005-2013 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information

| iii

Contents

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .v

Changes From the Previous Issue. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vi

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . vii

Connecting with TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixHow to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixHow to Access All TIBCO Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ixHow to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix

Chapter 1 Introduction. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

About Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2

Chapter 2 Rebranding TIBCO Openspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .3

About Openspace CSS Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4

Rebranding Login. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Rebranding Masthead . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7

Rebranding Gadgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10About Background . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13About Borders. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13About Tab States . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13About Masthead Images. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Replacing Images . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Customizing the Openspace Window Title . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16

Chapter 3 Locking Down Access to TIBCO Openspace Features . . . . . . . . . . . . . . . . . . . . . . .19

Lockdown Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Lockdown System Actions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Openspace Feature Lockdown Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23

Configuring the Lockdown Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 25

Checking Lockdown Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26

Chapter 4 How to Create an Openspace Compatible Gadget . . . . . . . . . . . . . . . . . . . . . . . . . . .29

Getting Started. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30

Creating a GWT Web Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31

TIBCO Openspace Customization Guide

iv | Contents

Modify the Web Application to Make it a GWT Gadget Project. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33

Compile Your Gadget . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35

Making Your Gadget Available to Openspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37

Chapter 5 Localizing Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39

About Localizing Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Manually Localizing Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41About Manually Localizing Openspace . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41How to Manually Localize Openspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44

Appendix A Constraints for Contributing Gadgets in Openspace . . . . . . . . . . . . . . . . . . . . . . 57

Constraints for Contributing Gadgets in Openspace. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Scenario 1 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 58Scenario 2 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59Scenario 3 . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59


| v

Preface

This guide describes how to customize TIBCO Openspace.

Topics

• Changes From the Previous Issue, page vi

• Typographical Conventions, page vii

• Connecting with TIBCO Resources, page ix


vi | Changes From the Previous Issue

Changes From the Previous Issue

The major technical changes from the information presented in the previous issue of this guide are:

• You can now customize the Openspace window title. See Customizing the Openspace Window Title on page 16.

• you customize access to specific Openspace features by uncommenting and configuring the lockdown properties in the CONFIG_HOME\tibcohost\Admin-AMX BPM-AMX BPM

Server\host\plugins\com.tibco.openspace.login_1.5.0.002\resourc

es\config.properties file. Locking down features means that the feature is NOT available to one or more users, depending on how you have configured your lockdown properties. See Locking Down Access to TIBCO Openspace Features on page 19.


Preface | vii

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use

TIBCO_HOME Many TIBCO products must be installed within the same home directory. This directory is referenced in documentation as TIBCO_HOME. The value of TIBCO_HOME depends on the operating system. For example, on Windows systems, the default value is C:\Program Files (x86)\tibco

TIBCO BPM installs into a directory within <TIBCO_HOME>. The value depends on the operating system. For example on Windows systems, the default value is C:\Program Files (x86)\tibco\amx-bpm

CONFIG_HOME The directory that stores TIBCO BPM configuration information, such as property and log files. The value of CONFIG_HOME depends on the operating system. For example, on Windows systems, the default value is c:\ProgramData\amx-bpm\tibco\data

OPENSPACE_HOME TIBCO Openspace installs into a directory within TIBCO_HOME. This directory is referenced in documentation as Openspace_HOME. The value of Openspace_HOME depends on the operating system. For example on Windows systems, the default value is C:Program Files\tibco\Openspace\1.2

code font Code font identifies commands, code examples, filenames, pathnames, and output displayed in a command window. For example:

Use MyCommand to start the foo process.

bold code font Bold code font is used in the following ways:

• In procedures, to indicate what a user types. For example: Type admin.

• In large code samples, to indicate the parts of the sample that are of particular interest.

• In command syntax, to indicate the default parameter for a command. For example, if no parameter is specified, MyCommand is enabled: MyCommand [enable | disable]


viii | Typographical Conventions

italic font Italic font is used in the following ways:

• To indicate a document title. For example: See TIBCO ActiveMatrix BusinessWorks Concepts.

• To introduce new terms For example: A portal page may contain several portlets. Portlets are mini-applications that run in a portal.

• To indicate a variable in a command or code syntax that you must replace. For example: MyCommand PathName

Key combinations Key name separated by a plus sign indicate keys pressed simultaneously. For example: Ctrl+C.

Key names separated by a comma and space indicate keys pressed one after the other. For example: Esc, Ctrl+Q.

The note icon indicates information that is of special interest or importance, for example, an additional action required only in certain circumstances.

The tip icon indicates an idea that could be useful, for example, a way to apply the information provided in the current section to achieve a specific result.

The warning icon indicates the potential for a damaging situation, for example, data loss or corruption if certain steps are taken or not taken.

Table 1 General Typographical Conventions (Cont’d)

Convention Use


Preface | ix

Connecting with TIBCO Resources

How to Join TIBCOmmunityTIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts, a place to share and access the collective experience of the TIBCO community. TIBCOmmunity offers forums, blogs, and access to a variety of resources. To register, go to http://www.tibcommunity.com.

How to Access All TIBCO DocumentationAfter you join TIBCOmmunity, you can access the documentation for all supported product versions here:

http://docs.tibco.com/

How to Contact TIBCO SupportFor comments or problems with this manual or the software it addresses, please contact TIBCO Support as follows.

• For an overview of TIBCO Support, and information about getting started with TIBCO Support, visit this site:

http://www.tibco.com/services/support

• If you already have a valid maintenance or support contract, visit this site:

https://support.tibco.com

Entry to this site requires a user name and password. If you do not have a user name, you can request one.


http://www.tibcommunity.com

http://docs.tibco.com/

http://www.tibco.com/services/support

https://support.tibco.com

x | Connecting with TIBCO Resources


| 1

Chapter 1 Introduction

This chapter provides an introduction to Openspace.

Topics

• About Openspace, page 2


2 | Chapter 1 Introduction

About Openspace

Openspace is a web application that enables you to host gadgets and widgets. It provides a Google Web Toolkit (GWT) framework that enables you to build, contribute and render gadgets. Using Openspace, you can add web content from different sources as gadgets and customize how they are displayed.

Openspace allows you to:

• add built-in gadgets that are developed, contributed and published by TIBCO developers, for example the Work Views and Business Services gadgets.

• add third party gadgets that are published as social gadgets, for example Google Maps.

• develop your Openspace social compatible gadgets.

Note that:

• This appendix is aimed at developers who wish to develop their own gadgets then host them in the Openspace dashboard along with the default gadgets provided by TIBCO.

• This appendix is aimed at Java / Web developers and assumes knowledge of the following:

— Java development

— HTML / XML

— Eclipse Java IDE

— CSS

— A basic knowledge of GWT and how to create simple GWT Web applications.

The term Gadget is used in this appendix to imply an OpenSocial framework compliant widget; a widget that is specifically designed to meet the OpenSocial gadget specifications. See http://code.google.com/apis/opensocial/ for more information about the OpenSocial gadget specification.


http://code.google.com/apis/opensocial/

| 3

Chapter 2 Rebranding TIBCO Openspace

This chapter describes how to rebrand TIBCO Openspace to match your corporate style.

Topics

• About Openspace CSS Files, page 4

• Rebranding Login, page 5

• Rebranding Masthead, page 7

• Rebranding Gadgets, page 10

• Replacing Images, page 14

• Customizing the Openspace Window Title, page 16


4 | Chapter 2 Rebranding TIBCO Openspace

About Openspace CSS Files

You can alter Openspace so that it integrates with your corporate style. Integrating your corporate style will enhance your users experience with Openspace. There are three areas that you can rebrand:

• Login

• Masthead

• Individual gadgets

Rebranding Openspace is achieved by replacing or amending the Openspace cascading style sheet (.css) files.

This following table describes the .css files you can amend.

where:

• adminenvironment is the name of your Administrator environment

• bpmenvironment is the name of your BPM environment

• adminservername is the name of your TIBCO Administrator server.

• n is the current version number of the Openspace application files.

For example:

c:\ProgramData\amx-bpm\tibco\data\data\tibcohost \Admin-AMX BPM-AMX BPM Server\host\plugins\com.tibco.openspace.login_1.2.0.034\resources\ themesArchive\themes\tibco\tibco.css

TIBCO recommend that you take a back up of the .css files you want to replace/amend before you start rebranding.

.css File Feature Location

authentication.css login \\CONFIG_HOME\tibcohost\adminenvironment-bpmenvironmentname-adminservername\host\plugins\com.tibco.openspace.login_n\resources

tibco.css • masthead

• gadget

\\CONFIG_HOME\tibcohost\adminenvironment-bpmenvironmentname-adminservername\host\plugins\com.tibco.openspace.login_n\resources\themesArchive\themes\tibco\


Rebranding Login | 5

Rebranding Login

The following screenshot shows the classes and IDs that represent the specific areas of the login that can be rebranded.

To rebrand the login, you must amend the authentication.css file. See About Openspace CSS Files, page 4. The following table describes the login classes and IDs that you can amend.

Table 2 Login Classes and IDs that can be Rebranded

Class/ID Attribute

splashbackground • Gradient

• Color

splash URL image



Note that:

• The main styling controls allow you to change the background and the inner background of the login form. As positioning is used, when adding new elements you may have to override program code with the !important statement in the css rule.

• For information on replacing the logo image, see Replacing Images, page 14.

splash_logo_amx • URL image

• Position

• Padding

username, password, remember

Color/Size/Font Family

login button Color/Size/Font Family

Table 2 Login Classes and IDs that can be Rebranded

Class/ID Attribute


Rebranding Masthead | 7

Rebranding Masthead

The following screenshots show how the specific areas of the masthead relate to the classes and IDs. The first screenshot identifies the areas of the masthead and the second screenshots identifies the classes and IDs for those areas.



To rebrand the masthead, you must amend the tibco.css file. See About Openspace CSS Files, page 4. The following table describes the masthead classes and IDs that you can amend.

Table 3 Masthead Properties that can be Rebranded

Class/ID Attribute

header • Gradient

• Color

logo URL image

system_links • Color

• Padding

welcome_settings_help Color


Rebranding Masthead | 9

Note that:

• To change the masthead background color, edit the background property. Gradient or solid colors can be used.

• Your logo dimensions should not exceed 30 pixels in height and be no longer than 300 pixels in width.

• To add a horizontal band to the masthead, set the background color of the system_links declaration. Decrease the padding depending on how thick you want the band to be.

• For information on replacing the logo image, see Replacing Images, page 14.



Rebranding Gadgets

The following screenshots shows the classes and IDs that represent the specific areas of the gadgets that can be rebranded. The first screenshot identifies the specific areas of the gadgets and the second screenshot identifies the classes and IDs for those areas.

To rebrand the gadgets, you must amend the tibco.css file. See About Openspace CSS Files, page 4. The following table describes the gadget classes and IDs that you can amend.

Table 4 Gadget Classes and IDs that can be Rebranded

Class/ID Feature Attribute

gwt-TabBar Tab bar • Background

— Gradient

— Color

• Border

— Top

— Right


Rebranding Gadgets | 11

MultiStateImage-16 Add tab image • Background

— URL (image)

gwt-TabBarFirst Decorative gutter • Background

— Color

gwt-TabBarSelected tib-tab a.tab-text Selected tab • Background

— Gradient

— URL (image)

— Color

• Font

— Color

gwt-TabBarItem tib-tab a.tab-ext:link Normal tab • Background

— Gradient

— URL (image)

— Color

• Font

— Color

• Border

— Right

gwt-TabBarItem tib-tab a.tab-ext:hover Hover tab • Background

— Gradient

— URL (image)

— Color

• Font

— Color

• Border

— Right





tib-tab Tab definition Border - Margin

MultiStateImage17 Minimize all gadgets

• Background

— URL (image)

— Color

• Border

— Top

— Bottom




Rebranding Gadgets | 13

About BackgroundTo change the background behind the tabs, use gwt-TabBar. You can change the color, add a gradient or enable borders if your branding is prominently white.

Set the background color to transparent or match the background color of the tab row. The decorative gutter also requires you set the background color accordingly.

About BordersA border on a tab highlights to a user that an action can be performed. Set the margin to zero for the gwt-TabBarItem if using borders. This increases the visual separation.

About Tab StatesTabs have three states:

• selected

• normal

• hover

You can set a number of styling attributes. These include the font color, background gradient or solid color and borders to give the tab definition. Do not use the same color as the help background. TIBCO recommends using a contrasting font color.

About Masthead ImagesCurrently there are two types of image displayed in the tab bar:

• the add new tab represented as a plus symbol

• the minimize all gadgets. This is positioned at the far right of the tabs and is represented as a down arrow.

See Replacing Images, page 14 for more information about replacing these images.

You can also use the down arrow to reflect the three different tab states.



Replacing Images

You can replace the images used in Openspace.

To do this:

1. Update the style sheet with the new image name as references to images are called from the style sheet.

2. Replace the images in the locations described in the table below. Images are stored in either one or both of the following locations: — \\CONFIG_HOME\tibcohost\

adminenvironment-bpmenvironmentname-adminservername\host\plugins\com.tibco.openspace.login_n\resources

— \\CONFIG_HOME\tibcohost\adminenvironment-bpmenvironmentname-adminservername\host\plugins\com.tibco.openspace.login_n\resources\images\

• adminenvironment is the name of your Administrator environment

• bpmenvironment is the name of your BPM environment



For example:

c:\ProgramData\amx-bpm\tibco\data\data\tibcohost\Admin-AMX BPM-AMX BPM Server\host\plugins\com.tibco.openspace.login_1.2.0.034\resources\images\

The following table describes the images you can replace and their paths. Where there are two locations for an image file, you must replace the image in both locations.

TIBCO recommends that you take a copy of every image you want to replace before you start rebranding.

Image Feature Path

logo • resources

• resources\images\

trans_add.png Add tab resources\images\icons\

tab_menu_view.png Table menu resources\images\tabs\

pulldown_arrow_current.png Selected tab • resources\

• resources\images\bg\


Replacing Images | 15

pulldown_arrow_opacity_m.png Normal and Hover tab • resources\

• resources\images\bg\

TIBCOOpenspace_logo_white.png resources\images\

Image Feature Path



Customizing the Openspace Window Title

You can customize the Openspace window title, as shown below.

To do this, amend the config.properties and BannerPanelMessage.properties file as follows:

1. Open the CONFIG_HOME\tibcohost\Admin-AMX BPM-AMX BPM Server\host\plugins\com.tibco.openspace.login_1.5.0.00n\resources\config.properties file in a text editor.

2. Change the branding.type property from AMX to CUSTOM. For example, branding.type=CUSTOM

3. Save and close the CONFIG_HOME\tibcohost\Admin-AMX BPM-AMX BPM Server\host\plugins\com.tibco.openspace.login_1.5.0.00n\resources\config.properties file.

Note that:

• TIBCO recommend that you take a back up of the config.properties and BannerPanelMessage.properties file before amending them.

• If Openspace has been localized the BannerPanelMessage.properties may have a language and country code appended to it. For example, BannerPanelMessage_ll_CC.properties. See Localizing Openspace on page 39.


Customizing the Openspace Window Title | 17

4. Open the CONFIG_HOME\tibcohost\Admin-AMX BPM-AMX BPM Server\host\plugins\com.tibco.openspace.login_1.5.0.00n\resources\locale\BannerPanelMessage.properties file in a a UTF-8 text editor or an editor capable of editing UTF-8 files. For example, TIBCO Business Studio.

5. Change the TIBCO Openspace property to the new window title. For example, customWindowTitle=My Custom Window Title

6. Save and close the CONFIG_HOME\tibcohost\Admin-AMX BPM-AMX BPM Server\host\plugins\com.tibco.openspace.login_1.5.0.00n\resources\locale\bannerpanelmessage.properties file.

7. Logout and reload the browser web page for the changes to take effect.




| 19

Chapter 3 Locking Down Access to TIBCO Openspace Features

This chapter describes how to customize who has access to specific TIBCO Openspace features. When you first login to TIBCO Openspace, all users have access to all Openspace features. However, you customize access to specific Openspace features by configuring the lockdown properties in the CONFIG_HOME\tibcohost\Admin-AMX BPM-AMX BPM

Server\host\plugins\com.tibco.openspace.login_1.5.0.002\resources\

config.properties file.

Topics

• Lockdown Properties, page 20

• Configuring the Lockdown Properties, page 25

• Checking Lockdown Properties, page 26

TIBCO recommend that you take a backup of the CONFIG_HOME\tibcohost\Admin-AMX BPM-AMX BPM


config.properties file before amending it.


20 | Chapter 3 Locking Down Access to TIBCO Openspace Features

Lockdown Properties

When you first login to TIBCO Openspace, all users have access to all Openspace features. However, you customize access to specific Openspace features by uncommenting and configuring the lockdown properties in the CONFIG_HOME\tibcohost\Admin-AMX BPM-AMX BPM


config.properties file. Locking down features means that the feature is NOT available to one or more users, depending on how you have configured your lockdown properties.

Lockdown properties can be in the following formats:

• lockdown.n where n is a numerical value. You can associate the lockdown property with a system action and assign it to one or more Openspace features. This means that only users who have been granted those privileges can view the Openspace features you have specified. For example, lockdown.1=WSB,applicationconfiguration. See Lockdown System Actions, page 20.

• lockdown.x where x is a specific Openspace feature. For example lockdown.showResetSettings=TRUE. These lockdown properties can be set to TRUE or FALSE. This enables you to configure access to one or more Openspace features for all users on your system. For example, you may never want any users to have access to the User Preferences Panel. In this case, you can set the lockdown.allowPrefPanel to TRUE. See Openspace Feature Lockdown Properties, page 23.

Lockdown System ActionsThe following system actions have been created for you to associate one or more Openspace features to:

• openspaceFeatureSetA

• openspaceFeatureSetB

• openspaceFeatureSetC

When configuring lockdown properties, no users are exempt. For example, they apply to the tibco-admin user in the same as any other user.


Lockdown Properties | 21

However, you can associate any system actions with any Openspace features and add as many as you require. For example, you may want different types of users to have access to different Openspace features. In an insurance company, for example, you may have the following types of users; customer service representatives, managers, administrators. The following table shows how you might want to lockdown Openspace features depending on these types of users.

To implement this, do the following:

1. From Openspace, go to the Organization Browser. Assign the following system actions to the different types of users:

Openspace Features Customer Service Representative Managers Administrators

showResetSettings Disable Enable Enable

showLogoutButton Disable Enable Enable

showAddTab Disable Enable Enable

allowPrefPanel Disable Enable Enable

showFullGadgetMenu Disable Disable Enable

allowMinRestoreAll Enable Enable Enable

enableWelcomePage Disable Disable Disable

max10Tabs Enable Disable Disable

Users System Actions

Customer Service Representatives OS, openspaceFeatureSetA

Managers OS, opensapceFeatureSetA OS, opensapceFeatureSetB

Administrators WSB, applicationConfigurationOS, opensapceFeatureSetA OS, opensapceFeatureSetBOS, opensapceFeatureSetC



2. Associate the system actions with Openspace features as shown in the table below:

3. Open the CONFIG_HOME\tibcohost\Admin-AMX BPM-AMX BPM Server\host\plugins\com.tibco.openspace.login_1.5.0.002\resourc

es\config.properties file in a text editor and amend the lockdown properties as follows:

lockdown.1=OS,openspaceFeatureSetAlockdown.2=OS,openspaceFeatureSetBlockdown.3=OS,openspaceFeatureSetClockdown.4=WSB,applicationConfiguration

lockdown.showResetSettings=lockdown.2lockdown.showLogoutButton=lockdown.2lockdown.showAddTab=lockdown.2lockdown.allowPrefPanel=lockdown.2lockdown.showFullGadgetMenu=lockdown.4lockdown.allowMinRestoreAll=lockdown.1lockdown.enableWelcome=falselockdown.max10Tabs=!lockdown.3

About Lockdown.4

In this example, lockdown.4 is granted the WSB, applicationConfiguration system action. The WSB, applicationConfiguration system action is typically granted to Administrators who are allowed privileged functions, such as Manage Settings.

In the example only the Administrators would get the full gadget menu. Out-of-the-box, only the tibco-admin user is granted this system action.

System Actions Openspace Features

OS, openspaceFeatureSetA allowMinRestoreAll

OS, openspaceFeatureSetB showResetSettingsshowLogoutButtonshowAddTaballowPrefPanel

OS, openspaceFeatureSetC max10Tabs

WSB, applicationConfiguration showFullGadgetMenu


Lockdown Properties | 23

Openspace Feature Lockdown PropertiesThe following table describes the properties that represent the Openspace features you can customize access to.

You can set the values as follows:

• set the value to a lockdown property that has been associated with a system action. For example, lockdown.1 , lockdown.2 etc. See Lockdown System Actions, page 20 for more information.

• set the value to TRUE or FALSE if the setting for the Openspace feature must apply to all users on the system.

— TRUE means the feature is available.

— FALSE means the feature is not available

• insert an ! before the value if you want to invert the logic. For example, you may wish to have a system action that enables complete access to Openspace that can be granted to administrative users. You may wish to associate this system action with the lockdown.1 property. In this situation, for the lockdown.max10Tabs property, you would specify a value of !lockdown.1. This means that users who have the lockdown.1 privilege can create more than 10 tabs.

Property Description

lockdown.showResetSettings Configures whether the Reset button on the main menu is displayed.

lockdown.showLogoutButton Configures whether the Logout button on the main menu is displayed.

lockdown.showAddTab Configures whether you can add a new tab.

lockdown.allowPrefPanel Configures whether the User Preferences panel is displayed.

lockdown.showFullGadgetMenu Configures whether you can refresh, minimize, maximize, remove or toggle the status of gadgets.

lockdown.allowMinRestoreAll Configures whether you can Minimize All or Restore All.

lockdown.enableWelcome Configures whether the Welcome Page is displayed.

lockdown.max10Tabs Configures whether you can add more than 10 tabs in Openspace.



For example:

• Setting lockdown.showLogoutButton to FALSE means Logout is not available as shown below.

• Setting lockdown.showAddTab to FALSE means new tabs cannot be added as shown below.


Configuring the Lockdown Properties | 25

Configuring the Lockdown Properties

When you first login to TIBCO Openspace, all users have access to all Openspace features. However, you customize access to specific Openspace features by configuring the lockdown properties in the CONFIG_HOME\tibcohost\Admin-AMX BPM-AMX BPM


config.properties file. To configure the lockdown properties, do the following:

1. Open the CONFIG_HOME\tibcohost\Admin-AMX BPM-AMX BPM Server\host\plugins\com.tibco.openspace.login_1.5.0.002\resourc

es\config.properties file in a text editor.

2. Uncomment and amend the lockdown properties. See Lockdown System Actions, page 20 and Openspace Feature Lockdown Properties, page 23.

3. Save and close the CONFIG_HOME\tibcohost\Admin-AMX BPM-AMX BPM Server\host\plugins\com.tibco.openspace.login_1.5.0.002\resourc

es\config.properties file.

4. Logout and log back into TIBCO Openspace for the changes to take effect.

TIBCO recommend that you take a backup of the CONFIG_HOME\tibcohost\Admin-AMX BPM-AMX BPM


config.properties before amending it.



Checking Lockdown Properties

You can use the Logger gadget to:

• check what system actions are applied for the user currently logged into Openspace

• check the lockdown properties for lockdown.n, if configured.

To do this:

1. From the Logger gadget, click and select DEBUG as the Default Log

Level. Click again to close the dialog.


Checking Lockdown Properties | 27

2. Look for the part of the trace that shows the evaluations of the lockdowns. The screenshot below shows the log of a user for whom no lockdown properties are configured. When you first install Openspace, no lockdown properties are configured.




| 29

Chapter 4 How to Create an Openspace Compatible Gadget

This chapter describes the steps required to create a simple OpenSocial compatible gadget. There are two methods for contributing an Openspace Compatible Gadget:

• using the URL is not a Gadget Spec - it is a web site option from the Contribute Gadget dialog; see TIBCO Openspace User’s Guide for more information.

• using the GWT toolkit, see below. Once complete, the gadget will be compatible with Openspace and can be imported using the Contribute Gadget option in the Openspace Gadget Store; see TIBCO Openspace User’s Guide for more information.

Whilst this chapter provides a very simple example the same steps can be used to create complex Gadgets that leverage the entire GWT toolkit.

Topics

• Getting Started on page 30

• Creating a GWT Web Application on page 31

• Modify the Web Application to Make it a GWT Gadget Project on page 33

• Compile Your Gadget on page 35

• Making Your Gadget Available to Openspace on page 37


30 | Chapter 4 How to Create an Openspace Compatible Gadget

Getting Started

Before creating a gadget, the following components must be installed on your machine.

• A version of the Eclipse Java IDE which is compatible with the Google plug-in for Eclipse.

• The Google plug-in for Eclipse. This can be installed from Eclipse using the Install new software option; see http://code.google.com/eclipse/docs/getting_started.html for details of the update site required.

Add the update site then select both the Plug-in and SDK components to install. Click Next and accept the license agreement to start the install.

• The gadget library for GWT. You can download the latest release of the library from http://code.google.com/p/gwt-google-apis/downloads/list. You should download version 1.2.0 or later of the gadget library. After you download the distribution, un compress it. Inside the folder you will find a .jar file named gwt-gadgets.jar. You need to reference this JAR file from your Eclipse workspace when creating the gadget.

• TIBCO Business Studio. This is required for deploying the DAA and contributing the Openspace gadget sample to TIBCO Openspace.

• A browser such as Internet Explorer, Google Chrome, or Mozilla Firefox to run the sample web client application.

Now you need to start the Eclipse IDE and create a new workspace for your project.


http://code.google.com/eclipse/docs/getting_started.html

http://code.google.com/p/gwt-google-apis/downloads/list

Creating a GWT Web Application | 31

Creating a GWT Web Application

The first step is to create a simple GWT web application which can then be converted into an OpenSocial compatible gadget.

1. From the Eclipse toolbar, click . The New Web Application wizard displays.

2. Enter your Project and Package name and also a location for the project.

3. Deselect Use Google App Engine.

4. Click Finish.

You now have a new web application containing a simple example.



Please note that the default web application contains a server side RPC interface (GreetingsService). This is not required for a simple OpenSocial gadget. A simple project containing only the code necessary for an OpenSocial gadget can be found in the example Eclipse project (TIBCO_HOME\amx-bpm\bpm\n.n\samples\TibcoOpenSocialExample.zip) where n.n is the version of TIBCO ActiveMatrix BPM you are using. The project can be imported into Eclipse instead of creating a default web application.

See http://code.google.com/eclipse/docs/creating_new_webapp.html for more information about creating a GWT web application.


http://code.google.com/eclipse/docs/creating_new_webapp.html

Modify the Web Application to Make it a GWT Gadget Project | 33

Modify the Web Application to Make it a GWT Gadget Project

There are several differences between a GWT web application and a GWT gadget project.

• A GWT gadget project has no class implementing the EntryPoint interface.

• The entry point must be a subclass of Gadget.

• There is a @ModulePrefs annotation on the class.

The web application must be modified as follows:

1. Since we are working with an additional library, add gwt-gadgets.jar to the Java classpath. Then, add the inherits line for com.google.gwt.gadgets.Gadgets to your module (in our examples OpenSocialGadget.gwt.xml).

<inherits name='com.google.gwt.gadgets.Gadgets' />

2. You also need to add the gwt-gadget.jar file into your Java build path. To do this:

a. Right-click on the top level project and select Properties.

b. Select Java Build Path. From the Libraries tab select Add External jars.

c. Use the Browse dialog to find the gwt-gadgets.jar file and select it.

3. Modify the OpenSocialGadget.java class definition to read:

public class OpenSocialGadget extends Gadget<UserPreferences>

You need to add the following imports (you can use the Eclipse shortcut <CTRL>+<SHIFT>+o to automatically add missing imports):import com.google.gwt.gadgets.client.Gadget;import com.google.gwt.gadgets.client.UserPreferences;

4. Implement the init(UserPreferences) method from the Gadget class. Remove the onModuleLoad method (you can also remove all the other methods in the class as we only require the init method) and add the following:

@Overrideprotected void init(UserPreferences preferences) {

VerticalPanel panel = newVerticalPanel();panel.setWidth("100%");panel.setHeight("100px");

final Label helloLabel = new Label("Hello World");final Button dialogButton = new Button("Show Dialog");

panel.add(helloLabel);panel.setCellHorizontalAlignment(helloLabel,



HasHorizontalAlignment.ALIGN_CENTER);

panel.add(dialogButton);

panel.setCellHorizontalAlignment(dialogButton,

HasHorizontalAlignment.ALIGN_CENTER);

dialogButton.addClickHandler(new ClickHandler() {

@Override

public void onClick(ClickEvent event) {

Window.alert("Tibco OpenSocial Contribution Example");

}

);

RootLayoutPanel.get().add(panel);

}

5. Add the following annotations above the class statement:

@ModulePrefs(title = "OpenSocialGadget", author ="yournamehere", author_email = "[email protected]",description = "OpenSocial Gadget Description",thumbnail="thumbnail.png", screenshot="screenshot.png")@UseLongManifestName(false)@AllowHtmlQuirksMode(false)

Note that:

• The title, author, author_email and description tags are part of the OpenSocial gadget spec which will be generated later. The values should be specific to the gadget you are creating. The screenshot and thumbnail values are used to specify the icons used for the gadget, if omitted a default value is used.

• The thumbnail is displayed in the Openspace Gadget Store and Preferences panel and should be an icon for your Gadget. When specifying a thumbnail the recommended size is 48x48 pixels and the image file mist be copied to the web server directory (see Compile Your Gadget on page 35).

• The screenshot is displayed when a Gadget is selected in the Gadget Store, it should contain an image which gives a user an idea of what the Gadget is used for. When specifying a screenshot the recommended size is 128x128 pixels and the image file must be copied to the web server directory (see Compile Your Gadget on page 35).

• The following imports will be required (you can use the Eclipse shortcut <CTRL>+<SHIFT>+o to automatically add missing imports):

import com.google.gwt.gadgets.client.Gadget.AllowHtmlQuirksMode;import com.google.gwt.gadgets.client.Gadget.ModulePrefs;import com.google.gwt.gadgets.client.Gadget.UseLongManifestName;


Compile Your Gadget | 35

Compile Your Gadget

Use the Google plugin to compile the gadget.

1. Click in the Eclipse toolbar. The GWT Compile dialog displays.



2. Click Compile. After a few seconds a number of files should appear under the war directory in your Eclipse project.

The OpenSocialGadget.gadget.xml file contains the OpenSocial definition for the gadget.


Making Your Gadget Available to Openspace | 37

Making Your Gadget Available to Openspace

Your gadget needs to be made available on a web server which Openspace can access. All the files under war/opensocialgadget need to be copied to the web server.

For testing, a Tomcat web server can be used. The Tomcat Server must be installed as specified on http://tomcat.apache.org. Once you have a Tomcat server installed, copy the OpenSocial gadget directory from Eclipse into a new directory TomcatInstallation/gadgets/

It will then be possible to access the gadget using a URL like http://<TomcatHost>:<TomcatPort>/gadgets/opensocialgadget/OpenSocialGadget.gadget.xml where:

• TomcatHost is the DNS name or IP address of the server hosting the Tomcat server.

• port is the port being used by the Tomcat server. The default value is 8080.

For example:

http://localhost:8080/gadgets/opensocialgadget/OpenSocialGadget.gadget.xml

Before attempting to add the gadget to Openspace you should check this URL is accessible by pasting the link into your browser. If successful, the OpenSocial gadget specification for your gadget should be displayed.

You are now ready to add your gadget to Openspace; see TIBCO Openspace User’s Guide for more information.


http://tomcat.apache.org



| 39

Chapter 5 Localizing Openspace

This chapter describes how to localize Openspace.

Topics

• About Localizing Openspace, page 40

• Manually Localizing Openspace on page 41


40 | Chapter 5 Localizing Openspace

About Localizing Openspace

By default, Openspace is available in American English or British English. To make Openspace available in different languages, you can either:

• deploy one of the available TIBCO Multilingual User Interface (MUI) Language Packs. See the documentation supplied with the language pack for more information.

• if the language you require is not available in a TIBCO MUI Language Pack, you must manually translate Openspace to use a new language. See Manually Localizing Openspace on page 41.

You can dynamically change both Openspace and the individual gadgets within Openspace to use different languages, depending on your requirements. You can:

• make the whole of Openspace available in a different language. You can either:

— select a different language when you log in, see TIBCO Openspace User’s Guide for more information.

— once you have logged in, select a different language for Openspace, see TIBCO Openspace User’s Guide for more information.

• make individual gadgets within Openspace available in different languages, that are different from both Openspace and other gadgets. For example, Openspace may be configured to use French but you want to open a work item in the Work Views gadget that relates to an English speaking customer. From the Work Views gadget, you can select English from the Language Selector drop-down list and translate the Work Views gadget into English while the rest of Openspace remains in French. See TIBCO Openspace User’s Guide for more information.


Manually Localizing Openspace | 41

Manually Localizing Openspace

The following section describes how to make Openspace available in different languages and localizations if there is not a TIBCO MUI Language Pack available.

• Before you start manually localizing Openspace, you should read the information in About Manually Localizing Openspace, page 41.

• To manually localize Openspace, see How to Manually Localize Openspace, page 44.

About Manually Localizing OpenspaceThis section describes what you need to know before you start manually localizing Openspace.

• When renaming the Openspace property files, you should include a country code. See About Locales, page 41.

• If you want to configure the date and time when translating the Openspace property files, see Configuring the Date Time Format, page 42.

About Locales

Openspace uses locales to distinguish between different language/country combinations. Each localized language is represented by a two-letter code, in the format:

• ll where ll is a lowercase, two-letter ISO 639 language code. For a list of language codes, visit the following web site: http://www.loc.gov/standards/iso639-2/langhome.html

Each country is represented by a two-letter code, in the format:

• CC where CC is an uppercase, two-letter ISO 3166 country code. For a list of country codes, visit the following web site: http://www.iso.org/iso/country_codes/iso_3166_code_lists.htm

A locale key is a string representation of a locale that includes a language and, optionally, a country code in the following format:

ll_CC


http://www.loc.gov/standards/iso639-2/langhome.html

http://www.iso.org/iso/country_codes/iso_3166_code_lists.htm


You do not have to include a country code but may wish to do so if you want a particular version of a language. For example, if you just want Spanish but do not mind which alphabets or dialects are used, you could just use es as the locale key. If you do want a particular alphabet or dialect, Mexican Spanish for example, you can include the country code in the locale key. In this case, the locale key would be es_ MX.

Configuring the Date Time Format

Date and time stamps are often used in Openspace. For example, the gadget status bar sometimes shows a timestamp and you can specify a start date and end date in the Process Instances Measures gadget. The date and time format in Openspace is configured using the dateTimePattern1 property in the TranslatorMessages_ll_CC.properties file where:

• ll is a lowercase, two-letter ISO 639 language code. For a list of language codes, visit the following web site: http://www.loc.gov/standards/iso639-2/langhome.html

• CC is an uppercase, two-letter ISO 3166 country code. For a list of country codes, visit the following web site: http://www.iso.org/

It is available in the following folder:

\\CONFIG_HOME\tibcohost\ Admin-environmentname-adminservername\host\plugins\com.tibco.opens

pace.login_n\resources\locale where:

• environmentname is the name of your BPM environment



The TranslatorMessages_ll_CC.properties file contains the core messages that are used by all gadgets across Openspace. You must configure a TranslatorMessages_ll_CC.properties file for each language you want Openspace to support.

The dateTimePattern1 property is made up of meta characters as defined in Google Web Toolkit. The table below shows the meta characters you can use.

TIBCO recommends that you take a back-up of this file before you amend it.

Symbol Meaning Presentation Example

G era designator Text AD


http://www.loc.gov/standards/iso639-2/langhome.html

http://www.iso.org/


The following table shows some example patterns.

y year Number 1996

M month in year Text or Number July (or) 07

d day in month Number 10

h hour in am/pm (1-12) Number 12

H hour in day (0-23) Number 0

m minute in hour Number 30

s second in minute Number 55

S fractional second Number 978

E day of week Text Tuesday

a am/pm marker Text PM

k hour in day (1-24) Number 24

K hour in am/pm (0-11) Number 0

z time zone Text Pacific Standard Time

Z time zone (RFC 822) Number -0800

v time zone (generic) Text Pacific Time

’ escape for text Delimiter ’Date=’

" single quote Literal ’o’ ’clock’

Symbol Meaning Presentation Example

Example Formatted Text

"yyyy.MM.dd G 'at' HH:mm:ss vvvv" 1996.07.10 AD at 15:08:56 Pacific Time

"EEE, MMM d, ''yy" Wed, July 10, '96

"h:mm a" 12:08 PM

"hh 'o''clock' a, zzzz" 12 o'clock PM, Pacific Daylight Time



See http://google-web-toolkit.googlecode.com/svn/javadoc/1.5/com/google/gwt/i18n/client/DateTimeFormat.html for more information.

If the dateTimePattern1 property is not defined in the locale specific TranslatorMessages_ll_CC.properties file then the dateTimePattern1 property defined in the TranslatorMessages_en_GB.properties file is used.

How to Manually Localize OpenspaceThis section describes how to manually localize Openspace.

Overview of the Steps Required to Manually Localize Openspace

To make Openspace available in different languages and localizations, you must:

1. manually translate Openspace application files, see Manually Translating Openspace Application Resource Bundles on page 45.

2. add the new language/country combination as a property to the locale.properties file. The locale.properties file contains the list of locales that Openspace supports. Adding the new language/country combination as a property to the locale.properties file enables the new language to be available for selection from the Locale Selector box within Openspace. See Adding the New Language as a Property to the locale.properties File, page 46.

3. Create your language pack as a composite application. To do this:

a. Create an SOA Project, page 46

b. Configure the Composite, page 49

c. Create the Distributed Application Archive (DAA), page 53

d. Deploying the DAA, page 54

"K:mm a, vvv" 0:00 PM, PT

"yyyyy.MMMMM.dd GGG hh:mm aaa" 01996.July.10 AD 12:08 PM

Example Formatted Text

The Logger gadget enables you to quickly identify any words that are not translated in a locale pack. Specify the level of logging in the Logger gadget at INFO level, and an error displays if there are any words that are not translated. Words that are not translated default to American English.


http://google-web-toolkit.googlecode.com/svn/javadoc/1.5/com/google/gwt/i18n/client/DateTimeFormat.html

http://google-web-toolkit.googlecode.com/svn/javadoc/1.5/com/google/gwt/i18n/client/DateTimeFormat.html


Manually Translating Openspace Application Resource Bundles

To manually translate Openspace application resource bundles:

1. Copy the base properties files. The base properties files are the files that do not have locale key already specified in the filename. These are available in the following folder:

\\CONFIG_HOME\tibcohost\Admin-environmentname-adminservername\host\plugins\com.tibco.openspace.login_n\resources\locale

where:

— environmentname is the name of your BPM environment

— adminservername is the name of your TIBCO Administrator server.

— n is the current version number of the Openspace application files.

Copy the files to a new location and translate them.

2. Once you have translated them, you must:

— Rename the files so that the file names now include the new locale key, see About Locales on page 41. For example, if you are translating from American English to Spanish, then LoggerMessages.properties must now be called LoggerMessages_es.properties. For all non-Latin-1 characters, properties files should be saved in UTF-8 encoding.

— copy the files back to their original location.

Note that:

— All forms that you are using in your process must also be translated. For information on how to translate forms, see the documentation provided with TIBCO Forms.

TIBCO recommends that you take a back-up of these files before you translate them.

Note that:

You cannot translate a default TIBCO form. You must create a custom form for all your steps and manually translate these.

Once you have translated the TIBCO Forms, you must redeploy your application to BPM for the new language to take effect.



— Openspace cannot translate any third party OpenSocial gadgets. If these gadgets are not available from the third party in the new language, they display in Openspace in their original language.

Adding the New Language as a Property to the locale.properties File

To make the new language available in the Locale Selector drop-down list within Openspace, add the new language to the\\CONFIG_HOME\tibcohost\Admin-environmentname-adminservername\host\plugins\com.tibco.openspace.login_n\resources\locale\locale.properties

where:

• environmentname is the name of your BPM environment



Add the property in the following format:

locale.n=locale_code where:

• n is an incremental number that increases each time you add a new language, for example locale.0, locale.1 etc.

• locale key is the ISO standard language and country code combination, see About Locales on page 41.

For example, locale.1=en_GB.

Create an SOA Project

You need to create an SOA project in TIBCO Business Studio to contain the composite that will be deployed to the BPM runtime. Open Studio for Designers.

1. Click File > New > Project. The New Project Wizard displays.

The Logger gadget enables you to quickly identify any words that are not translated in a locale pack. Specify the level of logging in the Logger gadget at INFO level, and an error displays if there are any words that are not translated. Words that are not translated default to American English.



2. Select TIBCO SOA Platform > TIBCO SOA Project and click Next.

3. In the Project box, type the name of your SOA project and click Next.

4. From the Asset Type Selection dialog, accept the defaults by clicking Next.

5. From the Composite Project dialog, select Empty SOA Project and click Finish to save your data and exit the wizard.

6. If you open or amend any of the properties files in TIBCO Business Studio, the files will be corrupted unless you change TIBCO Business Studio to use UTF-8 encoding. Therefore, TIBCO recommend that you change TIBCO Business Studio to use UTF-8 encoding.

To do this:

a. Click Window > Preferences. The Preferences dialog displays.

b. Expand General and click Content Types. The content types are listed in the right-hand pane.

c. Expand Text and click Java Properties Files.

d. In the Default Encoding box, replace the existing value with UTF-8 and click Update.

e. Click OK to exit the dialog.



7. From your temporary directory where you copied the language pack in Manually Localizing Openspace on page 41, copy the following files:

— locale.xx.xml

— eventLocale.xx.xml

— All the *_xx.properties files where * is the name of the properties file.

(where xx is the localized language represented by a two-letter code) to the root of your SOA project directory in your workspace.

8. On the toolbar, click the drop-down next to the Enable/Disable Business Studio Capabilities icon.

9. Ensure the TIBCO SOA Platform Extension capability is selected.

From TIBCO Business Studio, click F5 to refresh your workspace. In Project Explorer, expand your SOA project. You should now see the properties files you have copied, similar to the ones shown below:.



Configure the Composite

You need to configure the composite created above so that it can use the Openspace properties files from the language pack.

1. From Project Explorer in TIBCO Business Studio, expand the Composites folder in your SOA project and right-click projectname.Composite where projectname is the name of your SOA project.

2. Select New > File. The New File dialog displays.

3. In the File Name box, type a name for your .xml file and click Finish. The .xml file is created.

4. Click Source and copy the .xml similar to the following:

<?xml version="1.0" encoding="UTF-8" standalone="no"?><web-app xmlns="http://java.sun.com/xml/ns/j2ee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" version="2.4" xsi:schemaLocation="http://java.sun.com/xml/ns/j2ee http://java.sun.com/xml/ns/j2ee/web-app_2_4.xsd"></web-app>

and paste it into the Source tab. For example:

5. Save the project.

6. Select projectname.Composite where projectname is the name of your SOA project.

7. From the Component Type palette, select WebApp and drag it to your composite.



8. In the Name box, type a name for your web application

9. Click Properties.

10. Click Implementation and select Deployment Descriptor (web.xml).

11. From WebXml File, browse for the web.xml file you created in step 1, for example French > Composites > web.xml.

12. Click Properties and set the values for the following properties as described below:

13. Click General.

14. From Administrator Requirements, select Override. The Application Override dialog displays.

15. Click Resources.

16. Click Browse. The Open Resource dialog displays.

Property Value

contextRoot LanguagePackContextRoot_CODE

defaultConnector httpConnector

You can accept the current component version, However, if you are implementing a later version of a language pack, you must increase the component version so that the later version of the language pack is used.



17. From the Select an item to open box, type *.properties. A list of all your properties files displays. Select all of these and click OK.

18. From the Select an item to open box, type *.xml. The locale.xx.xml and eventLocale.xx.xml display where xx the locale code. Select both of these and click OK.

19. Click OK to close the dialog.

20. Right-click workspace\projectname\composites\name.composite file (where workspace is the location of your workspace) and select Open with > Text Editor.

21. Locate the following line:

</sca:component>

22. Copy the xml similar to the following above this line:

<scaext:extension xmi:id="_FYNUQEntEeC1W-tBHP1Z0A" name="LanguagePackInstallWebApp" requiredVersion="1.0.0" extensionPoint="com.tibco.n2.openspace.language-pack.extension-point"> <webapp:web-app-update xmi:id="_FYNUQUntEeC1W-tBHP1Z0A">

<static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP199A" location="/French/locale.fr.xml" path="/JSXAPPS/locale/locale.fr.xml"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP198A" location="/French/eventLocale.fr.xml" path="/JSXAPPS/locale/eventLocale.fr.xml"/>

If no files are shown, type ? to display the list.



<static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP197A"location="/French/AboutMessages_fr.properties"path="/locale/AboutMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP1Z2A"location="/French/AMXApssViewMessages_fr.properties" path="/locale/AMXApssViewMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP1Z3A"location="/French/AMXGadgetContainerViewMessages_fr.properties" path="/locale/AMXGadgetContainerViewMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP1Z4A"location="/French/AuthenticationWidgetMessages_fr.properties" path="/locale/AuthenticationWidgetMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP1Z5A"location="/French/BannerPanelMessages_fr.properties" path="/locale/BannerPanelMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP1Z6A"location="/French/BusinessServiceGadgetMessages_fr.properties" path="/locale/BusinessServiceGadgetMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP1Z7A"location="/French/GadgetStoreMessages_fr.properties" path="/locale/GadgetStoreMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP1Z8A"location="/French/LayoutMessages_fr.properties" path="/locale/LayoutMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP1Z9A"location="/French/LoggerMessages_fr.properties" path="/locale/LoggerMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP110A"location="/French/LoginWidgetMessages_fr.properties" path="/locale/LoginWidgetMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP111A"location="/French/PerformanceReportingMessages_fr.properties" path="/locale/PerformanceReportingMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP112A"location="/French/PreferencesPanelMessages_fr.properties" path="/locale/PreferencesPanelMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP113A"location="/French/PreferredGadgetsPanelMessages_fr.properties" path="/locale/PreferredGadgetsPanelMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP114A"location="/French/ProcessInstancesMessages_fr.properties" path="/locale/ProcessInstancesMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP115A"location="/French/ProcessTemplateGadgetMessages_fr.properties" path="/locale/ProcessTemplateGadgetMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP116A"location="/French/SilverWorkspaceAppMessages_fr.properties" path="/locale/SilverWorkspaceAppMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP117A"location="/French/ThemeMessages_fr.properties" path="/locale/ThemeMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP118A"location="/French/TibcoAuditMessages_fr.properties" path="/locale/TibcoAuditMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP119A"location="/French/TibcoAuditTrailViewMessages_fr.properties" path="/locale/TibcoAuditTrailViewMessages_fr.properties"/>



<static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP120A"location="/French/TibcoColumnMessages_fr.properties" path="/locale/TibcoColumnMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP121A"location="/French/TibcoCompositeMessages_fr.properties" path="/locale/TibcoCompositeMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP122A"location="/French/TibcoOrgModelMessages_fr.properties" path="/locale/TibcoOrgModelMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP123A"location="/French/TibcoProcessMigrationMessages_fr.properties" path="/locale/TibcoProcessMigrationMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP124A"location="/French/TibcoSortViewMessages_fr.properties" path="/locale/TibcoSortViewMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP125A"location="/French/TibcoTabCommandsMessages_fr.properties" path="/locale/TibcoTabCommandsMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP126A"location="/French/ToDoListGadgetMessages_fr.properties" path="/locale/ToDoListGadgetMessages_fr.properties"/> <static-resource xmi:id="_FYNUQ0ntEeC1W-tBHP127A"location="/French/TranslatorMessages_fr.properties" path="/locale/TranslatorMessages_fr.properties"/> </webapp:web-app-update></scaext:extension>

Note that the path to the location of your properties files needs to include the name of your SOA Project, in this example French.

23. Save the file.

Create the Distributed Application Archive (DAA)

As the SOA project only contains a composite, you must package the composite in a DAA, before it can be deployed. To create the DAA:

1. From TIBCO Business Studio in Project Explorer, navigate to name.composite where name is the name of the composite you created in Configure the Composite, page 49.



2. Right-click name.composite and select Create DAA. The Create Deployment Archive wizard displays.

3. From the Select Archive Location dialog, click Next to accept the defaults.

4. From the Select Distribution dialog, click Next to accept the default.

5. From the Create Deployment Archive dialog, click Finish.

Deploying the DAA

Once you have created your DAA, you must deploy it. To do this:

1. From the Deployment Server view, right-click the deployment server you want, and click Deploy Module.... The Deploy Module wizard displays.

2. From the Select Module Type dialog, select Deploy DAA.... The Application Setup dialog displays.

3. Select Workspace. The DAA Selection dialog displays. Navigate to name.daa where name is the name of the DAA you created in Create the Distributed Application Archive (DAA), page 53. Select it and click OK to close the dialog.



4. Click Next to exit the Application Setup dialog. The Administrator Setup dialog displays.

5. Make sure BPMEnvironment is selected and click Next. The Distribution dialog displays.

6. Select Single Node and select BPMNode from the drop-down list. Click Next. The Property Configuration dialog displays.

7. Make sure the values of the properties match the ones you defined in step 12 and click Finish.

8. Once the Deployment Complete dialog is displayed, click Close to close the dialog. The application is now deployed.

Now the application is running, the next time you login to Openspace it is displayed in the new language.

If you wish, you can go to TIBCO Administrator to check that the application is running.

If Openspace was running before the language pack was deployed, you will have to reload Openspace to be able to use the new language.




| 57

Appendix A Constraints for Contributing Gadgets in Openspace

This appendix describes the constraints that apply to the contribution of gadgets in Openspace.

Topics

• Constraints for Contributing Gadgets in Openspace, page 58


58 | Appendix A Constraints for Contributing Gadgets in Openspace

Constraints for Contributing Gadgets in Openspace

When adding a gadget to Openspace, you must specify the URL of the gadget you want to add. The gadget URL must point to an OpenSocial gadget that complies with the OpenSocial Specification V0.8/V0.9. For more information. See How to Create an Openspace Compatible Gadget, page 29.

However, not all the client side customizations available to OpenSocial gadgets are supported by Openspace. This can result in three possible scenarios:

• Scenario 1: The gadget is uploaded and rendered but as the gadget contains some client side customizations that are not supported, that functionality is not available in the uploaded gadget.

• Scenario 2: The gadget fails to upload and an error message displays.

• Scenario 3: The gadget is uploaded but fails to render and an error message displays.

For each scenario, you must make sure that the gadget specification that the gadget URL is pointing to is publicly accessible and is an HTTP URL.

Scenario 1In this scenario, the gadget is uploaded but as the gadget contains some client side customizations that are not supported, that functionality is not available in the uploaded gadget. In this scenario, you must make sure that the gadget specification that the gadget URL is pointing to does not use the following features:

• Canvass View, Default and Preview views.

• Gadget-side Pub Sub library.

• OpenSocial API.

• Tab support.

• Locales feature.

• Flash.

• Skins.

• Dynamic Height.

• Mini Message.

• User Preferences.

• Capability JavaScript (CAJA - a subset of JavaScript).


Constraints for Contributing Gadgets in Openspace | 59

Scenario 2In this scenario, the gadget fails to upload and the following error message displays.

This error is caused because the gadget specification that the gadget URL is pointing to is using RSS feed gadget specifications. To rectify this, make sure that the gadget specification does not use RSS feed gadget specifications.

Scenario 3In this scenario, if the gadget requires OAuth authentication support, the gadget is uploaded but fails to render and the following error message displays.

To rectify this, you should make sure that the gadget does not require support for OAuth authentication.


60 | Appendix A Constraints for Contributing Gadgets in Openspace


Date post:	05-Oct-2020
Category:	Documents
Upload:	others
View:	8 times
Download:	0 times

TIBCO® Openspace Customization Guide€¦ · add-on functionality) of the licensed tibco software....

Documents