tibbr and tibbr Service Installation and Configuration · tibbr®, tibbr Service, tibbr Community,...

Two-Second Adv

tibbr®, tibbr Service, tibbr Community, and tibbr Community Service

Installation and ConfigurationSoftware Release 4.0November 2012

antage®

Important Information

SOME TIBCO SOFTWARE EMBEDS OR BUNDLES OTHER TIBCO SOFTWARE. USE OF SUCH EMBEDDED OR BUNDLED TIBCO SOFTWARE IS SOLELY TO ENABLE THE FUNCTIONALITY (OR PROVIDE LIMITED ADD-ON FUNCTIONALITY) OF THE LICENSED TIBCO SOFTWARE. THE EMBEDDED OR BUNDLED SOFTWARE IS NOT LICENSED TO BE USED OR ACCESSED BY ANY OTHER TIBCO SOFTWARE OR FOR ANY OTHER PURPOSE.USE OF TIBCO SOFTWARE AND THIS DOCUMENT IS SUBJECT TO THE TERMS AND CONDITIONS OF A LICENSE AGREEMENT FOUND IN EITHER A SEPARATELY EXECUTED SOFTWARE LICENSE AGREEMENT, OR, IF THERE IS NO SUCH SEPARATE AGREEMENT, THE CLICKWRAP END USER LICENSE AGREEMENT WHICH IS DISPLAYED DURING DOWNLOAD OR INSTALLATION OF THE SOFTWARE (AND WHICH IS DUPLICATED IN THE LICENSE FILE) OR IF THERE IS NO SUCH SOFTWARE LICENSE AGREEMENT OR CLICKWRAP END USER LICENSE AGREEMENT, THE LICENSE(S) LOCATED IN THE “LICENSE” FILE(S) OF THE SOFTWARE. USE OF THIS DOCUMENT IS SUBJECT TO THOSE TERMS AND CONDITIONS, AND YOUR USE HEREOF SHALL CONSTITUTE ACCEPTANCE OF AND AN AGREEMENT TO BE BOUND BY THE SAME.This document contains confidential information that is subject to U.S. and international copyright laws and treaties. No part of this document may be reproduced in any form without the written authorization of TIBCO Software Inc.TIBCO, The Power of Now, TIBCO ActiveMatrix 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-2012 TIBCO Software Inc. ALL RIGHTS RESERVED.TIBCO Software Inc. Confidential Information

| iii

Contents

Figures . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xi

Tables . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xiii

Preface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xv

Related Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvitibbr Documentation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xviThird-Party Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .xvi

Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii

TIBCO Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxHow to Join TIBCOmmunity . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxHow to Access TIBCO Documentation. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xxHow to Contact TIBCO Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xx

Chapter 1 Installation of tibbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .1

Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2System Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Software Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2Libraries . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Installation Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5

Termination and Restart of tibbr Services . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10

Configuration of tibbr to Use Proxy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11

Uninstallation Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13

Backup or Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 14

Upgrade or Restore . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 15

Chapter 2 Architecture and Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .19

Architectural Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20tibbr Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20Web Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Mobile Clients . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Command-Line Interface . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Application Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Cache Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21

tibbr, tibbr Service, tibbr Community, and tibbr Community Service Installation and Configuration

iv | Contents

Apache Cassandra Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 21Search Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Job Runner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Application Runner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 22Chat Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Audio Conferences, Video Conferences, and Webinars . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Enterprise Data-Source Integration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Enterprise Resources . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 23Audit Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 24

Simple Enterprise Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26tibbr Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Web Client . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 26Job Runner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Cache Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Search Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 27Application Runner . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28Apache Web Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 28

High-Availability Deployment. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Configuration of Advanced Deployments . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Requirements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Installation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Virtualization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30Network Connectivity Between Machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Disk I/O . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Configuration of Load Balancer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Configuration of Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Configuration of LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 31Configuration of Shared Network File System. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33Configuration of Search Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34Configuration of Cassandra Cluster. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37Configuration of Multiple Cache Servers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 39Configuration of Apache HTTP Server as Load Balancer . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40

Test of Deployment . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42

Chapter 3 Configuration, Localization, and Performance Tuning . . . . . . . . . . . . . . . . . . . . . . . 43

Configuration Files and Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Mechanics of Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 44Related Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45Database Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47Administrator Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48Email Server Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50Group Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53Subject Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54


Contents | v

Authentication Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54tibCast Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65Site Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66Application Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 67Server Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73tibbr-Server Connection Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73Validation Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74Web UI Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80Chat Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 83User Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84Google Analytics Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Message Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86Channel Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Exception-Notification Configuration. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87Poll Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Branding Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88Search Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Multitenancy Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89Localization Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 90BlackBerry Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91Android Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Configuration of tibbr Desktop . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Configuration of Fields in Edit Profile Form . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 92Configuration of Banned Email Subjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 94Population of Users and User-Related Data. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Connection to LDAP Server. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 96

Configuration and Disabling of SSL . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 97

Display of User Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 98

Localization of tibbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 99

Performance Tuning . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 102

Chapter 4 Custom Applications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .105

Overview . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 106

Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 107

Chapter 5 Configuration of SharePoint for tibbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .115

Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

Installation of SharePoint Custom Web Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 118

Configuration of REST Service . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 119

Configuration of SharePoint Link . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Configuration of SharePoint Web Services for SSO . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 122


vi | Contents

Template Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Chapter 6 Customization of tibbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 129

Theme. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 130

Email Template . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 132

Home Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Top Navigation Bar. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 133Left Panel. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134Right Panel . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 134

More Menu . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 138

Login Page . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 139

Mobile and Desktop Branding . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 141

Chapter 7 Gadgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 143

Available Gadgets . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 144Wall Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 145Announcements . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 147Subject Messages . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 148tibbr Messages. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 149Message Delivery . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 150My Subjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 151Followers . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 152My Following . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 153People Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 154Subject Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 155Post . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 156Subject Search . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 157People . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 158User Profile . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 159Subjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 161SharePoint Search. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 162

Deployment Options . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Deployment of tibbr and Your Web Site on Same Domain . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164Deployment of tibbr and Your Web Site on Different Domains. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 164

Chapter 8 Administration Utilities. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 167

Introducing Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Caching User Data . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 172

Creating a User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 173

Deleting a User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 175

Undeleting a User Account . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 176


Contents | vii

Changing a User Login . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 177

Resetting a Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 178

Encrypting a Password . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 179

Resetting an Email Address. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 180

Enabling Applications for All Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 181

Enabling All Or Certain Users to Follow the Specified Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 182

Enabling All Or Certain Users to Unfollow the Specified Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 183

Replicating User Data from LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 184

Replicating Group Data from LDAP . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 186

Creating a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 188

Adding Members to a Group . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 189

Generating Influence Scores . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 190

Adding a User to a Role. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 191

Adding an Administrator to the System . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 192

Adding Banned Words From the Specified Text File . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 193

Indexing tibbr Content . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 194

Creating a Subject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 195

Deleting a Subject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 197

Undeleting a Subject . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 198

Creating Subscriptions for Subjects. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 199

Removing Subscriptions From Subjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 200

Adding Owners to Subjects From CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 201

Creating Subjects From CSV. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 202

Creating Subscriptions From CSV . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 203

Setting a Subject Hierarchy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 204

Enabling Manage Pages Option for All Subjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 205

Merging Subjects . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 206

Creating Email Channels for All Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 207

Creating Notifications on Subjects for All Users . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 208

Creating Notifications on Specified Subjects for All Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 209

Enabling Push Notifications . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 210

Creating a Filter for All Users. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 211

Recovering Delayed Jobs . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 213

Chapter 9 Monitoring of tibbr Processes. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .215

Core Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 216


viii | Contents

Web Client. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 217

Memcached. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 218

Job Runners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

Search Engine . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 220

Chat Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 221

Apache HTTP Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 222

Chapter 10 Authentication. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 223

Database. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

Active Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

SSO Through a Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

SSO Through SAML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 228

Mixed Mode. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 230

Chapter 11 Multitenancy . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 231

Multitenant Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 232

Database Configuration and Support . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 233

Tenant-Specific Configurations . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 234

Chapter 12 Hints and Tips . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 235

Appendix A Installation of Oracle Expenses PL/SQL for the tibbr Application . . . . . . . . . . . 239

Prerequisite . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 240

Related Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 241

Installation Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 242

Uninstallation Procedure . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 243

Appendix B Installation of an SAP Application in tibbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 245

Create a Transport . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 246

Import an Add-On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 247

Uninstall an SAP Application. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 248

Appendix C Installation and Deployment of tibbr on SharePoint . . . . . . . . . . . . . . . . . . . . . . 249

Installing and Configuring tibbr on SharePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 250

Using tibbr Web Parts . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252

Synchronizing User Profiles . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255Preparing for Synchronization . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 255


Contents | ix

Running the Synchronization Command . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 256

Importing tibbr SharePoint Sites . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 257

Appendix D SSO Authentication for tibbr Through IWA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .259

Architecture . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260

Configuration of IWA . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 261

Installation and Configuration of AAR . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 267

Configuration of Secure tibbr Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 274

Appendix E SSO Authentication for tibbr Through Apache . . . . . . . . . . . . . . . . . . . . . . . . . . .275

Configuration of mod_auth_tkt. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 276

Configuration of Secure tibbr Access. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 278

Index . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .279


x | Contents


Figures | xi

Figures

Figure 1 High-Level Architecture and Associated Components . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 20

Figure 2 High-Availability Deployment on Separate Machines . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29

Figure 3 Fault-Tolerant Search Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 34

Figure 4 Example of a Custom Event-Stream Application . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 110

Figure 5 Authentication Through the Database . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 224

Figure 6 Authentication Through Active Directory . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 225

Figure 7 Authentication for SSO Through a Web Server . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 226

Figure 8 Authentication for SSO Through SAML . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 229

Figure 9 Windows Integrated Authentication for tibbr . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 260


xii | Figures


Tables | xiii

Tables

Table 1 General Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xvii

Table 2 Syntax Typographical Conventions . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . xviii

Table 3 Linux Libraries by Binary . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 3

Table 4 Examples of Copying Configuration Directories in a tibbr Upgrade . . . . . . . . . . . . . . . . . . . . . . . . 15

Table 5 Configuration Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45

Table 6 Database Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 47

Table 7 Administrator Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49

Table 8 Email Server Configuration Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 50

Table 9 Group Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 53

Table 10 Subject Configuration Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 54

Table 11 Authentication Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 55

Table 12 SSO Configuration Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 56

Table 13 LDAP Server Configuration Parameters (LDAP) . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 57

Table 14 Authentication Configuration Parameters (Mapping Between LDAP and tibbr User Attributes) . . 59

Table 15 Authentication Configuration Parameter (LDAP Groups). . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 61

Table 16 SAML Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 62

Table 17 Video Conference Configuration Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 65

Table 18 Site Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 66

Table 19 LinkedIn Configuration Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Table 20 Facebook Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 71

Table 21 Twitter Configuration Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Table 22 Oracle Expenses Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 72

Table 23 Server Configuration Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Table 24 tibbr-Server Connection Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 73

Table 25 User Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 74

Table 26 Web UI Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 80

Table 27 Chat Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 84

Table 28 User Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 85


xiv | Tables

Table 29 Google Analytics Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Table 30 Message Configuration Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 86

Table 31 Channel Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Table 32 Exception-Notification Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 87

Table 33 Poll Configuration Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Table 34 Branding Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 88

Table 35 Search Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Table 36 Multitenancy Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 89

Table 37 Localization Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 91

Table 38 Configuration Parameters for the Edit Profile Form. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Table 39 Meta Data of User Properties . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 93

Table 40 User Configuration Parameters . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 95

Table 41 tibbr Source Files for Locales . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 100

Table 42 Staging Locations for Localization Files . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 101

Table 43 Maximum Threads and Maximum Waiting Users in Tomcat Server . . . . . . . . . . . . . . . . . . . . . . . 102

Table 44 Custom Event-Stream Field Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 108

Table 45 Default Fields in context Object . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 112

Table 46 Custom Application Icons . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 113

Table 47 SharePoint Configuration Parameters. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 116

Table 48 SharePoint Link Parameter . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 121

Table 49 SharePoint Server Template Types . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 126

Table 50 tibbr Administration Utilities . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 169

Table 51 Priority Numbers for Job Runners . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 219

Table 52 tibbr Web Parts for SharePoint . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 252


| xv

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 xvi

• Typographical Conventions, page xvii

• TIBCO Resources, page xx


xvi | Related Documentation

Related Documentation

This section lists documentation resources you might find useful.

tibbr DocumentationThe following documents form the tibbr documentation set:

• tibbr, tibbr Service, tibbr Community, and tibbr Community 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, tibbr Service, tibbr Community, and tibbr Community 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 applications, 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, tibbr Service, tibbr Community, and tibbr Community Service Release Notes This document describes the new and changed features and known and closed issues for the current release.

In addition, the tibbr API Reference manual, previously available as part of the documentation set, is now on developers.tibbr.com.

Third-Party DocumentationRead about the YAML data serialization standard at http://www.yaml.org/ and http://en.wikipedia.org/wiki/YAML.


http://www.yaml.org/

http://en.wikipedia.org/wiki/YAML

Preface | xvii

Typographical Conventions

The following typographical conventions are used in this manual.

Table 1 General Typographical Conventions

Convention Use

ENV_NAME

TIBCO_HOME

ProductAcronym_HOME

TIBCO products are installed into an installation environment. A product installed into an installation environment does not access components in other installation environments. Incompatible products and multiple instances of the same product must be installed into different installation environments.

An installation environment consists of the following properties:

• Name Identifies the installation environment. This name is referenced in documentation as ENV_NAME. On Microsoft Windows, the name is appended to the name of Windows services created by the installer and is a component of the path to the product shortcut in the Windows Start > All Programs menu.

• Path The folder into which the product is installed. This folder is referenced in documentation as TIBCO_HOME.

TIBCO ProductName installs into a directory within TIBCO_HOME. This directory is referenced in documentation as ProductAcronym_HOME. The default value of ProductAcronym_HOME depends on the operating system. For example, on Windows systems, the default value is C:\tibco\ProductAcronym\ReleaseNumber.

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]


xviii | Typographical Conventions

italic font Italic font is used in the following ways:

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

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

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

Key combinations

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

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

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

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

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

Table 1 General Typographical Conventions (Cont’d)

Convention Use

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


Preface | xix

{ } 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}

Table 2 Syntax Typographical Conventions (Cont’d)

Convention Use


xx | TIBCO Resources

TIBCO Resources

You have three ways in which to connect with TIBCO’s resources.

How to Join TIBCOmmunityTIBCOmmunity is an online destination for TIBCO customers, partners, and resident experts. It is 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 TIBCO DocumentationYou can access the documentation for many supported product versions here:

http://docs.tibco.com

How to Contact TIBCO SupportFor 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.


http://www.tibcommunity.com

http://docs.tibco.com

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

https://support.tibco.com

| 1

Chapter 1 Installation of tibbr

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

• Termination and Restart of tibbr Services, page 10

• Configuration of tibbr to Use Proxy, page 11

• Uninstallation Procedure, page 13

• Backup or Restore, page 14

• Upgrade or Restore, page 15

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 manual contains several mentions of the Web client. Note that its capability is now part of the tibbr server. A Web-client process is active for the administrator capabilities only, which will be phased out once they have been incorporated into the tibbr server.


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 RequirementsFollowing are the system requirements for a single node of tibbr server:

• Free disk space 20 GB

• Memory 12 GB of RAM.

• CPU Two quad core server processors at 3.0 GHz for each core

• Clean installation environment Do not install any significant third-party software or other TIBCO software on the system.

Software RequirementsFollowing are the software requirements for the Web version of tibbr and for tibbr Desktop.

For Web version of tibbr

The Web version of tibbr requires the following software:

• A supported Database Management System and driver, that is, an empty database instance and a user name and password with full read-write permissions. tibbr supports the following data management systems:

— Microsoft SQL Server

— MySQL

— Oracle 11g

For details on the supported versions and the drivers along with the download location, see the readme.

• A Web browser for access of the tibbr interface. For details on the supported versions, see the readme.

In addition, if you plan to connect tibbr to your company’s Lightweight Directory Access Protocol (LDAP) server, use Microsoft Active Directory for LDAP.


Requirements | 3

For tibbr Desktop

tibbr Desktop requires Adobe AIR 2 or later. For the latest download, go to http://get.adobe.com/air.

Librariestibbr supports both the 32-bit and 64-bit versions of Red Hat Enterprise Linux Server (Tikanga) 5.4 and 5.6. Table 3 lists the Linux libraries required by tibbr.

Table 3 Linux Libraries by Binary

64-Bit 32-Bit

imagemagick

ld-linux-x86-64.so.2 libk5crypto.so.3 ld-linux.so.2 libk5crypto.so.3

libavahi-client.so.3 libkeyutils.so.1 linux-gate.so.1 libkeyutils.so.1

libavahi-common.so.3 libkrb5.so.3 libavahi-client.so.3 libkrb5.so.3

libavahi-glib.so.1 libkrb5support.so.0 libavahi-common.so.3 libkrb5support.so.0

libbz2.so.1 libm.so.6 libavahi-glib.so.1 libm.so.6

libcairo.so.2 libnsl.so.1 libbz2.so.1 libnsl.so.1

libcap.so.1 libORBit-2.so.0 libcairo.so.2 libORBit-2.so.0

libcom_err.so.2 libpango-1.0.so.0 libcap.so.1 libpango-1.0.so.0

libcroco-0.6.so.3 libpangocairo-1.0.so.0 libcom_err.so.2 libpangocairo-1.0.so.0

libcrypto.so.6 libpangoft2-1.0.so.0 libcroco-0.6.so.3 libpangoft2-1.0.so.0

libc.so.6 libpng12.so.0 libcrypto.so.6 libpng12.so.0

libdbus-1.so.3 libpthread.so.0 libc.so.6 libpthread.so.0

libdbus-glib-1.so.2 libresolv.so.2 libdbus-1.so.3 libresolv.so.2

libdl.so.2 librsvg-2.so.2 libdbus-glib-1.so.2 librsvg-2.so.2

libexpat.so.0 librt.so.1 libdl.so.2 librt.so.1

libfontconfig.so.1 libselinux.so.1 libexpat.so.0 libselinux.so.1

libfreetype.so.6 libsepol.so.1 libfontconfig.so.1 libsepol.so.1

libgconf-2.so.4 libSM.so.6 libfreetype.so.6 libSM.so.6

libgdk_pixbuf-2.0.so.0 libssl.so.6 libgconf-2.so.4 libssl.so.6

libglib-2.0.so.0 libtiff.so.3 libgdk_pixbuf-2.0.so.0 libtiff.so.3



libgmodule-2.0.so.0 libutil.so.1 libglib-2.0.so.0 libutil.so.1

libgnomevfs-2.so.0 libX11.so.6 libgmodule-2.0.so.0 libX11.so.6

libgobject-2.0.so.0 libXau.so.6 libgnomevfs-2.so.0 libXau.so.6

libgomp.so.1 libXdmcp.so.6 libgobject-2.0.so.0 libXdmcp.so.6

libgssapi_krb5.so.2 libxml2.so.2 libgsf-1.so.114 libxml2.so.2

libgsf-1.so.114 libXext.so.6 libgomp.so.1 libXext.so.6

libgthread-2.0.so.0 libXrender.so.1 libgsf-1.so.114 libXrender.so.1

libICE.so.6 libXt.so.6 libgthread-2.0.so.0 libXt.so.6

libjpeg.so.62 libz.so.1 libICE.so.6 libz.so.1

libjpeg.so.62

lua

libreadline.so.5 linux-gate.so.1 libhistory.so.5

libncurses.so.5 libm.so.6 lisbncurses.so.5

libdl.so.2 libc.so.6

libreadline.so.5 ld-linux.so.2

libncurses.so.5

memcached

linux-gate.so.1 libc.so.6

libpthread.so.0 ld-linux.so.2

Table 3 Linux Libraries by Binary (Cont’d)

64-Bit 32-Bit


Installation Procedure | 5

Installation Procedure

You can install tibbr as root or nonroot.

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

• By default, the Apache port number is set to 80 (for HTTP) or 443 (for HTTPS). If you are not running as root, Apache with the default port number would fail at startup. As a resolution, change the port number to a value that is greater than 1000.

• Keep your installation directory path short, for example, /opt/tibco4.x. A long path such as /home/root/products/tibbr/newversion often leads to an incorrect display of job processes.



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.

• 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 the readme for the supported database drivers and download location.

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.

Ensure that your machine is connected to the Internet.

Ensure that the database encoding is UTF8, which supports multiple languages. For example, in MySQL, set the collation to UTF8-generic while creating the database.



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 47 — Configure the database in the production segment of the database.yml file.

Administrator Configuration. on page 48 — 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 48 — Configure the primary tibbr administrator in the default section of the app_config.yml file.

Email Server Configuration on page 50 — Configure the email server in the email segment of the app_config.yml file.

LDAP Configuration on page 56 — 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.

• By setting the parameters from the Web-based application configuration manager, which you can start as soon as installation is complete.

To start the application configuration manager, first execute the scripts as described in Task B, Download and install external libraries. Afterwards, do the following:

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 spaces alters the indentation and invalidates the YAML configuration, causing the installation process to fail.



a. Go to the tibbr_home/scripts directory.

b. Run the start_configure.sh script. Type:

./start_configure.sh

c. Start the application configuration manager. Go to the following URL on your browser:

http://your_tibbr_domain-or-IP_address:7777

d. Log in with the tibbradmin user name and password.

For advanced settings, see Chapter 3, Configuration, Localization, and Performance Tuning.

Task E Set the file-descriptor limit.

To optimize tibbr’s performance, set the file-descriptor limit to 100,000:

• If you are running as root, comment out the ulimit line in the tibbr_home/scripts/env.sh file.

• If you are running as nonroot, set the limit by adding the following line to the /etc/security/limits.conf file:

user-name hard nofile limit

where:

— user-name is the login name of the user who is running the tibbr process.

— limit is the maximum number of file descriptors.

Here is an example:

tibbr hard nofile 100000

Task F 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 G 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 H 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 I 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.

For this first login attempt, the user name you specified serves as both the login name and password.

To update the administrative configurations after starting tibbr, run the utilities described in Chapter 8, Administration Utilities.

To stop the tibbr services, see the next section, Termination and Restart of tibbr Services.



Termination 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 G, Run the startup script.


Configuration of tibbr to Use Proxy | 11

Configuration of tibbr to Use Proxy

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-IP- address -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_home/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

where prefix is the location in which the Apache HTTP Server is installed.



2. Run the following commands to install and enable the modules that are required for proxy setup:makemake install

For our purpose, we will use the mod_proxy and mod_proxy_http modules from here on. 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.soLoadModule proxy_http_module /etc/apache2/modules/mod_proxy_http.soProxyRequests OnProxyVia 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>

4. Start your Apache HTTP Server.

Henceforth, we will assume that /etc/apache2 is the location for the Apache installation. You can replace it with your location, as appropriate.

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.


Uninstallation Procedure | 13

Uninstallation Procedure

To uninstall tibbr or another TIBCO product on TIBCO_HOME:

1. Go to the universal_installer directory:

cd TIBCO_HOME/tools/universal_installer

2. Run the following command to invoke the installer’s maintenance mode:

./TIBCOUniversalInstaller-platform-id.extension

The maintenance mode performs a database update through which you can uninstall tibbr or another TIBCO product.



Backup or Restore

To back-up your tibbr database:

1. Stop all the tibbr processes. For the related command, see Termination and Restart of tibbr Services on page 10.

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/3.5.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 Termination and Restart of tibbr Services on page 10.


Upgrade or Restore | 15

Upgrade or Restore

To upgrade to a new tibbr release:.

1. Stop all the tibbr processes in the current tibbr installation, for example, /opt/tibco/tibbr/4.0.0. For the related command, see Termination and Restart of tibbr Services on page 10.

2. Make a backup copy of the database.

3. Follow Task A through Task E in the section Installation Procedure on page 5 to install the new version of tibbr in a new path, for example, /opt/tibco/tibbr/4.0.0.

4. Ensure that no other tibbr processes are running.

5. Manually copy the following configuration directories to the new installation. Table 4 shows an example.

Table 4 Examples of Copying Configuration Directories in a tibbr Upgrade

Copy From Copy To

TIBCO_HOME/tibbr/previous_version_number/tibbr-config/assets

TIBCO_HOME/tibbr/current_version_number/tibbr-config/shared/assets

TIBCO_HOME/tibbr/previous_version_number/tibbr-config/assets_protected

TIBCO_HOME/tibbr/current_version_number/tibbr-config/shared/assets_protected

TIBCO_HOME/tibbr/previous_version_number/tibbr-config/salesforce

TIBCO_HOME/tibbr/current_version_number/tibbr-config/shared/salesforce

TIBCO_HOME/tibbr/previous_version_number/tibbr-config/locales

TIBCO_HOME/tibbr/current_version_number/tibbr-config/shared/locales

TIBCO_HOME/tools/tomcat/webclient/webapps/ROOT (for tibbr desktop)

TIBCO_HOME/tibbr-config/shared/downloads

TIBCO_HOME/tools/tomcat/webclient/webapps/ROOT (for Android)

TIBCO_HOME/tibbr-config/shared/downloads

TIBCO_HOME/tools/tomcat/webclient/webapps/ROOT/bb5.0 (for BlackBerry)

TIBCO_HOME/tibbr-config/shared/downloads/bb5.0

TIBCO_HOME/tibbr/previous_version_number/tibbr-config/cassandra

TIBCO_HOME/tibbr/current_version_number/tibbr-config/cassandra



6. On the machines that are running Cassandra, copy the Cassandra data from the TIBCO_HOME/tibbr/previous_version_number/tibbr-config/cassandra directory to the TIBCO_HOME/tibbr/current_version_number/tibbr-config/cassandra directory.

7. On the machines that are running Solr, copy the Solr data from the TIBCO_HOME/tibbr/previous_version_number/tibbr-config/solr directory to the TIBCO_HOME/tibbr/current_version_number/tibbr-config/solr directory.

8. Identify the customizations (style sheets, translation files, and such) by running the diff command and merge them to the new installation path.

9. Follow Task F through Task I in the section Installation Procedure on page 5.

10. Reindex the tibbr content by running the reindex.sh script in the scripts directory at TIBCO_HOME/tibbr/release_number/scripts, for example, /opt/tibco/tibbr/3.6.0/scripts:

./reindex.sh

If you edited the following .yml files in a previous installation, those files now reside in the TIBCO_HOME/tibbr/current_version_number/tibbr-config/shared/config directory:

config_defination.ymlcustom_config_defination.ymlemail_template.ymlgroup_meta_details.ymllink_patterns.ymlseed.ymlseed_community.ymlseed_hierarchy.ymlsso_auth_config.ymltenant_seed.ymltenant_seed_prod.ymlui.ymluser_data_seed.ymluser_meta_details.ymlversion.yml

You might want to verify that they contain all your updates. If not, input your edits but do not replace the files with those from a previous installation.

The same case applies to the assets_content_types.yml file, which is now in the TIBCO_HOME/tibbr/current_version_number/tibbr-config/shared directory. Again, do not replace this file with one from a previous installation; just input your edits there.


Upgrade or Restore | 17

To restore the earlier version:

1. Stop all the tibbr processes in the latest installation, for example, /opt/tibco/tibbr/3.6.0.

2. Restore the database from the backup copy.

3. Start the tibbr processes in the older installation, for example, /opt/tibco/tibbr/3.5.0.




| 19

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 20

• Simple Enterprise Deployment, page 26

• High-Availability Deployment, page 29

• Configuration of Advanced Deployments, page 30

• Test of Deployment, page 42


20 | 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 ServerThe 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, applications, and utilities. All content data, including messages, subjects, and user information, is stored in the database by means of Java Database Connectivity (JDBC).


Architectural Overview | 21

Web ClientThe 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 ClientsMobile 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 InterfaceThe 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.

Application ServerThe application server runs the tibbr applications, such as Ideation.

Cache ServerBy 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.

Apache Cassandra ServerThe Apache Cassandra server stores and manages user notifications and access analytics.



Search ServerA search server enables users to search tibbr for information, such as the user’s messages, subjects, or people.

Job RunnerThe job runner, a daemon process that runs in the background, performs offline and scheduled tasks for the tibbr server. Examples of offline tasks are distribution of messages to specific user inboxes and dispatch of email notifications configured by the user.

Application RunnerWith applications, you can configure and receive events into tibbr from enterprise applications that you run day to day. Each application is a tibbr plug-in that integrates with a specific enterprise application. The application runner is a daemon process that runs the applications configured by you on a scheduled basis.

Applications 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 such sites 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 application 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 application 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 application reads events from SAP and publishes them as messages to a tibbr subject.

• SharePoint Document The SharePoint Document application maps SharePoint feeds to tibbr subjects.

• Oracle Expenses The Oracle Expenses application enables you to browse the details of your expense reports and, if you are a people manager, approve your staff’s expense reports.



• Voice Memo The Voice Memo (also known as tibVoice) application enables the posting of voice messages in the form of audio files on tibbr.

Chat ServerThe 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 WebinarsYou 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.

Enterprise Data-Source IntegrationYou can integrate information from structured or unstructured data sources and corporate Web services with tibbr through TIBCO BusinessWorks and the tibbr API.

Enterprise Resourcestibbr 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.

The Salesforce, SAP, Oracle Expenses, Orale Order Management, and voice memo features are not available in tibbr Community and tibbr Community Service.



• Email server tibbr sends email messages for both account management and notifications through a Simple Mail Transfer Protocol (SMTP) server. In 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 56.

— 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 62.

Audit Logtibbr 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 login name of the related user or, if the task is performed by someone who impersonated the user, the login 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.



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 ServerThe 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 ClientOver 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.


Simple Enterprise Deployment | 27

Job RunnerThe 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 ServerThe cache server stores user message information in memory for faster content delivery. By default, this server runs on port 11211.

Search ServerThe 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.

The reindex script (reindex.sh) in the tibbr_home/scripts directory reindexes the database in Apache Solr, tibbr’s search engine, in which user-interface updates are automatically indexed. The data models that are indexed by the script are as follows:

To synchronize the search index after running back-end scripts, such as LDAP sync and sharepoint profile sync, which only update the database but not the search index, run the reindex script. Go to the scripts directory and type:./reindex.sh

ApplicationInstance Link Subscription

Asset Message Subject

Follower Role User

For details on LDAP sync and sharepoint profile sync, see Connection to LDAP Server on page 96 and Synchronizing User Profiles on page 255, respectively.



To have the script index certain data models only, edit the following line in the reindex.sh file:

jruby -S rake tibbr:search_reindex[batch-size,ApplicationInstance+Asset+Role+Subscription+Subject+User+Follower+Message+Link] siteconfig=$siteconfig --trace

where batch-size is 500 by default. In case of problems with the Java Virtual Machine’s heap size, reduce that number.

Application RunnerOn a scheduled basis, the application runner runs the applications that you configure and interacts with the tibbr server through the latter’s API.

Apache Web ServerIn 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.


High-Availability Deployment | 29

High-Availability Deployment

Figure 2 shows the high-availability deployment mode with utility processes on separate machines.

Figure 2 High-Availability Deployment on Separate Machines



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, the search server, and the cache server. In addition, set up the Apache HTTP Server as a load balancer.

For a description of the tibbr components, see Architectural Overview on page 20.

RequirementsThis 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 the Apache HTTP 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.

• Application runner The application runner process must run on each machine.

In addition, an instance of the Apache HTTP Server or another load balancer must be running to load-balance the Tomcat server instances.

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

VirtualizationEnsure that the virtualization host’s physical hardware has sufficient resources to provide the maximum allotted CPU and memory, when required, for each of the virtual machines. For example, to handle the peak load, four virtual machines each with two cores and 8 GB of RAM would need eight cores and 32 GB of RAM physical resources on the host machine. Additional resources might be necessary to offset the virtualization software’s computing needs.


Configuration of Advanced Deployments | 31

Check the virtual machine-to-host resource ratio and consult your virtualization vendor for the best ratio.

Network Connectivity Between MachinesWe recommend 1 GBPS network connectivity among the tibbr servers. Ensure that the network latency is at its minimal among those servers. Sizing guidelines are based on a network latency of approximately 1 ms.

Disk I/OIn addition to CPU and memory configuration, disk I/O performance is important for the tibbr database machine and for the machine that hosts the tibbr files (assets and assets_protected). tibbr sizing guidelines are based on disks that are running at 7,500 RPM.

The following sections describe additional configurations for the high- availability and load-balanced environment.

Configuration of Load BalancerBecause tibbr supports configuration of nonsticky sessions, we recommend that you configure the load balancer in nonsticky session mode for optimal load balancing.

Configuration of DatabaseDifferent 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 LDAPOptionally, 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: host-name (for example, ldap.example.com)port: 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, 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.

To configure multiple LDAP domains, edit the domains parameters in the ldap section, which is a subset of the authentication segment in the tibbr-config/app_config.yml file:

domains:domain_name11:

base: OU=Organization1,DC=example,DC=com2

search_filter: '(employeeNumber=*)'3

1This is domain name from your LDAP server.2This is the description of the base parameter in the ldap section for domain_name1. See Table 13.3This is the description of the search_filter parameter in the ldap section for domain_name1. See Table 13.

By default, the following lines are commented out. Uncomment them before editing.



Configure more domains, as appropriate, for example:

domains:

domain_name2:base: OU=Organization1,DC=example,DC=com

search_filter: '(employeeNumber=*)'

Optionally, also configure the following parameters for the various domains:

• host:

• port:

• admin_dn:

• admin_password:

• ssl:

For details, see Table 13.

Configuration of Shared Network File SystemRecall 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:

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.

Directory Description

tibbr_home/tibbr-config/assets Stores user and subject images.

tibbr_home/tibbr-config/asset-protected Stores the attachments uploaded with messages.



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 ServersFor 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 3.

Figure 3 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.

Following is the procedure for configuring a master-slave setup.

Prerequisite Steps

First, install tibbr on both the master and slave. Then do the following:

1. Go to the tibbr_home/scripts directory and run these two scripts for both the master and slave:

— .env.sh (to set up the environment)

— configure.sh (to set up additional tibbr paths)

2. On the master, start all the tibbr processes by running start_tibbr.sh.

3. On the slave, start the search process by running 2_search_slave.sh.

4. Run tibbr_home/scripts/status.sh on both the master and slave to verify that the search processes have started.

Setup Process

Follow these steps to configure the master and slave:v

1. Update the production section in the tibbr_home/tibbr-config/sunspot.yml file on both the master and slave so that the section reads as follows:

For the steps on how to configure the search server in master-slave mode for multitenancy, see Multitenant Configurations on page 232.

Ensure the following:

• The tibbr instances on both the master and slave point to the same database so that the information in the database.yml file is the same for both instances.

• The JAVA_HOME environment variable points to tibbr_install_dir/tibcojre64/1.6.0, where tibbr_install_dir is the tibbr installation directory, for example, /opt/3.6.0_GA_HOME.

The tibbr home directory, called tibbr_home in this manual, is the location in which tibbr resides, for example, /opt/3.6.0_GA_HOME/tibbr/3.6.0.



production:solr:

hostname: localhostport: 8983log_level: WARNINGsolr_home: <%= APP_CONFIG_DIR%>/solr

master_solr:hostname: localhostport: 8983

slave_hosts: slave_host1:8984,slave_host2:8984

where:

— hostname is the IP address or name of the instance (under solr) in which the Solr service starts or the master (under master_solr).

— port is the Solr’s port number, whose default is 8983. If you have changed that port number, specify the correct one.

— <%= APP_CONFIG_DIR%> is equivalent to tibbr_home/tibbr-config.

— slave_hosts is a comma-separated list of the names or IP addresses of slave_Solr_instances:port numbers, for example, slave_host1:8984,slave_host2:8984,master_host:8984. You can also specify the master host as a slave instance, as in this example.

Leave the log_level and solr_home settings as is with their default values.

2. Configure the slave Solr server by editing the solrcore.properties file in the tibbr_home/solr/conf directory. For example:

MASTER_CORE_URL=http://localhost:8983/solrSLAVE_CORE_URL=http://localhost:8984/solr

# Used within slave's solrconfig.xml/MASTER_URL=http://localhost:8983/solr

# Poll IntervalPOLL_INTERVAL=10

No other configurations are required for the master Solr server other than those in the sunspot.yml file, as described in step 1. By default, the 2_search.sh process starts the server in master mode.



Tests

To confirm that the configurations are correct and that the master-slave replication is working, go to http://master_host:8983/solr/replication and verify that the browser returns the status OK.

Afterwards, test as follows:

1. Start all the processes on the master and only the search process on the slave.

2. Log in to the master on a browser. Enter a search keyword in the Search field and check the results.

If the setup is working, all the search read requests are handled by the slave; and the write requests, by the master.

Also note the following:

• If both the master and slave search processes are up, search works for both the older messages and for any new messages that you post right then.

• If the slave’s search process is down but the master’s search process is up, the browser cannot load the home page because tibbr startup depends on the search process. With its search process down, the slave cannot handle read requests, which all go to the slave.

• If the master’s search process is down but the slave’s search process is up, all the read requests still work. That is, you can search for the older messages but not for the new ones that you post. That is because the write requests all go to the master’s search process.

When the master search process is up again, the write requests that correspond to the new messages are handled properly. Those messages include the ones that were posted while master search was down and those that were queued at the tibbr server. After the polling time for the slave is over, you can search for the new messages.

You can adjust the polling time by editing the variable POLL_INTERVAL, whose default value is 60 seconds, in the slave’s solrcore.properties file. That means that the slave polls the master every 60 seconds for the new indexes created by the master for the latest messages.

Configuration of Cassandra ClusterThis section describes how to prepare the nodes of a Cassandra cluster and how to start or stop each of the nodes.

You must have tibbr installed on a minimum of three nodes. The number of nodes must be an odd number.



Preparation of First Node

To prepare the first node, edit the cassandra.yaml file in the tibbr_home/tools/apache-cassandra/conf directory and specify the appropriate values for these three properties:

• listen_address

Replace the default value localhost in this line with the node’s external IP address, for example:listen_address: 192.168.1.1

• rpc_address

Replace the default value localhost in this line with the node’s external IP address, for example:rpc_address: 192.168.1.1

• - seeds

Replace the default value "127.0.0.1" in this line with the node’s external IP address, for example:- seeds: "192.168.1.1"

Preparation of Remaining Nodes

To prepare the remaining nodes, edit the cassandra.yaml file and specify the appropriate values for these four properties for each of the nodes:

• auto_bootstrap

Add this line to the beginning of the file and specify the value of true, for example:auto_bootstrap: true

• listen_address

Replace the default value localhost in this line with the node’s external IP address, for example:listen_address: 192.168.2.1

• rpc_address

Replace the default value localhost in this line with the node’s external IP address, for example:rpc_address: 192.168.2.1

• - seeds

Replace the default value "127.0.0.1" in this line with the first node’s external IP address, for example:- seeds: "192.168.1.1"



Start and Stop Commands

Start the Cassandra cluster one node at a time. Be sure to start the first node first.

To start Cassandra, type:

$ cd tibbr_home/scripts$ ./2_cassandra start

To stop Cassandra, type:

$ cd tibbr_home/scripts$ ./2_cassandra stop

Configuration of Multiple Cache ServersTo 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 to read as follows:

cache_store:type: mem_cache_storehost: host1:11211namespace: tibbrtimeout: 60

• To configure multiple instances, edit the tibbr-config/app_config.yml file to read as follows:

cache_store:type: mem_cache_storehost: host1:11211,host2:11211namespace: tibbrtimeout: 60

Afterwards, tibbr uses the next available cache server to store and retrieve cache information.

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.



Configuration of Apache HTTP Server as Load BalancerTo configure the Apache HTTP Server as a load balancer, first ensure that the mod_proxy and mod_proxy_balancer modules (see the descriptions below) exist on the Apache HTTP Server. Note that both modules are in the Apache HTTP Server package in the tibbr installation.

• mod_proxy — 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.

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

• mod_proxy_balancer — This module, which requires the service of mod_proxy, 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.

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.

<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

This sample assumes that tibbr1 and tibbr2 are the tibbr servers and that tibbr3 is the chat server.



</Proxy>

ProxyPass /http-bind balancer://chat/http-bindProxyPass /a balancer://tibbrcore/a stickysession=JSESSIONID|jsessionid ProxyPass / balancer://mainsite/ stickysession=JSESSIONID|jsessionid



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.


| 43

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 44

• Connection to LDAP Server, page 96

• Configuration and Disabling of SSL, page 97

• Display of User Hierarchy, page 98

• Localization of tibbr, page 99

• Performance Tuning, page 102

For details on how to configure SharePoint for tibbr, see Chapter 5.

Several sections of this chapter mention the term event streams, which are, in effect, applications (apps for short). Those two terms are used interchangeably throughout the tibbr documentation.


44 | Chapter 3 Configuration, Localization, and Performance Tuning

Configuration Files and Parameters

Location All tibbr configuration files are located in the tibbr_home/tibbr-config directory.

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

Mechanics of ConfigurationYou configure tibbr parameters in either of these two ways:

• By specifying the parameter settings in the Web-based application configuration manager.

To start the application configuration manager, 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 48.

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”c2: “Example”

When editing the configuration files, do not add or delete spaces from the lines.


Configuration Files and Parameters | 45

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 Termination and Restart of tibbr Services on page 10.

You can also change the tibbr configuration with administrative requests through the utilities described in Chapter 8.

Related FilesYou configure tibbr by editing the files described in Table 4.

Table 5 Configuration Files

Configuration File Description Page

database.yml Database configuration 47

seed.yml Population of users and user-related data 48

app_config.yml Administrator configuration 48

Email server configuration 50

Group configuration 53

Subject configuration 54

Authentication configurationLDAP configurationSAML configuration

54

tibCast configuration 65



Site configuration 80

Application configurationLinkedInFacebookTwitterOracle Expenses

67

Server configuration 73

tibbr-Server connection configuration 73

Validation configuration 74

Web UI configuration 80

Chat configuration 83

User configuration 84

Google analytics configuration 86

Message configuration 86

Channel configuration 87

Exception-notification configuration 87

Poll configuration 88

Branding configuration 88

Search configuration 89

Multitenancy configuration 89

Localization settings 90

BlackBerry configuration 91

Android configuration 92

user_meta_details.yml Custom fields configuration for the Edit My Profile form 92

Table 5 Configuration Files (Cont’d)




Database ConfigurationYou configure the database in the production segment of the database.yml file. Table 6 describes the parameters.

email.properties Configuration of banned email subjects 94

sunspot.yml Configuration of Solr search 80

Table 5 Configuration Files (Cont’d)


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 the screen and parameter names in the application configuration tool in the format of screen_ name > parameter_name, for example, Database > Type.

Table 6 Database Configuration Parameters

Parameter Screen Parameter Description

production

adapter Database > Type The type of database you plan to use.

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.

port Database > Port The TCP port number of the database server.

database Database > Schema Name The name of your database. This field 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.

pool Database > Pool Size The maximum number of database connections to use.

encoding Database > Encoding The character encoding scheme of the database.



Administrator Configuration.

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:

url Database > Connection String URL

The parameter for customizing the Java Database Connectivity (JDBC) string for connecting to the database. Configure this parameter only if a specific JDBC URL is required, for example, when connecting to the Oracle cluster or to an Oracle database through LDAP lookup. Here is an example syntax for connecting to the Oracle database through LDAP lookup (all on one line):url:

"jdbc:oracle:thin:@ldap://LDAP-server-name:3060/database,cn=OracleContext,dc=company-name,dc=com"

If this parameter is set, tibbr ignores the database, host, and port parameters.

reconnect Database > Reconnect The parameter that, if set to true, enables the tibbr server to automatically reconnect to the database after a database restart.

For details on editing the app_config.yml file, see Mechanics of Configuration on page 44.

Table 6 Database Configuration Parameters (Cont’d)




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 an Administrator to the System on page 192.

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

Table 7 describes the parameters for configuring the tibbr administrator.

You can create a password in clear text or as an encrypted string, which we recommend for better security. To learn how to generate encrypted passwords, see Encrypting a Password on page 179. Note: To use that utility, you must manually edit the configuration parameters. For details, see Mechanics of Configuration on page 44.

Table 7 Administrator Configuration Parameters


server (a subset of the default segment)

admin_user Server > Administrator’s User Name

The name of the tibbr administrator used by the application runner and chat server to connect to the tibbr server. admin_user must have administrator privileges.



Email Server Configuration

Configure the email server in the email segment of the app_config.yml file. See Table 8 for the parameters.

admin_password Server > Password The password associated with admin_user.


Table 7 Administrator Configuration Parameters (Cont’d)


Table 8 Email Server Configuration Parameters


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.

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.

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.



protocol Email > Protocol The email protocol, which is either SMTP or SMTPS.

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_

auto

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.

emailgateway

(a subset of the email segment)

Inbound Email Settings

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.

protocol Email > Protocol The parameter that specifies the email protocol in use. The default is pop for POP3. The two other value choices are imap for Internet Message Access protocol and exchange for Microsoft Exchange.

enable_ssl Email > Enable SSL The parameter that, if set to true, enables Secure Sockets Layer (SSL) on the email gateway between tibbr and the POP3 or IMAP server. Setting this parameter to false disables SSL.

send_attachments Email > POP3 > Send Attachments

The parameter that, if set to true, enables the ability to attach files to tibbr posts. The default is true.

pop_address Email > POP3 > POP Address

The address of the POP3 server to which tibbr will be listening.

Table 8 Email Server Configuration Parameters (Cont’d)




pop_port Email > POP3 > POP Port The POP3 server’s port number.

user Email > POP3 > User Name The name of the POP3 Inbox account to which tibbr will be listening.

password Email > POP3 > Password The password for the POP email account.

send_attachments Email > IMAP > Send Attachments


imap_address Email > IMAP > IMAP Address

The address of the IMAP server to which tibbr will be listening.

imap_port Email > IMAP > IMAP Port The IMAP server’s port number.

user Email > IMAP > User Name The name of the IMAP Inbox account to which tibbr will be listening.

password Email > IMAP > Password The password for the IMAP email account.

exchange Email > Exchange The parameter that specifies the protocol with which to connect to Microsoft’s Exchange server. That protocol is Simple Object Access Protocol (SOAP).

endpoint Email > Exchange > Exchange Endpoint

The address of the Exchange server to which tibbr will be listening.

user Email > Exchange > User Name

The name of the Exchange Inbox account to which tibbr will be listening. The format is domain\username.

password Email > Exchange > Password

The password for the Exchange email account.

auth_type Email > Exchange > Authentication Type

The type of authentication for connecting to the Exchange server. The value choices are basic, digest, and ntlm.

send_attachments Email > Exchange > Send Attachments


Table 8 Email Server Configuration Parameters (Cont’d)




Group ConfigurationWith the group parameter enabled (see Table 9), users in your organization can create people groups with the names of a select group of people—similar to an email alias. Groups are handy for inviting group members to follow subjects, for example, without having to specify the individuals one by one.

1Enable this parameter once only. Disabling it afterwards does not remove the groups that have been added to subjects.

Table 9 Group Configuration Parameters


group

enabled Group > Enable1 The parameter that, if set to true, displays the Groups tab in the People tab. The default is false.

ldap_group Group > Enable LDAP Groups

The parameter that, if set to true, activates the LDAP groups for integration with the tibbr people groups. The default is false. For details, see the utility Replicating Group Data from LDAP on page 186.



Subject ConfigurationThe configuration parameter for subjects (see Table 10) enables their geolocation capability so that subjects are mapped with locations.

Authentication Configuration

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 match the Active Directory login names, you can import the user profiles, as follows:

Table 10 Subject Configuration Parameter


subject

Configure in the following:subject

visibility

enabled Subject > Visibility > Enable

The parameter that, if set to true, enables the subject-visibility capability and causes the Assign Visibility link to be displayed on the left panel of the subject page for the administrator or subject owner, assuming that the subject is at root level. The default is false.

subject

Configure in the following:subject

manage_pages

enabled Subject > Manage Subject Pages by Owner > Enable

The parameter that, if set to true, enables the subject owner to see the Manage Pages link on the subject page. Setting this parameter to false enables the tibbr administrator to specify whether the subject owner will see the Manage Pages link on the subject page.




1. Set up LDAP authentication to import users from LDAP to tibbr. For details, see Connection to LDAP Server on page 96.

2. Change the authentication type (see Table 11 below) to saml.

You configure the authentication type in the authentication segment of the app_config.yml file. See Table 11 for the parameters.

SSO Configuration

You can configure authentication through a Web server plug-in with third-party single sign-on (SSO) software, such as apache_auth_tkt. In this case, the Web server authenticates and sends the logged-in user’s information to tibbr by means of an HTTP header.

On the SSO server, you must protect the URL to which requests are directed. That URL is http://tibbr-host/a/users/login_by_sso.

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.

Table 11 Authentication Configuration Parameters


authentication

type Authentication > Authentication Mechanism

The authentication type. Specify the value as default, ldap, saml, or sso, as appropriate.

keep_me_signed_in_for

Authentication > Keep Session For Days

The number of days in which the user session stays active.



Table 12 describes the parameter.

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 96. For information on the parameters that specify the user credentials for connecting to the LDAP database, see Administrator Configuration. on page 48.

For details on how to configure LDAP domains, see Configuration of LDAP on page 31.

Table 12 SSO Configuration Parameter


user_attributes_map

(a subset of the sso segment under authentication)

login Authentication > SSO > Mapping Between SSO and tibbr User Attributes

Required. The name of the SSO attribute to be mapped as the login name, for example, user_name, which represents the authenticated user attribute from the Web server. If the Web server specifies that attribute in the format of domain\\user_name, tibbr parses it and enables the mapping according to that expression.

You can configure this parameter by combining the user_name and _domain attributes. For example, map login like this (all on one line):

login: '_domain ? user_name + "__"+_domain :

user_name'



Table 13 describes the parameters for the LDAP server.

Table 13 LDAP Server Configuration Parameters (LDAP)


ldap (a subset of the authentication segment)

LDAP

use_domain Authentication > LDAP > Use Domain

Optional. The parameter that, if set to true, causes tibbr to populate the domain value in the user object. You can then configure the login parameter according to its mapping. For details, see the login parameter in Table 14.

base Authentication > LDAP > Domains > Default domain > Base DN

The base domain name (DN) under which the users are located, for example:

CN=Users,DC=pmqa,DC=com

search_filter Authentication > LDAP > Domains > Default domain > 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=512))

—preloads all the records for which the employeeNumber attribute is populated and that are active in LDAP.

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.

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.



admin_dn Authentication > LDAP > Administrator’s User Name

The DN for the LDAP administrator account. See this example:

CN=Administrator,CN=Users,DC=pmqa,DC=com

This account must have read permission on LDAP and must be able to bind to LDAP.

admin_password Authentication > LDAP > Administrator’s Password

The password associated with admin_dn.

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.

Table 13 LDAP Server Configuration Parameters (LDAP) (Cont’d)




Table 14 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.

#upn:

userPrincipalName

Authentication > LDAP > User Principal Name > Enabled

The parameter that, if enabled, uncomments the line #upn: userPrincipalName.

Table 13 LDAP Server Configuration Parameters (LDAP) (Cont’d)


Table 14 Authentication Configuration Parameters (Mapping Between LDAP and tibbr User Attributes)


user_attributes_map (a subset of the ldap segment)

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.

zip Authentication > LDAP > ZIP

The name of the LDAP attribute to be mapped as the ZIP code, for example, postalCode.



login Authentication > LDAP > Login

Required. The name of the LDAP attribute to be mapped as the login name, for example, sAMAccountName.

You can configure this parameter by combining the attributes in the ldap_attributes and _domain sections, assuming that the use_domain value is true. If the domain parameter exists, specify login as domain_sAMAccountName. For example, you can map login like this (all on one line):login: '_domain ? sAMAccountName+"__"+_domain : sAMAccountName'

custom_properties1

office

Authentication > LDAP > Custom Properties > Add More > Name

Authentication > LDAP > Custom Properties > Add More > Value

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



The name of the LDAP attribute to be mapped as the location, such as the city name, for example, l.2

custom_properties1

phone



The name of the LDAP attribute to be mapped as the phone number, such as the office telephone number, for example, telephoneNumber.2





1This is a map between the LDAP attributes and the custom_properties attributeof a user object. You can extend the map by adding attributes, if required.

2See also Configuration of Fields in Edit Profile Form on page 92.

Table 15 describes the parameters for LDAP groups.

custom_properties1

mobile



The name of the LDAP attribute to be mapped as the mobile number, for example, mobile.2

custom_properties1

address



The name of the LDAP attribute to be mapped as the address, for example, streetAddress.2



Table 15 Authentication Configuration Parameter (LDAP Groups)


groups (a subset of the ldap segment)

LDAP Groups

search_filter LDAP Groups > Search Filter

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.



SAML Configuration

You configure the parameters for the SAML server in the authentication segment of the default_app_config file. See Table 16.

Also, on the SSO server, specify the SAML endpoint URL to which the client sends SAML responses. That URL is http://tibbr-host/a/users/login_by_saml or http://tibbr-host/tibbr/users/login_by_saml.

group_attributes

_map

LDAP Groups > Group Attributes Map > Name

LDAP Groups > Group Attributes Map > External ID

LDAP Groups > Group Attributes Map > Email

The attributes from the LDAP group that are mapped with tibbr groups. The name of the LDAP group is the same as the name of the corresponding people group in tibbr.

The system expects the mapping for the required groups attributes, as listed below with the default values:

• name: cn

• external_id: sAMAccountName

• email: mail

Table 15 Authentication Configuration Parameter (LDAP Groups) (Cont’d)


For information on how to disable the Join tibbr, Forgot Password, and Change Password capabilities during LDAP authentication, see the webui section in Table 26, Web UI Configuration Parameters, on page 80

Table 16 SAML Configuration Parameters


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 > SAML > SSO Target URL

The URL of the login page of the identity provider.



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

name_identifier_format Authentication > SAML > Name Identifier Format

The format of the name identifier, for example, urn:oasis:names:tc:SAML:1.1:nameid-format:

emailAddress.

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_

source

Authentication > SAML > SAML Source Identifier

The name of one of the attributes specified in saml_attributes, for example, email. name_id is the default.

user_attributes_map (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 > SAML > First Name

The name of the SAML attribute to be mapped as the first name, for example, firstname.

last_name Authentication > SAML > Last Name

The name of the SAML attribute to be mapped as the last name, for example, lastname.

Table 16 SAML Configuration Parameters (Cont’d)




department Authentication > SAML > Department

Optional. The name of the user’s department.

company Authentication > SAML > Company

Optional. The name of the user’s 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)

officeNone The name of the SAML attribute to be mapped as

the office location, such as the office number, for example, physicalDeliveryOfficeName.


locationNone The name of the SAML attribute to be mapped as

the location, such as the city name, for example, l.


phoneNone The name of the SAML attribute to be mapped as

the phone number, such as the office telephone number, for example, telephoneNumber.


mobileNone The name of the SAML attribute to be mapped as

the mobile number, for example, mobile.


addressNone The name of the SAML attribute to be mapped as

the address, for example, streetAddress.

mobile (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 > SAML > For Mobile Clients > Issuer

The name of the service provider, for example, tibbr.

idp_sso_target_url Authentication > SAML > For Mobile Clients > SSO Target URL

The URL of the login page of the identity provider.





tibCast Configuration

Configure the tibCast capability in the video_conference segment of the app_config.yml file. See Table 17 for the parameters.

idp_cert_fingerprint Authentication > SAML > For Mobile Clients > 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

name_identifier_format Authentication > SAML > For Mobile Clients > Name Identifier Format

The format of the name identifier, for example, urn:oasis:names:tc:SAML:1.1:nameid-format:

emailAddress.




Table 17 Video Conference Configuration Parameters


video_conference

enabled tibCast > Enable The parameter that, if set to true, enables the tibCast feature. The default is false, that is, tibCast is disabled.

url tibCast > URL A publicly accessible URL of the server for video conferences. TIBCO supplies this URL when you sign up for tibCast.

access_key tibCast > Access Key The access key associated with your tibCast subscription. TIBCO supplies this key when you sign up for tibCast.



Site Configuration

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 18 for the parameter.

user tibCast > User Name The user-name credential. TIBCO supplies this credential when you sign up for tibCast.

password tibCast > Password The password credential associated with user. TIBCO supplies this credential when you sign up for tibCast.


Table 17 Video Conference Configuration Parameters (Cont’d)


Table 18 Site Configuration Parameters


site

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



Application Configuration

Mousing over Apps in the left panel and then clicking the Explore Apps button on the top right corner in the pop-up pane takes you to a page with two tabs:

• Company Apps — These apps are ready for use within your company. To start one of them, mouse over the app icon and click See Details. On the app page that is displayed, click Enable.

tibbr then places the app under My Favorite Apps in the pop-up pane when you mouse over Apps.

• Marketplace Apps — These apps, developed by TIBCO or its application partners on top of the tibbr application framework, extend the capabilities of tibbr. See the next section for the procedure on importing them and making them available to users under Company Apps.

Marketplace Apps

Under Marketplace Apps, tibbr marks the apps that have been imported with a toolbox icon in the app icon’s lower right corner. Mousing over the toolbox icon displays the message This app has already been added to your Company Apps.

To make available to users an app that is not marked with the toolbox icon:

1. Mouse over the icon of the app and click See Details.


One of these three scenarios then follows:

— tibbr takes you to a page with an Import button. Proceed to step 2.

— tibbr takes you to a page with the following message below the app icon:

This app has been added to your Company Apps list.

Also on the page are other related details: a description at the top and the date, version number, and company name on the right.

Since the app is already up and running on tibbr, users can start it by mousing over Apps and clicking the app icon under My Favorite Apps.

— tibbr takes you to a page with a button Contact Us. Click the button and the compose window of your email client, preaddressed to [email protected], is displayed. Type and send a message for help in activating the application for your company. TIBCO will respond shortly.



2. Click Import.

tibbr displays the related end-user license agreement in a pop-up pane.

3. Read the agreement and, if you agree with the terms, click Agree.

tibbr displays a message to the effect that this app has been added to your Company Apps list.

4. Click Done.

Now click the Company Apps tab at the top and do the following:

1. Mouse over the icon of the app, which you just imported, and click See Details.

Depending on the app in question, tibbr takes you to a page with two or three buttons, as follows:

— Enable, Set Up, and Manage Permissions — Follow steps 2 through 6 below. Afterwards, if you’d like to activate the app for yourself, click Enable.

— Set Up and Manage Permissions — Follow steps 2 through 6 below.

— Enable and Manage Permissions — Follow steps 3 through 6 below. Again, to activate the app for yourself, click Enable afterwards.

2. Click Set Up to configure the app.

tibbr confirms the configuration with a message.

3. Click Manage Permissions to specify which users can access this app.

tibbr takes you to the Administrator page.

4. Locate the app in question in the Application column from the table and choose View/Edit Users from its Action drop-down menu.

The Edit Users dialog box is displayed.

5. Select All Users to grant access to everyone in your company.

Alternatively, select Limited Users and specify in the text field the names of those to whom you would like to grant access.

6. Click Update Users.

tibbr makes the app available to all users or only those whom you specified and places the app icon under Company Apps.

To activate an app that is shown under Company Apps, users must click See Details and then Enable on the app page that is displayed. Subsequently, tibbr displays the app icon under My Favorite Apps.



Social Apps

Social apps 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 app that is specifically associated with your tibbr domain and then register that app within tibbr. Users can then access messages from that Internet domain only.

To configure social apps:

Task A Create an application on the social networking site

To create an app for each social networking site that will be enabled in tibbr, do the following:

• Facebook

a. Log in to Facebook.

b. Create an app 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 app ID for the app 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 app by filling out the form. Specify the URL of the site on which you are hosting tibbr.

d. Copy the app ID for the app you created. You will enter this code while configuring tibbr in step B below.

• LinkedIn

a. Log in to LinkedIn.

b. Create an app at https://www.linkedin.com/secure/developer.

c. Copy the app key for the app you created. You will enter this key while configuring tibbr in step B below.


http://developers.facebook.com/setup/

https://developer.twitter.com/apps

https://www.linkedin.com/secure/developer


Task B Set the app ID in tibbr

Edit the tibbr_home/tibbr-config/app_config.yml file to specify the app IDs for the life streams. See this example:

app_config:linked_in:100:

client_config:app_id: "Y154oxYGrP1HY-u7XE8VFq_52PXarzd9lgodh_SefLZ"

type: clientfacebook:100:

client_config:app_id: "155823714475614"

type: clienttwitter: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.

Next, edit the app_config.yml file, as follows:

LinkedIn

Configure the LinkedIn app in the app_runner segment of the app_config.yml file. See Table 19 for the parameter.

Note: This configuration must be in place before users can add their LinkedIn profile to their tibbr profile.



Facebook

Configure the Facebook app in the app_runner segment of the app_config.yml file. See Table 20 for the parameter.

Table 19 LinkedIn Configuration Parameter


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 app ID in tibbr on page 70.

Table 20 Facebook Configuration Parameters


app_runner


app_config

facebook

‘100’

client_config

app_id Event Streams > Facebook > Client Configuration


channel_url Event Streams > Facebook > Client Configuration

The URL of the tibbr app that is registered with Facebook: the one in the Site URL text field under Website in the configuration screen.



Twitter

Configure the Twitter app in the app_runner segment of the app_config.yml file. See Table 21 for the parameter.

Oracle Expenses

Configure the Oracle Expenses app in the app_runner segment of the app_config.yml file. See Table 22 for the parameters.

Table 21 Twitter Configuration Parameter


app_runner


app_config

twitter

‘100’

client_config

app_id Event Streams > Twitter > Client Configuration


Table 22 Oracle Expenses Configuration Parameters


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 app, for example, tibbradmin, which is the default.



Server ConfigurationConfigure the parameters of the tibbr server in the server section of the app_config.yml file. See Table 23.

tibbr-Server Connection ConfigurationConfigure the parameters for connecting to the tibbr server in the api section of the app_config.yml file. See Table 24.

Table 23 Server Configuration Parameter


server

key Server > Server Key The encryption key for the user’s authentication token.

admin_user Server > Administrator’s User Name

The administrator’s login name, which is tibbradmin by default.

admin_password Server > Password The administrator’s password.

locale Server > Default Locale

The locale, for example, en, fr, fr-ca, de, or zh-cn. The translation file for the locale that you specify must reside in the tibbr_home/tibbr/config/locales directory.

time_zone Server >Locale > Time Zone

tibbr’s time zone, which is International Date Line West by default.

Table 24 tibbr-Server Connection Configuration Parameters


api

site tibbr Server Connection > Server URL

The URL of the tibbr server.

client_key tibbr Server Connection > Client Key

The key that identifies the client.

cache_ttl tibbr Server Connection > Cache Expiry Interval (Seconds)

The length of time (in seconds) in which the data is stored in tibbr’s cache server. The default is 60.



Validation Configuration

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 25 for the parameters.

host tibbr Server Connection > Cache Store > Host

The URL of tibbr’s cache server.

timeout tibbr Server Connection > Timeout (Seconds)

The length of time (in seconds) after which an attempt to connect to tibbr’s cache server stops.


Table 24 tibbr-Server Connection Configuration Parameters (Cont’d)


Table 25 User Configuration Parameters


Login-Name Validation

Configure the validation of login names in the following:

validationuser

login

validate_length Validation > User > Login > Validate Length

The parameter that, if set to true, denotes that the length of the login name is validated.

valid_length Validation > User > Login > Valid Length

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.



Password Validation

Configure the validation of passwords in the following:

validationuser

password

Note: This segment applies only if LDAP authentication is not in use and if the authentication type is default.

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.

Email Validation

Configure the validation of email addresses in the following:

validationuser

email

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.

Table 25 User Configuration Parameters (Cont’d)




valid_format Validation > User > Email > Valid Format

The regular expression against which to validate the email address. See this example:

'(^([^@\s]+)@((?:[-_a-z0-9]+\.)+[a-z]{2,})$)|(^$)'

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:

tibco.com, tibbr.com

Profile-Image Validation for Users

Configure the validation of user profile images in the following:

validationuser

profile_image

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 > Maximum Size (KB)

The maximum size of the profile image in KB. By default, the user’s profile image size must not exceed 2,000 KB.

allowed_content_type Validation > User > Profile Image > Allowed Content Types

The image file types that are allowed. The default is image/jpeg,image/png,image/gif,image/pj

peg,image/x-png.





Attachment Validation

Configure the validation of attachments in the following:

validationasset

attachment

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:valid_size_less_than: 10

To enforce this setting, first enable the parameter validate_size_less_than, that is, set it to true.

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.





Profile-Image Validation for Groups

Configure the validation of profile images in the following:

validationgroup

profile_image

allowed_content_type Validation > Group > Profile Image > Allowed Content Types

The image file types that are allowed. The default is image/jpeg,image/png,image/gif,image/pj

peg,image/x-png.

allowed_size Validation > Group > Profile Image > Allowed Size

The size of the image with a default of 500 KB.

Subject-Image Validation

Configure the validation of subject images in the following:

validationsubject

image

validate_size_less_t

han 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 (KB)

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:allowed_content_type: image/jpeg,image/png,image/gif,image/pjpeg,image/x-png





Subject-Name Validation

Configure the validation of subject images in the following:

validationsubject

name

validate_length Validation > Subject > Name > Validate Length

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.

Subject-Description Validation

Configure the validation of subject descriptions in the following:

validationsubject

description

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.





Web UI Configuration

Configure in the app_config.yml file the parameters that change the behavior and appearance of the tibbr Web interface. See Table 26 for the parameters.

Channel Validation

Configure the validation of channels in the following:

validationchannel

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




Table 26 Web UI Configuration Parameters


webuimenu

video_conference Web UI > Video Conference

The parameter that enables or disables the video-conference feature. The values are enabled and disabled; the default is disabled.

webui

Set the following parameters to disable the Join tibbr, Forgot Password, and Change Password capabilities during LDAP authentication as well as other capabilities.

enable_lync Web UI > Enable Lync

The parameter that, if set to true, enables the Lync integration with tibbr. The default is false.



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 corner 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 : tibbr_4.0

To customize the look and feel, set theme to the name of your customized style sheet, for example:

theme : acme

For more details, see Theme 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.

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.

invite_colleague Web UI > Link for Inviting Colleagues

The parameter that, if set to enabled (default), displays the Invite Your Colleagues pane in the right panel of the home page.

Table 26 Web UI Configuration Parameters (Cont’d)




check_terms Web UI > Check Terms

The parameter that, if set to true, takes the user, after the first login, to the End-User License Agreement (EULA), on which the user must select the option of agreeing to the terms before accessing the tibbr home page. The default is false.

Note: The EULA file is called euala.en.html, which is in the tibbr-config/shared/eualas directory. You can replace it with your own euala.html file.

en stands for the English language. Similarly, the file is called euala.fr.html for French.

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.

join_tibbr Web UI > Enable tibbr Registration

The parameter that, if set to true, enables the Join tibbr link on the login page. Users can then self-register. If you use LDAP, set this value to false.

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.





Chat Configuration

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.

right_nav Web UI > Enable Progress Bar in the Right Panel

The parameter that, if set to enabled (default), displays at the top of the home page’s right pane a progress bar of your setup steps for tibbr. Setting this parameter to disabled displays the New to tibbr? section with links to tips and tutorials, documentation, and the download procedures for tibbr’s mobile versions and tibbr Desktop.

message

exclude_mtypes Message > List of Message Types to Exclude from Wall

A comma-separated list of message types whose messages to exclude from the wall.




Note the following:

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

• To enable chat for mobile devices, open port 5222 over the firewall and ensure that it is accessible on mobile devices.



See Table 27 for the parameters.

User Configuration

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 28 for the parameters.

Table 27 Chat Configuration Parameters


chat

enabled Chat > Enable 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.

host Chat > Host The name of the machine in which the chat server resides.

console_port Chat > Console Port The number of the Prosody console port on which the chat server runs. By default, that port number is 5582.

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:

https://tibbr-host/http-bind

where tibbr-host is the name your tibbr machine, for example:

https://tibbr.tibco.com/http-bind

domain Chat > Domain The LAN address of the chat server. The default, localhost, is valid for most tibbr instances. Before changing this value, consult with TIBCO Support.


In the User screen, selecting True under Enabled under Hierarchy displays the Parent Attribute and Root User’s Login parameters.





user

auto_activate User > Auto-Activate

The parameter that, if set to true, enables automatic registration of users.

private_profile User > Private Profile

The parameter that, if set to true, makes the posts on the user’s wall not viewable unless approved by the user. The default is false. Note: The user’s profile is still displayed in the people directory even if you set this parameter to true.

display_name_

format

User > Display Name Format

The format in which user names are displayed in tibbr. The default is first_name last_name. Enter in the text field your preferred format, for example, last_name first name, first_name, or last_name.

hierarchy

(a subset of the user segment)

enabled User > Hierarchy > Enable

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

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 login name of the root user, for example, your CEO’s login name.



Google Analytics Configuration

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 29 for the parameter.

For the procedure on analytics, see http://analytics.google.com.

Message ConfigurationYou can specify the message types not to be displayed on the user wall by configuring the related parameters in the app_config.yml file. See Table 30.


Table 29 Google Analytics Configuration Parameters


webui

enabled Web UI > Google Tracking Code > Enable

The parameter that, if set to true, enables Google tracking.

tracking_code Web UI > Google Tracking Code

The generated code, for example, AB-12345678-1, for tracking the analytics of the tibbr site.

Table 30 Message Configuration Parameter


message

exclude_mtypes Message > List of Message Types to Exclude from Wall

A list of comma-separated message types not to display on the tibbr wall. The default is chat,application:RSS.


http://analytics.google.com


Channel Configuration

Configure the settings for automatic activation of channels and for the delayed dispatch parameter in the channel segment of the app_config.yml file. See Table 31 for the parameters.

Exception-Notification ConfigurationBy configuring the exception-notification parameter in the app_config.yml file, you can have the tibbr server send you email with the details of any errors that occur. See Table 32.


Table 31 Channel Configuration Parameters


channel

auto_activate Channel > Auto-Activate Channels

The parameter that, if set to true, enables automatic activation of channels.

broadcast_message

(a subset of the channel segment)

delayed_dispatch Channel > Broadcast Message > Delayed Dispatch

The parameter that, if set to true, causes tibbr to honor delayed channels.

Table 32 Exception-Notification Configuration Parameters


exception_notification

enabled Exception Notification > Enable

The parameter that, if set to true, enables the tibbr server to notify you by email of the details of any errors.

recipient_address Exception Notification > Recipient Address

The email address of the recipient of the email on the details of the server errors, assuming that enabled is set to true.



Poll ConfigurationYou configure the poll-related parameters in the app_config.yml file. See Table 33.

Branding ConfigurationYou configure the branding-related parameter in the app_config.yml file for your tibbr instances on the mobile platform. See Table 34.

sender_address Exception Notification > Sender Address

The email address of the sender of the email on the details of the server errors, assuming that enabled is set to true.

Table 32 Exception-Notification Configuration Parameters (Cont’d)


Table 33 Poll Configuration Parameters


poll

enabled Poll > Enabled The parameter that, if set to true, causes the Poll tab to be displayed below the top navigation bar. The default is true.

max_expiry_days Poll > Maximum Expiry Days

The maximum number of days in which polls are displayed. The default is 365.

default_expiry_days Poll > Default Expiry Days

The number of days in which polls are displayed by default. The default is 3.

Table 34 Branding Configuration Parameters


branding

enabled Branding > Enable The parameter that, if set to true, enables you to customize the logo for your tibbr instances on the mobile platform. The default is false.

logo_url Branding > Logo URL The relative path for the logo image file.



Search Configuration

tibbr uses Solr search for locating information, such as a user’s messages, subjects, and people. You configure Solr search in the sunspot.yml file. See Table 35 for the parameters.

Multitenancy ConfigurationYou configure the multitenancy-related parameters in the app_config.yml file. See Table 36.


Table 35 Search Configuration Parameters


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.

Table 36 Multitenancy Configuration Parameters


multi_tenant

test_mode Multitenant > Test Mode

The test setting for multitenancy. The default is false.

enabled Multitenant > Enabled The parameter that, if set to true, activates multitenancy. The default is false.

use_email_for_

domain

Multitenant > Use Email for Domain

The parameter that, if set to true, uses the email address as the domain name. The default is true.

from_email Multitenant >Contact Sales > Email From

The email addresses from which sales-related email messages are sent.



Localization Settings

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

to_emails Multitenant >Contact Sales > Email To

The email addresses to which sales-related email messages are sent.

from_email Multitenant >Contact Support > Email From

The email addresses from which support-related email messages are sent.

to_emails Multitenant >Contact Support > Email To

The email addresses to which support-related email messages are sent.

allowed_domains

_expression

Multitenant > Allowed Domain Expressions

A comma-separated list of the domain expressions that are allowed.

blocked_domains Multitenant > Blocked Domains

A comma-separated list of the competitor domains that are blocked.

blocked_public_domains

Multitenant > Blocked Public Domains

A comma-separated list of the public domains (for example, gmail, webmail, and so forth) that are blocked.

blocked_email_extensions

Multitenant > Blocked Email Extensions

The extensions (for example, .cu, .ir, and such) of the email addresses that are blocked.

tenant_event_

emails_to

Multitenant > Tenant Event Email

A comma-separated list of the email addresses that receive notifications of new tenant and user signups.


Table 36 Multitenancy Configuration Parameters (Cont’d)




Table 37 describes the localization parameter.

BlackBerry ConfigurationA 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 a subdirectory, bb5.0, in the TIBCO_HOME/tibbr-config/shared/downloads directory.

2. Copy the corresponding BlackBerry application binaries into the new subdirectory.

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 https://your_tibbr_domain/downloads/bb5.0/tibbr.jad in the browser.

Table 37 Localization Parameter


locale

default Server > Default Locale The default locale setting when tibbr loads a new user is as follows:

default: language

where language is the ISO 639-1 code for the language translation files. For example, the default locale setting for English reads like this:

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.

Note: For a list of the languages tibbr supports, see locales, a subset of the webui segment in the default_app_config.yml file.



Android ConfigurationA 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:

Copy the corresponding Android application into the TIBCO_HOME/tibbr-config/shared/downloads directory.

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 https://your_tibbr_domain/android/downloads/tibbr-release.apk in the browser.

Configuration of tibbr DesktopA 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/tibbr-config/shared/downloads directory.

Afterwards, test the setup by accessing one of the files at https://your_tibbr_domain/downloads/tibbrDesktop.dmg.

Configuration of Fields in Edit Profile FormYou define the fields in the Edit 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 38 describes the default fields.

You cannot configure these properties in the application configuration tool.



Custom Fields

An example structure of a custom field is at the top of the user_meta_details.yml file. Table 39 describes the meta data of the user properties in that example.

Table 38 Configuration Parameters for the Edit 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.

Table 39 Meta Data of User Properties


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 38, description is the key, which is mapped to the About Me field in the TIBCO_HOME/tibbr/config/locales/en.yml file.



Configuration of Banned Email SubjectsTo prevent certain automated and spam messages from being posted to tibbr through email replies and applications, customize the email.properties file.

For example, if a user has an automated away-from-my-mail 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 away-from-my-mail 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:

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

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:

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

allowed_values An array of the values allowed for the field, which apply to ui_type:select.

Table 39 Meta Data of User Properties (Cont’d)




Population of Users and User-Related DataYou configure users in the seed.yml file. See Table 40 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.



user Required. The user’s name. Replace the variable with a unique user name, for example, John. The name specified here also serves as 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].



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

— Configure the LDAP parameters as described in LDAP Configuration on page 56.

