tibbr®, tibbr Service, tibbr Community,
and tibbr Community Service
Installation and Configuration
Software Release 3.0
August 2011
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 BusinessWorks, tibbr, TIBCO Silver 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 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 INF3ORMATION 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 © 2010-2011 TIBCO Software Inc. ALL RIGHTS RESERVED.
TIBCO Software Inc. Confidential Information
| iii
Contents
Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . ix
Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi
Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
tibbr Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Third-Party Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xii
Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvi
How to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvi
How to Access All TIBCO Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvi
How to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvi
Chapter 1 Installation of tibbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3
Supported Platforms. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 4
Installation Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Stopping and Restart of tibbr Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Setup of Apache HTTP Server as a Proxy Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Uninstallation Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Backup and Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Upgrade and Restore. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14
Chapter 2 Architecture and Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .15
Architectural Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
tibbr Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Web Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Mobile Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Command-Line Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Cache Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Search Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Job Runner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Event-Stream Runner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
iv
| Contents
Chat Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Audio Conferences, Video Conferences, and Webinars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
SMS Gateway . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enterprise Data-Source Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Enterprise Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Audit Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
19
19
19
19
19
20
Simple Enterprise Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
tibbr Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Web Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Job Runner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Cache Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Search Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Event-Stream Runner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Apache Web Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
21
21
21
22
22
22
22
22
Advanced Deployments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Multinode Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
High-Availability Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
High-Availability Deployment Exposed to Internet . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
23
23
24
25
Configuration of Advanced Deployments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration of the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration of LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration of Shared Network File System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration of Search Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration of Multiple Cache Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Configuration of Apache Server as Load Balancer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
26
26
26
27
27
28
28
30
30
Test of Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 32
Chapter 3 Configuration, Localization, and Performance Tuning . . . . . . . . . . . . . . . . . . . . . . . 33
Configuration Files and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Mechanics of Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Related Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Administrator Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Email Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Authentication Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Search Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Site Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Web UI Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
Chat Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
User Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
tibCast Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
34
34
35
37
38
39
41
49
50
50
52
53
54
Contents v
|
SMS Gateway Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
SharePoint Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Event-Stream Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Google Analytics Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
Validation Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Channel Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Localization Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
BlackBerry Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Android Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Configuration of tibbr Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Configuration of SharePoint Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Configuration of Fields in the Edit My Profile Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Configuration of Banned Email Subjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Population of Users and User-Related Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Connection to LDAP Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74
Configuration and Disabling of SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 75
Display of User Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 76
Configuration of Life Streams . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 77
Localization of tibbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 79
Performance Tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 82
Chapter 4 Custom Event-Stream Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .85
Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86
Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87
Chapter 5 Gadgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .95
List of Gadgets. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Wall Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96
Subject Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97
tibbr Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98
My Subjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99
Followers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100
My Following. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101
People Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102
Subject Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 103
Post. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 104
Subject Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 105
People. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106
User Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107
Subjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 109
Deployment Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Deployment of tibbr and Your Web Site on the Same Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
vi
| Contents
Deployment of tibbr and Your Web Site on Different Domains. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110
Chapter 6 Administration Utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113
Introducing Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Creating a User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 115
Deleting a User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 117
Undeleting a User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118
Adding a User to a Role . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119
Adding Administrator to the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 120
Resetting a Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121
Resetting an Email Address . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122
Creating a Subject. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 123
Deleting a Subject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 125
Undeleting a Subject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126
Creating Subscriptions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 127
Chapter 7 Hints and Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129
Appendix A Installation of Oracle Expenses PL/SQL for the tibbr Event Stream . . . . . . . . . 133
Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134
Related Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 135
Installation Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 136
Uninstallation Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 137
Appendix B Installation of Oracle Order Management PL/SQL for tibbr . . . . . . . . . . . . . . . . 139
Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 140
Installation With Trigger. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141
Installation Without Trigger . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143
Uninstallation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144
Appendix C Installation of an SAP Event Stream in tibbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145
Create a Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 146
Import an Add-On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147
Uninstall an SAP Event Stream . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148
Appendix D Installation and Deployment of tibbr on SharePoint . . . . . . . . . . . . . . . . . . . . . . 149
Installing and Configuring tibbr on SharePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Contents vii
|
Using tibbr Web Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
Synchronizing User Profiles. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Preparing for Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155
Running the Synchronization Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156
Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .157
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
viii
| Contents
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Tables ix
|
Tables
Table 1
General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii
Table 2
Syntax Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiv
Table 3
Supported Databases and Drivers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Table 4
Example of Copying Configuration Directories in a tibbr Upgrade . . . . . . . . . . . . . . . . . . . . . . . . . 14
Table 5
Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 35
Table 6
Database Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Table 7
Administrator Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Table 8
Email Server Configuration Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39
Table 9
Authentication Configuration Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Table 10
LDAP Server Configuration Parameters (LDAP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Table 11
Authentication Configuration Parameter (Mapping Between LDAP and tibbr User Attributes) . . . 44
Table 12
Authentication Configuration Parameter (LDAP Groups). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Table 13
SAML Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 46
Table 14
Search Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Table 15
Site Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Table 16
Web UI Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50
Table 17
Chat Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53
Table 18
User Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Table 19
Video Conference Configuration Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54
Table 20
SMS Gateway Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55
Table 21
SharePoint Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56
Table 22
SharePoint Server Template Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57
Table 23
LinkedIn Configuration Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 59
Table 24
Facebook Configuration Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Table 25
Twitter Configuration Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 60
Table 26
Oracle Expenses Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Table 27
Oracle Order Management Configuration Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61
Table 28
Google Analytics Configuration Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
x
| Tables
Table 29
User Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 63
Table 30
Channel Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 68
Table 31
Localization Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 69
Table 32
SharePoint Link Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 70
Table 33
Configuration Parameters for the Edit My Profile Form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71
Table 34
Meta Data of User Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72
Table 35
User Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73
Table 36
tibbr Source Files for Locales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Table 37
Staging Locations for Localization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80
Table 38
Maximum Threads and Maximum Waiting Users in Tomcat Server . . . . . . . . . . . . . . . . . . . . . . . . 82
Table 39
Custom Event-Stream Field Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88
Table 40
Default Fields in context Object. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92
Table 41
Custom Application Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93
Table 42
tibbr Administration Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 114
Table 43
Web Parts in tibbr for SharePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
| xi
Preface
tibbr® is the first workplace communication tool with which you can follow
subjects that relate to your work and interests besides following people as you do
in typical social networking applications. That way, you have much more
flexibility in obtaining the right information at the right time in the right context.
In fact, the information will find you.
Topics
•
Related Documentation, page xii
•
Typographical Conventions, page xiii
•
TIBCO Resources, page xvi
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
xii
| Related Documentation
Related Documentation
This section lists documentation resources you might find useful.
tibbr Documentation
The following documents form the tibbr documentation set:
•
tibbr and tibbr Service Installation and Configuration This manual, available in
both PDF and HTML, is targeted for administrators of tibbr deployments. It
describes the procedures for installing and configuring tibbr.
•
tibbr and tibbr Service API Reference This manual, also available in both PDF
and HTML, details the tibbr application programming interface.
•
tibbr and tibbr Service How-To Guide This task-oriented guide tells you how to
use tibbr. The topics include following and posting to people and subjects,
setting up event streams, and creating subjects. This guide, available in both
PDF and HTML, is also accessible through the tibbr Web interface at
http://tibbr-host/doc, where tibbr-host is the address of your tibbr installation.
•
tibbr and tibbr Service Release Notes This document describes the new and
changed features and known and closed issues for the current release.
Third-Party Documentation
Read about the YAML data serialization standard at http://www.yaml.org/ and
http://en.wikipedia.org/wiki/YAML.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Preface xiii
|
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:\tibco.
ENV_HOME
Other TIBCO products are installed into an installation environment.
Incompatible products and multiple instances of the same product are installed
into different installation environments. An environment home directory is
referenced in documentation as ENV_HOME. The default value of ENV_HOME
depends on the operating system. For example, on Windows systems the
default value is C:\tibco.
tibbr installs into a directory within ENV_HOME. This directory is referenced in
documentation as TIBBR_HOME. The default value of TIBBR_HOME depends on
the operating system. For example on Linux systems, the default value is
/opt/tibco/tibbr/2.1.0.
code font
Code font identifies commands, code examples, file names, path names, 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]
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
xiv
| Typographical Conventions
Table 1 General Typographical Conventions (Cont’d)
Convention
Use
italic font
Italic font is used in the following ways:
Key
combinations
•
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 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 2 Syntax Typographical Conventions
Convention
Use
[ ]
An optional item in a command or code syntax.
For example:
MyCommand [optional_parameter] required_parameter
|
A logical OR that separates multiple items of which only one may be chosen.
For example, you can select only one of the following parameters:
MyCommand para1 | param2 | param3
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Preface xv
|
Table 2 Syntax Typographical Conventions (Cont’d)
Convention
Use
{ }
A logical group of items in a command. Other syntax notations may appear
within each logical group.
For example, the following command requires two parameters, which can be
either the pair param1 and param2, or the pair param3 and param4.
MyCommand {param1 param2} | {param3 param4}
In the next example, the command requires two parameters. The first parameter
can be either param1 or param2 and the second can be either param3 or param4:
MyCommand {param1 | param2} {param3 | param4}
In the next example, the command can accept either two or three parameters.
The first parameter must be param1. You can optionally include param2 as the
second parameter. And the last parameter is either param3 or param4.
MyCommand param1 [param2] {param3 | param4}
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
xvi
| TIBCO Resources
TIBCO Resources
How to Join TIBCOmmunity
TIBCOmmunity 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 Documentation
After joining TIBCOmmunity, you can access the documentation for all supported
product versions here:
http://docs.tibco.com/TibcoDoc
How to Contact TIBCO Support
For comments or problems with this document or the software it addresses,
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, click Register with Support.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
|1
Chapter 1
Installation of tibbr
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 file for the availability of this software version on a
specific operating system platform.
This chapter shows you how to install or uninstall tibbr and how to migrate from
a previous release to the current release.
Topics
•
Requirements, page 2
•
Installation Procedure, page 5
•
Stopping and Restart of tibbr Services, page 9
•
Setup of Apache HTTP Server as a Proxy Server, page 10
•
Uninstallation Procedure, page 12
•
Backup and Restore, page 13
•
Upgrade and Restore, page 14
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
2
| Chapter 1
Installation of tibbr
Requirements
Before installing tibbr, ensure that your system meets the system requirements
and that you have the prerequisite software installed.
System Requirements
Following are the system requirements:
•
Disk space tibbr requires a minimum of 10 GB of disk space.
•
Hardware memory We recommend 4 GB of RAM.
•
Clean installation environment Do not install any significant third-party
software or other TIBCO software on the system.
Software Requirements
The following software is required by tibbr:
•
A supported Database Management System and driver, that is, an empty
database instance and a user name and password with full read-write
permissions. See Table 3.
Table 3 Supported Databases and Drivers
Database
Driver
Microsoft SQL Server 2008
activerecord-jdbc-mssql
MySQL 5.x
jdbc-mysql
Oracle 11g Release 2
ojdbc6.jar
RubyGems version 5.0.4
The above file is in the Oracle installation directory. Ask your Oracle
administrator for the file that is specific to your installation.
Alternatively, download the driver file from the Oracle Database 11g
JDBC Drivers page at—
http://www.oracle.com/technetwork/database/
enterprise-edition/jdbc-112010-090769.html
—-and add it to the TIBCO_HOME/tools/jruby/lib directory.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Requirements 3
|
•
A supported Web browser for access of the tibbr interface. The supported
browsers are as follows:
— Mozilla Firefox, version 3.6 or later
— Microsoft Internet Explorer, versions 6, 7, and 8
— Google Chrome, version 11 or later
In addition, if you plan to connect tibbr to your company’s Lightweight Directory
Access Protocol (LDAP) server, use Microsoft Active Directory for LDAP.
Libraries
Following are the Linux libraries required by tibbr:
libexslt
libgnomevfs
libxslt
libgsf-1
libavahi-glib
librsvg-2
libcroco-0
In addition, the imagemagick library for image uploads requires the following
libraries:
*libtiff*
*libICE*
*libdl*
*libfreetype*
*libX11*
*libglib-2.0*
*libjpeg*
*libbz2*
*libxml2*
*libpng*
*librsvg-2*
*libz*
*libfontconfig*
*libgdk_pixbuf-2.0*
*libm*
*libXext*
*libm*
*libgomp*
*libXt*
*libgobject-.0*
*libpthread*
*libSM*
*libgmodule-2.0*
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
4
| Chapter 1
Installation of tibbr
Supported Platforms
tibbr supports both the 32-bit and 64-bit versions of Red Hat Enterprise Linux
Server 5.4 (Tikanga).
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Installation Procedure 5
|
Installation Procedure
To install tibbr:
Task A Extract the tibbr archive file.
1. Open the media or download the product package for your hardware, either
the 32-bit or 64-bit version.
2. Extract the tibbr product archive file to a temporary directory.
3. Run the TIBCO Universal Installer. Type on the command line:
./TIBCOUniversalInstaller-lnx-x86.bin
Alternatively, to run the installer in text-only mode, type:
./TIBCOUniversalInstaller-lnx-x86.bin –console
4. Follow the prompts to complete the installation.
Task B Download and install external libraries.
The following steps require an active Internet connection for connecting to
download.tibco.com:
1. Go to the scripts directory. Type:
cd
TIBBR_HOME/scripts
2. Set up the tibbr environment. Type:
. env.sh
3. Set up additional tibbr paths. Type:
./configure.sh
Task C Install the database driver.
Install the driver for your database type:
•
Microsoft SQL Server — Download and install the driver of Microsoft SQL
Server. Type:
jruby -S gem install jdbc-jtds -v=1.2.5
•
MySQL databases — Download and install the MySQL JDBC driver. Type:
jruby -S gem install jdbc-mysql
This command connects to http://rubygems.org/gems/jdbc-mysql and
installs the supported MySQL JDBC driver.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
6
| Chapter 1
Installation of tibbr
•
Oracle databases — Copy the supported Oracle driver to these two locations:
— tibbr_home/tools/jruby/lib
— tibbr_home/tools/tomcat/server/lib
where tibbr_home is the location in which you have installed tibbr.
See Table 3 on page 2 for the supported database drivers.
Task D Customize the configuration settings.
Now customize the tibbr configuration files to specify your database, email
server, and other implementation-specific settings. Optionally, you can also
connect tibbr to your company’s LDAP server.
You can customize the configuration settings in either of two ways, as follows:
•
By editing the YAML configuration files:
a. Go to the TIBBR_HOME/tibbr-config directory.
b. Edit the configuration files to specify your implementation’s settings. For
details, see Chapter 3, Configuration, Localization, and Performance
Tuning. In particular:
Database Configuration on page 37 — Configure the database in the
production segment of the database.yml file.
Administrator Configuration. on page 38 — Configure the initial users in
the seed.yml file. The users specified in this file can access the tibbr Web
interface without any additional steps. See the sample seed file in
tibbr-config/seed.yml on how to seed default subjects and messages.
Administrator Configuration. on page 38 — Configure the primary tibbr
administrator in the default section of the app_config.yml file.
Email Server Configuration on page 39 — Configure the email server in the
email segment of the app_config.yml file.
LDAP Configuration on page 42 — Optionally, configure tibbr to retrieve
user login information from an LDAP server. Configure the LDAP server in
the authentication section of the app_config.yml file.
When editing the configuration files, do not add or delete spaces from the lines.
That’s because tibbr is configured with the YAML markup language, whose
segment hierarchy is determined by indentations. Adding or deleting a space
alters the indentation and invalidates the YAML configuration, causing the tibbr
installation to fail.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Installation Procedure 7
|
•
By setting the parameters from the Web-based application configuration
tool. Install the tool as follows:
a. Execute the script tibbr_home/scripts/start_configure.sh.
b. Access the screens at http://IP address or host name:7777, for example,
http://acme.tibbr.com:7777 or http://10.101.102.103:7777.
For advanced settings, see Chapter 3, Configuration, Localization, and
Performance Tuning.
Task E Initialize the database.
To create tibbr tables in your database:
1. Go to TIBBR_HOME/scripts/.
2. Run the init-database.sh script. Type:
./init_database.sh
Task F Run the startup script.
Launch the tibbr services by running the tibbr startup script:
1. Go to TIBBR_HOME/scripts/.
2. Run the start-tibbr.sh script. Type:
./start_tibbr.sh
The tibbr services take approximately five minutes to start.
Task G Verify the startup.
To verify that tibbr has launched its services:
1. Go to TIBBR_HOME/scripts.
2. Run the status.sh script. Type:
./status.sh
Task H Access the tibbr Web interface.
Once tibbr has started its services, access tibbr through the Web interface:
1. Open a browser window and navigate to your tibbr server at
http://tibbr-host, where tibbr-host is the name or IP address of the machine in
which tibbr is installed.
2. Log in to tibbr as the initial user you created in Task D.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
8
| Chapter 1
Installation of tibbr
For this first login, the user name you specified serves as both the login name
and password.
To update the administrative configurations once tibbr has started, run the
utilities described in Chapter 6, Administration Utilities.
To stop the tibbr services, see the next section, Stopping and Restart of tibbr
Services.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Stopping and Restart of tibbr Services 9
|
Stopping and Restart of tibbr Services
To stop the tibbr services, go to the TIBBR_HOME/scripts directory and type this
command:
./stop_tibbr.sh
To restart the services, follow the steps in Task F, Run the startup script.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
10
| Chapter 1
Installation of tibbr
Setup of Apache HTTP Server as a Proxy Server
To configure tibbr to use a proxy server:
1. In the machine in which you have installed tibbr, open the /scripts/env.sh
file and update the http_proxy setting, as follows:
export http_proxy="-Dhttp.proxyHost=your-proxy-server-hostname-or-IPaddress -Dhttp.proxyPort=port number"
For example:
export http_proxy="-Dhttp.proxyHost=server1
-Dhttp.proxyPort=1234"
2. Start tibbr by running the script /scripts/start_tibbr.sh.
Finally, disable the Domain Name System (DNS) to ensure that the machine that
hosts tibbr goes through the proxy and does not have direct access to any internal
network in which the machine is located. Do the following:
1. Edit the /etc/resolv.conf file on the machine that hosts tibbr.
2. Comment out the entry that corresponds to the search keyword at the start of
the file, for example:
# search na.tibco.com
Feel free to use other ways to ensure that the machine that hosts tibbr does not
look up the local network to access the Internet.
Note: On the machine that hosts Apache, you can monitor tibbr activities by
tailing the log /apache2/logs/access.log. You can monitor tibbr logs in the
/tibbr/2.x/logs directory.
For example, to set up the Apache HTTP server as a proxy server for tibbr, follow
the steps below.
1. Install the Apache HTTP server. Ensure that you install the modules
mod_proxy and mod_proxy_http, which are required for the proxy
configuration.
Alternatively, for an existing Apache installation, go to the location of the
source, that is, where you extracted httpd, for example,
/root/httpd-2.2.17/, and run the following command:
./configure --enable-mods-shared="proxy proxy_http proxy_ftp
proxy_connect" --prefix=/etc/apache2
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Setup of Apache HTTP Server as a Proxy Server 11
|
where prefix is the location in which the Apache HTTP server is installed.
Henceforth, we will assume that /etc/apache2 is the location for the Apache
installation. You can replace it with your location, as appropriate.
2. Run the following commands to install and enable the modules that are
required for proxy setup:
make
make install
For our purpose, we will use the mod_proxy and mod_proxy_http modules
here. Once you have run the above commands, verify that mod_proxy.so and
other related files have been installed in the /apache2/modules directory.
3. Edit the /apache2/conf/httpd.conf file for proxy setup, as follows:
a. Add the following lines after the other LoadModule directives:
LoadModule proxy_module /etc/apache2/modules/mod_proxy.so
LoadModule proxy_http_module
/etc/apache2/modules/mod_proxy_http.so
ProxyRequests On
ProxyVia On
b. Add the following lines after the IfModule directives:
<IfModule mod_proxy.c>
<Proxy *>
Order Deny,Allow
Deny from all
Allow from 10.107.171.0/255.255.255.0
</Proxy>
</IfModule>
The last line within the block (Allow from …) specifies the IP addresses of the
clients that are allowed to use the proxy. The above example specifies all the
clients on the 10.107.171.* network. Replace that IP address with a list or range
of specific IP addresses that pertain to your environment.
4. Start your Apache HTTP server.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
12
| Chapter 1
Installation of tibbr
Uninstallation Procedure
To uninstall tibbr.
1. Stop all tibbr processes.
2. Go to TIBCO_HOME/_uninstall and run the uninstaller, that is, the
universal_uninstall executable.
The Welcome screen appears.
3. Click Next.
4. Do either of the following:
— To uninstall only tibbr, click Custom Uninstall. In the next screen, select the
products you would like to uninstall. The choices are those TIBCO
products that you installed before with the Universal Installer. Deselect any
products that you do not want to uninstall and click Next.
— To uninstall all the TIBCO products that were installed with the Universal
Installer, select Typical Uninstall and click Next.
5. Click Uninstall in the Pre-Uninstall Summary screen that appears.
6. Click Finish to close the uninstaller window.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Backup and Restore 13
|
Backup and Restore
To back-up your tibbr database:
1. Stop all the tibbr processes. For the related command, see Stopping and
Restart of tibbr Services on page 9.
2. Make a backup copy of the database.
3. Back-up your tibbr installation by creating a .tar or .zip file, for example,
zip the directory /opt/tibco/tibbr/2.3.0.
To restore the database:
1. Restore the database from the backup copy.
2. Restore your tibbr installation by untarring or unzipping the .tar or .zip file.
3. Start the tibbr processes. For the related command, see Stopping and Restart
of tibbr Services on page 9.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
14
| Chapter 1
Installation of tibbr
Upgrade and Restore
To upgrade to a new tibbr release:
.
1. Stop all the tibbr processes in the current tibbr installation, for example,
/opt/tibco/tibbr/2.3.0. For the related command, see Stopping and
Restart of tibbr Services on page 9.
2. Make a backup copy of the database.
3. Follow the steps in Installation Procedure on page 5 to install the new version
of tibbr in a new path, for example, /opt/tibco/tibbr/3.0.0.
4. Manually copy the assets and assets_protected configuration directories
to the new installation. Table 4 shows an example.
Table 4 Example of Copying Configuration Directories in a tibbr Upgrade
Copy From
Copy To
TIBCO_HOME/tibbr/2.3.0/tibbr-config/
TIBCO_HOME/tibbr/3.0.0/tibbr-config/
assets
assets
TIBCO_HOME/tibbr/2.3.0/tibbr-config/
TIBCO_HOME/tibbr/3.0.0/tibbr-config/
assets_protected
assets_protected
5. Copy any customizations, such as style sheets, translation files, and such to
the new installation path.
To restore the earlier version:
1. Stop all the tibbr processes in the latest installation, for example,
/opt/tibco/tibbr/3.0.0.
2. Restore the database from the backup copy.
3. Start the tibbr processes in the older installation, for example,
/opt/tibco/tibbr/2.3.0.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
| 15
Chapter 2
Architecture and Deployment
This chapter describes the architecture of tibbr; discusses the security aspects,
including authentication and authorization; and explains the procedures for
configuring and testing deployments.
Topics
•
Architectural Overview, page 16
•
Simple Enterprise Deployment, page 21
•
Advanced Deployments, page 23
•
Configuration of Advanced Deployments, page 26
•
Test of Deployment, page 32
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
16
| Chapter 2
Architecture and Deployment
Architectural Overview
Figure 1 illustrates the architecture of tibbr and its components.
Figure 1 High-Level Architecture and Associated Components
tibbr Server
The tibbr server manages all the core tibbr services, including users, messages,
and filtering. Within the server is an aggregation engine that offers such services
as message delivery for subjects, management of people and subjects,
authentication, authorization, auditing, and overall security.
The tibbr server provides a clear and secure Representational State Transfer
(REST) interface over HTTP for clients, event streams, and utilities. All content
data, including messages, subjects, and user information, is stored in the database
by means of Java Database Connectivity (JDBC).
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Architectural Overview 17
|
Web Client
The tibbr Web client delivers a rich Web interface, providing access to tibbr
services through HTML and Asynchronous JavaScript and XML (AJAX)
technologies. Web browsers can access the interface over either HTTP or the more
secure HTTPS protocol.
In addition, the tibbr Web client accords you the flexibility of deploying it in close
proximity to end users in global scenarios. That is, you can deploy the Web client
on the same machine as the server or on a different machine.
Mobile Clients
Mobile clients are available for the iPhone, iPad, Android, and BlackBerry
devices.
tibbr mobile clients are native mobile applications that are available for download
from the respective app stores. The applications provide direct access to tibbr
services from the devices. You can use mobile clients to access messages, subjects,
and people, and create or reply to posts. Depending on how you deploy the tibbr
server, mobile clients can communicate with the server over HTTP or the more
secure HTTPS protocol.
Command-Line Interface
The command-line interface (CLI) enables utilities to access the tibbr server
through the REST application programming interface (API), just as the Web and
mobile clients do. You can create utilities that manage tibbr deployments on the
CLI.
Cache Server
By using a cache server to cache the user’s wall information for a specific interval,
tibbr can respond quickly to client requests and reduce the database load.
Search Server
A search server enables users to search tibbr for information, such as the user’s
messages, subjects, or people.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
18
| Chapter 2
Architecture and Deployment
Job Runner
The job runner, a daemon process that runs in the background, performs offline
and scheduled tasks for the tibbr server. Examples of the offline tasks are
distribution of messages to specific user inboxes and dispatch of email or SMS
notifications configured by the user.
Event-Stream Runner
With event streams, you can configure and receive events into tibbr from
enterprise applications that you run day to day. Each event stream is a tibbr
plug-in that integrates with a specific enterprise application. The event-stream
runner is a daemon process that runs the event streams configured by you on a
scheduled basis.
Event streams are of various types, including the following:
•
RSS tibbr provides out-of-box support for listening on RSS feeds and makes
them available through tibbr subjects. You can configure RSS feeds from sites
such as TIBCOmmunity and CNN to publish messages to tibbr subjects. tibbr
ensures that the messages are published only once at a time.
•
Email The email event stream offers integration with email clients by
delivering tibbr messages to the subjects and people as addressed. That way,
you can receive, post, or reply to tibbr messages from any email client, such as
Outlook, iPhone, or BlackBerry. In tibbr, you can send and receive email in
secure mode as facilitated by the email server.
•
Salesforce The Salesforce event stream connects to a Salesforce system and
retrieves records according to the preferences that you specify. Records are
published as private tibbr subjects.
•
SAP The SAP event stream reads events from SAP and publishes them as
messages to a tibbr subject.
•
Oracle Expenses The Oracle Expenses event stream enables you to browse the
details of your expense reports and, if you are a people manager, approve
your staff’s expense reports.
•
Oracle Order Management The Oracle Order Management event stream tracks
the order fulfillment process and publishes the status as messages to a tibbr
subject.
•
Voice Memo The Voice Memo (also known as tibVoice) stream enables the
posting of voice messages in the form of audio files on tibbr.
The Salesforce, SAP, Oracle Expenses, Orale Order Management, and voice memo
features are not available in tibbr Community and tibbr Community Service.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Architectural Overview 19
|
Chat Server
The chat server, which enables you to chat directly from the tibbr environment,
does the following:
•
Distribute chat messages from one user to another.
•
Send presence notifications, which show who is online and offline.
Audio Conferences, Video Conferences, and Webinars
You can configure the tibCast capability so that users can invite people in your
organization to join an audio conference, video conference, or Webinar; start the
event; and replay the recording later.
SMS Gateway
You can configure notifications through Short Message Service (SMS) for mobile
devices. Currently, tibbr supports two SMS gateway providers: Clickatell and
Twilio.
Enterprise Data-Source Integration
You can integrate information from structured or unstructured data sources and
corporate Web services with tibbr through TIBCO BusinessWorks and the tibbr
API.
Enterprise Resources
tibbr uses the following enterprise resources:
•
Database tibbr stores all information, including that on users, subjects, and
messages, in a standard relational database. Also, tibbr creates the necessary
database schema inside the database that is configured as part of the
installation procedure.
•
File system and S3 tibbr stores profile and subject images as well as the
attachments that are posted with messages in a standard network file system.
All tibbr instances must be able to access and store data in that file system. If
you deploy tibbr on multiple machines, a shared network file system, such as
NFS, is required for load balancing or high availability.
Alternatively, tibbr can use S3 storage when running on a cloud.
•
Email server tibbr sends email messages for both account management and
notifications through a Simple Mail Transfer Protocol (SMTP) server. In
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
20
| Chapter 2
Architecture and Deployment
addition, tibbr supports server connections in both Secure Sockets Layer (SSL)
and non-SSL modes.
The tibbr email gateway connects to the inbox on a POP3 email server to read
the messages sent as replies and distributes them to the respective subjects.
•
Authentication and Authorization For enterprise deployments, tibbr supports
three types of user authentication:
— Default tibbr can authenticate through the user profiles in the tibbr
database.
— Lightweight Directory Access Protocol (LDAP) tibbr can connect to an
LDAP server to authenticate users and retrieve user profiles. A separate
utility is also available, which reads the user information from LDAP and
populates the tibbr database. tibbr supports LDAP server connections in
both SSL and non-SSL modes.
For details on the configuration parameters for the LDAP server, see LDAP
Configuration on page 42.
— Security Assertion Markup Language (SAML) tibbr can connect to a single
sign-on server that supports authentication through SAML. For details on
the configuration parameters for the SAML server, see SAML
Configuration on page 46.
Audit Log
tibbr keeps track of the following data that pertains to major operations, such as
creation, update, and deletion of subjects, by storing an audit log in the database:
•
The object’s present and previous states.
•
The operation type. By default, tibbr logs all creations, deletions, and other
operations for major entities: subjects, messages, user accounts, roles,
privileges.
•
The user name (login) of the related user or, if the task is performed by
someone who impersonated the user, the user name of the impersonator.
•
Comments on the operation if the parameter for inputting comments has been
configured by the administrator.
•
The date and time of the operation.
To run a log report, execute the following command:
rake tibbr:generate_audit_log file=path/filename
where path is the location in which the audit log resides and filename is the name
of the log.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Simple Enterprise Deployment 21
|
Simple Enterprise Deployment
tibbr's componentized architecture results in flexible deployment with a choice of
delivery options. You can deploy tibbr to a public cloud or on premises.
The option of simple enterprise deployment enables deployment of tibbr within
the premises of the enterprise and opens access to enterprise assets, such as the
corporate LDAP directory and enterprise resource planning (ERP) systems.
This section explains the interactions between the system components and the
protocols for communications.
tibbr Server
The core component of the tibbr platform is the tibbr server, which exposes the
REST API over HTTP, which is in turn used by the clients: the Web client, mobile
clients, and other programs. Internally, the tibbr server uses the services offered
by various other components, as follows:
•
Database tibbr connects to the database with JDBC to store and retrieve tibbr
data.
•
File system tibbr accesses the file system through the simple file system API
to store user profiles and subject images, as well as the attachments associated
with message posts.
•
LDAP server Optionally, tibbr can connect to LDAP directory servers, such as
Active Directory, with the LDAP protocol.
•
Search server tibbr connects to the search server over HTTP to perform search
operations.
•
•
Cache server tibbr connects to the cache server with a standard Transmission
Control Protocol (TCP) connection to store user profile and wall information.
Chat server tibbr connects to the chat server to enable exchanges of instant
messages.
•
tibCast server tibbr connects to the tibCast server for audio conferences, video
conferences, or Webinars.
Web Client
Over HTTP, the tibbr Web client delivers the Web interface to the Web browsers
and uses the services offered by the tibbr server. Through standard TCP, the tibbr
Web client connects to the cache servers in which it stores user profile and wall
information.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
22
| Chapter 2
Architecture and Deployment
Job Runner
The job runner runs as its own process and executes the offline jobs for the tibbr
server. The jobs performed by the job runner include delivering messages to user
inboxes, populating the indexes on the search server, and sending users email
notifications on, for example, new posts for which you have configured scheduled
delivery.
The job runner connects to the database over JDBC and to email servers over
SMTP.
Cache Server
The cache server stores user message information in memory for faster content
delivery. By default, this server runs on port 11211.
Search Server
The search server offers search capabilities. The tibbr server populates the indexes
and performs search operations. The search server offers the services over HTTP
and runs on port 8983 by default.
Event-Stream Runner
On a scheduled basis, the event-stream runner runs the event streams that you
configure and interacts with the tibbr server through the latter’s API.
Apache Web Server
In single-node deployments, you can adopt Apache Web Server, an optional
component, as a reverse proxy, port mapper, or HTTPS gateway. In multinode
deployments, you can use Apache Web server for load balancing or as an HTTPS
gateway.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Advanced Deployments 23
|
Advanced Deployments
The diagrams in this section illustrate the architecture of several advanced tibbr
deployments.
Multinode Deployment
Figure 2 shows a multinode tibbr deployment. Multiple Tomcat nodes share a
single instance of utility components, such as search, cache server, job runner, and
event-stream runners.
Figure 2 Multinode tibbr Deployment
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
24
| Chapter 2
Architecture and Deployment
High-Availability Deployment
Figure 3 illustrates a high-availability deployment of tibbr.
Figure 3 High-Availability Deployment
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Advanced Deployments 25
|
High-Availability Deployment Exposed to Internet
Figure 4 illustrates a high-availability deployment of tibbr that is exposed to the
Internet.
Figure 4 High-Availability Deployment Exposed to the Internet
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
26
| Chapter 2
Architecture and Deployment
Configuration of Advanced Deployments
This section shows you how to set up tibbr for load balance and high availability
on multiple server instances. You must configure the database, LDAP, the shared
network file system, and the search and multiple cache servers. In addition, set up
Apache Web Server as a load balancer.
For a description of the tibbr components, see Architectural Overview on page 16.
Requirements
This configuration procedure assumes that you have two instances of each of the
following components running on different machines:
•
Tomcat server Each Tomcat server instance must run on port 8080 (default),
including the tibbr server and Web client components. Both Tomcat server
instances are load-balanced through Apache Web Server.
•
Search server The search server instances must run on port 8983.
•
Job runner The job runner process must run on each machine.
•
Cache server The cache server instances must run on port 11211.
•
Event-stream runner The event-stream runner process must run on each
machine.
In addition, an instance of Apache Web Server or another load balancer must be
running to load-balance the Tomcat server instances.
Installation
On each machine, install tibbr with the tibbr installer. Although all nodes function
in the same way, mark one of them as a primary node for configuration changes
and then replicate its configuration on the other nodes.
On the primary node, configure tibbr by following the steps in Installation
Procedure on page 5.
The following sections describe additional configurations for the highavailability and load-balanced environment.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration of Advanced Deployments 27
|
Configuration of the Database
Different databases offer different options, such as database cluster or
master-slave replication, for making the database highly available. Generally,
database vendors provide the JDBC drivers that abstract the database cluster as if
connecting to a single node in the form of a JDBC connection string.
If you are using any of the high-availability options for your database, refer to
your database vendor’s documentation for the connection string for use in the
database.yml file.
Configuration of LDAP
Optionally, tibbr connects to corporate LDAP to perform authentication and
retrieve user-profile information that is stored in the LDAP server. You can
connect to multiple LDAP servers as a safeguard in case one of those servers is
down.
To configure LDAP servers, specify the LDAP server information as follows:
•
For a single LDAP server, specify the following information in the
tibbr-config/app_config.yml file:
host:
port:
•
host-name (for example, ldap.example.com)
port (for example, 389)
For multiple LDAP servers, specify the same information like this:
host: host-name1,host-name2:port (for example,
ldap1.example.com,ldap2.example.com:389)
port: port (for example, 389)
freeze_interval: 2 #in minutes
You can specify multiple server names and ports as part of the host entry. If
you do not specify port along with host, tibbr adopts the port value as part of
the port parameter.
tibbr connects to the LDAP servers in the same order as specified in the
configuration. If the connection fails due to a socket error, tibbr connects to the
next server.
If tibbr fails to connect to a server, then the server is frozen for the configured
interval. By default, that interval is 10 minutes, which you can change by
updating the freeze_interval setting.
tibbr ignores the frozen servers while making a new connection and revisits them
after trying all the known live servers.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
28
| Chapter 2
Architecture and Deployment
Configuration of Shared Network File System
Recall that tibbr stores user and subject profile images and attachments uploaded
with messages in a file system. If multiple instances of tibbr servers are running,
the locations of the file systems must be available to all the instances of the tibbr
nodes.
By default, tibbr stores files and attachments in two directories, as follows:
Directory
Description
TIBBR_HOME/tibbr-config/assets
Stores user and subject images.
TIBBR_HOME/tibbr-config/asset-protected
Stores the attachments uploaded with messages.
Link or mount those directories to the same physical location across all machines
with a network share.
Here is an example on how to mount a physical drive on one machine, which then
acts as the assets directory for two instances. In this example, the assets
directory is mounted on machine2 and machine1 points to it.
On machine2:
1. Open the exports file in the etc directory in an editor, for example:
vi etc/exports
2. Add an entry according to this syntax:
location-of-assets-directory-on-machine2 machine1-ip
3. Execute this command:
/sbin/service nfs reload
On machine1:
1. Clear the assets directory that will be mounted from machine2.
2. Mount:
machine2 ip:location-of-assets-directory-on-machine2 location-of-assets-directory-on-machine1
Configuration of Search Servers
For most tibbr deployments, a single instance of search server is adequate for
handling the search load. However, if you need a highly available, fault-tolerant
configuration for the search server, use the approach shown in Figure 5.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration of Advanced Deployments 29
|
Figure 5 Fault-Tolerant Search Server
Here, the tibbr server sends all index writes to the master, which replicates all the
data to the slaves. All read requests are also served by the slaves. The index reads
are highly available due to multiple slaves.
If the master goes down, all the write requests are queued in the tibbr server,
which retries them until successful completion.
For information on how to configure master, slave, and high-availability proxy
instances, go to http://wiki.apache.org/solr/SolrReplication.
Revise the tibbr-config/sunspot.yml file as follows:
production:
solr:
hostname: localhost
port: 8983
path: <%= APP_CONFIG_DIR%>/solr/data/development
log_level: WARNING
solr_home: <%= APP_CONFIG_DIR%>/solr
master_solr:
hostname: localhost
port: 8982
path: <%= APP_CONFIG_DIR%>/solr/data/development
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
30
| Chapter 2
Architecture and Deployment
Configuration of Multiple Cache Servers
To yield high performance, tibbr stores some user information temporarily in
memory in cache servers. Configure them as follows:
•
To configure a single instance, edit the tibbr-config/app_config.yml file as
follows:
cache_store:
type: mem_cache_store
host: host1:11211
namespace: tibbr
timeout: 60
•
To configure multiple instances, edit the tibbr-config/app_config.yml file
as follows:
cache_store:
type: mem_cache_store
host: host1:11211,host2:11211
namespace: tibbr
timeout: 60
The order is important here. On the second node, you might want to reverse the
order to evenly distribute the load across the two servers.
Afterwards, tibbr uses the next available cache server to store and retrieve
cache informations.
Configuration of Apache Server as Load Balancer
To configure Apache Server as a load balancer, first ensure that the mod_proxy
and mod_proxy_balancer modules (see the descriptions below) exist on Apache
Server. Note that both modules are in the Apache Server package in the tibbr
installation.
•
— This module creates a proxy or gateway for Apache, that is, a
proxying capability for Apache JServe Protocol version 1.3 (AJP13), FTP,
CONNECT (for Secure Socket Layer, commonly called SSL), HTTP/0.9,
HTTP/1.0, and HTTP/1.1.
mod_proxy
In addition to mod_proxy, Apache’s proxy features are divided into several
modules: mod_proxy_http, mod_proxy_ftp, mod_proxy_ajp,
mod_proxy_balancer, and mod_proxy_connect. To use one or more of the
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration of Advanced Deployments 31
|
proxy features, load mod_proxy and the appropriate modules into the
server—either statically at compile-time or dynamically with the LoadModule
directive.
For more details, see
http://httpd.apache.org/docs/2.1/mod/mod_proxy.html.
•
— This module, which requires the service of
supports load balancing for the HTTP, FTP, and AJP13 protocols.
For details, see
http://httpd.apache.org/docs/2.2/mod/mod_proxy_balancer.html.
mod_proxy_balancer
mod_proxy,
The code snippet below is a sample configuration. For SSL-enabled instances, add
a similar configuration in the
tibbr_home/tools/apache2/conf/extra/httpd-ssl.conf and
tibbr_home/tools/apache2/conf/httpd.conf files.
For non-SSL-enabled instances, add the configuration in the
tibbr_home/tools/apache2/conf/httpd.conf file only.
This sample assumes that tibbr1 and tibbr2 are the tibbr servers and that
tibbr3 is the chat server.
<Proxy balancer://mainsite>
BalancerMember ajp://<tibbr1>:8009
BalancerMember ajp://<tibbr2>:8009
</Proxy>
<Proxy balancer://tibbrcore>
BalancerMember ajp://<tibbr1>:9009
BalancerMember ajp://<tibbr2>:9009
</Proxy>
<Proxy balancer://chat>
BalancerMember http://<tibbr3>:5280
</Proxy>
ProxyPass /http-bind balancer://chat/http-bind
ProxyPass /a balancer://tibbrcore/a
stickysession=JSESSIONID|jsessionid
ProxyPass / balancer://mainsite/
stickysession=JSESSIONID|jsessionid
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
32
| Chapter 2
Architecture and Deployment
Test of Deployment
To test the configuration settings:
1. Shut down both the Apache HTTP Server and tibbr nodes on each machine.
2. Start the tibbr nodes.
3. Start the Apache HTTP Server.
4. Verify that your tibbr nodes have started properly by accessing the following:
—
http://tibbr-node1:port
—
http://tibbr-node2:port
5. Go to http://apache-host:port and verify that you can also access the tibbr
node through Apache.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
| 33
Chapter 3
Configuration, Localization, and
Performance Tuning
This chapter describes how to configure tibbr, localize its Web interface, and
fine-tune the performance.
Topics
•
Configuration Files and Parameters, page 34
•
Connection to LDAP Server, page 74
•
Configuration and Disabling of SSL, page 75
•
Display of User Hierarchy, page 76
•
Configuration of Life Streams, page 77
•
Localization of tibbr, page 79
•
Performance Tuning, page 82
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
34
| Chapter 3
Configuration, Localization, and Performance Tuning
Configuration Files and Parameters
Location
Format
All tibbr configuration files are located in the TIBBR_HOME/tibbr-config
directory.
tibbr is configured in YAML format. In YAML, segment hierarchy is determined
by indentations. Adding or deleting spaces alters the indentations and invalidates
the YAML configuration, causing tibbr startup to fail.
When editing the configuration files, do not add or delete spaces from the lines.
Mechanics of Configuration
You configure tibbr parameters in either of these two ways:
•
By specifying the parameter settings in the Web-based application
configuration tool.
To start the tool, see the second bullet in Customize the configuration settings.
on page 6.
If the parameter you would like to configure is missing in the tool, follow the
procedure in the next bullet.
•
By editing the app_config.yml file.
In a new installation, the app_config.yml file is empty. All default
configuration settings are in the default_app_config.yml file. To configure
parameters:
a. Copy the appropriate section from the default section in the
default_app_config.yml file to the production section in the
app_config.yml file.
b. Edit the parameters, as appropriate. For details, see the sections that
follow, starting with Administrator Configuration. on page 38.
If you configure the settings through the tool, tibbr adds them to the
appropriate sections in the app_config.yml file. For example, if the
default_app_config.yml file has an example section in the following
hierarchy—
example:
a1:
b1:
c1: “Example”
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 35
|
c2: “Example”
b2: “Example”
b3: “Example”
a2:“Example”
—to edit the values of a2 and c2, add the following section to the
app_config.yml file:
example:
a1:
b1:
c2:“new Example”
a2:“new Example”
tibbr services read configuration files only once, that is, when the services start,
and ignore subsequent changes to the configuration files. If you revise a
configuration file, you must shut down and restart all tibbr services by following
the procedure in Stopping and Restart of tibbr Services on page 9.
You can also change the tibbr configuration with administrative requests through
the utilities described in Chapter 6.
Related Files
You configure tibbr by editing the files described in Table 4.
Table 5 Configuration Files
Configuration File
Description
Page
database.yml
Database configuration
37
seed.yml
Population of users and user-related data
38
app_config.yml
Administrator configuration
38
Email server configuration
39
Authentication configuration
LDAP configuration
SAML configuration
41
Search configuration
49
Site configuration
50
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
36
| Chapter 3
Configuration, Localization, and Performance Tuning
Table 5 Configuration Files (Cont’d)
Configuration File
Description
Page
Web UI configuration
50
Chat configuration
52
User configuration
53
tibCast configuration
54
SMS gateway configuration
55
SharePoint configuration
56
Event-Stream Configuration
LinkedIn
Facebook
Twitter
Oracle Expenses
Oracle Order Management configuration
59
Google analytics configuration
62
Validation settings
63
Channel configuration
68
Localization settings
69
BlackBerry configuration
69
Android configuration
70
link_patterns.yml
Configuration of SharePoint link
70
user_meta_details.yml
Custom fields configuration for the Edit My Profile form
71
email.properties
Configuration of banned email subjects
72
sunsport.yml
Configuration of Solr search
49
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 37
|
In the tables in the subsections that follow, the first column, Parameter, lists the
parameters in the configuration file. The second column, Screen Parameter, lists
those in the application configuration tool, with the screen name preceding the
parameter name with a > symbol in between, for example, Database > Type.
Database Configuration
You configure the database in the production segment of the database.yml file.
Table 6 describes the parameters.
Table 6 Database Configuration Parameters
Parameter
Screen Parameter
Description
database
Database > Schema Name
The name of your database, which must not be empty.
username
Database > User Name
The user name with which tibbr connects to the
database. This user must have read-write permissions
for the database.
password
Database > Password
The password that corresponds to the specified user
name.
host
Database > Host
The IP address or name of the machine in which the
database is running. For example, 192.168.0.101 or
localhost.
adapter
Database > Type
The type of database you plan to use.
port
Database > Port
The TCP port number of the database server.
pool
Database > Pool Size
The maximum number of database connections to use.
encoding
Database > Encoding
The character encoding scheme of the database.
production
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
38
| Chapter 3
Configuration, Localization, and Performance Tuning
Administrator Configuration.
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
Configure the primary tibbr administrator in the default segment of the
app_config.yml file.
Regardless of the authentication scheme of your tibbr installation, tibbr supports
LDAP or database authentication for the primary tibbr administrator.
You configure the primary tibbr administrator in either of the following two
ways:
Through database authentication of the tibbr administrator
Do either of the following:
•
Apply the default, that is, adopt tibbradmin as the user name. To do so,
change the tibbradmin password by setting the admin_password parameter
(see Table 7).
•
Change the administrator credentials by configuring the admin_user
parameter as described in Table 7. Afterwards, run the
tibbr_home/scripts/tibbr_util.sh script to create the administrator
account in the database, as follows:
./tibbr_util.sh create_system_user
For details, see Adding Administrator to the System on page 120.
Through LDAP authentication
Create an administrator account in corporate LDAP, after which tibbr will import
the related data as part of the LDAP script. Be sure to set the admin_user
parameter (see Table 7) and run the tibbr_util.sh script to assign the
administrator role to the user, as follows:
./tibbr_util.sh add_user_to_role role_name=admin
user_login=administrator_user_name_in_LDAP
For details, see Adding a User to a Role on page 119.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 39
|
Table 7 describes the parameters for configuring the tibbr administrator.
Table 7 Administrator Configuration Parameters
Parameter
server
Screen Parameter
Description
(a subset of the default segment)
admin_user
Server >
Administrator’s
User Name
The name of the tibbr administrator used by the event
stream runner and chat server to connect to the tibbr
server. admin_user must have administrator privileges.
admin_password
Server > Password
The password associated with admin_user.
Email Server Configuration
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
Configure the email server in the email segment of the app_config.yml file. See
Table 8 for the parameters.
Table 8 Email Server Configuration Parameters
Parameter
Screen Parameter
Description
email
Outbound Email Settings
admin
Email > Administrator’s
Email Address
The tibbr administrator’s email address, for
example, [email protected], to
which tibbr sends notifications, such as
activation notices, to users by email.
address
Email > Email Server
Address
The host name or IP address in which your
email server is running.
port
Email > Port
The number of the SMTP port to which the
email server is connected.
authentication
Email > Authentication Type
The method of authentication through
which the email server identifies a tibbr
user. Specify one of these settings as
required by your SMTP server: plain,
login, or cram-md5.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
40
| Chapter 3
Configuration, Localization, and Performance Tuning
Table 8 Email Server Configuration Parameters (Cont’d)
Parameter
Screen Parameter
Description
user_name
Email > User Name
The mailbox that tibbr uses in conjunction
with the password for authentication when
connecting to the email server.
password
Email > Password
The password tibbr uses in conjunction with
the user name for authentication when
connecting to the email server.
domain
Email > Domain
The domain name of the email server, for
example, tibbr.com.
debug
None
The parameter that, if set to true, instructs
tibbr to print status messages to the node
log file.
enable_starttls_
Email > Enable Starttls Auto
The parameter that, if set to true, instructs
tibbr to use the STARTTLS protocol where
available. Setting this parameter to false
causes tibbr to never use STARTTLS.
auto
emailgateway
Inbound Email Settings
(a subset of the
email segment)
enable
Email > Enable
The parameter that, if set to true, which is
the default, enables emailgateway.
Note: For email replies to work in tibbr, set
this parameter to true.
enable_ssl
Email > Enable SSL
The parameter that, if set to true, enables
SSL on the email gateway between tibbr and
the POP3 server. Setting this parameter to
false disables SSL.
pop_address
Email > POP Address
The address of the POP3 server to which
tibbr will be listening.
pop_port
Email > POP Port
The POP3 server’s port number.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 41
|
Table 8 Email Server Configuration Parameters (Cont’d)
Parameter
Screen Parameter
Description
user
Email > User Name
The name of the POP3 Inbox account to
which tibbr will be listening.
password
Email > Password
The password for the email account.
Authentication Configuration
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
tibbr can authenticate users through the default (user profiles in the tibbr
database), LDAP, or SAML. With the SAML authentication mechanism, tibbr
creates user accounts at the time of their first login.
If your company uses Active Directory and the SAML login names matches the
Active Directory login names, you can import the user profiles, as follows:
1. Set up LDAP authentication to import users from LDAP to tibbr. For details,
see Connection to LDAP Server on page 74.
2. Change the authentication type (see Table 9 below) to saml.
You configure the authentication type in the authentication segment of the
file. See Table 9 for the parameter.
app_config.yml
In the Authentication screen, the default setting under Authentication Mechanism
is Default. Note the following:
•
Choosing LDAP under Authentication Mechanism displays the LDAP
subscreen.
•
Choosing SAML under Authentication Mechanism displays the SAML
subscreen
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
42
| Chapter 3
Configuration, Localization, and Performance Tuning
Table 9 Authentication Configuration Parameter
Parameter
Screen Parameter
Description
type
Authentication >
Authentication
Mechanism
The authentication type. Specify the value as default,
ldap, or saml, as appropriate.
keep_me_signed_
in_for
Authentication >
Keep Session For
Days
The number of days in which the user session stays
active.
authentication
LDAP Configuration
You configure the parameters for the LDAP server in the authentication
segment of the default_app_config file. For the connection procedure, see
Connection to LDAP Server on page 74. For information on the parameters that
specify the user credentials for connecting to the LDAP database, see
Administrator Configuration. on page 38.
Table 10 describes the parameters for the LDAP server.
Table 10 LDAP Server Configuration Parameters (LDAP)
Parameter
Screen Parameter
ldap
LDAP
Description
(a subset of the
authentication
segment)
host
Authentication >
LDAP > Host
The IP address or name of the machine in which
your LDAP server is running.
port
Authentication >
LDAP > Port
The number of the port on which the LDAP server
is running. The default is 389.
base
Authentication >
LDAP > Base DN
The base domain name (DN) under which the
users are located, for example:
CN=Users,DC=pmqa,DC=com
ssl
Authentication >
LDAP > Enable SSL
The parameter that, if set to true, causes an SSL
connection to the LDAP server. The default setting
is false, meaning that SSL is disabled.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 43
|
Table 10 LDAP Server Configuration Parameters (LDAP) (Cont’d)
Parameter
Screen Parameter
Description
account_name_field
Authentication >
LDAP > Account
Name Attribute
The name of the LDAP attribute that represents the
login name for the user account. That is, an
attribute name that corresponds to the login name.
For Active Directory, this attribute is
sAMAccountName.
manager_account_
name_field
Authentication >
LDAP > Manager
Account Name
Attribute
An LDAP field that identifies the name of the
manager for each user. This value is either the
manager’s login name (that is, the value in the
account_name_field property of the manager) or
the manager’s DN in LDAP. If the manager field is
stored under the attribute manager in LDAP, this
value is manager. See this example:
manager_account_name_field: manager
manager_account_
name_field_is_dn
Authentication >
LDAP > Manager
Account Is DN
The parameter that, if set to true, denotes that the
manager value is stored as a DN in the
manager_account_name_field attribute. If the
value is stored as a login name, set this parameter
to false.
modified_at_field
Authentication >
LDAP > Modified
At Field
The LDAP property that identifies the timestamp
at which the user’s LDAP entry was last modified.
ldap_attributes
Authentication >
LDAP > LDAP
Attributes
The comma-separated names of the LDAP
attributes to be retrieved for mapping to tibbr user
attributes, for example, mail,displayname.
admin_dn
Authentication >
LDAP >
Administrator’s
User Name
The DN for the LDAP administrator account. See
this example:
Authentication >
LDAP >
Administrator’s
Password
The password associated with admin_dn.
admin_password
CN=Administrator,CN=Users,DC=pmqa,DC=com
This account must have read permission on LDAP
and must be able to bind to LDAP.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
44
| Chapter 3
Configuration, Localization, and Performance Tuning
Table 10 LDAP Server Configuration Parameters (LDAP) (Cont’d)
Parameter
Screen Parameter
Description
search_filter
Authentication >
LDAP > Search
Filter
An LDAP search criterion to match the users that
are loaded with the replicate_ldap_users
utility, For example, this filter—
(&(employeeNumber=*)(userAccountControl=5
12))
—preloads all the records for which the
employeeNumber attribute is populated and active
in LDAP.
Table 11 describes the mapping between the LDAP attributes and user object
attributes and replicates the LDAP account on the tibbr system. You can extend
the map by adding attributes, if required. The map value can access any LDAP
attribute declared in ldap_attributes.
Table 11 Authentication Configuration Parameter (Mapping Between LDAP and tibbr User Attributes)
Parameter
Screen Parameter
Description
email
Authentication >
LDAP > Email
Required. The name of the LDAP attribute to be
mapped as email, for example, mail.
first_name
Authentication >
LDAP > First Name
Required. The name of the LDAP attribute to be
mapped as the first name, for example,
givenName.
last_name
Authentication >
LDAP > Last Name
Required. The name of the LDAP attribute to be
mapped as the last name, for example, sn.
department
Authentication >
LDAP >
Department
The name of the LDAP attribute to be mapped as
the department, for example, department.
company
Authentication >
LDAP > Company
The name of the LDAP attribute to be mapped as
the company, for example, company.
country
Authentication >
LDAP > Country
The name of the LDAP attribute to be mapped as
the company, for example, co.
user_attributes_map
(a subset of the ldap
segment)
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 45
|
Table 11 Authentication Configuration Parameter (Mapping Between LDAP and tibbr User Attributes)
Parameter
Screen Parameter
Description
zip
Authentication >
LDAP > ZIP
The name of the LDAP attribute to be mapped as
the ZIP code, for example, postalCode.
custom_properties1
office
None
The name of the LDAP attribute to be mapped as
the office location, such as the office number, for
example, physicalDeliveryOfficeName.2
custom_properties1
location
None
The name of the LDAP attribute to be mapped as
the location, such as the city name, for example,
l.2
custom_properties1
phone
None
The name of the LDAP attribute to be mapped as
the phone number, such as the office telephone
number, for example, telephoneNumber.2
custom_properties1
mobile
None
The name of the LDAP attribute to be mapped as
the mobile number, for example, mobile.2
custom_properties(1)
address
None
The name of the LDAP attribute to be mapped as
the address, for example, streetAddress.2
This is a map between the LDAP attributes and the custom_properties attribute
of a user object. You can extend the map by adding attributes, if required.
1
See also Configuration of Fields in the Edit My Profile Form on page 71.
2
Table 12 describes the parameters for LDAP groups.
Table 12 Authentication Configuration Parameter (LDAP Groups)
Parameter
Screen Parameter
groups (a subset of
the ldap segment)
LDAP Groups
search_filter
Authentication >
LDAP > Search
Filter
Description
An LDAP search criterion to match all the groups
that are returned in a tibbr search function. For
example, (grouptype=8) fetches all the groups of
the distribution list type from Active Directory.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
46
| Chapter 3
Configuration, Localization, and Performance Tuning
Table 12 Authentication Configuration Parameter (LDAP Groups)
Parameter
Screen Parameter
Description
caption
Authentication >
LDAP > LDAP
Groups > Group
Name
The name of the group attribute that is displayed to
users, for example, displayName.
email
Authentication >
LDAP > LDAP
Groups > Email
The email address that is associated with this group
for sending email notifications, for example, mail.
attributes_map
Configure
attributes_map
in
the following:
ldap
group
For information on how to disable the Join tibbr, Forgot Password, and Change
Password capabilities during LDAP authentication, see the webui section in
Table 16, Web UI Configuration Parameters, on page 50
SAML Configuration
You configure the parameters for the SAML server in the authentication
segment of the default_app_config file. See Table 13.
Table 13 SAML Configuration Parameters
Parameter
Screen Parameter Description
saml
(a subset of the
authentication
segment)
issuer
Authentication >
SAML > Issuer
The name of the service provider, for example,
tibbr.
idp_sso_target_url
Authentication >
The URL of the login page of the identity provider.
SAML > SSO Target
URL
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 47
|
Table 13 SAML Configuration Parameters (Cont’d)
Parameter
Screen Parameter Description
idp_cert_fingerprint
Authentication >
SAML > IdP
Certificate
Fingerprint
The fingerprint from a certificate, for example,
F0:85:E8:ED:A7:50:92:66:31:94:6E:9C:EF:02:
C4:13:DD:7C:F4:F9.
To generate a fignerprint from a certificate, run this
command:
openssl x509 -noout -fingerprint -in
public-cert.pem
Authentication >
SAML > Name
Identifier Format
The format of the name identifier, for example,
saml_attributes
Authentication >
SAML > SAML
Attributes
A comma-separated list of the SAML attributes
supplied by the identity provider, which must
include at least the following: the user’s first name,
last name, and email address. By default, the
attribute name_id is included in this list.
tibbr_identifer_name
Authentication >
SAML > tibbr
Identifier
The name of a unique field in tibbr for locating the
user, such as the user’s login name.
tibbr_identifier_saml_
Authentication >
SAML > tibbr
Identifier SAML
Source
The name of one of the attributes specified in
saml_attributes, for example, name_id.
name_identifier_format
source
user_attributes_map
urn:oasis:names:tc:SAML:1.1:nameid-format:
emailAddress.
(a subset of the saml segment)
This parameter, a map between the SAML attributes and user object attributes, replicates the SAML
account on the tibbr system. You can extend the map by adding attributes, if required. The map value
can access any SAML attribute declared in saml_attributes.
The system expects the mapping for the following required user attributes.
email
Authentication >
SAML > Email
The name of the SAML attribute to be mapped as
email, for example, email.
first_name
Authentication >
The name of the SAML attribute to be mapped as
SAML > First Name the first name, for example, firstname.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
48
| Chapter 3
Configuration, Localization, and Performance Tuning
Table 13 SAML Configuration Parameters (Cont’d)
Parameter
Screen Parameter Description
last_name
Authentication >
The name of the SAML attribute to be mapped as
SAML > Last Name the last name, for example, lastname.
department
Authentication >
SAML >
Department
company
Authentication >
Optional. The name of the user’s company.
SAML > Company
country
Authentication >
SAML > Country
Optional. The country in which the user is located.
zip
Authentication >
SAML > ZIP
Optional. The ZIP code of the user’s address.
custom_properties(1)
office
None
The name of the SAML attribute to be mapped as
the office location, such as the office number, for
example, physicalDeliveryOfficeName.
custom_properties(1)
location
None
The name of the SAML attribute to be mapped as
the location, such as the city name, for example, l.
custom_properties(1)
phone
None
The name of the SAML attribute to be mapped as
the phone number, such as the office telephone
number, for example, telephoneNumber.
custom_properties(1)
mobile
None
The name of the SAML attribute to be mapped as
the mobile number, for example, mobile.
custom_properties(1)
address
None
The name of the SAML attribute to be mapped as
the address, for example, streetAddress.
mobile
Optional. The name of the user’s department.
(a subset of the saml segment)
The tibbr BlackBerry application supports connections through the SAML provider. You must specify
a separate identity provider URL, which must support basic authentication challenge.
issuer
Authentication >
The name of the service provider, for example,
SAML > For Mobile tibbr.
Clients > Issuer
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 49
|
Table 13 SAML Configuration Parameters (Cont’d)
Parameter
Screen Parameter Description
idp_sso_target_url
The URL of the login page of the identity provider.
Authentication >
SAML > For Mobile
Clients > SSO
Target URL
idp_cert_fingerprint
The fingerprint from a certificate, for example,
Authentication >
SAML > For Mobile F0:85:E8:ED:A7:50:92:66:31:94:6E:9C:EF:02:
Clients > IdP
C4:13:DD:7C:F4:F9.
Certificate
To generate a fignerprint from a certificate, run this
Fingerprint
command:
openssl x509 -noout -fingerprint -in
public-cert.pem
name_identifier_format
The format of the name identifier, for example,
Authentication >
SAML > For Mobile urn:oasis:names:tc:SAML:1.1:nameid-format:
Clients > Name
emailAddress.
Identifier Format
Search Configuration
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
tibbr uses Solr search for locating information, such as the user’s messages,
subjects, or people. You configure Solr search in the sunspot.yml file. See
Table 14 for the parameters.
Table 14 Search Configuration Parameters
Parameter
Screen Parameter
Description
hostname
Search > Host Name
The name or IP address of the server in which the search
process is running.
port
Search > Port
The port number of the search server.
log_level
Search > Log Level
The level of detail in the log.
solr_home
Search > Solr Home
The path of the Solr server.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
50
| Chapter 3
Configuration, Localization, and Performance Tuning
Site Configuration
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
tibbr sends users email notifications on activation of user accounts or channels,
password resets, and so forth. You configure your company’s tibbr URL in the
app_config.yml file. See Table 15 for the parameter.
Table 15 Site Configuration Parameters
Parameter
Screen Parameter
Description
site_root
Site > Public URL
The link to your tibbr server that is specified in the email
notifications that are sent to users, for example,
http://tibco.tibbr.com/tibbr.
prod_name
Site > Product Name
The name of the deployment that is displayed as the title on
the browser, for example, TIBCO tibbr.
Server > Time Zone
The time zone for all tibbr users. Be sure to set this parameter
before running the database as described in the step Initialize
the database.
site
server
time_zone
Web UI Configuration
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
Configure in the app_config.yml file the parameters that change the behavior
and appearance of the tibbr Web interface. See Table 16 for the parameters.
Table 16 Web UI Configuration Parameters
Parameter
Screen Parameter
Description
Web UI > Video
Conference
The parameter that enables or disables the
video-conference feature. The values are enabled and
disabled; the default is disabled.
menu
video_conference
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 51
|
Table 16 Web UI Configuration Parameters (Cont’d)
Parameter
Screen Parameter
Description
webui
Set the following parameters to disable the Join tibbr, Forgot Password, and Change Password
capabilities during LDAP authentication:
password_control
Web UI > Password
Control
The parameter that enables or disables the Forgot
Password link. Set this value to slave because
passwords are maintained in LDAP so as to disable
the Forgot Password link. Additionally, the Change
Password tab displays the message configured under
the property slave_password_text.
invite_colleague
Web UI > Link for
Inviting Colleagues
The parameter that, if set to true, enables the Join
tibbr link on the home page. Users can then
self-register. If you use LDAP, set this value to false.
join_tibbr
Web UI > Enable
tibbr Registration
The parameter that, if set to enabled (default),
displays the New to tibbr sign-up form on the login
page.
about_path
Web UI > URL of
About Link
The URL of the About Us link in the bottom right
corner of tibbr.
privacy_path
Web UI > URL of
Privacy Link
The URL of the Privacy Policy link in the bottom right
of tibbr.
theme
Web UI > Theme
The name of the tibbr style sheet. To retain the default
look and feel of the tibbr interface, set this parameter
as follows:
theme : default
To customize the look and feel, set theme to the name
of your customized style sheet, for example:
theme : acme
For more details, see Q: Can I customize the tibbr
skin? If so, how? on page 130.
auto_complete:
post:
followers_
only
Web UI > Show
Followers Only For
Auto-Complete
Control
The parameter that, if set to true, shows the
logged-in user’s followers in the Post to field. The
default is false.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
52
| Chapter 3
Configuration, Localization, and Performance Tuning
Table 16 Web UI Configuration Parameters (Cont’d)
Parameter
Screen Parameter
Description
event_stream
Web UI > Event
Stream
The parameter that, if set to enabled (default),
activates the Event Streams tab in the navigation bar
at the top.
logout
Web UI > Logout
The parameter that, if set to enabled (default), shows
the Log out link on the top right corner.
wall_polling_
interval
Web UI > Wall
Polling Interval
(Seconds)
The interval in seconds at which tibbr refreshes its
home page.
minimum_subjects
_required
Web UI >
Minimum No. of
Subjects Required
Before Showing My
Subjects
The number of subjects users must follow before tibbr
directs them to the My Subjects page in the Subjects
tab. In case the number of subjects followed is less
than this value, tibbr takes the user to the Subject
Directory page.
minimum_people_
required
Web UI >
Minimum No. of
People Required
Before Showing My
People
The number of people users must follow before tibbr
directs them to the My People page in the People tab.
In case the number of people followed is less than this
value, tibbr takes the user to the Directory page.
Message > List of
Message Types to
Exclude from Wall
A comma-separated list of message types whose
messages to exclude from the wall.
message
exclude_mtypes
Chat Configuration
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
Configure tibbr chat in the app_config.yml and prosody.yml files. Most tibbr
implementations require changes to the app_config.yml file only. Contact
TIBCO Support before making additional changes.
In the Chat screen, the default setting under Enabled is False. Selecting True
under Enabled displays the three parameters that apply to the chat feature.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 53
|
See Table 17 for the parameters.
Table 17 Chat Configuration Parameters
Parameter
Screen Parameter
Description
enabled
Chat > Enabled
The parameter that, if set to true, enables the chat feature.
The default is false, that is, chat is disabled.
url
Chat > URL
The LAN address of the chat server to which the tibbr server
will connect.
public_url
Chat > Public URL
A publicly accessible URL for the chat server. If you have
enabled secure access, update public_url to reflect the
secure site, as follows:
chat
https://tibbr-host/http-bind
where tibbr-host is your tibbr host, for example:
https://tibbr.tibco.com/http-bind
domain
Chat > Domain
The LAN address of the chat server. The default of
is valid for most tibbr instances. Before changing
this value, contact TIBCO Support.
localhost
User Configuration
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
Configure the settings for auto-registration of users and for user hierarchy under
hierarchy, a subset of the user segment in the app_config.yml file. See Table 18
for the parameters.
In the User screen, selecting True under Enabled under Hierarchy displays the
Parent Attribute and Root User’s Login parameters.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
54
| Chapter 3
Configuration, Localization, and Performance Tuning
Table 18 User Configuration Parameters
Screen
Parameter
Description
User >
Auto-Activate
The parameter that, if set to true, enables automatic
registration of users.
enabled
User > Hierarchy
> Enabled
The parameter that, if set to true, enables the
hierarchical view. The default is false. To learn how to
enable the hierarchical view, see Display of User
Hierarchy on page 76.
parent_attribute
User > Hierarchy
> Parent
Attribute
The field in the user’s table that stores the manager’s
login name for the user. The default is
custom_properties[’manager’], which facilitates
connection to an LDAP server.
root
User > Hierarchy
> Root User’s
Login
The tibbr user name of the root user, for example, your
CEO’s user name.
Parameter
auto_activate
hierarchy
(a subset of the user
segment)
tibCast Configuration
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
Configure the tibCast capability in the video_conference segment of the
app_config.yml file. See Table 19 for the parameters.
Table 19 Video Conference Configuration Parameters
Parameter
Screen Parameter
Description
video_conference
enabled
tibCast > Enabled
The parameter that, if set to true, enables the tibCast
feature. The default is false, that is, tibCast is disabled.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 55
|
Table 19 Video Conference Configuration Parameters (Cont’d)
Parameter
Screen Parameter
Description
url
tibCast > URL
A publicly accessible URL of the server for video
conferences. TIBCO provides you with this URL when you
sign up for tibCast.
access_key
tibCast > Access Key
The access key associated with your tibCast subscription.
TIBCO provides you with this key when you sign up for
tibCast.
user
tibCast > User Name
The user-name credential. TIBCO provides you with this
credential when you sign up for tibCast.
password
tibCast > Enabled
The password for user. TIBCO provides you with this
credential when you sign up for tibCast.
SMS Gateway Configuration
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
Configure the SMS gateway in the default segment of the app_config.yml file.
See Table 20 for the parameters.
In the SMS screen, selecting True under Enabled displays the configuration
parameters for the SMS gateway.
Table 20 SMS Gateway Configuration Parameters
Parameter
Screen Parameter
Description
SMS > Enable
The parameter that, if set to true, enables the SMS
gateway. The default is false, that is, the SMS
gateway is disabled.
sms_gateway
(a subset of the
default segment)
enable
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
56
| Chapter 3
Configuration, Localization, and Performance Tuning
Table 20 SMS Gateway Configuration Parameters (Cont’d)
Parameter
Screen Parameter
Description
config
SMS > Configuration
The provider name Clickatell) and other related
details. See the following example:
adapter: “clickatell”
user: “jsmith”
password: “jsmith1”
api_id: “1234567”
adapter
SMS > Configuration
> SMS Gateway
The name of the SMS gateway provider, which is
Clickatell.
user
SMS > Configuration
> User Name
The user name for the Clickatell account.
password
SMS > Configuration
> Password
The password associated with User Name.
api_id
SMS > Configuration
> API-ID
The unique key from Clickatell for accessing the
HTTP API.
SharePoint Configuration
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
Configure the SharePoint feature in the sharepoint segment of the
app_config.yml file. See Table 21 for the parameters.
In the SharePoint screen, selecting True under Enabled displays the configuration
parameters for SharePoint.
The feature of uploading files to SharePoint from tibbr supports basic and NTLM
authentication.
Table 21 SharePoint Configuration Parameters
Parameter
Screen Parameter
Description
sharepoint
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 57
|
Table 21 SharePoint Configuration Parameters (Cont’d)
Parameter
Screen Parameter
Description
enabled
SharePoint >
Enabled
The parameter that, if set to true, enables the
SharePoint feature. The default is false, that is,
SharePoint is disabled.
base
SharePoint > Base
URL
The base URL of the SharePoint server.
credentials_
cache_duration
None
The duration in which to retain user credentials in
memory. The default is 24 hours.
per_page
None
The number of results to return per page for search
and list items. The default is 20.
auth_ntlm_domain
SharePoint > NTLM
Domain
The domain name to be appended for SharePoint
authentication. Leave this parameter blank if the
SharePoint server does not need a domain name for
authentication.
hide_hidden_lists
None
The parameter that, if set to true, means that the
SharePoint lists marked as Hidden are not
displayed. The default is true.
hide_empty_lists
None
The parameter that, if set to true, means that the
SharePoint lists that contain no files are not
displayed while you are browsing for SharePoint
files. The default is true.
exclude_lists_of_
None
The server template type IDs of the lists that are not
displayed. For example, the server template type ID
for the Generic list is 100 and that for the Events list
is 106. The default value is “100,103,104,106”.
Table 22 lists all the template types and their IDs.
None
The server template type IDs of the lists that are
allowed for file upload. The default value is
“101,109”, which means that upload is allowed for
the Document library and the Picture library.
type
upload_enabled_
lists
Table 22 SharePoint Server Template Types
ID
Description
ID
Description
100
Generic list
130
Data Connection library
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
58
| Chapter 3
Configuration, Localization, and Performance Tuning
Table 22 SharePoint Server Template Types
ID
Description
ID
Description
101
Document library
140
Workflow History
102
Survey
150
Gantt Tasks list
103
Links list
200
Meeting Series list
104
Announcements list
201
Meeting Agenda list
105
Contacts list
202
Meeting Attendees list
106
Events list
204
Meeting Decisions list
107
Tasks list
207
Meeting Objectives list
108
Discussion board
210
Meeting test box
109
Picture library
211
Meeting Things To Bring list
110
Data Sources
212
Meeting Workspace Pages list
111
Site Template gallery
300
Portal Sites list
112
User Information list
301
Blog Posts list
113
Web Part gallery
302
Blog Comments list
114
List Template gallery
303
Blog Categories list
115
XML Form library
850
Page library
116
Master Pages gallery
1100
Issue tracking
117
No-Code Workflows
1200
Administrator Tasks list
118
Custom Workflow Process
2002
Personal Document library
119
Wiki Page library
2003
Private Document library
120
Custom grid for a list
Also see Configuration of SharePoint Link on page 70 for information on how to
set up the SharePoint link.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 59
|
Event-Stream Configuration
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
Configure the LinkedIn, Facebook, Twitter, Oracle Expenses, and Oracle Order
Management as described in the following subsections.
LinkedIn
Configure the LinkedIn event stream in the app_runner segment of the
app_config.yml file. See Table 23 for the parameter.
Table 23 LinkedIn Configuration Parameter
Parameter
Screen Parameter
Description
app_runner
Configure in the following:
app_runner
app_config
linked_in
‘100’
client_config
app_id
Event Streams >
LinkedIn > Client
Configuration
See Set the application ID in tibbr on page 78.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
60
| Chapter 3
Configuration, Localization, and Performance Tuning
Facebook
Configure the Facebook event stream in the app_runner segment of the
app_config.yml file. See Table 24 for the parameter.
Table 24 Facebook Configuration Parameter
Parameter
Screen Parameter
Description
app_runner
Configure in the following:
app_runner
app_config
facebook
‘100’
client_config
Event Streams >
Facebook > Client
Configuration
app_id
See Set the application ID in tibbr on page 78.
Twitter
Configure the Twitter event stream in the app_runner segment of the
app_config.yml file. See Table 25 for the parameter.
Table 25 Twitter Configuration Parameter
Parameter
Screen Parameter
Description
app_runner
Configure in the following:
app_runner
app_config
twitter
‘100’
client_config
app_id
Event Streams >
Twitter > Client
Configuration
See Set the application ID in tibbr on page 78.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 61
|
Oracle Expenses
Configure the Oracle Expenses event stream in the app_runner segment of the
app_config.yml file. See Table 26 for the parameters.
Table 26 Oracle Expenses Configuration Parameters
Parameter
Screen Parameter
Description
app_runner
Configure in the following:
app_runner
app_config
oracle expenses
‘100’
system_user
Event Streams >
Oracle Expenses >
Client Configuration
The name of the system user (that is, the login name) with
the privilege of configuring the Oracle Expenses event
stream, for example, tibbradmin, which is the default.
Oracle Order Management
Table 27 describes the parameters for the Oracle Management event stream for
tracking order fulfillment.
Table 27 Oracle Order Management Configuration Parameters
Parameter
Screen Parameter
Description
server
Event Streams > Oracle
Order Management >
Database Credentials >
Server Name
The name or IP address of the
database server for Oracle Order
Management.
port
Event Streams > Oracle
Order Management >
Database Credentials >
Port
The port number of the database
server for Oracle Order
Management.
app_runner
Configure in the following:
app_config
oracle order management
‘100’
db_credential
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
62
| Chapter 3
Configuration, Localization, and Performance Tuning
Table 27 Oracle Order Management Configuration Parameters
Parameter
Screen Parameter
Description
sid
Event Streams > Oracle
Order Management >
Database Credentials >
SID
The Oracle system ID.
username
Event Streams > Oracle
Order Management >
Database Credentials >
User Name
The user name associated with the
Oracle Order Management
database.
password
Event Streams > Oracle
Order Management >
Database Credentials >
Password
The password associated with
username.
Google Analytics Configuration
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
The tibbr Web pages contain the necessary code for connecting to the Google
analytics site to track your site statistics. To use this capability, first generate and
configure the Google analytics tracking code in the app_config.yml file. See
Table 28 for the parameter.
For the procedure on analytics, see http://analytics.google.com.
Table 28 Google Analytics Configuration Parameter
Parameter
Screen Parameter
Description
Web UI > Google
Tracking Code
The generated code, for example, AB-12345678-1,
for tracking the analytics of the tibbr site.
webui
google_tracking_
code
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 63
|
Validation Settings
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
With tibbr, you can define validation rules for some properties, such as the length
of the login name, password, and email syntax. Configure the parameters that
govern those rules in the app_config.yml file. See Table 29 for the parameters.
Table 29 User Configuration Parameters
Parameter
Screen Parameter
Description
validate_length
Validation > User >
Login
The parameter that, if set to true, denotes that
the length of the login name is validated.
valid_length
Validation > User >
Login
The length of the login name allowed. For
example, set the value to 2..40 to specify a valid
length of two to 40 characters.
Login-Name Validation
Configure the validation
of login names in the
following:
validation
user
login
Password Validation
Configure the validation
of passwords in the
following:
validation
user
password
Note: This segment
applies only if LDAP
authentication is not in
use and if the
authentication type is
default.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
64
| Chapter 3
Configuration, Localization, and Performance Tuning
Table 29 User Configuration Parameters (Cont’d)
Parameter
Screen Parameter
Description
validate_length
Validation > User >
Password >
Validate Length
The parameter that, if set to true, denotes that
the password length is validated.
valid_length
Validation > User >
Password > Valid
Length
The length of the password allowed. For
example, set the value to 4..40 to specify a valid
length of four to 40 characters.
validate_length
Validation > User >
Email > Validate
Length
The parameter that, if set to true, denotes that
the email-address length is validated.
valid_length
Validation > User >
Email > Valid
Length
The length of the email address allowed. For
example, set the value to 6..100 to specify a
valid length of six to 100 characters.
validate_format
Validation > User >
Email > Validate
Format
The parameter that, if set to true, denotes that
the email-address format is validated.
valid_format
Validation > User >
Email > Valid
Format
The regular expression against which to validate
the email address. See this example:
validate_domain
Validation > User >
Email > Validate
Domain
The parameter that, if set to true, denotes that
the email domains are validated.
valid_domains
Validation > User >
Email > Valid
Domains
A comma-separated list of valid email domains,
for example:
Email Validation
Configure the validation
of email addresses in the
following:
validation
user
email
'(^([^@\s]+)@((?:[-_a-z0-9]+\.)+[a-z]{2
,})$)|(^$)'
tibco.com, tibbr.com
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 65
|
Table 29 User Configuration Parameters (Cont’d)
Parameter
Screen Parameter
Description
validate_size_less_
than
Validation > User >
Profile Image >
Validate Image Size
The parameter that, if set to true, denotes that
the size of images is limited to that specified in
valid_size_less_than.
valid_size_less_than
Validation > User >
Profile Image >
Validate Format
The maximum size of the profile image in KB.
By default, the user’s profile image size must
not exceed 500 KB.
allowed_content_type
Validation > User >
Profile Image >
Allowed Content
Types
The image file types that are allowed.
validate_size_less_
than
Validation > Assets
> Attachment >
Validate Size
The parameter that, if set to true, denotes that
the size of attachments is limited to that
specified in valid_size_less_than.
valid_size_less_than
Validation > Assets
> Attachment >
Maximum Size
The maximum size of the profile image in MB.
By default, the user’s profile image size must
not exceed 1 MB. See this example:
Profile-Image
Validation
Configure the validation
of profile images in the
following:
validation
user
profile_image
Attachment Validation
Configure the validation
of attachments in the
following:
validation
user
attachment
valid_size_less_than: 10
To enforce this setting, first enable the parameter
validate_size_less_than, that is, set it to
true.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
66
| Chapter 3
Configuration, Localization, and Performance Tuning
Table 29 User Configuration Parameters (Cont’d)
Parameter
Screen Parameter
Description
validate_extension
Validation > Assets
> Attachment >
Validate Extensions
The parameter that, if set to true, denotes that
the attachments are validated against the file
formats specified in blocked_extensions.
blocked_extensions
Validation > Assets
> Attachment >
Blocked Extensions
A comma-separated list of the file-type
extensions that are not allowed. See this
example:
blocked_extensions: .exe, .js, .bat,
.sh
To enforce this setting, first enable the parameter
validate_extension, that is, set it to true.
Subject-Image
Validation
Configure the validation
of subject images in the
following:
validation
subject
image
Validation > Subject
> Image > Validate
Size
The parameter that, if set to true, denotes that
the size of the subject image is validated.
valid_size_less_than
Validation > Subject
> Image >
Maximum Size
The maximum size of the subject image in KB.
By default, the subject image size must not
exceed 500 KB.
allowed_content_type
Validation > Subject
> Image > Allowed
Content Types
A comma-separated list of the file-type
extensions that are allowed, for example:
validate_size_less_t
han
allowed_content_type:
image/jpeg,image/png,image/gif,image/pj
peg,image/x-png
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 67
|
Table 29 User Configuration Parameters (Cont’d)
Parameter
Screen Parameter
Description
validate_length
Validation > Subject
> Name > Validate
Size
The parameter that, if set to true, denotes that
the name of subject is validated.
valid_length
Validation > Subject
> Name > Valid
Length
The length of the subject name allowed. For
example, set the value to 2..255 to specify a
valid length of two to 255 characters.
validate_length
Validation > Subject
> Description >
Validate Length
The parameter that, if set to true, denotes that
the description of subject is validated.
valid_length
Validation > Subject
> Description >
Valid Length
The length of the subject description allowed.
For example, set the value to 0..255 to specify a
valid length of zero to 255 characters.
Subject-Name
Validation
Configure the validation
of subject images in the
following:
validation
subject
name
Subject-Description
Validation
Configure the validation
of subject descriptions in
the following:
validation
subject
description
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
68
| Chapter 3
Configuration, Localization, and Performance Tuning
Table 29 User Configuration Parameters (Cont’d)
Parameter
Screen Parameter
Description
Validation >
Channel > Target >
Validate
Uniqueness
The parameter that, if set to true, denotes that
the channels are validated for uniqueness within
the scope of a user. That is, a user cannot create
multiple channels with the same target (email
address or mobile number) for notification.
Channel Validation
Configure the validation
of channels in the
following:
validation
channel
validate_uniqueness
Channel Configuration
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
Configure the settings for auto-activation of channel and for the delayed dispatch
parameter in the channel segment of the app_config.yml file. See Table 30 for
the parameters.
Table 30 Channel Configuration Parameters
Parameter
Screen Parameter
Description
auto_activate
Channel >
Auto-Activate
Channels
The parameter that, if set to true, enables
automatic activation of channels.
Channel > Broadcast
Message > Delayed
Dispatch
The parameter that, if set to true, causes tibbr to
honor delayed channels.
broadcast_message
(a subset of the
channel segment)
delayed_dispatch
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 69
|
Localization Settings
For details on editing the app_config.yml file, see Mechanics of Configuration
on page 34.
You can localize tibbr, offering users the option to view the tibbr interface in
languages other than English. Configure localization in the locale segment of the
default_app_config file. For details, see Localization of tibbr on page 79.
Table 31 describes the localization parameter.
Table 31 Localization Parameter
Parameter
Screen Parameter
Description
Server > Locale >
Default
The default locale setting when tibbr loads a new user is as
follows:
locale
default
default:
language
where language is the ISO 639-1 code for the language
translation files, for example:
default: en
If you have configured additional locales, users can change
the locale by editing their profiles. If no locale is specified,
the default is English.
BlackBerry Configuration
A placeholder link is available for hosting the tibbr application for BlackBerry on
the tibbr on the BlackBerry page at
https://your_tibbr_domain/tibbr/static_pages/blackberry. Copy the
BlackBerry installer as follows:
1. Create two directories, bb5.0 and bb4.5, in the
TIBCO_HOME/tools/tomcat/server/webapps/ROOT/ directory.
2. Copy the corresponding BlackBerry application binaries into those directories.
If those files are not already available on your machine, contact TIBCO
Support for them.
Afterwards, test the setup by accessing one of the files by going to
in the browser.
https://your_tibbr_domain/bb5.0/tibbr.jad
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
70
| Chapter 3
Configuration, Localization, and Performance Tuning
Android Configuration
A placeholder link is available for hosting the tibbr application for Android on the
tibbr on the Android page at
https://your_tibbr_domain/tibbr/static_pages/android. Copy the Android
installer as follows:
1. Create a directory for Android in the
TIBCO_HOME/tools/tomcat/server/webapps/ROOT/ directory.
2. Copy the corresponding Android application binaries into those directories.
If those files are not already available on your machine, contact TIBCO
Support for them.
Afterwards, test the setup by accessing one of the files by going to
in the browser.
https://your_tibbr_domain/android/tibbr-release.apk
Configuration of tibbr Desktop
A placeholder link is available for hosting the tibbr Desktop application under
New to tibbr? at the top of the right panel on the tibbr home page. Copy the
installers for tibbr Desktop as follows:
Copy the tibbrDesktop.exe and tibbrdesktop.dmg files to the
TIBCO_HOME/tools/tomcat/server/webapps/ROOT/ directory.
Afterwards, test the setup by accessing one of the files at
https://your_tibbr_domain/tibbrDesktop.dmg.
Configuration of SharePoint Link
Configure the SharePoint link in the link_patterns.yml file. See Table 32 for the
parameter.
Table 32 SharePoint Link Parameter
Parameter
Description
url_pattern
The regular expression for extracting SharePoint URLs.
Replace the IP address 10.107.172.79 with the IP address
or host name of your SharePoint server, for example,
sharepoint-server.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 71
|
Configuration of Fields in the Edit My Profile Form
You define the fields in the Edit My Profile form in the properties_config
segment of the user_meta_details.yml file. You can also add fields to that form.
Default Fields
Table 33 describes the default fields.
You cannot configure these properties in the application configuration tool.
Table 33 Configuration Parameters for the Edit My Profile Form
Parameter
Description
properties_config
phone
The user’s phone number.
office
The user’s office number.
mobile
The user’s mobile phone number.
location
The user’s geographical location.
time_zone
The user’s time zone.ibbr
first_name
The user’s first name.
last_name
The user’s last name.
email
The user’s email address.
title
The user’s job title.
department
The user’s department name.
company
The user’s company name.
description
The text in the About Me field in the user’s Edit My Profile form.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
72
| Chapter 3
Configuration, Localization, and Performance Tuning
Custom Fields
An example structure of a custom field is at the top of the
user_meta_details.yml file. Table 34 describes the meta data of the user
properties in that example.
Table 34 Meta Data of User Properties
Parameter
Description
property_name
The key of the field label on the Edit Profile Form. tibbr externalizes the text in
the translation files in the TIBCO_HOME/tibbr/config/locales and
TIBCO_HOME/webclient/config/locales directories.
For example, in Table 33, description is the key, which is mapped to the
About Me field in the TIBCO_HOME/tibbr/config/locales/en.yml file.
ui_type
The type of the field in the Edit Profile Form. The possible values are
text_field, text_area, select, select_table, hidden, password,
check_box, radio_button, date, and date_time.
editable
The parameter that, if set to true (default) makes this field editable. The
possible values are true and false.
required
The parameter that, if set to true (default) makes this a required field. The
possible values are true and false.
position
The position of the field in the UI. The possible values are as follows:
allowed_values
•
0
— Do not show this field in the Edit My Profile form.
•
1
— Show this field on the left column of the Edit My Profile form.
•
2 — Show this field on the right column of the Edit My Profile form. This
is the default.
An array of the values allowed for the field, which apply to ui_type:select.
Configuration of Banned Email Subjects
To prevent certain automated and spam messages from being posted to tibbr
through email replies and event streams, customize the email.properties file.
For example, if a user has an automated out-of-office reply configured in his email
client, that reply is sent to all the subjects and users he follows on an email
channel. To prevent Microsoft Outlook out-of-office replies from being posted to
the tibbr wall, include an Automatic reply entry in the email.properties file.
Specify banned words or phrases in this format:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration Files and Parameters 73
|
subject-ban=exclude1,exclude2,exclude3
where each exclude variable is a word or phrase that, if included in the email
subject line, prevents the message from being posted in tibbr. Note that the entries
are not case-sensitive. See this example:
subject-ban=RCPT:,Delivery Confirmation,NON-DELIVERY
of:,Undeliverable Message,Receipt Confirmation,Failed
mail,Returned mail,unable to deliver mail,away from my
mail,Autoreply,detected a virus,Mail Delivery,Automatic reply
Population of Users and User-Related Data
You configure users in the seed.yml file. See Table 35 for the parameters. For
details on how to seed default subjects and messages, see the sample seed file
tibbr-config/seed.yml.
Users added to this file can access the tibbr Web interface without any additional
steps.
There is no password setting in seed.yml. Users log in to tibbr for the first time
with their user names, which also serve as the passwords. They can then change
their passwords in the tibbr Web interface.
Table 35 User Configuration Parameters
Parameter
Description
user
Required. The user’s name. Replace the variable with a
unique user name, for example, John. The name specified here
is also the password the first time the user logs in.
first_name
Required. The user’s first name, for example, John.
last_name
Required. The user’s last name, for example, Smith.
email
Required. The user’s email address, for example,
[email protected].
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
74
| Chapter 3
Configuration, Localization, and Performance Tuning
Connection to LDAP Server
To connect to an LDAP server:
1. Create a tibbr admin user in the LDAP server. tibbr connects to the LDAP
server with the user name and credentials created.
2. Configure the LDAP settings in the app_config.yml file:
— Specify the admin_user credentials for connecting to the LDAP server in
the default segment. For details, see Administrator Configuration. on
page 38.
— Configure the LDAP parameters as described in LDAP Configuration on
page 42.
3. Run the LDAP sync utility from the TIBBR_HOME/scripts directory. Type:
./tibbr_util.sh replicate_ldap_users force_update=[true|false]
test=[true|false] write_to_file=[true|false]
data_output_file='file_path'
Note the following:
•
The data_output_file parameter is the location of the log file.
•
If you set force_update to true, the sync utility updates the users in the
tibbr database regardless of whether their data has been updated in LDAP
since the last synchronization.
•
If you set test to true, instead of updating the database, the sync utility runs
the test and outputs a log file specified in the data_output_file parameter.
•
If you set write_to_file to true, the sync utility writes the output to the log
file.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration and Disabling of SSL 75
|
Configuration and Disabling of SSL
SSL is enabled by default in all new tibbr instances. However, you must provide
your own SSL certificates. The default certificates are staged at
TIBBR_HOME/tools/apache2/certs. Replace the following three files with
your own SSL certificates:
•
server.crt
•
server.csr
•
server.key
To disable SSL in your tibbr instance, edit the Apache httpd.conf file at
TIBBR_HOME/tools/apache2/conf/httpd.conf by commenting out line 460,
which reads as follows:
Include conf/extra/httpd-ssl.conf
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
76
| Chapter 3
Configuration, Localization, and Performance Tuning
Display of User Hierarchy
Optionally, the People navigator in the tibbr Web interface can display users in the
organization’s hierarchy. Usually, you obtain the hierarchy through a connection
to an LDAP server. However, you can also set user hierarchy in a non-LDAP
configuration, which requires that you populate the parent_attribute field in
the app_config.yml file with the manager’s login for each user.
By default, the parent_attribute attribute is configured to enable connection to
an LDAP server. To display the hierarchical view without retrieving the value
from LDAP, specify the value of the manager’s login.
If you have already configured tibbr to connect to an LDAP server, you need not
change the default parent_attribute setting.
To enable the hierarchical view:
1. Configure the hierarchy settings in the app_config.yml file. For details on the
related parameters, see page 54.
2. Run the Set User Hierarchy utility. From the TIBBR_HOME/scripts directory,
type:
./tibbr_util.sh set_user_hierarchy file_path='file_path'
This is a slow running process that establishes the user hierarchy according to
the data in the user profiles. For LDAP connections, the hierarchy is based on
the value in the custom_properties[‘manager’] field. The root user is the
user defined by the root parameter.
If you delete a user with an administration utility, you also delete the user’s
subordinates from the hierarchy because they do not have an active manager.
However, if you undelete a user with an administration utility, that user and his
or her subordinates are not automatically set in the user hierarchy. To restore them
in the hierarchy, run the Set User Hierarchy utility.
For details on administration utilities, see Chapter 6.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Configuration of Life Streams 77
|
Configuration of Life Streams
Life streams enable tibbr users to access the content from their favorite personal
social networking sites, such as Facebook, Twitter, and LinkedIn, from within the
tibbr environment.
For security reasons, those sites require that you create an application that is
specifically associated with your tibbr domain and then register that application
within tibbr. Users can then access messages from that Internet domain only.
To configure tibbr life streams:
Task A Create an application on the social networking site
To create an application for each social networking site that will be enabled in
tibbr, do the following:
•
Facebook
a. Log in to Facebook.
b. Create an application at http://developers.facebook.com/setup/ by
specifying your tibbr site URL and a name, for example, tibbr for ACME
Inc.
Facebook might ask you to verify your account if it is not already verified.
c. Copy the application ID for the application you created. You will enter this
code while configuring tibbr in step B below.
•
Twitter
a. Log in to Twitter.
b. Access the Twitter developer applications site at
https://developer.twitter.com/apps.
c. Register an application by filling out the form. Specify the URL of the site
on which you are hosting tibbr.
d. Copy the application ID for the application you created. You will enter this
code while configuring tibbr in step B below.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
78
| Chapter 3
Configuration, Localization, and Performance Tuning
•
LinkedIn
a. Log in to LinkedIn.
b. Create an application at
https://www.linkedin.com/secure/developer.
c. Copy the application key for the application you created. You will enter
this key while configuring tibbr in step B below.
Task B Set the application ID in tibbr
Edit the TIBBR_HOME/tibbr-config/app_config.yml file to specify the
application IDs for the life streams. See this example:
app_config:
linked_in:
100:
client_config:
app_id: "Y154oxYGrP1HY-u7XE8VFq_52PXarzd9lgodh_SefLZ"
type: client
facebook:
100:
client_config:
app_id: "155823714475614"
type: client
twitter:
100:
client_config:
app_id: "kgf5WOQwaPtPZt31S2WKVw"
type: client
Task C Restart the tibbr server
Restart the tibbr server to cause the changes to take effect.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Localization of tibbr 79
|
Localization of tibbr
The tibbr Web interface is available in English. However, you can optionally
translate the interface, making localized versions of tibbr available to users. The
translation interfaces, or locales, are enabled through translation files for both the
tibbr Web interface (client) and the server.
Once you have configured the localized interfaces, users can change the default
tibbr locale in the Edit My Profile screen, for example:
To localize the tibbr Web interface, do the following:
Task A Create the resource files.
Four resource files are required for each locale, as follows:
•
TIBBR_HOME/tibbr/config/locales/language.yml: This is the resource
file for the tibbr server and must be translated.
•
TIBBR_HOME/webclient/config/locales/language.yml: This is the
resource file for the tibbr Web client and must be translated.
•
TIBBR_HOME/tibbr/config/locales/default/language.yml: This is the
resource file for the Ruby on Rails framework used by the tibbr server.
Download this file from
https://github.com/svenfuchs/rails-i18n/blob/master/rails/
locale.
•
TIBBR_HOME/webclient/config/locales/default/language.yml: This is
the resource file for the Ruby on Rails framework used by the tibbr Web client.
Download this file from
https://github.com/svenfuchs/rails-i18n/blob/master/rails/
locale.
where language is a two-letter ISO 639-1 code that identifies the language. For
example, a French translation would use the file names fr.yml and
fr_default.yml. For a list of all the language codes, see
http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.
The third and fourth files above, which you acquire by downloading from
github.com, are translations and need not be translated again.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
80
| Chapter 3
Configuration, Localization, and Performance Tuning
Next, create the to-be-translated resource files by making copies of the source files
described in Table 36 and renaming the copies.
Table 36 tibbr Source Files for Locales
Source File
Location
Copy Name
en.yml
TIBBR_HOME/tibbr/config/locales/
language.yml
Note: Do not delete or rename the original file. Copy the
file before making any changes.
en.yml
TIBBR_HOME/webclient/config/locales/
language.yml
Task B Translate the language.yml file.
The language.yml file consists of key-value pairs in this format:
key: "value"
where key is a property name and value is the string displayed in the UI. To localize
tibbr, translate the value strings.
•
Do not translate the key in the key:
•
Do not delete the space between the colon (:) and the translation string.
"value"
pairs. Translate the value only.
For example, you might translate this string—
selectProfileImage: "You must select a profile image or select the
default image."
—to the following in Spanish:
selectProfileImage: "Debe seleccionar una imagen de perfil o
seleccionar imagen predefinida."
Task C Stage the new files.
Stage the language.yml file in two locations, one on the client side and the other on
the server side, next to the English-language versions. See Table 37.
Table 37 Staging Locations for Localization Files
File
Location
Resource files for tibbr
•
Server side:
TIBBR_HOME/tibbr/config/locales/language.yml
•
Client side:
TIBBR_HOME/webclient/config/locales/language.yml
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Localization of tibbr 81
|
Table 37 Staging Locations for Localization Files
File
Location
Resource files for Ruby on Rails
•
Server side:
TIBBR_HOME/tibbr/config/locales/defaults/
language.yml
•
Client side:
TIBBR_HOME/webclient/config/locales/defaults/
language.yml
Task D Restart the tibbr server.
Restart the tibbr server for the locale changes to take effect. Afterwards, the new
language is available in the Locale menu when users edit their profiles in the tibbr
Web interface.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
82
| Chapter 3
Configuration, Localization, and Performance Tuning
Performance Tuning
The default tibbr configuration is optimal for system performance needs.
However, if you have a large system, for example, more than 16 GB RAM and
eight cores, you can fine-tune tibbr’s performance by increasing the maximum
number of concurrent database connections.
By default, the maximum number of concurrent database connections allowed at
one time is 300, which means that 300 users can access the server concurrently. An
additional 100 users (or their browsers) can be waiting in line.
TIBCO recommends allocating up to 120 threads for each core (at 3 GHz) to retain
the optimal system performance. For example, on a two-quad core (or eight
cores), cap the maximum threads at 1,000.
To fine-tune tibbr’s performance:
Task E Increase the thread count in the Tomcat server.
Revise these two settings in the Tomcat server.xml file in the
TIBBR_HOME/tools/tomcat/server/conf directory:
•
maxThreads
•
acceptCount
— The maximum number of threads.
— The maximum number of waiting users.
See Table 38.
Table 38 Maximum Threads and Maximum Waiting Users in Tomcat Server
Element
Description
Maximum Threads
<Connector
To change the number of threads allowed, locate the Connector element and
add a maxThreads setting, for example:
maxThreads="400"
The default value is 300.
Note: If you increase the maximum number of threads, also increase the pool
size in database.yml to make that number of database connections available for
the new threads.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Performance Tuning 83
|
Table 38 Maximum Threads and Maximum Waiting Users in Tomcat Server (Cont’d)
Element
Description
Maximum Waiting Users
<Connector
To change the maximum number of waiting users, update the acceptCount
setting in the Connector element, for example:
acceptCount="150"
The default value is 100.
For more information on the Tomcat elements, see—
http://tomcat.apache.org/tomcat-6.0-doc/config/http.html
Modifying the Tomcat server settings can negatively impact tibbr’s performance.
Contact TIBCO Support for assistance
Task F Increase the tibbr database pool size.
Update the database pool parameter in the database.yml file in the
TIBBR_HOME/tibbr-config directory.
specifies the number of database connections available for threads. Set the
size under development and production to the same value. The value of
pool must be the same as the maxThreads setting configured in step E.
pool
pool
The total number of database connections allowed is slightly greater than the
configured pool size. tibbr reserves three additional connections for the
delayed_job process, app_runner, and the search engine. For example, with a
pool size of 200, the maximum number of database connections is 203.
Task G Increase the heap memory size.
Update the JAVA_OPTS setting in the TIBBR_HOME/scripts/env.sh file to
increase the heap memory size.
Heap memory requirements are relative to the thread count. For example, if you
increased the thread count to 400, you would want to increase the heap memory
to 3072, as follows:
export JAVA_OPTS="-server -Xms256m -Xmx3072m -XX:MaxPermSize=128m
-Djruby.home=$ruby_home -Dlog_dir=$log_dir"
For details, see the documentation on tuning the Java runtime system at—
http://download.oracle.com/docs/cd/E19823-01/819-0084/pt_tuningjav
a.html
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
84
| Chapter 3
Configuration, Localization, and Performance Tuning
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
| 85
Chapter 4
Custom Event-Stream Applications
This chapter describes the steps for creating custom event-stream applications.
Topics
•
Overview, page 86
•
Procedure, page 87
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
86
| Chapter 4
Custom Event-Stream Applications
Overview
All event streams are protected by default and, unless they are public, only you as
the tibbr administrator can access them. Consequently, you might need to either
add users to an event stream or make it public before users can see it.
You can create a custom application that is available to users through the tibbr
Web client. The custom application can connect to any enterprise system, such as
TIBCO Enterprise Message Service feeds.
TIBCO recommends that you develop a new event stream only on a
nonproduction server because the process requires restarting the tibbr server to
see the event stream in action.
Once the event stream is deployment ready, move the stream to your production
server by copying the event-stream directory from the development server to the
same location on the production server and proceed from Task E in the section
Procedure on page 87 onwards.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Procedure 87
|
Procedure
Follow these steps to create a custom event-stream application.
Task A Create an application template.
Create the application template code on the machine in which tibbr is installed:
1. Go to TIBBR_HOME/scripts and run the env.sh script. Type:
. env.sh
2. Go to TIBBR_HOME/tibbr to create an application template. Run:
generate custom_app "app_name"
release
where app_name is the name of the application and release is its version number.
For example, the following call creates an application template called
hello world with a release number of 1.0.0:
jruby -S script/generate custom_app "hello world"
100
The above command creates an application template in the
TIBBR_HOME/custom_apps/apps/hello_world directory.
When creating a template, tibbr converts spaces, if any, in app_name to underscores.
Task B Edit the application_config.rb file.
Edit the application_config.rb template file to create an instance
configuration for your custom application. An instance is similar to a category or
server connection. For example, you might wish to create an application that
connects to Salesforce. The instance includes the information for creating the
initial server connection: the server name, a user name, a password, and so forth.
The instance itself does not query for information.
When creating an instance of this event-stream type through the tibbr Web
interface, the user sees the fields created here.
Follow these steps:
1. Go to the newly created application template directory, for example,
TIBBR_HOME/custom_apps/apps/hello_world.
2. Open the application_config.rb file in an editor.
3. Declare the fields by editing the config_field line. Follow this syntax:
config_field :field_name
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
88
| Chapter 4
Custom Event-Stream Applications
config_field :field_name
config_field :field_name
config_field also takes these optional parameters to create a specific HTML
widget with specified values:
config_field :field_name, :ui_type, :label, :description,
:default, :required, :allowed_values, :multi_value,
:has_dependents, :dependency, :filter_value
See Table 39 for a description of the parameters. An example is on page 90.
The fields named password are shown as password text fields.
With the exception of the user name and password fields, tibbr converts
underscores in the field names to spaces and applies the title case when
rendering the field in the Web interface. For example, tibbr displays
hello_world as Hello World in the Web interface.
Table 39 Custom Event-Stream Field Parameters
Parameter Name
Values
Description
:ui_type
:text_field
:select
:checkbox
:password
:subjects
The widget type to render this field.
The :subjects value renders a subject selection text
field, where a user can select one or more subjects.
Use the :select value with :allowed_values and
to offer a list of field values.
:multi_value
:label
String
The text for the label.
:description
String
A description of the field that will be displayed below
the field in the user interface.
:default
String
The default value of the field.
:required
true
or false
The parameter that, if set to true, specifies that the field
is required. If you do not include :required, the
default value is false, that is, the field is not required.
:allowed_values
An array of strings,
an array of two
valued arrays of
strings, or a
combination
A value that is required only if :ui_type is :select. In
the case of an array of two valued arrays of strings, the
first string becomes the value of the selected field. The
second string is for display only.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Procedure 89
|
Table 39 Custom Event-Stream Field Parameters (Cont’d)
Parameter Name
Values
:multi_value
true
or false
:dependency
Reference
:filter_value
String
Description
A value that is required only if :ui_type is :select.
•
If the setting is true, the :allowed_values are
rendered in a table with checkboxes on the left so
that users can select multiple values.
•
If the value is false, a dropbox widget is shown so
that users can select only one value.
A reference to another config_field. This field is
shown only if you change the referenced field value.
Optionally, you can point:filter_value to a specific
value of a referenced field.
A specific value of config_field referenced from the
parameter.
:dependency
:has_dependents
true
or false
The parameter that, if set to true, means that this field
has dependents. The default value is false. You need
not specify this parameter if this field has no
dependents.
4. Specify which fields the user is required to complete when creating an
application instance through the tibbr Web interface. Follow this syntax:
validates_presence_of :field_name, :field_name
Fields not specified here are optional. To create an instance of the application,
the user must complete the required fields.
5. Validate how the fields are completed. Follow this syntax:
validates_format_of :field_name, :with =>
format, :message =>
’error_msg’
where format specifies the field requirements and error_msg is a string (enclosed
in single quotes) that the user sees after attempting to submit an incorrectly
completed form. The user must meet the text format requirements specified
here.
For example, the following declaration results in the Web interface similar to that
shown in Figure 6.
config_field :server, :ui_type => :text_field, :label => "My Server URL", :required
=> true
config_field :port, :required => true
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
90
| Chapter 4
Custom Event-Stream Applications
config_field :user, :ui_type => :text_field
config_field :password, :ui_type => "password"
validates_presence_of :user, :password
Figure 6 Example of a Custom Event-Stream Application
If the user fills out the fields incorrectly, an error message similar to the following
is displayed:
As an example, you can create an HTML widget with specified values by using
the optional config_field parameters that are described in Table 39, as follows:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Procedure 91
|
config_field :record, :ui_type => :select, :label => "Salesforce Record Type",
:has_dependents => true,
:allowed_values =>[["Select", "Select a type ..."],
"Opportunity","Account"], :required => true,
:multi_value => false
config_field :opportunity_filter1, :ui_type => :select, :label => "Close Date"
:description => "Choose a close date to show only opportunities that match it.",
:dependency => :record, :filter_value => "Opportunity",
:allowed_values => [["CloseDate=THIS_QUARTER","This Quarter"],
["CloseDate=LAST_QUARTER","Last Quarter"],
["CloseDate=NEXT_90_DAYS","Next 90 Days"],
["CloseDate=THIS_YEAR","This Year"],
["CloseDate=LAST_FISCAL_QUARTER","Last Fiscal Quarter"],
["CloseDate=NEXT_FISCAL_QUARTER","Next Fiscal Quarter"],
["","None"]], :multi_value => false
validates_presence_of :user, :password
validates_format_of :port, :with => /^\d+$/, :message =>'Enter a valid number'
Task C Edit the application_data_source_config.rb file.
Edit the application_data_source_config.rb template file to create the fields
a user must complete in order to retrieve data from the event-stream instance. The
data source specified here is an implementation of the instance created in Task B.
Any fields that you add in the application_data_source_config.rb file
appear while the user is configuring a new stream under an instance.
Follow these steps:
1. Open in an editor the application_data_source_config.rb file in the lib
subdirectory of the application template directory.
2. Declare the fields by editing the config_field line. Follow this syntax:
config_field :subjects, :field_one, :field_two, :field_three
With the exception of the user name and password fields, tibbr converts
underscores in the field names to spaces and applies title case when rendering the
field in the Web interface. For example, tibbr displays hello_world as Hello
World in the Web interface.
3. Specify the fields the user must complete in the Web interface. Follow this
syntax:
validates_presence_of :field_name, :field_name
The fields that are not specified here are optional.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
92
| Chapter 4
Custom Event-Stream Applications
4. Validate how the fields are completed. Follow this syntax:
validates_format_of :field_name, :with =>
format, :message =>
’error_msg’
where format specifies the field requirements and error_msg is a string (enclosed
in single quotes) that the user sees after attempting to submit an incorrectly
completed form. The user must meet the text format requirements specified
here.
Task D Add implementation code.
Add your implementation code to the application_instance.rb file. This code,
which must be valid Ruby code, is run when a user creates an instance of the
custom event-stream.
Here is an example:
def execute context
messages= context.config.data_sources.map do |ds|
logger.info "launching helloworld application"
["hello #{ds.your_name}",ds.subjects,nil,nil]
end
messages
end
Context Object
The fields in Table 40 are available by default in the context object:
Table 40 Default Fields in context Object
Field
Description
instance
The application instance.
config
The configuration of the application instance.
application
The definition of the application.
current_user
The user ID of the current user.
app_config
The configuration for the application from the
app_config.yml file.
shared_config
The common configuration for all the applications from
the app_config.yml file.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Procedure 93
|
Table 40 Default Fields in context Object (Cont’d)
Java Code
Field
Description
result
The execution result, which is available only in an
after_execute callback.
error
The error information, if any, that was generated during
the previous execution, available only in an
after_execute callback.
You can also call Java code. For details, see—
http://kenai.com/projects/jruby/pages/CallingJavaFromJRuby
Task E Add application icons.
Optionally, you can add icons to the application. If available, the icons display
information on the application event-stream in the tibbr Web interface.
Each application must have three icons, which must match the size requirements
and naming conventions shown in Table 41, where app_name is the name of the
application. tibbr accepts PNG image files only.
Table 41 Custom Application Icons
Image Name
Size
app_name-feed.gif
50x50
app_name-feed-big.gif
130x130
app_name-feed-profile.gif
20x20
To add those icons, place the three PNG files in the
TIBBR_HOME/webclient/public/images/my_streams directory.
Task F Specify the run mode.
You can run the application in isolated or grouped mode by editing the run_mode
line in the app.yml file, for example,
TIBBR_HOME/custom_apps/apps/hello_world/100/app.yml:
# grouped/isolated
run_mode: "grouped"
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
94
| Chapter 4
Custom Event-Stream Applications
The default is grouped. Running in isolated mode means that the application runs
in a host other than the tibbr server.
For isolated mode to take effect, you must also run a separate event-stream
runner with processing parameters by editing the 4_app_runner.sh script in
the scripts directory. For example, for the Oracle Expenses event stream, make
the rake tibbr line in that script read as follows:
rake tibbr:app:runner:start name="Oracle Expenses" version=100
Task G Register the application.
To make the new application available in the tibbr Web interface, register the
application with the tibbr server. Run this script (all on one line):
TIBBR_HOME/tibbr/rake tibbr:app:register name="app_name"
version=release
where app_name is the name of the application and release is its version number. For
example, the following call (all on one line) registers the Hello World
application:
TIBBR_HOME/tibbr/rake tibbr:app:register name="hello world"
version=1.0.0
Task H Restart the tibbr server.
Be sure to restart the tibbr server. Otherwise, users might encounter a Resource
not available error when attempting to access their tibbr pages.
Task I
Verify the Application
Ensure that the application is available as an event stream in the tibbr Web
interface.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
| 95
Chapter 5
Gadgets
tibSmartWidgets (henceforth referred to as tibbr gadgets) are simple UI widgets
that enable accessing tibbr or embedding tibbr into other Web sites. This chapter
describes the gadgets and their deployment options, which enable the gadgets to
interact with one another.
Topics
•
List of Gadgets, page 96
•
Deployment Options, page 110
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
96
| Chapter 5
Gadgets
List of Gadgets
The gadgets in tibbr are as follows:
Wall Messages
My Following
Subject Search
Subject Messages
People Directory
People
tibbr Messages
Subject Directory
User Profile
My Subjects
Post
Subjects
Followers
Wall Messages
The Wall Messages gadget displays the messages for the logged-in user. The URL
for this gadget is http://your_tibbr_domain/a/gadgets/wall_messages.html.
See the following example:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
List of Gadgets 97
|
Subject Messages
The Subject Messages gadget displays the messages for a given subject. You can
pass the subject for which the messages need to be retrieved as part of the
parameter id, for example,
http://your_tibbr_domain/a/gadgets/subject_messages.html?
id=tibbr.help.
The URL for this gadget is
http://your_tibbr_domain/a/gadgets/subject_messages.html?
id=subject-name. See the following example:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
98
| Chapter 5
Gadgets
tibbr Messages
The tibbr Messages gadget contains a My Wall tab and a Search tab that enables
you to search for messages that have been posted on your wall. The URL for this
gadget is http://your_tibbr_domain/a/gadgets/tibbr_messages.html. See the
following example:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
List of Gadgets 99
|
My Subjects
The My Subjects gadget lists the subjects the currently logged-in user is following.
The URL for this gadget is
http://your_tibbr_domain/a/gadgets/my_subjects.html. See the following
example:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
100
| Chapter 5
Gadgets
Followers
The Followers gadget lists all the followers of the subject that you click in any
gadget, for example, a subject on your wall. The URL for this gadget is
http://your_tibbr_domain/a/gadgets/followers.html. In the following
example, as soon as you click Engineering in the My Subjects gadget, the
followers for Engineering are displayed on the right:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
List of Gadgets 101
|
My Following
The My Following gadget lists the people the currently logged-in user is
following. The URL for this gadget is
http://your_tibbr_domain/a/gadgets/my_following.html. See the following
example:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
102
| Chapter 5
Gadgets
People Directory
The People Directory gadget displays the people directory in a tree structure. The
URL for this gadget is
http://your_tibbr_domain/a/gadgets/people_directory.html. See the
following example:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
List of Gadgets 103
|
Subject Directory
The Subject Directory gadget displays the subject directory in a tree structure and
enables you to add subjects or subsubjects. The URL for this gadget is
http://your_tibbr_domain/a/gadgets/subject_directory.html. See the
following example:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
104
| Chapter 5
Gadgets
Post
The Post gadget displays the screen for posting messages on the tibbr wall. The
URL for this gadget is http://your_tibbr_domain/a/gadgets/post.html. See the
following example:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
List of Gadgets 105
|
Subject Search
The Subject Search gadget enables the searching of subjects. The URL for this
gadget is http://your_tibbr_domain/a/gadgets/subject_search.html. See the
following example:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
106
| Chapter 5
Gadgets
People
The People gadget is a combination gadget that lists the people the user is
following (My Following) and his or her followers (My Followers). This gadget
also enables the user to search for people and follow them. The URL for this
gadget is http://your_tibbr_domain/a/gadgets/people.html. See the following
example:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
List of Gadgets 107
|
User Profile
The User Profile gadget enables you to view or edit your profile. If you use this
gadget along with the People gadget and click someone’s name, you can view his
or her profile.
The URL for this gadget is
http://your_tibbr_domain/a/gadgets/user_profile.html. The example below
shows a People gadget at the top. Clicking Abby Bremen displays her profile,
shown at the bottom:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
108
| Chapter 5
Gadgets
Here is an example of the Edit Profile screen:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
List of Gadgets 109
|
Subjects
The Subjects gadget is a combination gadget that lists the subjects the user is
following (My Subjects) and enables the user to search for subjects and follow
them. The URL for this gadget is
http://your_tibbr_domain/a/gadgets/subjects.html. See the following
example:
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
110
| Chapter 5
Gadgets
Deployment Options
Web browsers impose security restrictions on the interactions based on the origins
of the Web pages. Depending on whether or not you can modify your Web site,
you deploy gadgets in either of two modes: on the same domain or on different
domains.
Deployment of tibbr and Your Web Site on the Same Domain
Adopt this deployment mode if you cannot modify the hosting site, such as
embedding the JavaScript code provided by tibbr. In this case, both the Web site
that embeds the tibbr gadgets and the tibbr server proxy through the same proxy
server. That way, Web browsers think that those applications originated from the
same host and thus allow them to communicate with one another.
To use the gadgets in this mode, you need not modify the hosted site itself. All
you need to do is include the gadgets within iframes by pointing to the gadget
URLs.
A sample HTML file that demonstrates how to deploy tibbr gadgets in this mode
is at TIBBR_HOME/tibbr/public/gadgets/InterGadgetDemo.html.
Deployment of tibbr and Your Web Site on Different Domains
Adopt this deployment option to run tibbr and the hosted Web site in different
domains without configuring the external proxy. To run the gadgets in this mode,
instantiate them with the JavaScript API provided by tibbr. Follow these steps:
1. Copy the pagebus directory from the following tibbr installation directory
and host it on your site in which the tibbr gadgets are embedded:
TIBBR_HOME/tibbr/public/gadgets/javascripts/pagebus
2. Instantiate the gadgets with the following script:
var settings = {
tunnelURL:
"http(s)://your_site/a/gadgets/javascripts/pagebus/js/full/tunnel.html",
gadgetURL: "http://your_tibbr_domain/gadgets/",
gadgets: [
{container: "MySubject", name: "my_subject"},
{container: "SubjectsSearch", name: "subject_search"},
{container: "SubjectMessages", name: "subject_messages"}
]
}
TIB.PageBus.gadgets(settings);
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Deployment Options 111
|
A sample HTML file that demonstrates the instantiation is at
TIBBR_HOME/a/gadgets/external/index.html.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
112
| Chapter 5
Gadgets
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
| 113
Chapter 6
Administration Utilities
This chapter describes the administration utilities for modifying tibbr users and
subjects after deployment.
Topics
•
Introducing Utilities, page 114
•
Creating a User Account, page 115
•
Deleting a User Account, page 117
•
Undeleting a User Account, page 118
•
Adding a User to a Role, page 119
•
Adding Administrator to the System, page 120
•
Resetting a Password, page 121
•
Resetting an Email Address, page 122
•
Creating a Subject, page 123
•
Deleting a Subject, page 125
•
Undeleting a Subject, page 126
•
Creating Subscriptions, page 127
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
114
| Chapter 6
Administration Utilities
Introducing Utilities
Administration utilities offer command-line capabilities for revising subjects and
users. You run all the utilities from the TIBBR_HOME/scripts directory, that is, go
to that directory before executing their commands. The syntax is as follows:
./tibbr_util.sh
command
Table 42 lists and describes the utilities.
Table 42 tibbr Administration Utilities
Command
Description
Page
Creating a User Account
Creates a user account with the specified login name, email
address, and first and last names.
115
Deleting a User Account
Deletes the specified user.
117
Undeleting a User Account
Restores a deleted user account.
118
Adding a User to a Role
Adds a user with the specified login name to a role.
119
Adding Administrator to
the System
Adds a user to the system.
120
Resetting a Password
Resets a user’s password.
121
Resetting an Email
Address
Changes a user’s email address.
122
Creating a Subject
Creates a new subject.
123
Deleting a Subject
Deletes a subject.
125
Undeleting a Subject
Restores a deleted subject.
126
Creating Subscriptions
Creates one or more subjects and specifies their subscribers.
127
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Creating a User Account 115
|
Creating a User Account
Creates a user account with the specified login, email address, and name.
If tibbr is in LDAP mode, the administrator cannot create user accounts with this
command-line utility.
Syntax
Parameters
Description
./tibbr_util.sh create_user login=login-name email=address
password=password first_name=first-name last_name=last-name
notify=true|false
Parameter
Description
login=login-name
Required. A unique login name that identifies the
user in tibbr.
email=address
Required. A unique email address for the user.
password=password
Required. The user’s initial password.
first_name=first-name
Required. The user’s first name, for example,
first_name=John.
last_name=last-name
Required. The user’s user’s last name, for example,
last_name=Smith.
notify=true|false
Optional. The parameter that, if set to true, causes an
activation message to be sent to the new user by
email. If you do not specify this parameter, the default
of false applies and tibbr does not send an activation
message to the user.
The create_user command creates a user account with the specified login name
in tibbr. If you set notify to true, tibbr sends an activation email message to the
user, who must then activate the account before using tibbr.
All user data must meet the validation requirements. If the user account already
exists or any of the specified parameters are invalid, tibbr displays an error
message. For more information on validation, see Validation Settings on page 63.
Example
The following example creates a user with the name Tom Riddle, the login name
triddle, and the password secret:
./tibbr_util.sh create_user login=triddle
[email protected] password=secret first_name=Tom
last_name=Riddle notify=true
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
116
| Chapter 6
Administration Utilities
tibbr sends an activation message to [email protected], to which Tom
Riddle must respond to activate his tibbr account.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Deleting a User Account 117
|
Deleting a User Account
Deletes the specified user account.
Syntax
Parameter
Description
Example
./tibbr_util.sh delete_user login=login-name
Parameter
Description
login=login-name
Required. The login name of the user account to be
deleted.
The delete_user command deletes a user account. To restore a deleted user
account, see Undeleting a User Account on page 118.
To delete the account for the user Tom Riddle with the login triddle, run this
command line:
./tibbr_util.sh delete_user login=triddle
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
118
| Chapter 6
Administration Utilities
Undeleting a User Account
Restores a deleted user account.
Syntax
Parameter
./tibbr_util.sh undelete_user login=login-name
Parameter
Description
login=login-name
Required. The login name of a previously deleted user
account.
Description
The undelete_user command restores a user account that has been deleted.
Example
To restore the previously deleted user account for Tom Riddle with the login
triddle, run this command line:
./tibbr_util.sh undelete_user login=triddle
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Adding a User to a Role 119
|
Adding a User to a Role
Adds a user with the specified login name to a role.
Syntax
Parameters
Description
./tibbr_util.sh add_user_to_role role_name=role-name
user_login=login-name
Parameter
Description
role_name=role-name
Required. The name of the admin role.
user_login=login-name
Required. The login name of the user to be added to
a role.
The add_user_to_role command adds a user with the specified login name to a
role.
Both parameters must meet validation requirements. If the user account or role
does not exist, tibbr displays an error message.
Example
To add a user with the login name triddle to a role called guest, run this
command line:
./tibbr_util.sh add_user_to_role role_name=guest
user_login=triddle
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
120
| Chapter 6
Administration Utilities
Adding Administrator to the System
Adds an administrator to the system.
Syntax
Parameters
./tibbr_util.sh create_system_user
Parameter
admin_user:
Description
login-name
admin_password:password
admin_email:
email-address
Required. The login name of the user to be
added to the system.
Required. The initial password of the user to be
added to the system.
Optional. The email address of the user to be
added to the system.
You must set up the above parameters in the server section of the
app_config.yml file.
Description
Example
The create_system_user command creates a user in the system.
To add a user with the login name triddle to the system, first add the following
lines to the server section of the app_config.yml file:
admin_user: triddle
admin_password: triddle
Afterwards, run this command line:
./tibbr_util.sh create_system_user
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Resetting a Password 121
|
Resetting a Password
Resets a user’s password.
Syntax
Parameter
Description
Example
./tibbr_util.sh reset_password email=email-address
Parameter
Description
email=email-address
Required. The email address of the user whose
password you would like to reset.
The reset_password command causes tibbr to send a password-reset message to
the user by email with instructions on how to reset his or her password.
To reset Tom Riddle’s password, run this command line:
./tibbr_util.sh reset_password [email protected]
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
122
| Chapter 6
Administration Utilities
Resetting an Email Address
Changes a user’s email address.
Syntax
Parameters
Description
Example
./tibbr_util.sh reset_email login=login-name email=address
Parameter
Description
login=login-name
Required. The login name of the user whose email address
you would like to change.
email=address
Required. The user’s new email address. The address
must be unique and not in use by another user.
The reset_email command updates a user’s profile with a new email address.
Afterwards, tibbr sends a new activation message to the user by email. Note that
this command only resets the user’s primary email address and does not affect
any channels that the user has configured.
To change Tom Riddle’s email address to [email protected], run this
command line:
./tibbr_util.sh reset_email login=triddle
[email protected]
tibbr then sends an activation message to [email protected].
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Creating a Subject 123
|
Creating a Subject
Creates a new subject.
Syntax
Parameters
./tibbr_util.sh create_subject name=subject-name owner=login-name
description="description-of-subject" scope=public|private|protected
Parameter
Description
name=subject-name
Required. The new subject name, which must not
be already in use. That is, the subject name must
be new to tibbr.
owner=login-name
Required. The login name of the subject owner,
who is the only person who can make changes to
the subject.
description="description-
Optional. A description of the new subject,
enclosed within double quotes. If you do not
specify a value for this parameter, the subject
description is left blank.
of-subject"
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
124
| Chapter 6
Administration Utilities
Parameter
Description
scope=public|private|
Optional. The subject scope, which is either of
these two settings:
protected
•
public
•
private
•
protected — The subject is visible to all users.
However, when a user clicks Follow, tibbr
displays a message, “Waiting for approval,”
and notifies the subject owner of the request
with a message on the left panel. As soon as
the owner clicks that message, a dialog box is
displayed, prompting him or her to approve or
reject the request. Once the owner has clicked
Approve, the requestor’s name and picture (if
uploaded) appear on the Followers list on the
subject page.
— The subject is public, that is, all
users can view and subscribe to the subject.
— The subject is private, that is,
hidden from other users. In order that other
users can subscribe to this subject, the subject
owner must explicitely invite them.
If you do not specify a value for this parameter,
the subject is public and available to all users.
Description
Example
The create_subject command creates a new subject with the specified name,
owned by the specified owner. Optionally, you can add a short description and
define the subject scope. Note that if a subject of the specified name already exists,
the command fails.
To create a private subject owned by the user triddle along with a short
description, run this command line:
./tibbr_util.sh create_subject name=tom.quotes tibbr.silver.dev
owner=triddle description="Motivational sayings for my loyal
followers" scope=private
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Deleting a Subject 125
|
Deleting a Subject
Deletes a subject.
Syntax
Parameter
Description
Example
./tibbr_util.sh delete_subject name="subjet-name"
Parameter
Description
name="subject-name"
Required. The name of the subject you would like to
delete.
The delete_subject command deletes the specified subject. To restore a deleted
subject, follow the procedure described in the section Undeleting a Subject on
page 126.
To delete the subject slytherin.quotes, run this command line:
./tibbr_util.sh delete_subject name="slytherine.quotes"
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
126
| Chapter 6
Administration Utilities
Undeleting a Subject
Restores a deleted subject.
Syntax
Parameter
Description
Example
./tibbr_util.sh undelete_subject name=”subject-name”
Parameter
Description
name=”subject-name”
Required. The name of a subject that was previously
deleted.
The undelete_subject command restores a subject that was previously deleted.
If the subject exists, the command returns a success message irrespective of
whether the subject was deleted earlier. Otherwise, the command displays a
Subject not found error message.
This command restores the deleted subject slytherin.quotes:
./tibbr_util.sh undelete_subject name=”slytherin.quotes”
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Creating Subscriptions 127
|
Creating Subscriptions
Creates one or more subjects and specifies their subscribers.
Syntax
./tibbr_util.sh create_subscription subjects=sub1,sub2
users=login1,login2
To subscribe all users to one or more subjects, run this command:
./tibbr_util.sh create_subscription_for_all_users subjects=sub1,sub2
Parameters
Description
Example
Parameter
Description
subjects=sub1,sub2
Required. The name of one or more subjects for which
to create subscriptions. For multiple subjects, specify
their names in a comma-separated list.
users=login1,login2
Required. The login name of one or more users for
whom to create one or more subscriptions. To create
subscriptions for multiple users, specify the latter’s
login names in a comma-separated list.
The command create_subscription creates subscriptions for one or more
subjects.
To create subscriptions for the subjects sales and marketing for the users
hpotter, rweasley, and hgranger, run this command line:
./tibbr_util.sh create_subscription subjects=sales,marketing
users=hpotter,rweasley,hgranger
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
128
| Chapter 6
Administration Utilities
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
| 129
Chapter 7
Hints and Tips
This chapter contains the frequently asked questions and answers to them, which
you might find helpful for configuring tibbr to your satisfaction.
Topics
•
Q: How do I replace the tibbr logo with my company logo?
•
Q: Can I customize the tibbr skin? If so, how?
•
Q: How do I enable the user hierarchy?
•
Q: How do I disable the Change Password link in an LDAP setup?
•
Q: How do I disable the Invitation to Join tibbr link in the right panel of the
home page?
•
Q: How do I customize the New to tibbr? link?
•
Q: How do I synchronize the user data from LDAP to tibbr?
•
Q: How often should I synchronize user data from LDAP to tibbr?
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
130
| Chapter 7
Hints and Tips
Q: How do I replace the tibbr logo with my company logo?
A: Replace the image file tibbr-logo.png in the
TIBBR_HOME/webclient/public/images directory with an image file that
shows your company logo.
Q: Can I customize the tibbr skin? If so, how?
A: Yes, you can customize the color scheme of the tibbr skin, for example, to
comply with your organization’s preference. Do the following:
1. Create a cascading style sheet (CSS) for tibbr called your-company-name.css in
the tibbr_home/public/stylesheets directory, where tibbr_home is the
location in which you have installed tibbr.
2. Change the following line in the webui section of the
default_app_config.yml file to read as follows:
theme: default to theme:
your-company-name
For an example, see the tibbr_home/webclient/stylesheets/acme.css file.
3. Restart the tibbr server.
Q: How do I enable the user hierarchy?
A: See Display of User Hierarchy on page 76.
Q: How do I disable the Change Password link in an LDAP setup?
A: Set the password_control parameter, which is described in Table 10, LDAP
Server Configuration Parameters (LDAP).
Q: How do I disable the Invitation to Join tibbr link in the right panel of the
home page?
A: Set the join_tibbr parameter, which is described in Table 10, LDAP Server
Configuration Parameters (LDAP).
Q: How do I customize the New to tibbr? link?
A: The New to tibbr? link is displayed in three places:
•
The left panel of the login page
•
The right panel of the home page
•
The section on helpful information in certain email messages from tibbr
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Hints and Tips 131
|
To customize the link:
1. Add a section to the links section in the
tibbr_home/tibbr-config/default_app_config.yml file to read as follows:
Do not add or delete spaces from the lines. The leading hyphen in the first line
denotes list members in YAML syntax.
name: "my_link"
link: my_url
image: image_name
big_image: big_image_name
where:
— my_link is the definition of the my_link parameter in the en.yml file. For
details on that file, see Task B in Localization of tibbr on page 79.
— my_url is the URL of your site.
— image_name is the name of the image file, for example, acme.png, for the
small icons under New to tibbr?. This file must reside in the
tibbr_home/webclient/public/images directory. The maximum
dimensions of the image is 20 x 20 pixels.
— big_image_name is the name of the image file, for example, big_acme.png,
for the icons displayed in the email messages from tibbr. This file must
reside in the tibbr_home/webclient/public/images directory. The
maximum dimensions of the image is 60 x 60 pixels.
Q: How do I synchronize the user data from LDAP to tibbr?
A: See the section Connection to LDAP Server on page 74.
Here is an example of the command (all in one line):
./tibbr_util.sh replicate_ldap_users test=true write_to_file=true
data_output_file=/path/to/log
Here is a sample entry for a user in the log:
#<Net::LDAP::Entry:0x1a84
@myhash=
{:dn=>["CN=tibbr _usr2,CN=Users,DC=tibbr,DC=com"],
:sn=>["_usr2"],
:givenname=>["tibbr"],
:samaccountname=>["tibbr_usr2"],
:mail=>["[email protected]"],
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
132
| Chapter 7
Hints and Tips
:modifytimestamp=>["20110518184640.0Z"]}>
{:email=>"[email protected]",
:first_name=>"tibbr",
:last_name=>"_usr2",
:title=>nil,
:custom_properties=>
{:phone=>nil,
:mobile=>nil,
:modified_at=>"20110518184640.0Z",
:manager=>nil}}
By way of explanation:
•
The section enclosed within the first set of curly braces shows the attributes of
the user from LDAP.
•
The section enclosed within the second set of curly braces is information for
the tibbr database.
Q: How often should I synchronize user data from LDAP to tibbr?
A: New users can log in to tibbr even if you, the administrator, have not run
LDAP synchronization before their initial login. tibbr creates the user account at
first login. However, for good housekeeping, we do recommend that you
schedule a regular chron job to synchronize user data at a frequency that you
prefer.
To set up the chron job, execute these three commands in a Shell script:
./tibbr_util.sh replicate_ldap_users test=false write_to_file=true
data_output_file=/path/to/file
./tibbr_util.sh set_user_hierarchy
./reindex.sh
You need not execute the command for set_user_hierarchy if that hierarchy is
not enabled in your organization.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
| 133
Appendix A
Installation of Oracle Expenses PL/SQL for
the tibbr Event Stream
This appendix describes how to install or uninstall Oracle Expenses PL/SQL for
the tibbr event stream.
This feature is not available in tibbr Community and tibbr Community Service.
Topics
•
Prerequisite, page 134
•
Related Files, page 135
•
Installation Procedure, page 136
•
Uninstallation Procedure, page 137
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
134
| Appendix A
Installation of Oracle Expenses PL/SQL for the tibbr Event Stream
Prerequisite
The Oracle Expenses event stream requires the driver file ojdbc6.jar. For details
on how to download the driver file and where to place it, see Table 3 in the section
Software Requirements on page 2.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Related Files 135
|
Related Files
The following two files in the TIBBR_HOME/external/Oracle/Expenses
directory contain all the scripts for installing Oracle Expenses PL/SQL for tibbr:
•
tibbr.tar
•
installtibbrapi.tar
— This file creates the tibbr user database and the table space.
— This file creates the tibbr API and grants the
necessary permissions from the application to the tibbr schema.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
136
| Appendix A
Installation of Oracle Expenses PL/SQL for the tibbr Event Stream
Installation Procedure
Before installing Oracle Expenses PL/SQL for the tibbr event stream, ensure that
you have installed the Oracle client on the Oracle Application Server.
To install Oracle Expenses PL/SQL for the tibbr event stream:
Currently, this procedure applies to Oracle Application Server Release 11.5.10.
1. Create the tibbr user database and schema, as follows:
a. Untar the tibbr.tar file.
b. Execute tibbr_exec.sql with the following command:
tibbr_exec.sql system_dba_password tns_alias
where system_dba_password is the password of the system database
administrator and tns_alias is the Oracle Transparent Network Substrate
(TNS) name.
Note: Contact your database administrator for the TNS name.
The script then connects to the system schema and prompts you for the
path of the data file.
c. Specify the full path for the data file and enclose the file name within
single quotes.
The tablespace and user name, both called TIBBR, are then created.
2. Grant privileges to the tibbr schema and install Oracle Expenses PL/SQL for
tibbr, as follows:
a. Untar the installtibbrapi.tar file.
b. Connect to the database as the APPS database user in SQL *Plus.
c. Run install_tibbr_api.sql.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Uninstallation Procedure 137
|
Uninstallation Procedure
To uninstall Oracle Expenses PL/SQL for tibbr:
1. Log in as the system database administrator.
2. Execute the following command:
DROP USER TIBBR CASCADE;
The above command deletes all the objects in the tibbr schema.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
138
| Appendix A
Installation of Oracle Expenses PL/SQL for the tibbr Event Stream
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
| 139
Appendix B
Installation of Oracle Order Management
PL/SQL for tibbr
This appendix describes how to install or uninstall Oracle Order Management
PL/SQL for tibbr.
This feature is not available in tibbr Community and tibbr Community Service.
You have two options for installation:
•
Install with the trigger — This process captures all the order status updates.
•
Install without the trigger — This process only captures five order status
updates: Entered, Booked, Wait For Shipping, Shipped, and Closed.
Currently, the procedures described in this appendix apply to Oracle Application
Server Release 12.
Topics
•
Prerequisite, page 140
•
Installation With Trigger, page 141
•
Installation Without Trigger, page 143
•
Uninstallation, page 144
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
140
| Appendix B
Installation of Oracle Order Management PL/SQL for tibbr
Prerequisite
The Oracle Order Management event stream requires the driver file ojdbc6.jar.
For details on how to download the driver file and where to place it, see Table 3 in
the section Software Requirements on page 2.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Installation With Trigger 141
|
Installation With Trigger
To install Oracle Order Management PL/SQL for tibbr with the trigger:
1. Set up the Applications Environment in Oracle Order Management.
2. Copy the Scripts_With_Trigger.tar patch file in the
TIBBR_HOME/external/Oracle/OrderManagement directory to your
staging area.
3. Untar the Scripts_with_Trigger.tar file, which contains the following
files:
—
XXTBR_WSH_DELIVERY_DETAILS_TAB.sql
—
XXTBR_WSH_DELIVERY_DETAILS_SYN.sql
—
XXTBR_WSH_DELIVERY_DETAILS_T1_TRG.sql
—
XXTBR_TAB_TYP.sql
—
XXTBR_TBL_STR_FUNC.sql
—
XXTBR_HDR_URL_FUNC.sql
—
XXTBR_LINE_URL_FUNC.sql
—
XXTBR_OM_ORDER_STATUS_PKG.sql
4. Install as follows:
a. Type the path name for TIBBR_TOP or press Enter to default to the
environment variable.
Note: The path must be a directory. The following subdirectories under that
directory must be writable:
bin
reports
java
log
forms
sql
b. Type the Oracle system ID (SID) or press Enter to default to the
environment variable.
c. Type the password for the tibbr user.
d. Type the password for the APPS user.
Oracle Order Management creates a log file with a date-timestamp in the
log directory under the TIBBR_TOP directory.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
142
| Appendix B
Installation of Oracle Order Management PL/SQL for tibbr
5. Execute an FTP command to transfer the APPS.tar file to the Application
Server.
6. Untar the APPS.tar file in the staging area.
7. Run the install script.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Installation Without Trigger 143
|
Installation Without Trigger
to install Oracle Order Management PL/SQL for tibbr without the trigger:
1. Set up the Applications Environment in Oracle Order Management.
2. Copy the Scripts_Without_Trigger.tar patch file in the
TIBBR_HOME/external/Oracle/OrderManagement directory to your
staging area.
3. Untar the Scripts_with_Trigger.tar file, which contains the following
files:
—
XXTBR_TAB_TYP.sq
—
XXTBR_TBL_STR_FUNC.sql
—
XXTBR_HDR_URL_FUNC.sql
—
XXTBR_LINE_URL_FUNC.sql
—
XXTBR_OM_ORDER_STATUS_PKG.sql
4. Install as follows:
a. Type the path name for TIBBR_TOP or press Enter to default to the
environment variable.
Note: The path must be a directory. The following subdirectories under that
directory must be writable:
bin
reports
java
log
forms
sql
b. Type the Oracle system ID (SID) or press Enter to default to the
environment variable.
c. Type the password for the tibbr user.
d. Type the password for the APPS user.
Oracle Order Management creates a log file with a date-timestamp in the
log directory under the TIBBR_TOP directory.
5. Execute an FTP command to transfer the APPS.tar file to the Application
Server.
6. Untar the APPS.tar file in the staging area.
7. Run the install script.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
144
| Appendix B
Installation of Oracle Order Management PL/SQL for tibbr
Uninstallation
To uninstall Oracle Order Management PL/SQL for tibbr, run the
UNINSTALL_SCRIPT.sql script in the Scripts_With_Trigger.tar or
Scripts_Without_Trigger.tar file.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
| 145
Appendix C
Installation of an SAP Event Stream in tibbr
This appendix describes how to install or uninstall an SAP event stream for tibbr.
You have two options for installation: Create a transport or import an add-on.
This feature is not available in tibbr Community and tibbr Community Service.
Topics
•
Create a Transport, page 146
•
Import an Add-On, page 147
•
Uninstall an SAP Event Stream, page 148
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
146
| Appendix C
Installation of an SAP Event Stream in tibbr
Create a Transport
You can install the SAP event stream in tibbr by creating a transport for the
package ZESN_INT and its objects. Follow this procedure on SAP:
1. Copy the two files (the company file and the data file) for the transport:
a. Copy the company file to •usr•sap•trans•cofiles.
b. Copy the data file to •usr•sap•trans•data.
2. Add a transport through an SAP Transport Management System (STMS)
transaction: Choose STMS > Imports > System.
3. Click Extras > Other Requests > Add > transport-number.
4. Select Transport and click Import Request.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Import an Add-On 147
|
Import an Add-On
Alternatively, you can import an add-on that is certified by SAP. Contact TIBCO
Support for assistance.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
148
| Appendix C
Installation of an SAP Event Stream in tibbr
Uninstall an SAP Event Stream
To uninstall an SAP event stream, execute the transaction SE80 in SAP and delete
the objects in the ZESN_INT package and then the package itself.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
| 149
Appendix D
Installation and Deployment of tibbr on
SharePoint
This appendix contains the procedures for installing and configuring tibbr on
SharePoint and for deploying tibbr there.
Topics
•
Installing and Configuring tibbr on SharePoint, page 150
•
Using tibbr Web Parts, page 152
•
Synchronizing User Profiles, page 155
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
150
| Appendix D
Installation and Deployment of tibbr on SharePoint
Installing and Configuring tibbr on SharePoint
To install tibbr on SharePoint:
Unless otherwise stated, the files referred to in the following steps, such as
tibbrForSharePoint.wsp, reside at
TIBBR_HOME/external/SharePoint/tibbr4sharepoint.
1. Add the solution by running either install2010tibbr.bat or the following
command line:
stsadm -o addsolution -filename tibbrForSharePoint.wsp
2. In SharePoint, deploy the solution:
a. Click System Settings under Central Administration on the left panel and,
on the screen that is displayed, click Manage farm solutions under Farm
Management.
The file tibbrForSharePoint.wsp is displayed in the farm’s solution
store.
b. Click tibbrForSharePoint.wsp and, in the screen that is displayed, click
Deploy Solution.
3. Activate the solution for a site, as follows:
a. On the SharePoint home page, choose Site Actions > Site Settings on the
top left corner.
b. Click Site collection features under Site Collection Administration.
c. In the Features screen that is displayed, click the Activate button next to
the solution name.
4. Add the following line to the appSettings section in the web.xml file in the
C:\inetpub\wwwroot\wss\VirtualDirectories\80 directory:
<add key="BaseURL"
value="http://your-tibbr-server-host-name/a/gadgets/"
/>
The appSettings section then reads as follows:
<appSettings>
<add key="FeedCacheTime" value="300" />
<add key="FeedPageUrl" value="/_layouts/feed.aspx?" />
<add key="FeedXsl1" value="/Style Library/Xsl Style
Sheets/Rss.xsl" />
<add key="ReportViewerMessages"
value="Microsoft.SharePoint.Portal.Analytics.UI.ReportViewerMessag
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Installing and Configuring tibbr on SharePoint 151
|
es, Microsoft.SharePoint.Portal, Version=14.0.0.0,
Culture=neutral, PublicKeyToken=71e9bce111e9429c" />
<add key="BaseURL"
value="http://your-tibbr-server-host-name/a/gadgets/" />
</appSettings>
</configuration>
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
152
| Appendix D
Installation and Deployment of tibbr on SharePoint
Using tibbr Web Parts
tibbr for SharePoint contains 16 Web Parts, as described in Table 43.
Table 43 Web Parts in tibbr for SharePoint
Web Part
Description
Followers
Lists all the followers of the subject the user clicks in any Web Part.
My Followers
Lists the people who are following the user.
My Following
Lists the people the user is following.
My Profile
Enables the user to view or edit his or her profile.
My Subjects
Lists the subjects the user is following.
My Wall
Displays the messages for the user.
People
Lists the people the user is following (My Following) and his or her followers
(My Followers).
People Directory
Displays the people directory in a tree structure.
Post
Displays the screen for posting messages on the tibbr wall.
Search Message
Enables the searching of messages.
Search People
Enables the searching of people.
Search Subject
Enables the searching of subjects.
Subject Directory
Displays the subject directory in a tree structure and enables you to add
subjects or subsubjects
Subject Messages
Displays the messages for a given subject.
Subjects
Lists the subjects the user is following (My Subjects) and enables the user to
search for subjects and follow them.
Messages
Displays the messages for the user and the results from a message search in
the Search tab.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Using tibbr Web Parts 153
|
Navigate to a page in which you would like to place a Web Part and choose Site
Actions > Edit Page on the top left corner.
The Web Parts are listed under tibbr in the Categories column.
To edit the properties of a Web Part, for example, Subjects:
1. Select the Subjects Web Part and click Edit Properties below the top
navigation bar.
The properties of the Subjects Web Part are displayed.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
154
| Appendix D
Installation and Deployment of tibbr on SharePoint
Expanding Gadget Setting displays three fields, as follows:
— Base URL is the URL of the tibbr server.
Note: Do not modify this URL, which is a global configuration.
— Gadgets is a drop-down menu from which you can choose the tibbr gadget
you desire.
— Query String is an optional field in which you can add text for queries, for
example, ?name='Finance'. This field is required, however, for the Subject
Messages Web Part.
2. Edit the other properties, as appropriate, and click OK.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Synchronizing User Profiles 155
|
Synchronizing User Profiles
Follow the steps in this section to synchronize user profiles. This procedure is a
one-way synchronization, which updates the tibbr profile data from SharePoint.
Preparing for Synchronization
To prepare for synchronization:
1. Edit the for
section in the
file in the tibbr_home/tibbr-config directory to
reflect the fields of your SharePoint user profile.
sharepoint profile sync
user_meta_details.yml
Here is part of the default content:
#for sharepoint profile sync
#
ask_me_about:
#
ui_type: "text_field"
#
editable: true
#
required: false
#
searchable: true
#
sync_source: sharepoint
#
map_to: "SPS-Responsibility"
#
position: 1
…
Feel free to add more fields and be sure to map the value of the
map_to parameter to that in the SharePoint user profile schema.
The following example shows the format of the URL to the Web Services
Description Language (WSDL) file in the User Profile Service Web service:
http://SharePoint-server/custom-site/_vti_bin/UserProfileService.asmx
If you do not have a custom site, specify this URL:
http://SharePoint-server/_vti_bin/UserProfileService.asmx
2. Specify the appropriate labels and their values in the en.yml file in the
tibbr_home/tibbr/config/locales directory. Do the following:
a. Locate the join_tibbr label, which has a preset value of Join
enclosed within quotes.
tibbr,
The lines that follow, ask_me_about and so forth, all have preset values:
join_tibbr: "Join tibbr"
ask_me_about: "Ask me about"
past_projects: "Past Projects"
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
156
| Appendix D
Installation and Deployment of tibbr on SharePoint
assistant: "Assistant"
past_projects: "Past Projects"
skills: "Skills"
schools: "Schools"
birthday: "Birthday"
interests: "Interests"
b. Edit the values and add more labels, as appropriate.
Running the Synchronization Command
To synchronize user profiles, go to the tibbr_home/scripts directory and type the
following (all on one line):
./sp_profile_sync.sh host=SharePoint-host-name
user=user-name
password=password test=true|false
For example:
./sp_profile_sync.sh host=sharepoint.tibbr.com user=johnsmith
password=smithpassword test=true
Note the following:
•
The default value for the test option is false, meaning that an update of the
tibbr database will occur. Setting test to true outputs the information
without database updates.
•
The user with the specified user name and password must have read
permission for all user profiles.
Here are a couple of tips:
•
To browse the output in detail later, save it to a file by appending the
command line with a > symbol, followed by the name of the file, for example:
./sp_profile_sync.sh host=sharepoint.tibbr.com user=johnsmith
password=smithpassword test=true > output.txt
•
To synchronize user profiles on a regular basis, set up a Linux cron job.
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
| 157
Index
A
C
adding an administrator to the system 120
administration utilities
adding
a user to a role 119
an administrator to the system 120
creates a subject 123
creating
a user account 115
subscriptions 127
deleting
a subject 125
a user account 117
overview 114
resetting a password 121
resetting an email address 122
restoring a user account 118
undeleting a subject 126
Android, configuration of 70
Apache
HTTP Server
as a proxy server, setup of 10
configuration of 30
Web Server 22
app_config.yml file 34
application configuration tool 7, 34
architectural overview 16
audit log 20
authentication and authorization 20
cache server 22
configuration of 30
overview 17
Change Password link, disabling 130
chat
configuration of 52
server 19
command-line interface 17
configuration
administrator 38
advanced deployments 26
Android 70
authentication 41
banned email subjects 72
BlackBerry 69
chat 52
custom fields for Edit My Profile form 71
database 37
email server 39
event streams
Facebook 60
LinkedIn 59
Oracle Expenses 61
Oracle Order Management 61
B
backup procedure 13
banned email subjects, configuration of 72
BlackBerry, configuration of 69
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
158
| Index
Twitter 60
Facebook 77
files 34
Google analytics 62
LDAP 42
life streams 77
LinkedIn 78
localization settings 69
population of users and user-related data 73
procedures 34
SAML 46
search 49
SharePoint 56, 70
site 50
SMS gateway 55
SSL 75
tibbr Desktop 70
Twitter 77
user 53
validation settings 63
video conference (tibCast) 54
Web UI 50
connecting to LDAP server 74
creating
a subject 123
a user account 115
subscriptions 127
custom event-stream applications, creating 85
customer support xvi, xvi
customizing
New to tibbr? link 130
tibbr logo 130
tibbr skin 130
deleting
a subject 125
a user account 117
deployment of gadgets 110
disabling
Change Password link 130
Join tibbr link 130
SSL 75
D
F
database
configuration of 27, 37
overview 19
database.yml file 35
file system and S3 19
default_app_config.yml file
E
editing Web Parts in SharePoint 153
email server 19
enabling user hierarchy 130
enterprise
deployment
configuration of 26
high-availability 24
high-availability exposed to Internet 25
multinode 23
simple 21
resources 19
event streams
email 18
Oracle Expenses 18
Oracle Order Management 18
RSS 18
runner 18, 22
Salesforce 18
SAP 18
voice memo (tibVoice) 18
34, 35
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Index 159
|
G
integration of information from data sources 19
gadgets (tibSmartWidgets) 95
deployment options 110
Followers 100
list of 96
My Following 101
My Subjects 99
People 106
People Directory 102
Post 104
Subject Hierarchy 103
Subject Messages 97
Subject Search 105
Subjects 109
tibbr Messages 98
User Profile 107
Wall Messages 96
Google analytics, configuration of 62
J
job runner 18, 22
Join tibbr link, disabling 130
L
LDAP
configuration of 27, 42
server, connecting to 74
life streams, configuration of 77
localization
settings 69
tibbr Web interface 79
log, audit 20
H
hierarchical view, enabling of 76
M
migration and upgrade procedure 14
mobile clients 17
I
installation
Oracle Expenses PL/SQL for tibbr
procedure 136
related files 135
Oracle Order Management PL/SQL for tibbr
with trigger 141
without trigger 143
SAP event stream in tibbr
create a transport 146
import an add-on 147
tibbr
on SharePoint 150
procedure 5
requirements 2
supported platforms 4
N
network file system, configuration of 28
New to tibbr? link, customizing 130
O
Oracle Order Management, configuration of 61
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
160
| Index
P
performance tuning 82
R
resetting
a password 121
an email address 122
restore procedure 13, 14
restoring a user account 118
tibbr
Desktop, configuration of 70
logo, replacing 130
server 16, 21
skin, customizing 130
tibCast (audio conferences, video conferences, and
Webinars) 19
TIBCO documentation xvi
TIBCO_HOME xiii
TIBCOmmunity xvi
tibSmartWidgets (gadgets) 95
U
S
SAML, configuration of 46
search server 22
configuration of 28
overview 17
search, configuration of 49
seed.yml file 35
setting up Apache HTTP Server as a proxy server 10
SharePoint
configuration of 56, 70
installation and deployment of 149
Short Message Service (SMS) gateway
configuration 55
overview 19
site, configuration of 50
source files, locales 80
SSL, configuration and disabling 75
stopping and restart of tibbr services 9
support, contacting xvi, xvi
synchronizing
user data from LDAP to tibbr 131, 132
user profiles in SharePoint 155
undeleting a subject 126
uninstallation procedure 12
Oracle Expenses PL/SQL for tibbr 137
Oracle Order Management PL/SQL for tibbr 144
SAP event stream in tibbr 148
user
auto-registration and hierarchy, configuration of 53
data from LDAP to tibbr, synchronizing 131, 132
hierarchy
display of 76
enabling 130
using Web Parts in SharePoint 153
utilities, administration 113
V
validation settings, configuration of 63
video conference (tibCast), configuration of 54
W
T
Web
client 17, 21
UI, configuration of 50
technical support xvi, xvi
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration
Index 161
|
Web Parts
description of 152
using 153
tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration