BizCoves 9.0 BluePrint

Transcription

BizFlow® 9.0 BizCoves
BluePrint
HandySoft Global Corporation — 1952 Gallows Road Suite 100 — Vienna, VA USA 703.442.5600 — www.handysoft.com
© 1999-2004 HANDYSOFT GLOBAL CORPORATION. ALL RIGHTS RESERVED. THIS DOCUMENTATION IS PROTECTED
BY COPYRIGHT AND DISTRIBUTED UNDER A LICENSE THAT RESTRICTS ITS USE, COPYING, AND DISTRIBUTION. NO
PART OF THIS DOCUMENTATION MAY BE REPRODUCED IN ANY FORM OR BY ANY MEANS WITHOUT THE PRIOR
WRITTEN AUTHORIZATION OF HANDYSOFT. WHILE EVERY PRECAUTION HAS BEEN TAKEN IN THE PREPARATION OF
THIS DOCUMENTATION, HANDYSOFT ASSUMES NO REPSONSIBILITY FOR ERRORS OR OMISSIONS. THIS
DOCUMENTATION AND THE FEATURES DESCRIBED HEREIN ARE SUBJECT TO CHANGE WITHOUT NOTICE.
HANDYSOFT ASSUMES NO RESPONSIBILITY REGARDING THE ACCURACY OF THE INFORMATION THAT IS PROVIDED
BY HANDYSOFT AND USE OF SUCH INFORMATION IS AT THE RECIPEINT’S OWN RISK.
BizFlow is a registered trademark and/or trademark of HandySoft Global Corporation in the United States
and/or other countries.
All other trademarks are the property of their respective owners.
The example organizations, companies, persons, server and object IDs, and email addresses depicted herein
are fictitious. No association with any real or actual entity is intended or should be inferred.
This document may contain suggested guidelines that can be followed in order to implement integration with a
third-party software product. As such, any files that accompany this document are templates that can be
used to quick-start the integration. Because HandySoft has no control over the evolution of the third-party
software, we cannot be held responsible for any modifications that may need to be made in order to fully
implement this integration as a result. As the third-party software evolves, full integration may require additional
procedures and may require alteration or additions to the template files.
This BluePrint paper is intended for use with BizFlow 9.0.
BC0090001_10152004B
HandySoft Global Corporation — 1952 Gallows Road Suite 100 — Vienna, VA USA 703.442.5600 — www.handysoft.com
BizFlow 9.0 BizCoves BluePrint
Contents
Contents
Introduction .......................................................................................................................................1
Recommended Configurations for this BizCoves BluePrint Paper.........................................1
About BizCoves .............................................................................................................................1
Extensibility of BizCove Framework.............................................................................................2
Models in this BluePrint Paper......................................................................................................3
Standalone Website or Intranet......................................................................................................4
IFRAME Parameters .......................................................................................................................4
Authentication and Access to BizCoves.......................................................................................7
Step 1 — Register Users.................................................................................................................7
Step 2 — Create User Groups .....................................................................................................7
Step 3 — Create the Process Definitions ...................................................................................8
Step 4 — Create the BizCoves ....................................................................................................8
Step 5 — Create the Work Area Pages ...................................................................................10
Test User Access...........................................................................................................................12
Conditional Logic ...........................................................................................................................14
Sharepoint 2001 with NT Single Sign-On ......................................................................................17
Adding a BizCove to Sharepoint ..............................................................................................17
Using Windows NT Single Sign-On .............................................................................................18
Sharepoint 2003 Portal Adapter ...................................................................................................19
How To Use the Sharepoint 2003 Adapter ..............................................................................19
Installing New Files.......................................................................................................................20
New Files ...................................................................................................................................20
New JAR Files............................................................................................................................20
URL and Parameters of the BizFlow Gateway JSP .................................................................20
Configuring BizFlow .....................................................................................................................23
Creating the BizCove on Sharepoint 2003 ..............................................................................23
Hummingbird and Credential Storage........................................................................................28
Adding a BizCove to Hummingbird .........................................................................................28
e-Clip Tags and Parameters ......................................................................................................29
Adding the BizCove e-Clip to a User Page.............................................................................30
Credential Storage for End-users ..............................................................................................30
Contents
Integrating BizCoves into a Plumtree Portal ...............................................................................32
How the Plumtree Adapter Works ............................................................................................33
Installing New Files.......................................................................................................................33
Modified JSP Files.....................................................................................................................33
New Files ...................................................................................................................................34
New JAR Files............................................................................................................................34
URL and Parameters ...................................................................................................................34
bizflowgateway.jsp..................................................................................................................34
adminprefs.jsp..........................................................................................................................38
Configuring BizFlow .....................................................................................................................38
Copy Files..................................................................................................................................38
Modify web.xml File.................................................................................................................38
Configuring Plumtree..................................................................................................................39
Single Sign-On ..........................................................................................................................39
How to Use the Universal Password for each User..............................................................39
BizFlow as a Service in Plumtree............................................................................................40
Register BizFlow as a Remote Server ....................................................................................41
Register the Service.................................................................................................................42
Create the Portlet Template..................................................................................................46
Create the Portlet....................................................................................................................46
View the Portlet........................................................................................................................48
Registering the BizFlow Preferences in Plumtree ....................................................................49
Registering the Preferences ...................................................................................................50
Accessing the BizFlow Preferences.......................................................................................51
Setting the Time Zone .................................................................................................................52
Non-Personalized Time Zone Setting for All Users................................................................52
Personalized Time Zone Setting .............................................................................................52
Look-and-feel Customization ........................................................................................................55
Creating the New Theme’s Style Sheets..................................................................................55
Adding Your Theme to the System ...........................................................................................55
Summary...........................................................................................................................................57
Introduction
Introduction
The BizCoves models in this BluePrint paper are examples on how your organization can
leverage the flexibility offered by BizFlow® to integrate – and tailor – BizCoves to your
existing environment and applications:
•
Standalone website or intranet
•
Portal such as Sharepoint, Hummingbird, or PlumTree
Code samples and instructions are provided for each model to serve as a brief but
concise guide to integrators or managers interested in the benefits of customizing
BizCoves or deploying them outside of BizFlow.
For more services around those models and for file packages that are required, please
contact HandySoft Global Corporation.
Recommended Configurations for this
BizCoves BluePrint Paper
In order to develop the BizCove models in this BluePrint paper make sure you are using
the following:
•
BizFlow 9.0 SP1
•
Microsoft Sharepoint 2001 SP 2; although Sharepoint 2003 is not officially
supported at this time for BizFlow 9.0, the BizFlow Portal Adapter for Sharepoint
2003 can be purchased to support it(configuration steps are provided in this
BluePrint)
•
Hummingbird 5.1.05 with latest service packs
•
PlumTree 5.0
About BizCoves
BizCoves organize and simplify the way people work.
BizCoves are containers, which, thanks to a straightforward and elegant user interface,
provide at-a-glance access to work items and functionality to handle them, as well as
reports on process benchmarking or monitoring.
Work area pages using BizCoves are personally assigned to workflow participants based
on their responsibilities within an organization. As a result, users no longer sift through the
information they don’t need, while managers have access to the big picture through
reports and monitoring BizCoves.
October / 2004
1
Introduction
Out-of-the-box BizCoves offer great customization capabilities
Out of the box, BizFlow already offers great flexibility in the way BizCoves can be
designed and adapted to each user’s work and responsibilities:
•
Personalization – Worklist BizCoves display work items assigned to a user, an
organizational unit or a user group, and can narrow down the list to specific
process activities.
•
Functionality selection and customization – BizCoves’ names, icons and controls
are fully customizable, whether choosing your own image, labeling buttons with
your own terminology, or modifying their location. The eight types of reporting
BizCoves can be displayed as tables or charts, and a report’s timeframe can be
set to whatever range you want. You also have full control over the columns
displayed within the BizCoves. Customizable filters allows you to alert users about
urgent tasks or communicate critical business information.
For more details on BizCove types, and how to create them using the BizFlow
administration tool, please refer to the BizFlow User Guide.
Extensibility of BizCove Framework
Thanks to BizFlow extensibility, BizCove Work Area Pages may be easily transported to
other portal applications, intranets or websites through:
•
Extensive APIs enabling conditional logic
•
The support of single sign-on and automatic user identification
•
Look-and-feel customization via CSS
A Very Comprehensive Set of APIs
Using Java, C++, COM and SOAP APIs, applications can communicate with BizFlow to
directly control the content and functionality within BizCoves. Result sets in XML can be
easily parsed to store and display information.
Furthermore, APIs, through conditional logic statements, enable the BizCoves’
information and functionality to be uniquely specific to users, according to data related
to their groups, organizational unit or authority groups. Other information such as
customized greeting messages can also be displayed.
Note:
For more information on the BizFlow API Libraries, please refer to the BizFlow API Developer
Guides, “C++ Application Program Interface Developer Guide”, “Java Application Program Interface
Developer Guide”, “SOAP Application Program Interface Developer Guide”, and “XML Application
Program Interface Developer Guide.”
Full Single Sign-on Support for a Seamless User Experience
BizFlow supports Windows NT and PKI single sign-on technologies as well as user
identification across applications. (Those need to be set up correctly.) This automatic
authentication capability allows users to log in only once – to the portal or application in
which BizCoves are displayed – without logging into BizFlow.
October / 2004
2
Introduction
Note:
Notes about NT and PKI Single Sign-On:
NT Single Sign On -- You must be using Microsoft Windows NT 4.0 or higher or Windows 2000, and your
network must use Microsoft Active Server Directory for authentication. With NT Single Sign On, once a
user logs onto NT or Windows, they are given automatic access to BizCoves.
Selecting NT Single Sign On is a BizFlow Administrator Preference option found in the General tab. For
more information about single sign on or how to select it, refer to the “BizFlow Administrator User
Guide.”
Customizable User Interface
The user Interface that dictates the look and feel of any BizCove can be easily
customized for usability, consistency or presentation. The XML data that is used to create
the BizCove does not contain any formatting information. Cascading Style Sheets (CSS)
determine the way the XML data will be rendered, or displayed. Style sheets can be
edited to modify BizCoves’ themes with your own selection of fonts, colors or to position
the information differently.
Models in this BluePrint Paper
Each model in this BluePrint paper illustrates a way to deploy BizCoves using the
techniques previously discussed:
•
Standalone Website or Intranet — Explains how to present BizCoves within a
corporate intranet or Web site.
•
Conditional Logic — Explains how to use conditional logic so that the information
and functionality displayed to the user within the BizCove is uniquely specific to
that user.
•
Authentication and Access to BizCoves– Explains how to grant access to BizCoves
based on user authentication and user group participation.
•
Integrating BizCoves into Sharepoint 2001 Portal with Single Sign-on — Presents
the procedure to integrate the BizCove into a Sharepoint 2001 portal. This
BluePrint paper also illustrates how NT single sign-on affects user authentication.
•
Integrating BizCoves into Sharepoint 2003 — Explains how to integrate the
BizCove into a Sharepoint 2003 portal using the portal adapter.
•
Integrating BizCoves into Hummingbird Portal — Explains how to integrate
BizCoves within a Hummingbird portal.
•
Integrating BizCoves into a Plumtree Portal – Describes how to deploy BizCoves in
Plumtree using BizFlow as a Web service. For this deployment, single sign-on must
be employed, so use of the universal password is covered.
•
Look-and-feel Customization – Details how to use the CSS to create your own
BizCove theme or appearance.
October / 2004
3
Standalone Website or Intranet
BizCoves can be easily integrated into a regular Web page using the <IFRAME> tag,
supported by both Netscape (6.x minimum) and Internet Explorer (5.x recommended).
The IFRAME element allows you to insert the BizCove within a block of text, and is very
similar to inserting an image or an object. In its simplest version, no programming is
required since the call to the BizCove also includes user authentication. Should the user
be authenticated by BizFlow, a small popup window prompts the user for a login and
password.
The BizCove is inserted via the SRC attribute of the IFRAME tag, using the following format:
src=”http://<%BIZFLOW_SERVER%>/bizflow/
bizlogin.jsp?loginID=<%LOGINID%>&password=<%PASSWORD%>&forceLogin=tru
e&returnURL=http://<%BIZFLOW_SERVER%>/bizflow/data/bizcoves/
<%BIZCOVE_FOLDER%>/
<%BIZCOVE_TYPE%>_<%BIZCOVE_ID%>.jsp%3frefresh=y”
Replace <%BIZFLOW_SERVER%> with the server name or IP address followed by a colon
(:), followed by the Web Server port number.
IFRAME Parameters
Parameter
Instructions
<%BIZFLOW_SERVER%>
Replace with the DNS or IP and port
number of the BizFlow server containing
the BizCove.
Example: bizflow.company.com or
123.456.6.123:7201
<%LOGINID%>
Replace with a valid user ID. The user
must be authorized to view the BizCove.
<%PASSWORD%>
Replace with the user’s password
matching with the user ID.
<%BIZCOVE_FOLDER%>
Replace with one the following values
according to the BizCove type:
Process initiation BizCove: definition
Worklist Bizcove: worklist
Monitoring Bizcove: monitor
Report BizCove: report
October / 2004
4
Parameter
Instructions
Report list BizCove: reportlist
External report BizCove: externalreport
<%BIZCOVE_TYPE%>
Replace with one of the following values
according to the BizCove type:
Process initiation: definition
Worklist: worklist
Monitoring: monitor
Process benchmark report: report1a
Activity benchmark report: report1b
Current activity status report: report2a
Historic activity status report: report2b
Overdue activity report: report3a
Activities due shortly report: report3b
Completed processes report: report4a
Completed activities report: report4b
External report: externalreport
<%BIZCOVE_ID%>
Replace with the BizCove ID on the
BizFlow server containing the BizCove.
As an example, this simple HTML code displays a Worklist BizCove, without any
programming required.
<HTML>
<BODY>
<IFRAME name="worklistbizcove" id="1"
src="http://bizflowserver:8080/bizflow/
bizlogin.jsp?loginID=user&password=password
&forceLogin=true&returnURL=http://bizflowserver:8080/
bizflow/data/bizcoves/worklist/
worklist_1000101.jsp%3frefresh=y"
width="500"
height="350"
scrolling="yes”
frameborder=”0”
marginheight=”5”
marginwidth=”5”
October / 2004
5
align="center">
</IFRAME>
</BODY>
</HTML>
Figure 1.
BizCoves integrated using the IFRAME model
To modify the look-and-feel and position of the IFRAME, edit its attributes. Refer to an
HTML manual for more information about the IFRAME tag.
October / 2004
6
Authentication and Access to BizCoves
Authentication and Access to
BizCoves
This section explains how to grant access to BizCoves based on user authentication and
user group participation. Access to different BizCoves is controlled by authentication
and which organizational unit a participant belongs to, which user groups a participant
belongs to, and whether or not the participant is a user or manager.
How you choose to deploy your BizCoves is dependent upon how users are
authenticated by BizFlow. If you use LDAP import to authenticate users, you may want to
use user groups to create distinct BizCoves for users. Whether or not you deploy your
BizCoves through a portal or through BizFlow and the Work Area Pages also determines
access to the BizCoves. If you are using a portal, you may want to create a distinct
BizCove for each user group to limit access. You can create as many user groups, each
with as many users, as you need to filter the work appropriately. If you decide to use a
portal to deploy your BizCoves, you can follow the instructions later in this BluePrint on
how to integrate with portals.
The example in this section explains how to create BizCoves so that two participants in
the same organizational unit can each access both the work sent to their organizational
unit and work sent to their user group while being able to initiate work only from their own
user group. This example also shows how the manager’s BizCove can be entirely
different from that of the users’. All of the steps in this section reflect the example that is
shown in the related figures. This example is just a suggested way to organize the
BizCoves. The way you construct yours will depend on factors including folder
authorization, use of organizational units, and use of user groups.
Step 1 — Register Users
Go to Authentication in the default General Administrator menu.
1. Create an organizational unit called Claims Department.
2. Register three users in the new organizational unit with User licenses: Terry, Fred,
and Jane. Terry is the manager.
Step 2 — Create User Groups
Go to User Group in the default Business Administrator menu.
1. Create a user group hierarchy called ClaimsDepartment with user groups
underneath called Fast Track Officer and Claims Processor.
October / 2004
7
2. Assign your users so that Fred is in the Fast Track Officer user group and Jane is in
the Claims Processor user group.
Step 3 — Create the Process Definitions
Go to Process Design in the default Designer menu.
Create some process definitions to use that have at least one normal activity. For
example:
Process Definition
Participant
Normal Claim
Claims Processor
Special Claim
Fast Track Officer
Vacation Request
Initiator
1. Set the participant in the normal activity to the user group that is going to do the
work.
2. Set the participant to initiator for any processes you want to make generally
available.
Step 4 — Create the BizCoves
Go to BizCove in the default Business Administrator menu. You will create a process
initiation BizCove for each user group and a worklist BizCove for the organizational unit.
1. Create a process initiation BizCove called Fast Track Process Initiation BizCove.
2. Designate the Fast Track Officer user group to have access to this BizCove.
October / 2004
8
3. Add the Special Claim, Normal Claim and Vacation Request process definitions
to the BizCove.
4. Finish the wizard. You can create filters and buttons as you want. Refer to the
BizFlow User Guide for assistance.
October / 2004
9
5. Create a process initiation BizCove called Claims Processing Process Initiation
BizCove.
6. Designate the Claims Processor user group to have access to this BizCove.
7. Add the Normal Claim and Vacation Request process definitions to the BizCove.
8. Finish the wizard. You can create filters and buttons as you want. Refer to the
BizFlow User Guide for assistance.
9. Create a report BizCove. For example, create an Activity Benchmark report
including all of the processes you created.
10. Designate the Claims Department organizational unit to have access to this
BizCove.
11. Finish the wizard.
12. Create a worklist BizCove called the Claims Department Worklist BizCove.
13. Designate the Claims Department organizational unit to have access to this
BizCove.
14. When you define the scope of the Work Area, include any of the process
definitions for which you set any of the user groups as participants so that they’ll
be able to see the running processes.
Remember, you can include the entire folder, a process definition or the specific
activity for which the user group is a participant. This will determine what work will
be included in the BizCove. Any work assigned to the members of the user group
will be displayed as long as the activity with the workitem has been included. It
does not mean that the work will not be assigned if the activity (process definition
or folder) is not included, the participants just won’t be able to see it.
15. Finish the wizard.
Step 5 — Create the Work Area Pages
Go to BizCove in the default Business Administrator menu.
You can either deploy the BizCoves through a portal, which this BluePrint examines in
other sections that follow, or you can deploy through Work Area Pages. BizFlow lets the
business administrator create two BizCoves for each user group or organizational unit.
One is for the general users of the user group or organizational unit and one is for the
manager. The example in this BluePrint uses four different Work Area Pages.
1. Create a user Work Area Page for the Claims Department organizational unit.
October / 2004
10
2. Choose two columns.
October / 2004
11
3. Add BizCoves:
•
Column 1 — assign the Report BizCove that you created
•
Column 2 — assign the Claims Department Worklist BizCove
4. Create a manager Work Area Page for the Claims Department organizational
unit.
5. Choose two columns.
6. Add BizCoves:
•
Column 1 — assign the Report BizCove that you created
•
Column 2 — assign the Claims Processing Process Initiation BizCove and the
Fast Track Process Initiation BizCove
7. Create a user Work Area Page for the Fast Track user group.
8. Choose one column.
9. Add the Fast Track Process Initiation BizCove.
10. Create a user Work Area Page for the Claims Processor user group.
11. Choose one column.
12. Add the Claims Processing Process Initiation BizCove.
Test User Access
Now try logging in as each one of the users, Terry, Fred and Jane to see how access to
the BizCoves varies.
Figure 2.
Jane will see work assigned to members of the Claims Processor user group in the
Claims Department Organizational Unit Work Area Page. Jane can also select the Claims
Processor user group Work Area Page from the Show drop box to see the two process
definitions that they are allowed to initiate in the user group.
October / 2004
12
Figure 3.
Fred will see work assigned to members of the Claims Processor user group in the
Claims Department Organizational Unit Work Area Page. Fred can also select the Fast
Track Officer user group Work Area Page from the Show drop box to see the three process
definitions that they are allowed to initiate in the user group.
Figure 4.
Because Terry is the manager of the organizational unit, the manager Work Area
Page is displayed. Terry can initiate the process definitions from either user group BizCove.
October / 2004
13
Conditional Logic
Conditional Logic
One of the core benefits and usability points of BizCoves is their ability to display only
what pertains to users, based on their user group, organizational unit, authority group or
other filtering criteria. The conditional logic model enables personalization outside
BizFlow, and even enhances its capabilities. To benefit from the conditional logic
capability, JSP and Java Beans (hwjsp.jar, hwweb.jar) must be used.
As an example, by using the following beans in the code below, it is very easy to greet
the user by name and/or organizational unit.
<jsp:useBean id="hwSessionInfo"
class="com.hs.bf.web.beans.HWSessionInfo" scope="session"/>
<jsp:useBean id="hwSessionFactory"
class="com.hs.bf.web.beans.HWSessionFactory"
scope="application"/>
<%
// Retrieves the User ID
String userID = hwSessionInfo.get("USERID");
// Retrieves the organizational unit
String deptID = hwSessionInfo.get("DEPTID");
%>
Additionally, you may retrieve any information about the authority groups to which the
user belongs, and use this to display information and capabilities to which the user has
access authorization.
<%
HWFilter hwfilter = new HWFilter();
inputStream resultStream =
hwSession.getGroups(hwSessionInfo.toString(),hwFilter.toByteArray());
%>
Combined with conditional statements, the BizFlow API allows you to fully tailor how
BizCoves display to their audience. The following are examples of the difference
between how the BizCoves display for the manager and how they display for a user.
October / 2004
14
Conditional Logic
Figure 5.
October / 2004
The manager’s BizCoves
15
Conditional Logic
Figure 6.
October / 2004
The user’s BizCoves
16
Sharepoint 2001 with NT Single Sign-On
Sharepoint 2001 with NT Single SignOn
BizCoves may be integrated into the Sharepoint portal by adding a new Web Part and
assigning the BizCove to it. To provide a seamless user experience, Windows NT Single
Sign On is supported so users can view BizCoves directly from Sharepoint without logging
into BizFlow. BizFlow Preferences are also accessible from Sharepoint, through each
embedded BizCove.
Figure 7.
BizCoves integrated into Sharepoint
Adding a BizCove to Sharepoint
Follow these steps to add and define the new Web Part.
1. Log in to the Sharepoint Portal.
October / 2004
17
Sharepoint 2001 with NT Single Sign-On
2. Click on the Content link located at the top right of the window.
3. Click Create a New Web Part.
4. Modify the General Settings for the new Web Part.
a. At Name, enter a name for the New Web Part.
b. Check Include this Web Part on the Dashboard.
5. Modify the Advanced Settings for the new Web Part.
a. Check Get Content from the Following Link.
b. Enter the BizCove link in the following format:
http://<%BIZFLOW_SERVER%>/bizflow/bizcoves/<%BIZCOVE_FOLDER%>/
<%BIZCOVE_TYPE%>_<%BIZCOVE_ID%>.jsp
For information on how to replace the parameters in this example, refer to the
table IFRAME Parameters.
6. Check Isolate this Web Part’s content from the Other Web Parts.
7. Check Provide Content Personalization for this Web Part through the Following
Link.
8. Enter the link to BizFlow Preferences:
javascript:self.showModalDialog('http://<%BIZFLOW_SERVER%>/bizflow/preference/
preference.htm',",'dialogHeight:435px;dialogWidth: 526px;status:no;help:no;');
9. Click on the Save button to save the New Web Part.
Using Windows NT Single Sign-On
By registering the Windows NT Key in the BizFlow Preferences and turning on the NT Single
Sign-on feature, users have the option to directly access BizFlow from Sharepoint without
logging in a second time. If Single Sign-on is selected, the BizCoves will immediately
display in Sharepoint. If Single Sign-on has not been set up, the BizFlow login dialog box
will be displayed to prompt for the user’s ID and password.
October / 2004
18
Sharepoint 2003 Portal Adapter
An adapter that is specifically designed by HandySoft to act as a proxy between BizFlow
and the portal facilitates the integration of BizCoves into the Sharepoint 2003 portal.
How To Use the Sharepoint 2003 Adapter
1. Login to Bizflow using SSO.
2. Redirect to the required URL.
October / 2004
19
Installing New Files
New Files
The following JSP files and JS files are added. These files must be installed in the gadgets
directory of the BizFlow web application directory on the Web server:
•
gadgets/sharepoint/bizflowgateway.jsp
•
gadgets/sharepoint/constants.jsp
•
gadgets/sharepoint/setprefs.jsp
•
gadgets/sharepoint/userprefs.jsp
•
gadgets/loginfn.jsp
These files are located in the BizFlow folder in the zip file distributed with the BizFlow
Portal Adapter for Sharepoint 2003.
New JAR Files
The following JAR file is added. This JAR file must be installed in the WEB-INF/lib directory
of the BizFlow web application directory on the Web server.
•
WEB-INF/lib/hwextutil.jar
This file is located in the BizFlow folder in the zip file distributed with the BizFlow Portal
Adapter for Sharepoint 2003.
URL and Parameters of the BizFlow Gateway
JSP
The main module of the BizFlow Portal Adapter for Sharepoint 2003 is bizflowgateway.jsp.
Context URL: /bizflow/gadgets/sharepoint/bizflowgateway.jsp
Parameters:
Parameter
Name
Explanation
DEFAULT
Mandatory
loginID
User ID
NO
password
The password of the
user
NO
loginType
Login type
•
October / 2004
BIZFLOWSECURITY
NO
BIZFLOWSECURITY:
20
Parameter
Name
Explanation
DEFAULT
Mandatory
using login ID and
password
loginID and
password
parameters
must exist
•
NTSSO: using NT
SID
Ignore login
ID and
password
parameters
•
PROPERTYAUTH:
get login id and
password from a
cookie
If this parameter is
not specified, the
loginType is assumed
to be
“BIZFLOWSECURITY”
NTSID
User’s NTSID. This
parameter is only
used if loginType is
“NTSSO”.
NO
targetURL
The URL of the Bizflow
web application to
be executed.
NO
forceLogin
When the user is
already logged into
another browser, and
the value is true, the
user will be forcibly
logged out and the
new attempt to login
will be successful.
false
NO
If the user is already
logged into another
browser, and this
October / 2004
21
Parameter
Name
Explanation
DEFAULT
Mandatory
value is false, the
will fail.
localGMT
Timezone. For
example, when using
the GMT-5 timezone,
this value is –5.
0
bizcoveID
The ID of a BizCove
1000202
bizcoveType
The type of a
BizCove. The value is
one of the following:
z
definition
z
worklist
z
report
z
externalreport
z
monitor
YES
YES
When the loginType is “BIZFLOWSECURITY”, and the loginID and password
parameters do not exist in the URL, the BizFlow Gateway gets the value of loginID
and password from a Cookie:
o
The cookie name of loginID is “loginID”
o
The cookie name of password is “password”
When the loginType is “PROPERTYAUTH”, the BizFlow Gateway tries to get the
BizFlow ID and password from the Cookie. If the BizFflow ID and password do not
exist in the Cookie, the login screen will be displayed. Once the user inputs the
BizFlow ID and password, they are saved in the Cookie and the user will no longer
be prompted unless an error occurs during login to BizFlow.
If you want to customize the login screen, please modify
gadgets/sharepoint/userprefs.jsp.
The following are examples of the URL:
October / 2004
22
http://jkcom:8080/bizflow/gadgets/sharepoint/bizflowgateway.jsp?loginType=PROPERTYAUTH&bi
zcoveID=1000202&bizcoveType=worklist
zcoveID=1000203&bizcoveType=definition
zcoveID=1000204&bizcoveType=monitor
Configuring BizFlow
1.
Copy all of the new JSP files and jar files to the following folder:
%WEB_APPLICATION_HOME%\bizflow
2.
Restart the web server.
Creating the BizCove on Sharepoint 2003
1. Click Modify My Page at the top and select the Browse menu.
2. Select Page Viewer Web Part in left frame.
October / 2004
23
3. Drag it down to the place where a BizCove shows up.
October / 2004
24
4. Click the ▼ icon on the Page Viewer Web Part and select Modify My Web
Part.
5. Enter the URL of the BizFlow Gateway in the Link field.
October / 2004
25
A sample URL is:
http://jkcom:8080/bizflow/gadgets/sharepoint/bizflowgateway.jsp?loginType=PROPE
RTYAUTH&bizcoveID=1000202&bizcoveType=worklist
6. Expand Appearance.
7. Enter the title of a BizCove.
October / 2004
26
8. If needed, change Appearance, Layout and Advanced options and click
OK.
October / 2004
27
Hummingbird and Credential Storage
Hummingbird and Credential
Storage
The integration of BizCoves into Hummingbird is similar to interfacing with Sharepoint. But,
instead of using Windows NT Single Sign-On, Hummingbird supports credential storage
that retains the user’s login ID and password for specific applications. Specifically, the
BizFlow user ID and password are stored in the hcl.bizflow credential file and will be used
to launch BizCoves without requiring the user to login a second time.
Adding a BizCove to Hummingbird
Integration with Hummingbird requires the creation of a Hummingbird e-Clip, to which
the BizCove is added, then a component is scripted utilizing the IFRAME tag.
1. Create and name an e-Clip file in the folder of the www e-Clip category:
$Home\Hummingbird\eip\repository\eclips\www\, using the following code
pattern. Tags and parameters in this example are detailed below. For more
information on other e-Clip parameters, please consult Hummingbird
documentation.
<ECLIP>
<DESCRIPTION>
This is a BizCove integrated into the Hummingbird Portal
</DESCRIPTION>
<PARAMETERS>
title="BizCove Eclip"
credentials=hcl.bizflow
credentialendocingmethod=url
cache=transient
</PARAMETERS>
<COMPONENTS>
Iframe
http://<%BIZFLOW_SERVER%>/bizflow/
bizlogin.jsp?loginID=$Username$&password=$Password$&forceLogin=true&returnURL
=http://<%BIZFLOW_SERVER%>/bizflow/data/bizcoves/<%BIZCOVE_FOLDER%>/
<%BIZCOVE_TYPE%>_<%BIZCOVE_ID%>.jsp
</COMPONENTS>
</ECLIP>
October / 2004
28
e-Clip Tags and Parameters
Tag/Parameter
Description/Instructions
<DESCRIPTION>[…]</ DESCRIPTION>
Describes the purpose of the e-Clip. In
some themes, the description may be
displayed.
<PARAMETERS>[…]</ PARAMETERS>
Sets the parameters for the e-Clip such as
the caching mechanism.
title
The title of the e-Clip must be enclosed
within double-quotes and if none exists, “”
is the default to use.
credentials
This must be set to hcl.bizflow, which is the
file used to store credentials i.e. user login
and password.
credentialencodingmetho d
Indicates the encoding method to use
when transmitting the user’s credentials.
For BizCoves, this must be set to url.
cache
Sets the caching scope for the e-Clip:
global: cached results are available to all
users.
session: cached results are on a per-user
basis (personalized or private
information).
transient: no caching (default).
<COMPONENTS>[...]</ COMPONENTS>
Lists the components that input and
output information related to the BizCove.
Iframe
Indicates that the BizCove uses IFRAME to
be integrated to the Hummingbird portal.
This cannot be changed or left out.
http:// <%BIZFLOW_SERVER%>/ bizflow/
bizlogin.jsp?loginID=$Usern
ame$&password=$Passwor
d$&forceLogin=true&retur nURL=http://
<%BIZFLOW_SERVER%>/
bizflow/data/bizcoves/
<%BIZCOVE_FOLDER%>/
<%BIZCOVE_TYPE%>_<%BIZ COVE_ID%>.jsp
This is the URL of the BizCove component.
Refer to the table IFRAME Parameters. for
more information on how to replace the
parameters for the BizFlow server and the
BizCove.
October / 2004
29
2. Add the scripted component using IFrame for the e-Clip by updating or
creating the IFrame file in the directory
$Home\Hummingbird\eip\repository\compscr\, using the following code:
<COMPONENT>
<REPLACE>
<IFRAME
src="$eClipRequest$"
width="100%"
height="320px"
scrolling="yes"
frameborder=0
marginheight=0
marginwidth=0
align="left">
</IFRAME>
</REPLACE>
</COMPONENT>
Unlike the src attribute, parameters such as width, height or alignment can be changed.
They are used to build the IFRAME when the BizCove is displayed. Please refer to an HTML
guide for more details about the IFRAME element.
Adding the BizCove e-Clip to a User Page
1. Select General Information, then select Add User Page.
2. Enter a name.
3. Click the Create User Page icon.
4. Click the Insert e-Clip button.
5. Select www as the Category.
6. From the list, select the e-Clip that you created.
7. Click the Add e-Clip To User Page icon. Hummingbird displays the BizCove.
8. Click the Build Page icon.
Credential Storage for End-users
To benefit from credential storage and single sign-on, users need to modify the
credentials in their Hummingbird user’s profile. If there is a BizFlow application available,
select hcl.bizflow, and enter a valid user name and password.
If there is no BizFlow application, do the following:
October / 2004
30
1. From the Browse tab, select Administration Tools, and then select Application
Management.
2. Select the Add tab to add a new application.
3. Enter the application identifier as follows: hcl.bizflow
4. Select Simple (username/password) as Authentication type, and press the Save
button.
5. Return to the portal page.
6. Select hcl.bizflow, enter a valid user name and password, and press the Save
button.
October / 2004
31
Integrating BizCoves into a Plumtree Portal
Integrating BizCoves into a Plumtree
Portal
Unlike the IFRAME model, the integration of BizCoves in the Plumtree portal is based on
an adapter that is specifically designed by HandySoft to act as a proxy between BizFlow
and the portal. The Bizflow adapter modifies the content of the Bizflow web application
as Plumtree expects it to be and returns it to Plumtree.
BizCoves are embedded in Plumtree without losing any functionality
•
JavaScript code is included and URLs remain unchanged (absolute path),
including the Refresh link.
•
The BizFlow Workitem Handler is automatically installed if it is not present on the
user’s desktop the very first time a task it worked on.
Figure 8.
A BizCove in the Plumtree portal
The following BizFlow features are supported in the Plumtree Portal:
•
Process Initiation Bizcove
•
Monitor Bizcove
•
Report Bizcove
•
Reportlist Bizcove
•
Worklist Bizcove
•
Preferences
October / 2004
32
Note:
Some files need to be modified and added. To integrate BizCoves as Plumtree Gadgets, you must
first adapt your BizFlow server. A set of new JSP and JAR files need to be installed, while some existing
ones need to be modified. Please contact HandySoft to have this package made available to you.
After installing those files, both BizFlow and Plumtree need to be configured to enable communication
between each server.
How the Plumtree Adapter Works
1. Login into Bizflow using SSO.
2. Remove the HTML tags that are not allowed by Plumtree, such as <HTML>,
<HEAD>, and <BODY> from the HTML of the Bizflow web application.
3. Embed the context of the Java Script files that are in the HTML of the
Bizflow web application into the resulting HTML.
Because the resulting HTML is embedded in the Plumtree portal,
the relative URL of the resulting HTML must be modified to be an
absolute URL. Luckily, Plumtree modifies the relative URL of the
resulting HTML but it doesn’t modify the relative URL of Java
Script files that are in the resulting HTML. So If the context of the
Java Script files has a relative URL, the context of the Java Script
files must be embedded into the resulting HTML.
4. Modify the refresh URL in the resulting HTML of the Bizflow web application.
Because the refresh URL of the HTML page doesn’t consider the
environment of the Plumtree portal, all refresh URLs must be
modified to accommodate the Plumtree environment.
5. If needed, change the Java Script function in the resulting HTML of the
Bizflow web application to work in the Plumtree environment.
6. If the Workitem Handler program is not installed on the client, it will install
automatically.
Installing New Files
Modified JSP Files
The following BizFlow JSP files are modified and must be overwritten in same location:
•
includes\bizcoves\common\userinfo.js
•
includes\instance\piactivity.js
•
includes\instance\piattach.js
•
includes\instance\picomment.js
October / 2004
33
These modified JSP files are in the webapps/bizflow folder in the zip file distributed with
the Bizflow Adapter for Plumtree.
New Files
The following JSP files and JS files are added. These files must be installed in the gadgets
directory of the BizFlow web application directory:
•
gadgets/plumtree/adminprefs.jsp
•
gadgets/plumtree/bg_definition.js
•
gadgets/plumtree/bg_embeededdefinition.js
•
gadgets/plumtree/bg_monitor.js
•
gadgets/plumtree/bg_worklist.js
•
gadgets/plumtree/bizflowgateway.jsp
•
gadgets/plumtree/bizflowprefreences.jsp
•
gadgets/plumtree/mainstyle-en.css
•
gadgets/plumtree/setprefs.jsp
•
gadgets/plumtree/userprefs.jsp
•
gadgets/plumtree/userprefs_simple.jsp
•
gadgets/bizflowpreferences.jsp
•
gadgets/loginfn.jsp
These files are in webapps/bizflow folder in the zip file distributed with the Bizflow
Adapter for Plumtree.
New JAR Files
The following JAR files are added. These JAR files must be installed in WEB-INF/lib directory
of Bizflow web application directory
•
WEB-INF/lib/bizcove.jar
•
WEB-INF/lib/gdk.jar
•
WEB-INF/lib/hwextutil.jar
These files are in the webapps/bizflow folder of the zip file distributed with the Bizflow
Adapter for Plumtree
URL and Parameters
bizflowgateway.jsp
The main module of the Bizflow adapter for Plumtree is bizflowgateway.jsp.
October / 2004
34
Context URL: /bizflow/gadgets/plumtree/bizflowgateway.jsp
Parameters:
Parameter
Name
Explanation
DEFAULT
Mandatory
loginID
User ID
NO
password
The password of the
user
NO
loginType
Login type
•
BIZFLOWSECURITY
NO
BIZFLOWSECURITY:
using login ID and
password
loginID and
password
parameters
must exist
•
NTSSO: using NT
SID
Ignore login
ID and
password
parameters
•
BASICAUTH: using
login ID and
password for
Plumtree
•
PROPERTYAUTH:
get login id and
password from
properties of the
Plumtree
If this parameter is
not specified, the
loginType is assumed
to be
“BIZFLOWSECURITY”
NTSID
October / 2004
User’s NTSID. This
parameter is only
used if loginType is
“NTSSO”.
NO
35
Parameter
Name
Explanation
targetURL
The URL of the Bizflow
web application to
be executed.
forceLogin
When the user is
already logged into
another browser, and
the value is true, the
user will be forcibly
logged out and the
will be successful.
DEFAULT
Mandatory
NO
false
NO
If the user is already
logged into another
browser, and this
value is false, the
will fail.
pwdPropertyName
Administrative
property name to
pass a user’s
password.
•
In the case of All
so that user’s
password is same,
please use this
parameter.
•
If you use this
parameter, the
value of the
loginType
parameter must
be
BIZFLOWSECURITY
NO
localGMT
Timezone. For
example, when using
the GMT-5 timezone,
this value is –5.
0
useBizcoveStyleSheet
If this value is false, it
will remove the
true
October / 2004
36
Parameter
Name
Explanation
DEFAULT
Mandatory
Bizflow style sheet
information from the
HTML content of the
Bizcove.
When the loginType is “BIZFLOWSECURITY”, and the login ID and password
parameters do not exist in the URL, the Bizflow adapter for Plumtree module gets
the value of the login ID and password from the “Authorization” HTTP header. In
order to use the “Authorization” HTTP header, the “User’s Basic Authentication
Information” must be set in Advanced Settings when registering a gadget.
When the loginType is “PROPERTYAUTH”, the BizFlow Gateway tries to get the
BizFlow ID and password from the properties of the Plumtree portal. If, however,
the BizFlow ID and password do not exist in the Plumtree properties, the login
screen will be displayed. Once the user inputs the BizFlow ID and password, they
are saved in the properties of the Plumtree portal and the user will no longer be
prompted unless an error occurs during login to BizFlow.
If you want to customize the login screen, please modify
gadgets/plumtree/userprefs.jsp.
October / 2004
37
adminprefs.jsp
The adminprefs.jsp file saves information from the BizCove into the Plumtree Administrator
properties.
Context URL: /bizflow/gadgets/plumtree/adminprefs.jsp
Parameters:
Parameter
Name
pwdPropertyName
Explanation
Administrative
property name to
pass a user’s
password.
DEFAULT
Mandatory
NO
In the case of All so
that user’s
password is same,
please use this
parameter.
Configuring BizFlow
Copy Files
Copy all modified JSP files, new JSP files and jar file to the root directory of the BizFlow
web application.
Modify web.xml File
Configuration of BizFlow for the Plumtree Portal occurs in the web.xml file, located under
$BIZFLOW_HOME\WEB-INF\ where $BIZFLOW_HOME is the Web application directory for
BizFlow on the Web server.
Example: If the web application directory of Bizflow is C:\Program Files\Apache Tomcat
4.0\webapps\bizflow, the web.xml resides in C:\Program Files\Apache Tomcat
4.0\webapps\bizflow\WEB-INF\web.xml
1. Set the com.hs.bf.xml.soap.endPoint parameter to specify the RPCRouter URL for
BizFlow:
<init-param><param-name>com.hs.bf.xml.soap.endPoint</param-name><paramvalue>http://<%BIZFLOW_SERVER%>:PORT/bizflow/rpcrouter</param-value></initparam>
October / 2004
38
Replace <%BIZFLOW_SERVER%> with the IP address or name of the machine
where BizFlow is installed that contains the BizCove and replace PORT with the
port number of the web server.
Here is an example: machine_name:8080 or 123.456.6.123:8080
2. Set the com.hs.bf.web.gadget.basedir parameter to specify the root directory
path of BizFlow:
<init-param><param-name>com.hs.bf.web.gadget.basedir</param-name><paramvalue><%WEB_APPLICATION_ROOT_DIRECTORY%></param-value></init-param>
If the web application directory of BizFlow is C:\Program Files\Apache Tomcat
4.0\webapps\bizflow, <%WEB_APPLICATION_ROOT_DIRECTORY%> is C:/ Program
Files/Apache Tomcat 4.0/webapps. (Make sure to change \ to /.)
3. Restart the BizFlow server.
Configuring Plumtree
This configures the BizFlow gadgets on Plumtree.
Single Sign-On
Plumtree requires single sign-on to be set up between the portal and any application,
including BizFlow. Please refer to the Plumtree documentation to enable SSO.
How to Use the Universal Password for each User
1. Decide the property name as password parameter.
2. Add the pwdPropertyName=YOUR_PROPERTY_NAME parameter to the URL of
bizflowgateway.jsp and specify BIZFLOWSECURITY as the value of the loginType
parameter when creatinge the BizFlow web service.
For example, If you use “ADMIN_PASSWORD” as the property name of the
password parameter, the URL of the bizflowgateway.jsp is
bizflow/gadgets/plumtree/bizflowgateway.jsp?forceLogin=true&loginType=
BIZFLOWSECURITY&pwdPropertyName=ADMIN_PASSWORD&localGMT=-5
3. Add pwdPropertyName=YOUR_PROPERTY_NAME parameter tot the URL of
adminprefs.jsp when entering the Administrative Preferences URL.
For example, If you use “ADMIN_PASSWORD” as property name of password
parameter. The Administrative Preferences URL is
bizflow/gadgets/plumtree/adminprefs.jsp?pwdPropertyName=ADMIN_PASSWORD
4. Set the password when configuring the Bizflow BizCove.
October / 2004
39
BizFlow as a Service in Plumtree
After enabling single sign-on between Plumtree and BizFlow, BizCoves may be integrated
using a service. The following instructions provide a summary of the procedure; for more
details, please refer to the Plumtree documentation.
1. Log into Plumtree as an administrator.
2. Click the Administrator menu at the top.
3. In the Admin Objects Directory, select the Create Objects drop box and select
Administrative Folder.
4. Enter a name and a description, and click OK.
October / 2004
40
Register BizFlow as a Remote Server
1. Select the folder you just created.
2. Select Remote Server from the Create Objects drop box.
3. Enter the base URL of the BizFlow server, including the port number.
For example: http://bizflow:8080/
4. Leave Base Authentication Type set to None.
October / 2004
41
5. Click Properties and Names and enter the name of the remote server, for
example BizFlow web server.
6. Click Finish and select your folder as the one in which to save the property of the
remote server.
7. Click Save.
8. Click Close.
Register the Service
1. Make sure you are in the folder you previously created.
2. Select Web Service – Remote Portlet from the list in the Create Objects drop box.
October / 2004
42
3. Click Browse and select the remote server you created, for example BizFlow web
server.
4. In the HTTP settings, enter the base URL of bizflowgateway.jsp for the portlet URL.
This is core module acting as the gateway between BizFlow and Plumtree. The
base URL of the bizflowgateway.jsp is:
“bizflow/gadgets/plumtree/bizflowgateway.jsp?forceLogin=true”
Note:
You may also need to add parameters. See bizflowgateway.jsp on page 34
Note:
If you use BASICAUTH login type, please add loginType=BASICAUTH into the URL and if you want
to specify timezone, add localGMT parameter. For example If you use GMT-5 timezone, the url is
bizflow/gadgets/plumtree/bizflowgateway.jsp?forceLogin=true&loginType=BASICAUTH&localGMT=-5
5. Make sure the status of the Web service is enabled.
October / 2004
43
6. Click HTTP Configuration.
7. Add the gateway URL prefix “bizflow”.
October / 2004
44
8. Select Advanced Settings.
9. Select User’s Basic Authentication Information.
10. Click Preferences (on the left).
11. Enter as the Administrative Preferences URL and Portlet Template Preferences URL,
the basic URL:
bizflow/gadgets/plumtree/adminprefs.jsp
Note:
You may also need to add parameters. See bizflowgateway.jsp on page 34
12. Click Properties and Names (on the left).
13. In the Properties and Name page, enter the name of the Web service.
14. Click Finish.
15. Select your folder to save the Web service.
16. Click Save.
17. Click Close.
October / 2004
45
Create the Portlet Template
1. In your folder, select Portlet Template in list in the the Create Objects drop box.
2. Click Browse and select the Web Service you created.
3. Select Properties and Names (on the left).
4. On the Properties and Name page, enter the name of the portlet template, for
example:
BizFlow BizCove Template
5. Click Finish.
6. Select your folder to save the Web service.
7. Click Save.
8. Click Close.
Create the Portlet
1. In your folder, select Portlet in the list in the Create Objects drop box.
October / 2004
46
2. Select the portlet template you designed (BizFlow BizCove Template) and click
OK.
3. Click the Edit button.
4. Select the type and ID of the BizCove to be inserted into the portlet.
5. Click Finish.
6. Select Properties and Names (on the left).
7. In the Properties and Names screen name the portlet, for example, BizCove
Worklist.
8. Select Security (on the left).
October / 2004
47
9. In order to allow every user to view the portlet, choose Select in the Security
page.
10. Click Finish.
9. Select your folder to save the portlet.
10. Click Save.
11. Click Close.
View the Portlet
The portlet needs to be added to a page.
1. Select Add Portlets from of My Pages at the top of the screen.
2. Select the portlet you created, for example, BizCove Worklist
3. If configured correctly, the BizCove is displayed in the portal.
October / 2004
48
Registering the BizFlow Preferences in
Plumtree
Add or modify the bizflowpreferences.jsp, this jsp file must be located in the
gadgets/plumtree directory under the BizFlow web application directory. You should
have copied it there earlier in this BluePrint. See New Files on page 20.
The following in the bizflowpreferences.jsp file:
<%@ page language="java" import="java.io.FileInputStream,
java.io.FileReader,
java.io.FileOutputStream,
java.net.URL,
java.net.MalformedURLException,
java.net.URLEncoder" %>
<head>
<title>
Sarbanes User Preferences
</title>
</head>
<SCRIPT language='javascript'>
function openPreferencesWindow()
{
var height = 520;
var width = 540;
var strXLocation = String((screen.width - width) / 2);
var strYLocation = String((screen.height - height) /2);
this.location =
"bizflowgateway.jsp?forceLogin=true&loginType=BASICAUTH&refresh=y&prefPage=true";
}
October / 2004
49
openPreferencesWindow();
</SCRIPT>
Registering the Preferences
1. Go to the web service of the Bizflow BizCove.
2. Select the Preferences menu on the left side of the screen.
3. Enter the following at the Portlet Preferences URL: on right side
bizflow/gadgets/plumtree/bizflowpreferences.jsp
4. Click Finish (at the top of the screen).
October / 2004
50
Accessing the BizFlow Preferences
1. Click the icon with the pencil image
in the BizCove portlet.
2. From the on My Preferences list, click a Portlet name.
October / 2004
51
The BizFlow preferences will be displayed.
Setting the Time Zone
If you do not specify a Time Zone, the GMT+0 time zone is used.
You can specify a Time Zone for all users using the localGMT parameter of
bizflowgateway.jsp or allow each user to specify a personalized Time Zone.
Non-Personalized Time Zone Setting for All Users
Please add the localGMT pararmeter when you Register the Service.
Personalized Time Zone Setting
To allow each user to specify their own personalized Time Zone, the “Send timezone to
Portles” option of Web Service must be turned on. The localGMT parameter must not be
specified in the URL of bizflowgateway.jsp to prevent use of a personalized Time Zone.
October / 2004
52
Each user can then specify a personalized time zone using the “Edit Locale Settings”
menu under My Account.
October / 2004
53
October / 2004
54
Look-and-feel Customization
Using the CSS (Cascading Style Sheet), a BizCove’s look-and-feel and user controls can
easily be customized to reflect your corporate identity or be consistent with your portal’s
user interface. BizFlow comes with five built-in themes. When a user creates a new
BizCove through the BizCove creation wizard, the themes are presented to the user in a
list so that one of them can be applied to the BizCove. You may create your own
BizCove appearance themes by following these instructions:
Creating the New Theme’s Style Sheets
The files for each theme – CSS and images – are stored under $BIZFLOW_HOME/bizflow/
themes/ where $BIZFLOW_HOME is the BizFlow server root directory.
Example: $BIZFLOW_HOME/bizflow/themes/fall/ contains the CSS and image files for the
theme “Fall”. Under each theme directory, there are separate CSS files for each locale.
1. To create and name the directory of your own theme, copy the directory of a an
existing theme – such as Fall – including its content, and rename the new
directory. The folder name should be one word, for example you could call it
mytheme:
$BIZFLOW_HOME/bizflow/themes/mytheme/
2. Within your new theme directory, locate the bizflow_xx.css file for each of the
locales that you use:
bizflow_en.css for English, bizflow_fr.css for French, bizflow_de.css for German,
bizflow_zh for Traditional Chinese, bizflow_ko for Korean, bizflow_ja for Japanese.
3. One at a time, open each of the CSS files in a text editor and modify it for your
new look and feel.
a. Only modify properties and values. DO NOT modify class names.
b. Save each CSS file when you are finished modifying it.
Note:
Unless you want to have a different look for each locale, remember to modify all the locale CSS
files the same way.
Adding Your Theme to the System
Open the bizcove_xx.xconf file XML file – under $BIZFLOW_HOME/bizflow/WEB-INF/ –
corresponding to each locale for which you have created a style sheet in a text editor so
that you can edit it. For example, if you are using the English locale, edit
bizcove_en.xconf for English and if you are using the French locale, edit bizcove_fr.xconf.
Notice that in the XML file there is a section that lists the themes that BizFlow uses. For
each one, the theme “listname” is the name that this theme is called in the list presented
October / 2004
55
to the user in the BizCove creation wizard and “name” is the name of the folder where
the image and CSS files that define the theme are found (the folder you just created.)
1. Add the following element as a child of <themes>:
<theme listname="<display_name>" name="<theme_folder_name>"/>
Replace <display_name> with the name that you want to call this theme. This
name will be displayed in a list to the user along with the other theme names. You
can call the theme whatever you want but it should be specific to the locale of
the XML file. For example, this would be My Theme in English or Mon Thème in
French.
Replace <theme_folder_name> with the same name that you named the folder
you created for your theme. This is not locale specific and will be the same no
matter which locale XML file you are editing. See Step 1 on page 55.
Final examples:
For the English locale (bizcove_en.xconf):
<themes>
<theme listname="default" name="default"/>
<theme listname="fall" name="fall"/>
<theme listname="winter" name="winter"/>
<theme listname="modern" name="modern"/>
<theme listname="fancy" name="fancy"/>
<theme listname="My Theme" name="mytheme"/>
</themes>
For the French local (bizcove_fr.xconf):
<themes>
<theme listname="Standard" name="default"/>
<theme listname="Automne" name="fall"/>
<theme listname="Hiver" name="winter"/>
<theme listname="Moderne" name="modern"/>
<theme listname="Elegant" name="fancy"/>
<theme listname="Mon Thème" name="mytheme"/>
</themes>
October / 2004
56
Summary
Summary
BizCoves can be deployed in a number of ways including through the Internet, portals or
through BizFlow, giving users access to BizCoves where they are the most needed. There
are several methods and techniques that can be used to extend BizCoves. These
techniques can be used together or separately to provide customized BizCoves. The
point-and-click configuration options offered as a standard part of BizFlow enable you to
define many of the design and usability aspects of the BizCoves including the basic type
of BizCove, user interface theme and button format, how much information is shown and
how it is organized. More advanced techniques provide even more functionality such as
launching the BizCoves within a portal, applying a customized theme or style sheet so
that the BizCoves are more a part of a corporate look, and using conditional logic so
that the BizCove provides personalized information and functionality that is different for
each user who logs in.
October / 2004
57

BizCoves 9.0 BluePrint

Transcription

Similar documents

Teacher Portal Overview

How to register your company with Bantrel`s Supplier/ Contractor

19 Sept (G3) Fione Tan

Portal User Guide Login to Portal

Veterinary Medical Center

How to reset your existing Nurre Caxton password:

planningAND development - myOrangeLadder

PORTAL - myCSULA Identity

BOSSLey Biz - Bossley Park High School

Setting up my WiFi - Alaska Communications