3. Run the LDAP sync utility from the tibbr_home/scripts directory. Type:./tibbr_util.sh replicate_ldap_users force_update=[true|false] undelete=[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 undelete to true, the sync utility restores the users who have been reactivated in LDAP.

— If you set test to true, instead of updating the database, the sync utility runs the test and outputs the 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.


Configuration and Disabling of SSL | 97

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



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 the 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 manager’s login.

To enable the hierarchical view:

1. Configure the hierarchy settings in the app_config.yml file. For details on the related parameters, see page 85.

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 have already configured tibbr to connect to an LDAP server, you need not change the default parent_attribute setting.

If you delete a user with an administration utility, you also delete the user’s subordinates from the hierarchy because they do not have a manager any more. 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 8.


Localization of tibbr | 99

Localization of tibbr

Besides English, tibbr also supports the following languages:

You can translate the tibbr Web interface into a variety of languages and make 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 after adding a language to tibbr (see Tasks A through D below), users can change the default tibbr locale in either of two ways:

• Specify the language you desire in your browser.

• Choose a locale from the Locale drop-down menu in the Edit My Profile screen, for example:

To localize the tibbr Web interface, do the following:

Task A Create the resource files.

Two resource files are required for each locale and they must be translated, as follows:

• tibbr_home/tibbr/config/locales/language.yml

• tibbr_home/webclient/config/locales/language.yml

Chinese (Simplified) German

French Japanese

French (Canada) Spanish



where language is a two-letter ISO 639-1 code that identifies the language. For example, a French translation would use the file name fr.yml. For a list of all the language codes, see http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes.

Next, create the to-be-translated resource files by making copies of the source files described in Table 41 and renaming the copies.

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.

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

In case language contains a two-letter region code, for example, fr-CA, follow the convention defined in ISO 3166-1. See http://www.iso.org/iso/country_codes/iso_3166_code_lists/country_n

ames_and_code_elements.htm.

Table 41 tibbr Source Files for Locales

Source File Location Copy Name

en.yml tibbr_home/tibbr/config/locales/

Note: Do not delete or rename the original file. Copy the file before making any changes.

language.yml

en.yml tibbr_home/webclient/config/locales/ language.yml

• Do not translate the key in the key: "value" pairs. Translate the value only.

• Do not delete the space between the colon (:) and the translation string.


http://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

Localization of tibbr | 101

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

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 or switch the browser locale to the new language.

Table 42 Staging Locations for Localization Files

Files Location

Resource files for tibbr • Server side:tibbr_home/tibbr/config/locales/language.yml

• Client side:tibbr_home/webclient/config/locales/language.yml



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.

To fine-tune tibbr’s performance:

Task A 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 — The maximum number of threads.

• acceptCount — The maximum number of waiting users.

See Table 43.

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.

Table 43 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.


Performance Tuning | 103

For more information on the Tomcat elements, see—

http://tomcat.apache.org/tomcat-6.0-doc/config/http.html

Task B Increase the tibbr database pool size.

Update the database pool parameter in the database.yml file in the tibbr_home/tibbr-config directory to increase the tibbr database pool size.

pool specifies the number of database connections available for threads. Set the pool size under development and production to the same value. The value of pool must be the same as the maxThreads setting configured in step A.

Task C 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_tuningjava.html

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.

Table 43 Maximum Threads and Maximum Waiting Users in Tomcat Server (Cont’d)

Element Description

Modifying the Tomcat server settings can negatively impact tibbr’s performance. Contact TIBCO Support for assistance.

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.


http://download.oracle.com/docs/cd/E19823-01/819-0084/pt_tuningjava.html

http://download.oracle.com/docs/cd/E19823-01/819-0084/pt_tuningjava.html

http://tomcat.apache.org/tomcat-6.0-doc/config/http.html



| 105

Chapter 4 Custom Applications

This chapter describes the procedure for configuring applications.

Topics

• Overview, page 106

• Procedure, page 107

The procedures in this chapter have been deprecated. For details on configuring tibbr applications, go to developers.tibbr.com.


106 | Chapter 4 Custom 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 event streams on a nonproduction server only because the process requires restarting the tibbr server to see the event streams 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 107 onwards.


Procedure | 107

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 the version number. For example, the following call creates an application template called hello world with a version 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.

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

When creating a template, tibbr converts spaces, if any, in app_name to underscores.



config_field :field_nameconfig_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 44 for a description of the parameters. An example is on page 110.

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 44 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 :multi_value to offer a list of field values.

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


Procedure | 109

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

config_field :server, :ui_type => :text_field, :label => "My Server URL", :required => trueconfig_field :port, :required => true

:multi_value true or false 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 choose only one value.

:dependency Reference 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.

:filter_value String A specific value of config_field referenced from the :dependency parameter.

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

Table 44 Custom Event-Stream Field Parameters (Cont’d)

Parameter Name Values Description



config_field :user, :ui_type => :text_field config_field :password, :ui_type => "password"validates_presence_of :user, :password

Figure 4 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 44, as follows:


Procedure | 111

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, :passwordvalidates_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

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.

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.



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 contextmessages= context.config.data_sources.map do |ds|

logger.info "launching helloworld application"["hello #{ds.your_name}",ds.subjects,nil,nil]

endmessages

end

Context Object The fields in Table 45 are available by default in the context object:

Table 45 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.


Procedure | 113

Java Code 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 46, where app_name is the name of the application. tibbr accepts PNG image files only.

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/isolatedrun_mode: "grouped"

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.

Table 45 Default Fields in context Object (Cont’d)

Field Description

Table 46 Custom Application Icons

Image Name Size

app_name-feed.gif 50x50 pixels

app_name-feed-big.gif 130x130 pixels

app_name-feed-profile.gif 20x20 pixels


http://kenai.com/projects/jruby/pages/CallingJavaFromJRuby


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. Go to the tibbr_home/tibbr directory and run this command line:

rake tibbr:app:register name="app_name" version=release

where app_name is the name of the application and release is the 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.

Run a test and ensure that the application is available as an event stream in the tibbr Web interface.


| 115

Chapter 5 Configuration of SharePoint for tibbr

This chapter describes the parameters for configuring Microsoft SharePoint for tibbr, the template types for SharePoint Server, and the procedure for setting up SharePoint Web services for single sign-on (SSO).

Topics

• Configuration Parameters, page 116

• Installation of SharePoint Custom Web Service, page 118

• Configuration of REST Service, page 119

• Configuration of SharePoint Link, page 121

• Configuration of SharePoint Web Services for SSO, page 122

• Template Types, page 126

While creating a subject on tibbr, you can specify the default location for uploading the SharePoint files for the subject. See the bullet SharePoint Files in the section Create a Subject in the tibbr How-To Guide.


116 | Chapter 5 Configuration of SharePoint for tibbr

Configuration Parameters

The feature of uploading files to SharePoint from tibbr supports basic and NTLM authentication.

Configure the SharePoint feature in the sharepoint segment of the app_config.yml file. See Table 47 for the parameters.


In the SharePoint screen, selecting True under Enabled displays the configuration parameters for SharePoint.

Table 47 SharePoint Configuration Parameters


sharepoint

enabled SharePoint > Enable The parameter that, if set to true, enables the SharePoint feature. The default is false, that is, SharePoint is disabled.

If you enable SharePoint, be sure to install the Web service TibbrCustomSPWSDeploy.wsp on your SharePoint server. For details, see Installation of SharePoint Custom Web Service on page 118.

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.


Configuration Parameters | 117

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_type

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 49 lists all the template types and their IDs.

upload_enabled_lists

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.

sso (a subset of the sharepoint segment)

enabled SharePoint > SSO > Enable The parameter that, if set to true, enables SSO for SharePoint. The default is false, that is, SSO for SharePoint is disabled.

sp_service_user SharePoint > SSO > User Name

The login name of the domain account’s Service Principal Name for the Web Server that runs SharePoint.

sp_service_pwd SharePoint > SSO > Password

The password of the domain account’s SharePoint Principal Name for the Web Server that runs SharePoint.

Table 47 SharePoint Configuration Parameters (Cont’d)




Installation of SharePoint Custom Web Service

The SharePoint custom Web service is similar to getAllSubWebCollection in the webs.asmx SharePoint Out-Of-Box Web service. This custom Web service lists the subsites the user can access; the Out-Of-Box Web service retrieves the results for Site Collection administrators.

To install the SharePoint custom Web service TibbrCustomSPWSDeploy.wsp:

1. Run installTibbrCustomSPWebService.bat in the tibbr_home\external\sharepoint\tibbrCustomSpWebService directory.

2. Deploy the solution:

a. In SharePoint Central Administration, click System Settings.

b. Under Farm Management, click Manage farm solutions.

c. Click TibbrCustomSPWSDeploy and, in the Solution Properties screen that is displayed, click Deploy Solution.

d. In the Deploy Solution screen that is displayed, click OK.


Configuration of REST Service | 119

Configuration of REST Service

The Representational State Transfer (REST) Windows Communication Foundation (WCF) service uploads files into SharePoint from tibbr. The service is available through the TibbrCustomSPWSDeploy.wsp package.

Configure the related settings, as follows:

1. On the SharePoint server, navigate to Windows_dir\Program Files\Common Files\Microsoft Shared\Web Server

Extensions\14\ISAPI\tibbrSPRestServices, where Windows_dir is the directory in which the Windows OS resides, for example, C:\.

2. Edit the web.config file in the tibbrSPRestServices directory, as follows

Under the configuration\services\service\host\baseAddresses tag, replace the line—

<add baseAddress="http://sharepoint/_vti_bin/" />

—with one that shows your SharePoint base URL instead of sharepoint after http://.

For example, if the SharePoint base URL in the C:\tibbr_home\siteconfig_sample\app_config.yml file is http://Sharepoint1:5534, change—

<add baseAddress="http://sharepoint/_vti_bin/" />

to—

<add baseAddress="http://Sharepoint1:5534/_vti_bin/” />

The buffer value under the Configuration\appSettings tag in the web.config file is set to 1 MB by default, which is valid for most cases, as follows:

<add key ="bufferSize" value ="1048576"/>

Changing the value might cause errors in the REST service. We strongly recommend that you leave the line as is. If you do want to update this value, contact tibbr Support first.



3. In IIS Manager, click your SharePoint Web application under Sites. In the center pane, double-click Authentication and then click Windows Authentication. Afterwards, click Providers in the right pane.

The following dialog box is displayed.

If the Negotiate item is not in the Enabled Providers pane at the top, choose Negotiate from the Available Providers drop-down menu and click Add. Click OK.


Configuration of SharePoint Link | 121

Configuration of SharePoint Link

Configure the SharePoint link in the link_patterns.yml file. See Table 48 for the parameter.

Table 48 SharePoint Link Parameter


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.



Configuration of SharePoint Web Services for SSO

By configuring SSO for the SharePoint Web Services, you can prevent logins into SharePoint from tibbr when browsing or uploading files into SharePoint. Configure SSO as described below.

On Domain Controller

Do the following on the domain controller:

1. Create a domain account in the domain controller.

Name the account, for example, sptibbrservice.

2. Set up a Service Principal Name (SPN) for the domain account for the Web server that runs SharePoint by running this command on the domain controller:

setspn -a http/SharePoint-Web-Server domain\domain-account

For example, type the following on one line:setspn -a http/SP-tibbr.na.tibco.com na.tibco.com\sptibbrservice

The domain controller then adds the SPN for the Web server in the domain.

3. Set up delegation for the domain account:

a. Right-click the domain account and choose Properties from the context menu.

b. Click the Delegation tab in the Active Directory Users pane.

c. Select the option Trust this user for delegation for any service (Kerberos only).

d. Click OK.

On Web Server

On the Web server, follow the procedures below.

Build a Web Application with Kerberos Authentication in SharePoint

1. In SharePoint Central Administration, click Application Management on the left pane and then Manage web applications under Web Applications.

2. Click the New icon in the top ribbon for the Create New Web Application dialog box.


Configuration of SharePoint Web Services for SSO | 123

3. Under Security Configuration on the left pane, select Negotiate (Kerberos) under Authentication provider.

4. Fill in the other fields, as appropriate.

5. Click OK.

If a Web application already exists, update it as follows:

1. In SharePoint Central Administration, click Application Management on the left pane and then Manage web applications under Web Applications.

2. Click the Web application associated with the SharePoint site and then click the Authentication Providers icon in the top ribbon.

3. In the Authentication Providers dialog box that is displayed, click Default.

4. Under IIS Authentication Settings in the Edit Authentication dialog box that is displayed, select Negotiate (Kerberos) under Integrated Windows authentication.

5. Click Save.

Configure the IIS application Pool with the Domain Account

1. In IIS, click SharePoint Web Application Site and then click Basic Settings on the right pane.

2. In the Edit Site dialog box that is displayed, make a note of the application pool (for example, SharePoint –14433) in the Application pool field.

3. Click Application Pools on the left pane. Right-click the application pool (for example, SharePoint –14433) and choose Advanced Settings from the context menu.

4. In the dialog box that is displayed, click the button with an ellipsis (…) to the right of Identity under Process Model.

5. In the Application Pool Identity dialog box that is displayed, select Custom account and click the Set button.

6. In the Set Credentials dialog box that is displayed, type the SPN domain account’s user name and password in the appropriate fields. Type the password again in the Confirm Password field.

7. Click OK.



Add and Configure the Dynamic-Link Library

1. Add the HttpModule dynamic-link library (DLL) (tibbr_home/external/SharePoint/TibbrSPImpersonationModule/TibbrSPImpersonationModule.dll) to the GAC folder of the SharePoint server.

2. Add the SafeControl tag to the SafeControls section in the web.config file, as follows:

<SafeControl Assembly="TibbrSPImpersonationModule, Version=1.0.0.0, Culture=neutral,PublicKeyToken=35b0297c2ec5f7a2"Namespace="TibbrSPImpersonationModule.SPImpersonationModule" TypeName="*"Safe="True" AllowRemoteDesigner="True" SafeAgainstScript="True" />

3. Change the default line <identity impersonate="true" /> in the web.config file to <identity impersonate="false" />.

Configure IIS to Pick the Custom HTTP Module During Processing

1. In IIS, click SharePoint Web Application Site on the left pane and then Modules on the right pane.

2. In the Add Managed Module dialog box that is displayed, fill in the fields, as follows:

Name: TibbrSPImpersonationModule

Type: TibbrSPImpersonationModule.SPImpersonationModule, TibbrSPImpersonationModule, Version=1.0.0.0, Culture=neutral,

PublicKeyToken=35b0297c2ec5f7a2

3. Click OK.

On tibbr

On tibbr, edit the default_app_config.yml file, as follows:

1. Uncomment the line #upn: userPrincipalName under custom_properties in the user_attributes_map section. The line then reads like this:upn: userPrincipalName

Note: Be sure to map userPrincipalName to the custom_properties attribute in the user_attributes_map section under ldap in the app_config.yml file.

2. In the sharepoint section, specify the user name and password of the SPN domain account, as follows:


Configuration of SharePoint Web Services for SSO | 125

sharepoint: sp_service_user: "user-name" sp_service_pwd: "password"



Template Types

Table 49 lists and describes the template types in SharePoint Server.

Table 49 SharePoint Server Template Types

ID Description ID Description

100 Generic list 130 Data Connection library

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


Template Types | 127

Also see Configuration of SharePoint Link on page 121 for information on how to set up the SharePoint link.

119 Wiki Page library 2003 Private Document library

120 Custom grid for a list

Table 49 SharePoint Server Template Types (Cont’d)

ID Description ID Description




| 129

Chapter 6 Customization of tibbr

This chapter shows you how to customize several aspects of the tibbr user interface: its theme, email template, home page, the More menu at the bottom of a post.

Topics

• Theme, page 130

• Email Template, page 132

• Home Page, page 133

• More Menu, page 138

• Login Page, page 139

• Mobile and Desktop Branding, page 141


130 | Chapter 6 Customization of tibbr

Theme

You can customize the tibbr theme (such as the logo, page-background color, button colors, text color, text font, and so forth) as desired by your company.

The default tibbr properties reside in the tibbr_home/public/themes/tibbr directory, whose structure is as follows:

tibbr_home/public/themes/tibbrimages/

less/

stylesheets/

html/

To customize the theme:

1. Run the tibbr_home/scripts/.env.sh script to load the tibbr environment.

2. Run a rake task in the tibbr_home/tibbr directory to create, for your company, a subdirectory that is identical in structure to the tibbr subdirectory above. The following example assumes that the company name is ACME:jruby -S rake tibbr:web:create_theme[ACME]

3. Go to the tibbr_home/public/themes/your-theme-name/less directory and create your own .less file, for example, acme.less.

4. Edit the main.less file and append the content of your .less file, for example, acme.less, to the bottom.

Alternatively, edit the variables.less file in the less subdirectory to define the properties that reflect your company’s theme.

See the comments in the file for an explanation of the properties.

5. Optional. To add Internet Explorer-specific conditional styles, edit the ie.less file in the less subdirectory. For example, to add Internet Explorer 8-specific styles, add the following lines anywhere in the file:

.ie8{/* Add your styles here. */}

6. Run another rake task in the tibbr_home/public/themes/tibbr directory to create the appropriate cascading style sheet. Type, for example:jruby -S rake tibbr:web:build_css[ACME]


Theme | 131

7. Edit the default_app_config.yml file: Change the following line in the webui section from—theme : default

to—

theme : your-company-name

For example:theme: ACME

8. Restart the tibbr server.



Email Template

You can edit the tibbr email template called email.html.erb so that it matches your corporate branding standards. The .erb extension stands for Embedded Ruby and is plain HTML with embedded Ruby on Rails code that is processed at runtime.

The email.html.erb file resides in the tibbr_home/tibbr/app/views/layouts directory.

Edit the HTML code in the template in either of these two ways:

• Edit in any text editor. Note that you must define CSS styling inline for email message delivery.

• Delete the .erb extension from the file name and then edit the HTML code in an HTML WYSIWYG editor.

After editing, replace the email.html.erb file with the modified version.

Before editing, make a copy of the email.html.erb file in case you want to revert to it later.

While editing, be sure not to invalidate any of the embedded Ruby statements, which begin and end with the characters <%= … %>. Also, you must retain the line <%= yield %>, which yields the actual message content on delivery.


Home Page | 133

Home Page

To customize the UI on the home page, edit the tibbr_home/tibbr-config/ui.yml file, which contains the parameters for configuring the top navigation bar and the panes in the left and right panels. You can also customize the panes in the right panel or create a custom pane there.

Top Navigation BarYou can add or delete any tab from the top navigation bar. Following are the parameters:

For example, if your company does not use event streams, setting the Event Streams tab’s display value to false removes that tab from the top navigation bar.

Another example: To add a tab called Test_tab to the top navigation bar, edit the parameters to read as follows:

key: test_menu #key is defined in the locales directories as Test_tab.link: "#"display: true

The bar then looks like this:


key The name of the tab on the navigation bar. tibbr externalizes the text in the translation files in the tibbr_home/webclient/config/locales and tibbr_home/tibbr/config/locales directories.

link The URL of the page that opens if you click the tab.

display The parameter that, if set to true (default), makes the tab visible. The possible values are true and false.



Left PanelThe default display of the left panel looks like this:

You can make an item invisible by changing its value in the ui.yml file from true (default) to false. For example, to make My Wall invisible, edit the ui.yml file and change my_wall: true to my_wall: false.

Right PanelYou can change the default display of the panes in the right panel or create a custom pane.

Panes

Following are the parameters of a pane:


key The name of the pane in the right panel. tibbr externalizes the text in the translation files in the tibbr_home/webclient/config/locales and tibbr_home/tibbr/config/locales directories.

handler The JavaScript function as defined in the file right_nav.js in the directory tibbr_home/tibbr/public/app/views/home.

url A blank field. Do not edit this field.

enable The parameter that, if set to true (default), makes the pane visible. The possible values are true and false.


Home Page | 135

For example, if the enable value is true for the New to tibbr? pane and its progress bar, that pane is visible and looks like this:

To hide the New to tibbr? pane and its progress bar, set the parameters as follows:

key: new_to_tibbrhandler: newToTibbrurl:enable: false

key: new_to_tibbrhandler: newToTibbrProgressurl:enable: false

The New to tibbr? pane and its progress bar then become invisible:



Custom Pane (<iframe>)

Creating a custom pane in the right panel as an <iframe> element displays the page of the associated URL. The default parameters are as follows:

#This is for external configuration for any new requirement.key: twitterxhandler: buildNavurl: https://tibco.tibbr.com/tibbr/height: 200style: "border:2px"enable: true

Here is an example of the edited parameter settings:

key: test_tibbr #key is defined in the locales directories as Test Tibbr.handler: customize_navurl: http://www.tibbr.com/height: 200style: “border:2px”enable: true


key The name of the pane in the right panel. tibbr externalizes the text in the translation files in the tibbr_home/webclient/config/locales and tibbr_home/tibbr/config/locales directories.

handler The JavaScript function buildNav as defined in the file right_nav.js in the directory tibbr_home/tibbr/app/views/home.

url The URL of the page that is displayed in the frame.

height The height of iframe in pixels, for example, 200.

style The presentation attributes of iframe, for example, border:2px.

enable The parameter that, if set to true, makes the pane visible. The possible values are true and false.


Home Page | 137

This pane is then displayed:



More Menu

You can customize the items in the More menu at the bottom of a post. Following are the parameters:

For example, if you set the parameters this way—

message: more_actions: -

key: show_name #key is defined in the locales directories as Custom Action.handler: showNameargs: Tibco,Tibbrenable: true

—the More menu would look like this:


key The name of the item in the More menu. tibbr externalizes the text in the translation files in the tibbr_home/webclient/config/locales and tibbr_home/tibbr/config/locales directories.

handler The JavaScript function window.showName as defined in the file custom.js in the directory tibbr_home/tibbr/public/javascripts.

args The arguments of the function, if required.

enable The parameter that, if set to true, makes the item visible in the More menu. The possible values are true and false.


Login Page | 139

Login Page

By default, the theme of the login page is set to default under theme in the webui section of the configuration file (default_app_config.yml). See the section Theme on page 130. The display looks like this:

To customize the theme:

1. Edit the theme value in the default_app_config.yml file. Refer to step 7 in the section Theme.

2. Edit the _login.en.html file, which contains the content of the login page, in the tibbr_home/tibbr/public/themes/your-company-name/html directory.



Alternatively, you can customize the login page by editing the HTML files in the tibbr_home/webclient/app/views/web/home directory. The localization for the content is in the en.yml file. You can construct your own theme and CSS.


Mobile and Desktop Branding | 141

Mobile and Desktop Branding

The tibbr logo is displayed on tibbr Desktop and the tibbr mobile-device applications. You can change that logo with a few minor server-side configuration steps. Follow this procedure:

1. Create a logo of the size 181 x 117 pixels and name it your-company-name-logo.png, for example, ACME-logo.png.

2. Create a subdirectory called branding under tibbr_home/tibbr/public/images.

3. Upload the logo file to the tibbr_home/tibbr/public/images/branding subdirectory.

4. Name your logo image file tibbr-logo.png and upload it to the tibbr_home/tibbrmobile/images/branding directory.

5. Edit the following lines in the default_app_config.yml file to read like this:

branding: enabled: true logo_url:/images/branding/your-company-name-logo.png

6. Restart the tibbr server.

We recommend that you create your logo in PNG with a transparent background.

A default tibbr-logo.png file is already in that directory. Performing this step replaces the default image with yours.

Spaces within YML files are important. Be sure to insert proper spacing to define the elements.




| 143

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

• Available Gadgets, page 144

• Deployment Options, page 164


144 | Chapter 7 Gadgets

Available Gadgets

The gadgets in tibbr are as follows:

Wall Messages Followers Subject Search

Announcements My Following People

Subject Messages People Hierarchy User Profile

tibbr Messages Subject Directory Subjects

Message Delivery Post SharePoint Search

My Subjects


Available Gadgets | 145

Wall MessagesThe 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:

In addition, the Wall Messages gadget offers the following capabilities:

• Poll — You can create a poll to survey the opinions of your colleagues on a certain topic.

• Filters — To show the filters, pass the value wall for the parameter type in the wall_messages.html file:

<script type="text/javascript"> TIB.Gadgets.Message.init("tibbr-content", {gadget: TIB.Gadgets.Message.Post, subOptions: {type: "wall", hasParent: true, show_profile_pic: false}, sector: "post", poll_messages: true});…</script>



• Picture in user profile — To show the picture in the user profile, set the parameter show_profile_pic to true:

<script type="text/javascript"> TIB.Gadgets.Message.init("tibbr-content", {gadget: TIB.Gadgets.Message.Post, subOptions: {type: "wall", hasParent: true, show_profile_pic: true}, sector: "post", poll_messages: true});…</script>

• Display of new messages at regular intervals — To fetch and display new messages at regular intervals, set the parameter fetch_messages to true.

<script type="text/javascript"> TIB.Gadgets.Message.init("tibbr-content", {gadget: TIB.Gadgets.Message.Post, subOptions: {type: "wall", hasParent: true, show_profile_pic: true}, sector: "post", poll_messages: true});…</script>

• Display of a user-specific wall — To display a user’s wall, set the parameters user_id and user_name in the URL:

http://your_tibbr_domain/gadgets/wall_messages.html?user_id=user_id&user_name=user_login

where:

— user_id is the sequential number of the user in the user table.

— user_login is the login name of the user.



AnnouncementsThe Announcements gadget, which is similar to the Wall Messages gadget, displays a post, addressed to one or more users or subjects, that is marked as a global announcement by the tibbr administrator. The URL for this gadget is http://your_tibbr_domain/a/gadgets/announcements.html.

See the following example:

You as a user cannot perform any actions on the announcement. For example, you cannot reply to, delete, copy, or forward the announcement by email. In case the announcement is a poll, you cannot vote on any of the options or add options to the poll.

However, you can do the following:

• In case the announcement is a calendar event, you can download it to your Microsoft Outlook or Apple iCal calendar.

• You can delete an announcement any time.



Subject MessagesThe Subject Messages gadget displays the messages for a given subject. The URL for this gadget is http://your_tibbr_domain/a/gadgets/subject_messages.html?name=subject-name&id=subject_id. Pass the subject name and subject ID for which the messages need to be retrieved as the parameters, for example, http://your_tibbr_domain/a/gadgets/subject_messages.html?name=tibbr.help&id=456. The subject ID is the number at the end of the subject’s URL.


You can display only polls, private messages, starred messages, or calendar events on the Subjects Messages gadget. The syntax is as follows:

http://your_tibbr_domain/a/gadgets/subject_messages.html?wall_type=value&name=subject-name&id=subject_id

where value is polls, privatemessages, starredmessages, or events.



tibbr MessagesThe 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:



Message DeliveryThe Message Delivery gadget enables you to set up message-delivery channels, which notify you by email in real time, daily, or hourly, depending on your choice, when new messages arrive. The URL for this gadget is http://your_tibbr_domain/a/gadgets/message_delivery.html. See the following example:



My SubjectsThe My Subjects gadget lists the subjects the logged-in user is following. The URL for this gadget is http://your_tibbr_domain/a/gadgets/my_subjects.html. See the following example:



FollowersThe 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:



My FollowingThe 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:



People HierarchyThe People Hierarchy gadget displays the people directory in a tree structure. The URL for this gadget is http://your_tibbr_domain/a/gadgets/people_hierarchy.html. See the following example:



Subject DirectoryThe 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.


To enable users to create subjects in the subject directory, go to—

http://your_tibbr_domain/a/gadgets/subject_directory.html?createsubject=1



PostThe 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:



Subject SearchThe 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:



PeopleThe 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:



User ProfileThe 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:



Here is Abby Bremen’s Edit Profile screen:



SubjectsThe 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:



SharePoint SearchThree gadgets are on the SharePoint search page:

• Search Messages — This gadget displays the tibbr messages that match the search keywords on the SharePoint search page.

• Search Subjects — This gadget displays the tibbr subjects that match the search keywords on the SharePoint search page.

Before using the SharePoint Search Messages and Search Subjects gadgets, you must add them to the SharePoint results.aspx search-result page if you are using enterprise search.

Here is an example of those two gadgets:



• Search People — This gadget enables search for tibbr users through the SharePoint people-search capability.

Before using this gadget, you must add it to the SharePoint peopleresults.aspx search-result page if you are using enterprise search.

Here is an example of this gadget:



Deployment Options

Web browsers impose security restrictions on the interactions based on the origins of the Web pages. Depending on whether 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 Same DomainAdopt 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 DomainsYou can deploy gadgets from one domain to another, for example, from tibco.com to my-company.com. This deployment option enables you 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"},


Deployment Options | 165

{container: "SubjectMessages", name: "subject_messages"}]

}TIB.PageBus.gadgets(settings);

A sample HTML file that demonstrates the instantiation is at tibbr_home/a/gadgets/external/index.html.




| 167

Chapter 8 Administration Utilities

This chapter describes the administration utilities for various tasks after deployment, for example, modifying tibbr users and roles and permissions.

Topics

Introducing Utilities, page 169

Users

• Caching User Data, page 172

• Creating a User Account, page 173

• Deleting a User Account, page 175

• Undeleting a User Account, page 176

• Changing a User Login, page 177

• Resetting a Password, page 178

• Encrypting a Password, page 179

• Resetting an Email Address, page 180

• Enabling Applications for All Users, page 181

• Enabling All Or Certain Users to Follow the Specified Users, page 182

• Enabling All Or Certain Users to Unfollow the Specified Users, page 183

• Replicating User Data from LDAP, page 184

• Replicating Group Data from LDAP, page 186

• Creating a Group, page 188

• Adding Members to a Group, page 189

• Generating Influence Scores, page 190


168 | Chapter 8 Administration Utilities

Roles and Permissions

• Adding a User to a Role, page 191

• Adding an Administrator to the System, page 192

• Adding Banned Words From the Specified Text File, page 193

Subjects

• Indexing tibbr Content, page 194

• Creating a Subject, page 195

• Deleting a Subject, page 197

• Undeleting a Subject, page 198

• Creating Subscriptions for Subjects, page 199

• Removing Subscriptions From Subjects, page 200

• Adding Owners to Subjects From CSV, page 201

• Creating Subjects From CSV, page 202

• Creating Subscriptions From CSV, page 203

• Setting a Subject Hierarchy, page 204

• Enabling Manage Pages Option for All Subjects, page 205

• Merging Subjects, page 206

Message Delivery and Email Notification

• Creating Email Channels for All Users, page 207

• Creating Notifications on Subjects for All Users, page 208

• Creating Notifications on Specified Subjects for All Users, page 209

• Enabling Push Notifications, page 210

Filters

Creating a Filter for All Users, page 211

Jobs

Recovering Delayed Jobs, page 213


Introducing Utilities | 169

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 50 lists and describes tibbr’s administration utilities.

Table 50 tibbr Administration Utilities

Command Description Page

Caching User Data Caches all user data for faster access. 172

Creating a User Account Creates a user account with the specified login name, email address, and first and last names.

173

Deleting a User Account Deletes the specified user account. 175

Undeleting a User Account Restores a deleted user account. 176

Changing a User Login Changes an existing user’s login name (sometimes referred to as a user name).

177

Resetting a Password Resets a user’s password. 178

Encrypting a Password Encrypts a password string. 179

Resetting an Email Address Changes a user’s email address. 180

Enabling Applications for All Users

Enables applications for all users. 181

Enabling All Or Certain Users to Follow the Specified Users

Enables all or certain users to follow the specified users. 182

Enabling All Or Certain Users to Unfollow the Specified Users

Enables all or certain users to unfollow the specified users.

183

Replicating User Data from LDAP

Replicates into the tibbr database all the LDAP user data that matches the search criteria specified in the app_config.yml file.

184



Replicating Group Data from LDAP

Replicates into the tibbr database all the LDAP group data that matches the search criteria specified in the app_config.yml file.

186

Adding a User to a Role Adds a user with the specified login name to a role. 191

Adding Banned Words From the Specified Text File

Updates the banned words in the tibbr database without duplication.

193

Adding an Administrator to the System

Adds an administrator to the system. 192

Indexing tibbr Content Indexes the tibbr content for search. 194

Creating a Subject Creates a new subject. 195

Deleting a Subject Deletes a subject. 197

Undeleting a Subject Restores a deleted subject. 198

Creating Subscriptions for Subjects

Adds subscribers (followers) to one or more subjects. 199

Removing Subscriptions From Subjects

Removes subscribers (followers) from one or more subjects.

200

Adding Owners to Subjects From CSV

Adds multiple owners to the subjects specified in a comma-separated value (CSV)-based file.

201

Creating Subjects From CSV Creates subjects with owners by reading the subject names from a CSV file.

202

Creating Subscriptions From CSV

Creates subscriptions with the subjects and followers specified in a CSV file.

203

Setting a Subject Hierarchy Sets or resets the hierarchy for all the subjects in the tibbr database.

204

Enabling Manage Pages Option for All Subjects

Enables the Manage Pages option for all subject pages. 205

Merging Subjects Merges the posts in one subject with those in another subject.

206

Table 50 tibbr Administration Utilities (Cont’d)



Introducing Utilities | 171

Creating Email Channels for All Users

Creates email channels for all users. 207

Creating Notifications on Subjects for All Users

Creates notifications on the specified subjects for all users.

208

Creating Notifications on Specified Subjects for All Users

Creates notifications on the specified subjects for all the users.

209

Enabling Push Notifications Enables push notifications from the delayed-jobs queue to all the tibbr platforms.

210

Creating a Filter for All Users Creates a filter according to the specified criteria for all users.

211

Recovering Delayed Jobs Resolves the errors in the delayed jobs and recovers the jobs.

213

Table 50 tibbr Administration Utilities (Cont’d)




Caching User Data

This utility caches all user data for faster access. We recommend that you run this utility before making tibbr available to users to speed up the first-time login response.

Syntax ./cache_warmup_users.sh

Parameters None.

Dependencies Cache server and database

This utility consumes significant CPU and memory on both machines in which it runs, also on the database machine. Hence, run it on a machine with at least 512 MB physical RAM and two CPU cores.


Creating a User Account | 173

Creating a User Account

This utility creates a user account with the specified login name, email address, and first and last names.

Syntax ./tibbr_util.sh create_user login=login-name email=address password=password first_name=first-name last_name=last-name notify=true|false

Parameters

Description 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 Message Configuration on page 86.

Example The following example creates a user with the name Tom Riddle, the login name triddle, and the password secret:

If tibbr is in Lightweight Directory Access Protocol (LDAP) mode, the administrator cannot create user accounts with this command-line utility.


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.



./tibbr_util.sh create_user login=triddle [email protected] password=secret first_name=Tom last_name=Riddle notify=true

tibbr sends an activation message to [email protected], to which Tom Riddle must respond to activate his tibbr account.


Deleting a User Account | 175

Deleting a User Account

This utility deletes the specified user account.

Syntax ./tibbr_util.sh delete_user login=login-name

Parameter

Description The delete_user command deletes a user account. To restore a deleted user account, see Undeleting a User Account on page 176.

Example To delete the account for the user Tom Riddle with the login triddle, run this command line:

./tibbr_util.sh delete_user login=triddle


login=login-name Required. The login name of the user account to be deleted.



Undeleting a User Account

This utility restores a deleted user account.

Syntax ./tibbr_util.sh undelete_user login=login-name

Parameter

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


login=login-name Required. The login name of a previously deleted user account.


Changing a User Login | 177

Changing a User Login

This utility changes an existing user’s login name (sometimes referred to as a user name).

Syntax ./tibbr_util.sh change_user_login changed_logins="old_login|new_login,old_login1|new_login1"

Parameter

Description The change_user_login utility changes an existing user’s login name.

Example To change triddle, Tom Riddle’s old login name, to tomriddle; and bmalley, Ben Malley’s old login name, to benmalley, run this command line:

./tibbr_util.sh change_user_login

changed_logins=“triddle|tomriddle,bmalley|benmalley”


changed_logins="old_login|new_login,old_login1|new_login1"

Required. A pair of old and new login names separated by the | character.

To change the login names of multiple users, separate the users’ old and new login names with a comma.



Resetting a Password

This utility resets a user’s password.

Syntax ./tibbr_util.sh reset_password email=email-address

Parameter

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

Example To reset Tom Riddle’s password, run this command line:

./tibbr_util.sh reset_password [email protected]


email=email-address Required. The email address of the user whose password to reset.


Encrypting a Password | 179

Encrypting a Password

This utility encrypts a password string.

Syntax ./tibbr_config_util.sh encrypt input=password-string

Parameter

Description For security, you can encrypt a password with this utility and specify the encrypted key in the app_config.yml file.

Example To encrypt a password string, run this command line:

./tibbr_config_util.sh encrypt input=password

The output is an encrypted key, which you can then input into the app_config.yml file. Here is an example:Encrypted Key: D6f6dwQOp75yCPouZF9lXQ==


input=password-string Required. The string that serves as the password.



Resetting an Email Address

This utility changes a user’s email address.

Syntax ./tibbr_util.sh reset_email login=login-name email=address

Parameters

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

Example 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].


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.


Enabling Applications for All Users | 181

Enabling Applications for All Users

This utility enables applications for all users.

Syntax ./tibbr_util.sh subscribe_users_to_application_definitions names=”comma-separated-application-names”

Parameter

Description The subscribe_users_to_application_definitions command activates applications for all users. Before running this utility, look up the names of the applications in question in the application_definitions table or from the Manage Event Streams screen under the Administrator tab.

Example To enable Facebook, Twitter, and RSS Client for all users, run this command line:

./tibbr_util.sh subscribe_users_to_application_definitions names=”Facebook, Twitter, RSS Client"


names=comma-separated-application -names

Required. A list of the comma-separated names of the applications to enable for all users.



Enabling All Or Certain Users to Follow the Specified Users

This utility enables all or certain users to follow the specified users, called idols in tibbr nomenclature.

Syntax ./tibbr_util.sh add_idols_to_users idols=comma-separated-login names users=all|user-login-names

Parameters

Example To make all users follow Ben Malley and the tibbr administrator, run this command line:

./tibbr_util.sh add_idols_to_users idols=ben.malley,tibbradmin

users=all

To make Abby Bremen and Robert Oben follow Ben Malley and the tibbr administrator, run this command line:

./tibbr_util.sh add_idols_to_users idols=ben.malley,tibbradmin

users=abby.bremen,robert.oben


idols=comma-separated-login-names Required. A list of the comma-separated logins of the idols you would like all users to follow.

users=all|user-login-names Required. Either all (all users) or a comma-separated list of the logins of the users whom you would like to follow the idols.


Enabling All Or Certain Users to Unfollow the Specified Users | 183

Enabling All Or Certain Users to Unfollow the Specified Users

This utility enables all or certain users to unfollow the specified users, called idols in tibbr nomenclature.

Syntax ./tibbr_util.sh remove_idols_from_users idols=comma-separated-login- names users=all|user-login-names

Parameters

Example To make all users unfollow Ben Malley and the tibbr administrator, run this command line:./tibbr_util.sh remove_idols_from_users idols=ben.malley,tibbradmin users=all

To make Abby Bremen and Robert Oben unfollow Ben Malley and the tibbr administrator, run this command line:./tibbr_util.sh remove_idols_from_users idols=ben.malley,tibbradmin users=abby.bremen,robert.oben


idols=comma-separated-login- names

Required. A list of the comma-separated logins of the idols you would like all users to unfollow.

users=all|user-login- names Required. Either all (all users) or a comma-separated list of the logins of the users whom you would like to unfollow the idols.



Replicating User Data from LDAP

This utility replicates into the tibbr database all the LDAP user data that matches the search criteria specified in the app_config.yml file.

Syntax ./tibbr_util.sh replicate_ldap_users indexing_enabled=true|false

force_update=true|false undelete=true|false test=true|false

write_to_file=true|false data_output_file=’filename’

tibbr replicates only the data for new or updated users in LDAP since the last replication into the tibbr database. To force replication of user data that has not been updated in LDAP since the last replication, add the force_update option, as follows:

./tibbr_util.sh replicate_ldap_users indexing_enabled=true|false

force_update=true undelete=true|false test=true|false

write_to_file=true|false data_output_file=’filename’

Parameters Parameter Description

indexing_enabled=true|false The parameter that, if set to true, enables the user data that was updated during the replication process to be queued for indexing with the search server. The default is false.

When running replicate_ldap_users for the first time, set this parameter to false. Upon completion, run the reindex utility, which then indexes the replication updates for search.

For all subsequent executions of replicate_ldap_users, set this parameter to true. Subsequently, you need not run the reindex utility after replication.


Replicating User Data from LDAP | 185

If any of the required parameters are missing, tibbr displays an error message.

Example The following command line replicates into the tibbr database all the LDAP user data that matches the search criteria and logs that data into a file called output.txt in the tibbr_home/tibbr directory:

./tibbr_util.sh replicate_ldap_users indexing_enabled=false

force_update=false test=false write_to_file=true

data_output_file='output.txt'

force_update=true|false The parameter that, if set to false, updates only the delta of the user records, that is, those that were not synchronized during the last execution of the process or that were created after the last synchronization.

Setting this parameter to true adds or updates all the user records from LDAP without consideration of the delta. We recommend a true setting if you detect inconsistencies, such as missing users, after synchronization.

undelete=true|false The parameter that, if set to true, enables tibbr to restore in the tibbr database the user data that was deleted earlier and that is now reactivated in LDAP. The default is false.

test=true|false Required. The parameter that, if set to false, replicates into the tibbr database all the LDAP user data. Setting this parameter to true means no user data is entered into the tibbr database.

write_to_file=true|false Required. The parameter that, if set to true, logs the replicated user data into an output file. Setting this parameter to false means no such logging occurs.

data_output_file=’filename’ The name of the file (with or without its path) in which to log the replicated user data. If you do not specify a file path, tibbr creates the file in the tibbr_home/tibbr directory.




Replicating Group Data from LDAP

This utility replicates into the tibbr database all the LDAP group data that matches the search criteria specified in the app_config.yml file. Once replication succeeds, your people groups are displayed under People in the Groups tab.

Syntax ./tibbr_util.sh replicate_ldap_groups indexing_enabled=true|false

force_update=true|false test=true|false write_to_file=true|false

data_output_file=’filename’

tibbr replicates only the data for updated groups in LDAP since the last replication into the tibbr database.

Parameters

Be sure to verify that your LDAP groups are configured as described in Table 15.


indexing_enabled=true|false The parameter that, if set to true, enables the group data that was updated during the replication process to be queued for indexing with the search server. The default is false.

When running replicate_ldap_groups for the first time, set this parameter to false. Upon completion, run the reindex utility, which then indexes the replication updates for search.

For all subsequent executions of replicate_ldap_groups, set this parameter to true. Subsequently, you need not run the reindex utility after replication.


Replicating Group Data from LDAP | 187

If any of the required parameters are missing, tibbr displays an error message.

Example The following command line replicates into the tibbr database all the LDAP group data that matches the search criteria and logs that data into a file called output.txt in the tibbr_home/tibbr directory:

./tibbr_util.sh replicate_ldap_groups indexing_enabled=false

force_update=false test=false write_to_file=true

data_output_file='output.txt'

force_update=true|false The parameter that, if set to false, updates only the delta of the user records, that is, those that were not synchronized during the last execution of the process or that were created after the last synchronization.s

Setting this parameter to true adds or updates all the group records from LDAP without consideration of the delta. We recommend a true setting if you detect inconsistencies, such as missing groups, after synchronization.

test=true|false Required. The parameter that, if set to false, replicates into the tibbr database all the LDAP group data. Setting this parameter to true means no LDAP group data is entered into the tibbr database.

write_to_file=true|false Required. The parameter that, if set to true, logs the replicated group data into an output file. Setting this parameter to false means no such logging occurs.

data_output_file=’filename’ The name of the file (with or without its path) in which to log the replicated group data. If you do not specify a file path, tibbr creates the file in the tibbr_home/tibbr directory.




Creating a Group

This utility creates a group and assigns a user as the owner.

Syntax ./tibbr_util.sh create_group name=group-name user_name=owner-login

Parameters

Description The command create_group creates a group and assigns a user as the owner.

Example To create a group called ABC and assign the user whose login name is DEF as the owner, run this command line:

./tibbr_util.sh create_group name=ABC user_name=DEF


names=group-name Required. The name of the group.

user_name=login Required. The login name of the user to be assigned as the owner.


Adding Members to a Group | 189

Adding Members to a Group

This utility adds the specified users as members of the given group.

Syntax ./tibbr_util.sh add_members_to_group group_name=group-name members_names=login1,login2

Parameters

Description The command add_members adds the users whose login names are specified in the parameter user_name as members of the group identified by group_name.

Example To add the three users whose login names are hpotter, rweasley, and hgranger as members of the group called ABC, run this command line:./tibbr_util.sh add_members_to_group group_name=ABC members_names=hpotter,rweasley,hgranger


group_name=group-name Required. The name of the group to which to add members.

members_names=login1,login2 Required. A comma-separated list of the login names of the users to add as members of the group.



Generating Influence Scores

This utility generates an influence score for each of the users for the last four weeks.

Syntax ./tibbr_util.sh generate_influence_data

Description The generate_influence_data command creates a score for a user’s influence over the last four weeks.


Adding a User to a Role | 191

Adding a User to a Role

This utility adds a user with the specified login name to a role.

Syntax ./tibbr_util.sh add_user_to_role role_name=role-name user_login=login-name

Parameters

Description 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


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.



Adding an Administrator to the System

This utility adds an administrator to the system.

Syntax ./tibbr_util.sh create_system_user

Parameters

You must set up the above parameters in the server section of the app_config.yml file.

Description The create_system_user command creates a user in the system.

Example 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: triddleadmin_password: triddle

Afterwards, run this command line:./tibbr_util.sh create_system_user


admin_user: login-name Required. The login name of the user to be added to the system.

admin_password:password Required. The initial password of the user to be added to the system.

admin_email: email-address Optional. The email address of the user to be added to the system.


Adding Banned Words From the Specified Text File | 193

Adding Banned Words From the Specified Text File

This utility updates the banned words in the tibbr database without duplication.

Syntax ./tibbr_util.sh add_banned_words_from_the_given_txt_file input=’input-file-pathname’ error_file=true|false data_file_path=’output-file-pathname’

Parameter

Description The command add_banned_words_from_the_given_txt_file adds the words in the given text file to the tibbr database.

Example To add the 10 banned words in the one_banned.txt file in the current directory to the tibbr database, run this command line:

./tibbr_util.sh add_banned_words_from_the_given_txt_file

input=./public/one_banned.txt error_file=true

data_file_path=./public/output.txt


input=’input-file-pathname’ Required. The directory path of the input file.

error_file=true|false Required. The parameter that, if set to true, enables tibbr to log the output in a file.

data_file_path=

’output-file-pathname’The directory path of the output file.



Indexing tibbr Content

This utility indexes the tibbr content for search.

Syntax ./reindex.sh

Parameters None.

Description The reindex.sh script indexes the tibbr content.


Creating a Subject | 195

Creating a Subject

This utility creates a new subject.

Syntax ./tibbr_util.sh create_subject name=subject-name owner=login-name description="description-of-subject" scope=public|private|protected

Parameters 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-of-subject"

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.



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

Example 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

scope=public|private|

protected

Optional. The subject scope, which is either of these two settings:

• public — The subject is public, that is, all users can view and subscribe to the subject.

• private — 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.

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

If you do not specify a value for this parameter, the subject is public and available to all users.



Deleting a Subject | 197

Deleting a Subject

This utility deletes a subject.

Syntax ./tibbr_util.sh delete_subject name="subjet-name"

Parameter

Description 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 198.

Example To delete the subject slytherin.quotes, run this command line:

./tibbr_util.sh delete_subject name="slytherine.quotes"


name="subject-name" Required. The name of the subject you would like to delete.



Undeleting a Subject

This utility restores a deleted subject.

Syntax ./tibbr_util.sh undelete_subject name=”subject-name”

Parameter

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

Example This command restores the deleted subject slytherin.quotes:

./tibbr_util.sh undelete_subject name=”slytherin.quotes”


name=”subject-name” Required. The name of a subject that was previously deleted.


Creating Subscriptions for Subjects | 199

Creating Subscriptions for Subjects

This utility adds subscribers (followers) to one or more subjects.

Syntax ./tibbr_util.sh create_subscription subjects=subject1,subject2 users=login1,login2

To subscribe all users to one or more subjects, run this command line:

./tibbr_util.sh create_subscription_for_all_users subjects=subject1,subject2

Parameters

Description The command create_subscription creates subscriptions for one or more subjects.

Example 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


subjects=subject1,subject2 Required. A comma-separated list of the names 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. A comma-separated list of the login names 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.



Removing Subscriptions From Subjects

This utility removes subscribers (followers) from one or more subjects.

Syntax ./tibbr_util.sh remove_subscription subjects=subject1,subject2 users=login1,login2

Parameters

Description The command remove_subscription removes subscriptions from one or more subjects.

Example To remove subscriptions for the subjects sales and marketing for the users hpotter, rweasley, and hgranger, run this command line:./tibbr_util.sh remove_subscription subjects=sales,marketing users=hpotter,rweasley,hgranger


subjects=subject1,subject2 Required. The name of one or more subjects from which to remove 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 remove one or more subscriptions. To remove subscriptions for multiple users, specify the latter’s login names in a comma-separated list.


Adding Owners to Subjects From CSV | 201

Adding Owners to Subjects From CSV

This utility adds multiple owners to the subjects specified in a comma-separated value (CSV)-based file.

Syntax ./tibbr_util.sh add_owners_to_subjects_from_csv file_path=’CSV-pathname’ write_to_file=true|false log_file=’logfile-name’

Parameters

Description The command add_owners_to_subjects_from_csv adds the owners specified in the CSV file to the subjects specified in the file.

Example For example, to add owners to 50 subjects, each of which with a different number of owners, create a CSV file with the subject names in the first column and the owner names in the other columns.

Here is an example of the command line:./tibbr_util.sh add_owners_to_subjects_from_csv file_path='subject_input.csv' write_to_file=true log_file='subject_create.log'


file_path=CSV-pathname Required. The directory path of the input CSV file.

write_to_file=true|false Required. The parameter that, if set to true, enables tibbr to log the output in a file.

log_file=’logfile-name’ The name of the log file.

Ensure that the subjects specified in the CSV file are in the tibbr database. Otherwise, this utility logs errors.



Creating Subjects From CSV

This utility creates subjects with owners by reading the subject names from a CSV file.

Syntax ./tibbr_util.sh create_subjects_from_csv file_path=’CSV-pathname’ write_to_file=true|false log_file=’logfile-name’

Parameters

Description The command create_subjects_from_csv creates subjects by reading the related details (subject names, descriptions, scope, and owner names) from the specified CSV file.

Example To create, for example, 25 subjects and assign owners to them, run this command line:./tibbr_util.sh create_subjects_from_csv file_path='subject_input.csv' write_to_file=true log_file='subject_create.log'


file_path=CSV-pathname Required. The directory path of the input CSV file.

write_to_file=true|false Required. The parameter that, if set to true, enables tibbr to log the output in a file.

log_file=’logfile-name’ The name of the log file.

Ensure that the owners specified in the CSV file are login names, which must be already in the tibbr database.


Creating Subscriptions From CSV | 203

Creating Subscriptions From CSV

This utility creates subscriptions with the subjects and followers specified in a CSV file.

Syntax ./tibbr_util.sh create_subscriptions_for_given_csv_file input=’CSV-pathname’ error_file=true|false data_file_path=’logfile-pathname’

Parameters

Description The command create_subscriptions_for_given_csv_file creates subscriptions by reading the related details (subject and follower names) from the specified CSV file.


input=’CSV-pathname’ Required. The directory path of the input CSV file.

error_file=true|false Required. The parameter that, if set to true, enables tibbr to log the output in a file.

data_file_path=’logfile-pathname’ The directory path of the log file.



Setting a Subject Hierarchy

This utility sets or resets the hierarchy for all the subjects in the tibbr database.

Syntax ./tibbr_util.sh set_subject_hierarchy

Parameters None.

Description This utility sets a root subject from which to create a hierarchy tree.


Enabling Manage Pages Option for All Subjects | 205

Enabling Manage Pages Option for All Subjects

This utility enables the Manage Pages option for all subject pages.

Syntax ./tibbr_util.sh enable_manage_pages

Parameters None.

Description This utility runs through all the subjects in the tibbr database and enables the Manage Pages option so that it is displayed on all the subject pages.



Merging Subjects

This utility merges the posts in one subject with those in another subject.

Syntax ./tibbr_util.sh merge_subjects source=subject1 target=subject2

Parameters

Description This operational utility merges the posts in one subject into another subject, usually to clean up unwanted or invalid subjects. You can run this utility even when the tibbr server is running. Be sure to inform your tibbr users beforehand, however.

Since the number of posts to be merged might be large, we recommend that you run this utility when the system load is light.

Example To merge the posts in the subject Tech_Sessions into the subject All_Sessions, run this command line:

./tibbr_util.sh merge_subjects source=Tech_Sessions

target=All_Sessions


source=subject1 Required. The name of the subject whose posts are to be merged into another subject.

target=subject2 Required. The name of the subject into which the posts in subject1 are to be merged.


Creating Email Channels for All Users | 207

Creating Email Channels for All Users

This utility creates email channels for all users.

Syntax ./tibbr_util.sh create_email_channel_for_all

Parameters None.

Description This utility, equivalent to the Add New operation under Message Delivery in the My Profile tab, sets up email as the message-delivery channel for all users.



Creating Notifications on Subjects for All Users

This utility creates notifications for all the users on the subjects that they follow.

Syntax ./tibbr_util.sh add_notifications_on_subjects_for_all_users notify_on_subscribed_subjects=true|false schedule=day|realtime|hour

Parameters

Description This utility enables tibbr to alert all the users of new posts on the subjects that they follow according to the specified schedule.

Example To alert all users in real time of new posts on the subjects that they follow, run this command line:./tibbr_util.sh notify_on_subscribed_subjects=true schedule=realtime

Ensure that you have run the preceding utility, create_email_channel_for_all, before running this one.


notify_on_subscribed_subjects

=true|false

Required. The parameter that, if set to true, enables tibbr to notify all users of new posts on the subjects that they follow. The default is false, in which case tibbr notifies users of new posts on the users’ walls only.

schedule=day|hour|realtime Required. The frequency (once a day, once an hour, or in real time) at which to alert the users.


Creating Notifications on Specified Subjects for All Users | 209

Creating Notifications on Specified Subjects for All Users

This utility creates notifications on the specified subjects for all the users.

Syntax ./tibbr_util.sh

add_notifications_on_specific_subjects_for_all_users

subjects=subject-names schedule=day|realtime|hour overwrite_existing_notification=true|false

Parameters

Description The add_notifications_on_specific_subjects_for_all_users command enables tibbr to alert all the users of new posts on the specified subjects.

Example To alert all the users once a day of new posts on the tibbr.announcements subject, run this command line:./tibbr_util.sh add_notifications_on_specific_subjects_for_all_users subjects=tibbr.announcements schedule=day overwrite_existing_notification=true


subjects=subject-names Required. The names of one or more subjects on which to create notifications.

schedule=day|hour|realtime Required. The frequency (once a day, once an hour, or in real time) at which to alert the users.

overwrite_existing_notification Required. The parameter that, if set to true, enables tibbr to replace the current notifications with the newly created ones.



Enabling Push Notifications

This utility enables push notifications from the delayed-jobs queue to all the tibbr platforms.

Syntax ./tibbr_util.sh add_push_notification_job

Parameters None.

Description This utility enables push notifications to all the platforms that have been registered with the tibbr server.

Example To enable push notifications for all the devices (iPhone, Android, and BlackBerry) that are registered with the tibbr server, run this utility.


Creating a Filter for All Users | 211

Creating a Filter for All Users

This utility creates a filter according to the specified criteria for all users.

Syntax ./tibbr_util.sh create_filter_for_all_users name=filter-name desc=filter-description subject_names=fully-qualified-subject-names start_date=start-date-of-filter end_date=end-date-of-filter keywords=keywords-for-filter-search people=login-names-of-users-for-filter

Parameters

Examples • To create a filter called My Company News for the subjects tibbr.help and tibbr.announcements, run this command line:./tibbr_util.sh create_filter_for_all_users name=’My Company News’ desc=’News on the company’ subject_names=’tibbr.help,tibbr.annoucements’

• To create a filter called My Company News for the period November 1, 2011 to December 31, 2011, run this command line:./tibbr_util.sh create_filter_for_all_users name='My Company News' desc=’News on the company’ start_date=2011-11-01 end_date=2011-12-31


name=’filter-name’ Required. The name of the filter enclosed within single quotes.

desc=’filter-description’ Required. A description of the filter enclosed within single quotes.

subject_names=

’fully-qualified-subject-names’

A list of comma-separated names of one or more subjects for which to create a filter. Enclose the names within quotes.

start_date=start-date-of-filter

The date (in the format YYYY-MM-DD) on which to start the filter.

end_date=end-date-of-filter

The date (in the format YYYY-MM-DD) on which to end the filter.

keywords=keywords-for-filter-search

One or more keywords according to which to search for the filter.

people=login-names-of-users-for-filters

A list of comma-separated logins of the users for whom to create the filter.



• To create a filter called My Company News on the keywords tibbr and help, run this command line:./tibbr_util.sh create_filter_for_all_users name='My Company News' desc=’News on the company’ keywords=’tibbr,help’

• To create a filter called My Company News on the people Adam Edwards and Ben Malley, run this command line:./tibbr_util.sh create_filter_for_all_users name='My Company News' desc=’News on the company’ people=’adam.edwards,ben.malley’

• To create a filter called My Company News in the subject tibbr.help on the keywords tibbr and help on Ben Malley, run this command line:./tibbr_util.sh create_filter_for_all_users name='My Company News' desc=’News on the company’ subject_names=tibbr.help keywords=’tibbr,help’ people=ben.malley


Recovering Delayed Jobs | 213

Recovering Delayed Jobs

This utility resolves the errors in the delayed jobs and recovers the jobs.

Syntax ./tibbr_util.sh recover_schedules_delayed_jobs

Parameters None.

Description This utility moves the delayed jobs to a table and then fixes their errors, such as incorrect or cohesive values.




| 215

Chapter 9 Monitoring of tibbr Processes

This chapter spells out the scripts for monitoring tibbr processes and specifies the locations of the related log files, where applicable.

All the scripts for monitoring tibbr processes reside in the tibbr_home/scripts/monitor directory.

Topics

• Core Server, page 216

• Web Client, page 217

• Memcached, page 218

• Job Runners, page 219

• Search Engine, page 220

• Chat Server, page 221

• Apache HTTP Server, page 222


216 | Chapter 9 Monitoring of tibbr Processes

Core Server

To monitor the core server, run the core_server_check.sh script. To view the core server activities, browse the tibbr_home/logs/tibbr_server.log file.


Web Client | 217

Web Client

To monitor the Web client, run the webclient_check.sh script.

To monitor the Web client’s response time, run the webclient_completed_time_check.sh.

To view the Web client server’s activities, browse the tibbr_home/logs/tibbr_webclient.log file.



Memcached

To find out if memcached is running, run the memcache_check.sh script.

No other monitoring of memcached is required.


Job Runners | 219

Job Runners

tibbr has three job runners: main, supplemental, and application.

To monitor the main job runner, run the main_job_runner_check.sh script.

To monitor the supplemental job runner, run the supplemental_job_runner_check.sh script.

To monitor the application job runner, run the app_runner_check.sh script.

To find out the number of pending main, supplemental, and application jobs, run one of the following queries for your database type:

• MySQLselect count(*) from delayed_jobs where run_at < NOW()

• MSSQLselect count(*) from delayed_jobs where run_at < getutcdate()

• Oracleselect count(*) from delayed_jobs where run_at <

CURRENT_TIMESTAMP

Table 51 lists the priority numbers and log files for the three job runners. All the log files reside in the tibbr_home/logs directory.

Table 51 Priority Numbers for Job Runners

Job Runner Priority Numbers Log Files

Main job runner 20 through 99 main_job_runner1_console.log

main_job_runner_1.log

Supplemental job runner 0 through 19 supplemental_job_runner_1_console.log

supplemental_job_runner_1.log

Application job runner 100 app_runner.log

app_runner_console.log

app_runner_java.log



Search Engine

To monitor the search engine, run the search_engine_check.sh script.

To view the search engine’s activities, browse the tibbr_home/tibbr-config/solr/log/solr_production.log file.


Chat Server | 221

Chat Server

To monitor the chat server, run the chat_server_check.sh script.

Monitoring the process level is adequate for the chat server.

To view the chat server’s activities, browse the tibbr_home/tibbr-config/prosody/log/prosody.log file.



Apache HTTP Server

To monitor the Apache HTTP Server, run the apache_check.sh script.

The output shows the number of processes.

To view the Apache HTTP Server’s activities, browse these four files at tibbr_home/tools/apach2/logs/:

• main-access_log

• main-error_log

• ssl_request.log

• access_log


| 223

Chapter 10 Authentication

tibbr supports five authentication schemes, as follows:

• Database

• Microsoft Active Directory

• SSO through a Web server

• SSO through SAML

• Mixed mode

Topics

• Database, page 224

• Active Directory, page 225

• SSO Through a Web Server, page 226

• SSO Through SAML, page 228

• Mixed Mode, page 230


224 | Chapter 10 Authentication

Database

The simplest form of authentication is through the database. In this scheme, tibbr authenticates against the user store in the tibbr database, in which the user names and encrypted passwords are stored.

Authentication through the database is a simple two-step process:

1. The user enters the credentials (user name and password) on the tibbr login page.

2. tibbr verifies the credentials against the tibbr database and, if they are valid, accords the user access.

Figure 5 illustrates the process.

Figure 5 Authentication Through the Database

The advantage for this scheme is that it is available for tibbr on the Web and mobile platforms regardless of the identity-management system adopted by your company.

However, the following cons apply:

• Two user stores and multiple credentials are required for companies with their own identity management systems, resulting in complexity and labor-intensive maintenance.

• The manual efforts involved in creating user profiles in the database is far less efficient than their automatic synchronization with Active Directory.


Active Directory | 225

Active Directory

tibbr can authenticate against your corporate Active Directory on the Web and mobile platforms. The authentication process is as follows:

1. The user enters the credentials (user name and password) on the tibbr login page.

2. tibbr verifies the credentials against Active Directory and, if they are valid, accords the user access.


Figure 6 Authentication Through Active Directory

A major advantage for this scheme is that in the case of integration with Active Directory, tibbr can extract user profiles from there, eliminating the step of recreating them in the tibbr database.

For hosted tibbr installations, however, you must open a proxy server in the DMZ so that the tibbr server can communicate with your corporate Active Directory in the intranet.



SSO Through a Web Server

You can make SSO available for tibbr users by authenticating them through a Web server, such as the Apache HTTP Server (commonly called Apache) or IIS. Apache supports SSO through the mod_auth_tkt or mod_ldap module; IIS does that through NT LAN Manager (NTLM) or Kerberos.

Here is the authentication process:

1. The user types the tibbr URL in the browser.

2. The Web server intercepts the access request and presents the user with a challenge.

3. The user enters his credentials, which the Web server then verifies for validity. If they are valid, the Web Server sets the REMOTE_USER environment variable in the header of the user request and forwards the request to tibbr.

4. tibbr redirects the user to its home page.


Figure 7 Authentication for SSO Through a Web Server


SSO Through a Web Server | 227

Obviously, a major advantage of this scheme is SSO. That means that users can access all the systems in your company by logging in only once through, for example, Integrated Windows Authentication (IWA) through IIS.

However, this scheme is not available for the tibbr mobile clients (for iOS, Android, and BlackBerry) and tibbr Desktop. Also, unlike the Active Directory scenario, user profiles are not automatically propagated to the tibbr database.

Here is what we recommend:

1. Schedule regular synchronizations with Active Directory to keep user profiles in the tibbr database up-to-date.

2. Set up authentication for SSO through a Web server. Be sure to adopt authentication chaining (see the explanation at the beginning of this chapter) so that mobile devices can rely on Active Directory for authentication.

For this scheme to work in hosted tibbr installations, you must open a proxy server in the DMZ.

For two examples on how to set up SSO authentication through third-party modules, see the following:

• Appendix D, SSO Authentication for tibbr Through IWA, on page 259

• Appendix E, SSO Authentication for tibbr Through Apache, on page 275



SSO Through SAML

Another alternative of making SSO available for tibbr users is through SAML 2.0. For details, see—http://www.oasis-open.org/committees/tc_home.php?wg_abbrev=security#samlv20

In this scheme, the SAML server processes access requests by verifying user credentials and sending a SAML token to tibbr through POST requests with the parameter SAMLResponse. Many identity vendors support SSO authentication through SAML or through a Web server.

Here is the authentication process:

1. The user types the tibbr URL in the browser.

2. tibbr redirects the access request to the SAML server, which presents the user with a login page.

3. The user enters the credentials.

4. The SAML server verifies the credentials and, if they are valid, redirects to tibbr with a SAML token in the request.

5. tibbr redirects the user to its home page.



SSO Through SAML | 229

Figure 8 Authentication for SSO Through SAML

The pros and cons for this scheme are the same as that for the SSO-through-a-Web-server scheme. See the previous section for details. The same recommendations apply.



Mixed Mode

The capability of authentication chaining in tibbr enables you to specify multiple authentication schemes. For example:

• To set SAML or LDAP as the scheme, set the authentication configuration parameter as authentication: saml,ldap.

That means that SAML authentication is in place for Web-based tibbr; and LDAP authentication, for native tibbr mobile applications.

• To set SSO or LDAP as the scheme, set the authentication configuration parameter as authentication: sso,ldap.

That means that SSO authentication is in place for Web-based tibbr; and LDAP authentication, for native tibbr mobile applications.


| 231

Chapter 11 Multitenancy

Multitenancy means a single tibbr deployment that runs on one or multiple servers and that serves multiple tenants, which are also called logical tibbr deployments or domains. You can run multiple tibbr deployments on the same set of hardware.

With the multitenant architecture, tibbr can partition its data and configurations, whereby each tenant works with a customized virtual tibbr instance. That way, you can partition resources like Solr search, MySQL database, Apache Cassandra, and Memcache.

This chapter explains how to configure tibbr to run in multitenant mode.

Topics

• Multitenant Configurations, page 232

• Database Configuration and Support, page 233

• Tenant-Specific Configurations, page 234


232 | Chapter 11 Multitenancy

Multitenant Configurations

Configuration parameters for multitenancy are available under the Multitenant tab of the application configuration manager at http://your_tibbr_domain-or-IP_address:7777. For details, see Multitenancy Configuration on page 89.

To configure the search server in master-slave mode for multitenancy:

1. Copy the solr.xml file in the tibbr_home/tibbr-config/multicore_solr_configs directory to the tibbr_home/tibbr-config/solr directory on both the master and slave instances.

2. Copy the solrconfig.xml file in the tibbr_home/tibbr-config/multicore_solr_configs directory to the tibbr_home/tibbr-config/solr_slave/conf directory on the slave instances only.

Perform these steps for first-time installations of tibbr only, not for upgrades.


Database Configuration and Support | 233

Database Configuration and Support

In the application configuration manager, you can configure only the base instance database under the Database tab.

tibbr supports multitenancy with the MySQL database only. The database user specified as part of the database setting must have the privilege of creating schemas.


234 | Chapter 11 Multitenancy

Tenant-Specific Configurations

The default data for a tenant is in the tenant_seed_prod.yml file in the tibbr_home/tibbr-config/shared/config directory.

To create and configure a tenant:

1. Create a tenant by first clicking View/Edit Tenants under Tenant Management in the left panel of the Administrator tab. For details, see the section Manage Tenants in the tibbr How-To Guide.

After creation, the new tenant configurations reside in a file called app_config.yml in the tibbr_home/tibbr-config/shared/tenant_name directory.

2. Configure the tenant-specific properties by editing the app_config.yml file mentioned in step 1.

For example, you can set different passwords for the tibbr administrators in the tenants’ app_config.yml files. Similarly, configure the other properties as you desire for the various tenants.


| 235

Chapter 12 Hints and Tips

This chapter contains the frequently asked questions and their answers, which you might find helpful while configuring tibbr.

Topics

• 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 on 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?

Q: How do I enable the user hierarchy?

A: See Display of User Hierarchy on page 98.

Q: How do I disable the Change Password link in an LDAP setup?

A: Set the password_control parameter, which is described in Table 26, Web UI Configuration Parameters.

Q: How do I disable the Invitation to Join tibbr link on the right panel of the home page?

A: Set the join_tibbr parameter, which is described in Table 26, Web UI Configuration Parameters.


236 | Chapter 12 Hints and Tips

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

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:

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

— 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 96.

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

Do not add or delete spaces from the lines. The leading hyphen in the first line denotes list members in YAML syntax.


Hints and Tips | 237

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]"],: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 first login attempt. tibbr creates the user account at first login. However, for good housekeeping, we do recommend that you schedule a regular cron job to synchronize user data at a frequency that you prefer.

To set up the cron 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.


238 | Chapter 12 Hints and Tips


| 239

Appendix A Installation of Oracle Expenses PL/SQL for the tibbr Application

This appendix describes how to install or uninstall Oracle Expenses PL/SQL for the tibbr application.

Topics

• Prerequisite, page 240

• Related Files, page 241

• Installation Procedure, page 242

• Uninstallation Procedure, page 243

This feature is not available in tibbr Community and tibbr Community Service.


240 | Appendix A Installation of Oracle Expenses PL/SQL for the tibbr Application

Prerequisite

The Oracle Expenses application requires the driver file ojdbc6.jar. For details on how to download the driver file and where to place it, see the readme.


Related Files | 241

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 — This file creates the tibbr user database and the table space.

• installtibbrapi.tar — This file creates the tibbr API and grants the necessary permissions from the application to the tibbr schema.



Installation Procedure

To install Oracle Expenses PL/SQL for the tibbr application:

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.

Before installing Oracle Expenses PL/SQL for the tibbr application, ensure that you have installed the Oracle client on the Oracle Application Server.

Currently, this procedure applies to Oracle Application Server Release 11.5.10.


Uninstallation Procedure | 243

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.




| 245

Appendix B Installation of an SAP Application in tibbr

This appendix describes how to install or uninstall an SAP application for tibbr. You have two options for installation: Create a transport or import an add-on.

Topics

• Create a Transport, page 246

• Import an Add-On, page 247

• Uninstall an SAP Application, page 248

This feature is not available in tibbr Community and tibbr Community Service.


246 | Appendix B Installation of an SAP Application in tibbr

Create a Transport

You can install the SAP application 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.


Import an Add-On | 247

Import an Add-On

Alternatively, you can import an add-on that is certified by SAP. Contact TIBCO Support for assistance.


248 | Appendix B Installation of an SAP Application in tibbr

Uninstall an SAP Application

To uninstall an SAP application, execute the transaction SE80 in SAP and delete the objects in the ZESN_INT package and then the package itself.


| 249

Appendix C 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 250

• Using tibbr Web Parts, page 252

• Synchronizing User Profiles, page 255

• Importing tibbr SharePoint Sites, page 257


250 | Appendix C Installation and Deployment of tibbr on SharePoint

Installing and Configuring tibbr on SharePoint

To install tibbr on SharePoint:

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

Unless otherwise stated, the files referred to in the following steps, such as tibbrForSharePoint.wsp, reside at tibbr_home/external/SharePoint/tibbr4sharepoint.


Installing and Configuring tibbr on SharePoint | 251

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>



Using tibbr Web Parts

tibbr for SharePoint contains numerous Web Parts, as described in Table 52.

Table 52 tibbr Web Parts for SharePoint

Web Part Task

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.

Dynamic Gadgets Operates as other gadget Web Parts according to the property settings.


Using tibbr Web Parts | 253

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.

SPSearch Messages Displays the tibbr messages that match the search keywords on the SharePoint search page.

SPSearch Subjects Displays the tibbr subjects that match the search keywords on the SharePoint search page.

SPSearch People Enables search for tibbr users through the SharePoint people-search capability.

Table 52 tibbr Web Parts for SharePoint (Cont’d)

Web Part Task



The properties of the Subjects Web Part are displayed.

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'. Note: This field is required for the Subject Messages Web Part.

2. Edit the other properties, as appropriate, and click OK.


Synchronizing User Profiles | 255

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 SynchronizationTo prepare for synchronization:

1. Edit the for sharepoint profile sync section in the user_meta_details.yml file in the tibbr_home/tibbr-config directory to reflect the fields of your SharePoint user profile.

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 tibbr, enclosed within quotes.

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"



assistant: "Assistant"past_projects: "Past Projects"skills: "Skills"schools: "Schools"birthday: "Birthday"interests: "Interests"

b. Edit the values and add more labels, as appropriate.

c. Restart the tibbr server so that the updates to the user_meta_details.yml file can take effect.

Running the Synchronization CommandTo 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.


Importing tibbr SharePoint Sites | 257

Importing tibbr SharePoint Sites

If you import SharePoint sites, you can take advantage of the following features:

• tibbr’s SharePoint Web parts have the SharePoint look and feel along with pagination for the Web parts.

• mysite and the tibbr site are concurrently available.

• You can create a tibbr community site with a custom SharePoint template, which then results in a new subject in tibbr.

• Web parts for navigating users and subjects on the SharePoint mysite home page are available.

To deploy tibbr’s SharePoint packages and import preconfigured SharePoint sites that contain tibbr Web parts, do the following:

1. In the SharePoint server, choose Microsoft SharePoint 2010 Products > SharePoint 2010 Management Shell > Run as administrator.

The Management Shell (also called Power Shell) is displayed.

2. Go to tibbr_home/external/SharePoint/sites and run the script tibbrWSPDeploy.ps1.

You are prompted in the Management Shell for the path of the solutions.

3. Type the directory path for the solutions and press Enter.

The path is the same as tibbr_home/external/SharePoint/sites.

Afterwards, the Management Shell deploys the required packages for SharePoint Web parts and Web services, displaying the progress on screen.

The Management Shell then prompts:

Please enter the SharePoint site collection url for tibbr

Community Template to be installed:

Before performing the steps below, be sure to delete the TibbrCustomSPWSDeploy.wsp, tibbrForSharepoint.wsp, and navigationGadget.wsp files from your SharePoint instance.

The Management Shell asks whether to import the tibbr site and mysite with prearranged Web parts. If you type Y, the Management Shell will overwrite the given SharePoint site and SharePoint mysite with tibbr’s SharePoint sites.



4. Type the URL of the SharePoint site collection in which the tibbr community site template is to be installed, that is, the site collection in which to add the tibbr site.

Afterwards, Management Shell installs the tibbr community template and prompt you for the SharePoint site URL for the tibbr SharePoint site to be imported.

5. Create a team site in SharePoint with the URL for importing the tibbr SharePoint site.

6. Type the SharePoint site URL and press Enter.

The Management Shell then imports the tibbr SharePoint site and prompts for the mysite URL for importing tibbr’s SharePoint mysite.

7. Type the URL and press Enter.

The Management Shell then imports tibbr’s SharePoint mysite.

8. Edit the SharePoint tibbr site’s web.config file and add these three lines to the bottom of the <appSettings> section:

<add key="BaseURL" value="http://your_tibbr_domain/a/gadgets/" /> <add key="tibbrUserName" value="tibbr_admin_user_name" /> <add key="tibbrPassword" value="tibbr_admin_password" />

9. Add the following tag to the <appSettings> section of the web.config file of SharePoint mysite for navigation to work with the subjects:

<add key="NavigationURL" value="http://SPSiteURL/" />

where SPSiteURL is the URL of the SharePoint site collection in which you installed the community template.

10. Repeat step 2 in the section Configuration of REST Service.


| 259

Appendix D SSO Authentication for tibbr Through IWA

When users log in to the tibbr Web interface, the tibbr server verifies their credentials according to the authentication scheme you have in place. You can also set up SSO authentication through other modules, such as Integrated Windows Authentication (IWA). This appendix shows you how.

For another example, see Appendix E, SSO Authentication for tibbr Through Apache.

Topics

• Architecture, page 260

• Configuration of IWA, page 261

• Installation and Configuration of AAR, page 267

• Configuration of Secure tibbr Access, page 274


260 | Appendix D SSO Authentication for tibbr Through IWA

Architecture

Figure 9 illustrates how tibbr authenticates for SSO through IWA.

Figure 9 Windows Integrated Authentication for tibbr

This architecture requires two Domain Name Systems (DNS) for tibbr access: one for browser HTTP requests and the other for mobile-device requests.

Also note the following:

• All browser HTTP requests proceed through IWA on IIS 7. See the next section for details on how to redirect the Internet Server Application Programming Interface (ISAPI) to do the same.

Mobile-device requests go through the Apache HTTP Server (commonly called the Apache Web Server or Apache) on the tibbr server, which authenticates them against Active Directory.


Configuration of IWA | 261

Configuration of IWA

First, follow the procedure below to configure IWA—a mod_jk connector for connecting with the Apache HTTP Server—for tibbr:

1. In IIS Manager, click Sites in the left panel and right-click SharePoint – 80 (or the site of the Web application) for the context menu.

2. Choose Add Virtual Directory for the related dialog box and fill in the fields, as shown in the example below, which assumes that you would like to extract the related files in a directory called isapi in your C drive. Click OK.

3. Download the 32-bit or 64-bit Tomcat connector (tomcat-connectors-1.2.32-windows-x86_64-iis.zip) from the Apache site at http://www.apache.org/dist/tomcat/tomcat-connectors/jk/binaries

/windows.

The user-interface descriptions in the following steps pertain to IIS 7. The UI in other IIS versions might vary.



4. Extract the files in C:\isapi or the directory you specified in step 2. This screenshot shows an example of the result:

5. In the left panel of IIS Manager, click Sites > SharePoint – 80 and double-click ISAPI Filters in the center panel to display the filers.

6. Click Add in the right panel for the Add ISAPI Filter dialog box.

7. Fill in the fields, as shown in the example below, assuming that C:\isapi\isapi_redirect.dll is the path you desire. Click OK.



8. In the left panel, click the server name near the top and double-click ISAPI and CGI Restrictions in the center panel.

The ISAPI and CGI Restrictions panel is displayed.

9. Click Add in the right panel for the related dialog box.

10. Fill in the fields and select Allow extension path to execute, as shown in the example below. Click OK.

IIS creates and adds the entry to the bottom of the ISAPI and CGI Restrictions panel, as shown in this example:



11. Click Jakarta in the left panel and double-click Handler Mappings in the center panel.

The handler mappings are displayed in the center panel, as in this example:

12. Verify that for ISAPI-dll, Enabled is shown under State.

13. Click Edit Feature Mappings in the right panel for the related dialog box.

14. Select Allow unspecified ISAPI modules and click OK.



15. Configure the isapi_redirect.properties file for your environment. For details, see the Apache documentation at http://tomcat.apache.org/connectors-doc/reference/iis.html.

Below is an example of the isapi_redirect.properties file. The four boldfaced lines require customization.

isapi_redirect.properties# Configuration file for the Jakarta ISAPI Redirector

# The path to the ISAPI Redirector Extension, relative to the website# This must be in a virtual directory with execute privilegesextension_uri=/jakarta/isapi_redirect.dll

# Full path to the log file for the ISAPI Redirectorlog_file=c:\isapi\isapi_redirect.log

# Log level (debug, info, warn, error or trace)log_level=debug

# Full path to the workers.properties fileworker_file=c:\isapi\workers.properties

# Full path to the uriworkermap.properties fileworker_mount_file=c:\isapi\uriworkermap.properties

16. Configure the uriworkermap.properties file for your environment. For details, see the Apache documentation at http://tomcat.apache.org/connectors-doc/reference/uriworkermap.

html.

Below is an example of the uriworkermap.properties file.

# *********** Begin uriworkermap.properties ***## Simple worker configuration file#

# Mount the Servlet context to the ajp13 worker/a/*=tibbr/tibbr/*=tibbr/web/*=webclient

# Advanced mount of the examples context# /examples/servlet/*=ajp13# ************* End uriworkermap.properties ****/jkmanager=jkstatus



17. Configure the workers.properties file for your environment. For details, see the Apache documentation at http://tomcat.apache.org/connectors-doc/reference/workers.html.

Below is an example of the workers.properties file. The two boldfaced lines require customization.

# Define 3 workers, 2 real workers using ajp13, the last one being a JK status worker worker.list=webclient,tibbr,jkstatus

worker.webclient.type=ajp13worker.webclient.host=<specify tibbr host or ip>worker.webclient.port=8009worker.webclient.lbfactor=1worker.webclient.connection_pool_timeout=600worker.webclient.connection_pool_size=250worker.webclient.socket_keepalive=1worker.webclient.socket_timeout=60

worker.tibbr.type=ajp13worker.tibbr.host=<specify tibbr host or ip>worker.tibbr.port=9009worker.tibbr.lbfactor=1worker.tibbr.connection_pool_timeout=600worker.tibbr.connection_pool_size=250worker.tibbr.socket_keepalive=1worker.tibbr.socket_timeout=60

#status onlyworker.jkstatus.type=status

Finally, restart the IIS server for the configurations to take effect.


Installation and Configuration of AAR | 267

Installation and Configuration of AAR

Next, install and configure the Application Request Routing (ARR) module so that IIS can serve as a proxy server and forward requests to Tomcat. Follow the procedure below.

Installation

1. Download the ARRv2_setup_x86_en-us.EXE file (called ARRv2_setup_amd64_en-us.EXE for 64-bit Windows) and double-click it.

The following dialog box is displayed.

2. Click Yes.

When installation is complete, a log file called arr_setup.log resides in the %TEMP% folder, as confirmed by this message:



Configuration of AAR as Proxy Server

1. In IIS Manager, click Application Request Routing Cache and then click Open Feature under Act ions



2. Click Server Proxy Settings under Actions.

3. Select Enable proxy and click Apply. Leave the default settings as is.



Definition of URL Rewrite Rules for IIS

1. Click Default Web Site under Connections, select URL Rewrite, and click Open Feature under Actions.



2. Click Add Rules under Actions.

3. Click Blank rule in the Add Rule(s) dialog box and click OK.



4. Add two rules, HTTP bind mapping and downloads, under Edit Inbound Rule:

— For the rule on HTTP bind mapping, type a name of your choice in the Name text field and then type http-bind in the Pattern text field. Click Apply.



— For the rule on downloads, type a name of your choice in the Name text field and then type downloads/([_0-9a-z-\,]+) in the Pattern text field. Click Apply.



Configuration of Secure tibbr Access

Next, to secure SSO access to tibbr, set up the Remote Address Filter. For a description of the filter and its attributes, see the Tomcat documentation at http://tomcat.apache.org/tomcat-5.5-doc/config/valve.html#Remote_A

ddress_Filter.

To restrict access to Tomcat through the IP address or host name, edit these two files:

• tibbr-home/tools/tomcat/tibbr/conf/server.xml

• tibbr-home/tools/tomcat/webclient/conf/server.xml

As reference, see the examples at—

http://www.digitalsanctum.com/2008/11/05/restricting-access-to-tom

cat-via-ip-address-or-hostname


| 275

Appendix E SSO Authentication for tibbr Through Apache

As mentioned previously, the tibbr server the tibbr server verifies their credentials according to the authentication scheme you have in place. Optionally, you can set up authentication through third-party software, such as Apache’s mod_auth_tkt module, enabling users to log in by means of SSO. This appendix describes the procedure.

Topics

• Configuration of mod_auth_tkt, page 276

• Configuration of Secure tibbr Access, page 278

For details on how to set the authentication type to ldap, see Table 11, Authentication Configuration Parameters.


276 | Appendix E SSO Authentication for tibbr Through Apache

Configuration of mod_auth_tkt

To configure mod_auth_tkt for tibbr, follow these steps, which assume that you’re running tibbr, tibbr Service, tibbr Community, and tibbr Community Service 3.5.0:

1. Stop all the tibbr processes. For the procedure, see Termination and Restart of tibbr Services on page 10.

2. Make a backup copy of your tibbr database at TIBCO_HOME/tibbr/3.5.0 in case you want to revert to the previous state later. For the procedure, see Backup or Restore on page 14.

3. Place a copy of the mod_auth_tkt.so file in the TIBCO_HOME/tibbr/3.5.0/tools/apache2/modules directory.

4. Edit the httpd.conf file in the TIBCO_HOME/tibbr/3.5.0/tools/apache2/conf directory, as follows:

Add the line—

LoadModule auth_tkt_module modules/mod_auth_tkt.so

—below the line LoadModule rewrite_module modules/mod_rewrite.so.

5. Configure tibbr to run in SSO and fallback mode by setting the type parameter in the authentication segment to sso,ldap. For details, see Table 11, Authentication Configuration Parameters.

6. Configure Apache to protect tibbr’s SSO URL by adding the appropriate lines to the bottom of the section <VirtualHost *:80> in the httpd.conf file, as in this example:

TKTAuthSecret "asdsapopofpodafpoaskdpokdsposakq1312kml" <Location /a/users/login_by_sso> AuthType Basic require valid-user TKTAuthLoginURL /sso TKTAuthDomain .tibco.com TKTAuthCookieName auth_tkt TKTAuthTimeout 1w TKTAuthCookieExpires 1w TKTAuthBackCookieName ssobackcookie #TKTAuthBackArgName redirect_to </Location>

7. Configure your SSO application module: Ensure that in the file tibbr_home/tibbr-config/sso_auth_config.yml, the value of


Configuration of mod_auth_tkt | 277

back_url_param matches that of TKTAuthBackCookieName in the httpd.conf file.

In the example under step 6, that value is ssobackcookie.

8. Restart the tibbr server by executing the following commands:

$ cd TIBCO_HOME/tibbr/3.5.0/scripts$ ./start_tibbr.sh

Afterwards, when users access the tibbr login page, they are redirected to your SSO application’s login page instead. Once they have logged in, the tibbr home page is displayed.

If your SSO application does not have a logout capability, users are not logged out even after clicking the Log out link in tibbr. In this case, we recommend that you disable the logout parameter: See Table 26, Web UI Configuration Parameters.


278 | Appendix E SSO Authentication for tibbr Through Apache

Configuration of Secure tibbr Access

As a final step, for security, set up access control by host name or IP address through mod_authz_host. For a description and the syntax, see the Apache documentation at—

http://httpd.apache.org/docs/2.2/howto/access.html#host

To restrict access, edit the httpd.conf file in the tibbr-home/tools/apache2/conf directory. See these two examples as reference:http://www.cyberciti.biz/faq/securing-apache-mod_proxy-serve/

http://www.cyberciti.biz/faq/apache-restrict-access-based-on-ip-address-to-selected-directories/


| 279

Index

A

addingan administrator to the system 192members to a group 189owners to subjects from CSV 201

administration utilitiesadding

a user to a role 191an administrator to the system 192members to a group 189owners to subjects from CSV 201

caching user data 172changing a user login 177creating

a group 188a subject 195a user account 173email channels for all users 207filters for all users 211notifications on specific subjects for all users 209notifications on subjects for all users 208subjects from CSV 202subscriptions for subjects 199subscriptions from CSV 203

deletinga subject 197a user account 175

enablingall or certain users to follow the specified

users 182all or certain users to unfollow the specified

users 183applications for all users 181manage pages option for all subjects 205

push notifications 210encrypting a password 179, 193generating influence scores 190indexing tibbr content 194merging subjects 206overview 169recovering scheduled delayed jobs 213removing subscriptions from subjects 200replicating group data from LDAP 186replicating user data from LDAP 184resetting

a password 178an email address 180

restoring a user account 176setting subject hierarchy 204undeleting a subject 198

administrator tips 235Android, configuration of 92Apache

Server as load balancer, configuration of 40Web Server 28

Apache Cassandra server 21Apache SSO authentication for tibbr 275app_config.yml file 44application configuration manager 7, 44application server 21applications

Company Apps 67configuration of 67email 22enabling for all users 181Marketplace Apps 67Oracle Expenses 22RSS 22runner 22, 28Salesforce 22SAP 22SharePoint Document 22voice memo (tibVoice) 23


280 | Index

architectural overview 20audit log 24authentication

and authorization 24schemes 223through Apache for SSO, configuration of 275through Integrated Windows Authentication (IWA),

configuration of 259

B

backup procedure 14banned email subjects, configuration of 94BlackBerry, configuration of 91

C

cache server 27configuration of 39overview 21

caching user data 172Cassandra server

configuration of 37overview 21

Change Password link, disabling 235changing a user login 177chat

configuration of 83server 23

command-line interface 21configuration

administrator 48advanced deployments 30Android 92applications

Facebook 71LinkedIn 70Marketplace Apps 67Oracle Expenses 72social apps 69

Twitter 72authentication

LDAP and type 54SSO for tibbr 275

banned email subjects 94BlackBerry 91chat 83custom fields for Edit Profile form 92database 47email server 50Facebook 69files 44Google analytics 86group 53Integrated Windows Authentication (IWA) for

tibbr 259LDAP 56LinkedIn 69localization settings 90message types 86multitenancy

master-slave mode 232parameters 89

population of users and user-related data 95procedures 44proxy for tibbr 11SAML 62search 89SharePoint 116, 121single sign-on (SSO) 55site 66SSL 97subject 54tibbr Desktop 92tibbr server 73tibbr-server connection 73Twitter 69user 84validation settings 74video conference (tibCast) 65Web UI 80

connecting to LDAP server 96connection to tibbr server, configuration of 73


Index | 281

creatinga group 188a subject 195a user account 173email channels for all users 207filters for all users 211notifications on specific subjects for all users 209notifications on subjects for all users 208subjects from CSV 202subscriptions for subjects 199subscriptions from CSV 203

custom event-stream applications, creating 105customer support xxcustomizing

email template 132home page 133login page 139mobile and desktop branding 141More menu 138New to tibbr? link 236tibbr theme 130

D

databaseconfiguration of 31, 47overview 23

database.yml file 45default_app_config.yml file 44, 45deleting

a subject 197a user account 175

deployment of gadgets 164disabling

Change Password link 235Join tibbr link 235

disabling SSL 97disk I/O 31

E

editing Web Parts in SharePoint 253email server 24enabling

all or certain users to follow the specified users 182all or certain users to unfollow the specified

users 183applications for all users 181push notifications 210user hierarchy 235

encrypting a password 179, 193enterprise

deploymentconfiguration of 30high-availability deployment mode with copy of

utility process running on separate machines 29

high-availability with utility processes on sepa-rate machines 29

simple 26resources 23

F

file system and S3 23


282 | Index

G

gadgets (tibSmartWidgets) 143Announcements 147deployment options 164Followers 152list of 144Message Delivery 150My Following 153My Subjects 151People 158People Directory 154Post 156SharePoint search 162Subject Hierarchy 155Subject Messages 148Subject Search 157Subjects 161tibbr Messages 149User Profile 159Wall Messages 145

Google analytics, configuration of 86

H

hierarchical view, enabling of 98

I

importing tibbr SharePoint sites 257indexing tibbr content for search 194installation

Oracle Expenses PL/SQL for tibbrprocedure 242related files 241

SAP application in tibbr, creating a transport 246SAP application in tibbr, importing an add-on 247tibbr

on SharePoint 250procedure 5requirements 2

supported platforms 3Integrated Windows Authentication (IWA) for

tibbr 259integration of information from data sources 23

J

job runner 22, 27Join tibbr link, disabling 235

L

LDAPconfiguration of 31, 56server, connecting to 96

localizationsettings 90tibbr Web interface 99

log, audit 24

M

message types, configuration of 86migration and upgrade procedure 15mobile clients 21monitoring

Apache HTTP Server 222chat server 221core server 216job runners 219memcached 218search engine 220tibbr processes 215Web client 217

multitenancy 231–234


Index | 283

N

network connectivity among tibbr servers 31network file system, configuration of 33New to tibbr? link, customizing 236

P

performance tuning 102

R

recovering scheduled delayed jobs 213reindex script (reindex.sh) 27removing subscriptions from subjects 200replicating group data from LDAP 186replicating user data from LDAP 184resetting

a password 178an email address 180

restore procedure 14, 17restoring a user account 176

S

SAML, configuration of 62script, reindex 27scripts for monitoring tibbr processes 215search

configuration of 89server 27

configuration of 34overview 22

seed.yml file 45setting subject hierarchy 204SharePoint

configuration of 116, 121installation and deployment of 249

SharePoint Server template types 126

site, configuration of 66source files, locales 100SSL, configuration and disabling 97stopping and restart of tibbr services 10support, contacting xxsynchronizing

user data from LDAP to tibbr 236user profiles in SharePoint 255

T

technical support xxtibbr

Desktop, configuration of 92server 20, 26server, configuration of 73using proxy, configuration of 11

tibCast (audio conferences, video conferences, and Webinars) 23

TIBCO documentation xxTIBCO_HOME xviiTIBCOmmunity xxtibSmartWidgets (gadgets) 143tips for administrators 235

U

undeleting a subject 198uninstallation procedure 13

Oracle Expenses PL/SQL for tibbr 243SAP application in tibbr 248

userauto-registration and hierarchy, configuration of 84data from LDAP to tibbr, synchronizing 236hierarchy

display of 98enabling 235

using Web Parts in SharePoint 253utilities, administration 167


284 | Index

V

validation settings, configuration of 74video conference (tibCast), configuration of 65virtualization 30

W

Webclient 21, 26UI, configuration of 80

Web Parts in SharePointdescription of 252using 253


Date post:	27-Jun-2020
Category:	Documents
Upload:	others
View:	2 times
Download:	0 times

tibbr and tibbr Service Installation and Configuration · tibbr®, tibbr Service, tibbr Community,...

Documents