XCC Documentation

XCC Technical User’s Guide
XCC_R_10.0.0

XCC_R_10.0.0
2 / 79
Contents
1 Requirements ............................................................................................................ 5
1.1 IBM Connections versions........................................................................................................... 5
1.2 Browser ....................................................................................................................................... 5
1.2.1 Mozilla Firefox ..................................................................................................................... 5
1.2.2 Google Chrome.................................................................................................................... 5
1.2.3 Apple Safari ......................................................................................................................... 5
1.3 Mobile devices............................................................................................................................. 5
2 Prerequisites.............................................................................................................. 6
2.1 Files needed for installation........................................................................................................ 6
2.2 System Requirements.................................................................................................................. 6
3 Architectural Information........................................................................................... 7
3.1 XCC Runtime Modes.................................................................................................................... 7
3.1.1 On-premise mode (Desktop mode)...................................................................................... 7
3.1.2 Flyout mode (new since 9.0.0)............................................................................................. 7
3.1.3 Community mode (new since 8.0.0) .................................................................................... 7
3.1.4 Anonymous mode (new since 8.0.0).................................................................................... 7
3.1.5 Cloud mode (new since 8.0.0).............................................................................................. 7
3.1.6 Mobile mode........................................................................................................................ 7
3.2 XCC Authorization........................................................................................................................ 8
3.3 XCC Authorization in the Runtime Modes................................................................................... 8
3.3.1 On Premise Mode (Desktop Mode) ..................................................................................... 8
3.3.2 Flyout Mode......................................................................................................................... 9
3.3.3 Community Mode................................................................................................................ 9
3.3.4 Anonymous Mode.............................................................................................................. 10
3.3.5 Cloud Mode (IBM Connections Cloud Mode)..................................................................... 10
3.3.6 Mobile Mode ..................................................................................................................... 11
3.4 XCC startup background work................................................................................................... 11
4 Installation............................................................................................................... 13
4.1 Installation Prerequisites........................................................................................................... 13
4.1.1 Creating a new Application Server (optional).................................................................... 13
4.1.2 Enable trace logs to analyze errors (optional)................................................................... 16
4.1.3 WebSphere Application Server configurations (required)................................................. 20
4.2 XCC Installation.......................................................................................................................... 20
4.2.1 Map user to security roles ................................................................................................. 24
5 Update..................................................................................................................... 26
5.1 MSSQL update script (required)................................................................................................ 27

XCC_R_10.0.0
3 / 79
6 Database ................................................................................................................. 28
6.1 Create Derby database.............................................................................................................. 28
6.2 Using DB2 as database .............................................................................................................. 31
6.2.1 Create DB2 database......................................................................................................... 31
6.2.2 Create DB2 JDBC provider (optional)................................................................................. 32
6.2.3 Create DB2 data source..................................................................................................... 35
6.3 Using MSSQL as database.......................................................................................................... 40
6.3.1 Create MSSQL database.................................................................................................... 40
6.3.2 Create MSSQL JAAS security alias...................................................................................... 40
6.3.3 Create MSSQL JDBC provider (optional)............................................................................ 42
6.3.4 Create MSSQL data source ................................................................................................ 44
6.4 Using Oracle as database .......................................................................................................... 47
6.4.1 Create Oracle database..................................................................................................... 47
6.4.2 Create Oracle JAAS security alias ...................................................................................... 49
6.4.3 Create Oracle JDBC provider (optional)............................................................................. 50
6.4.4 Create Oracle data source................................................................................................. 52
7 Configuration........................................................................................................... 56
7.1 General XCC configuration ........................................................................................................ 56
7.2 XCC Anonymous mode configurations...................................................................................... 60
7.3 XCC Community mode configurations ...................................................................................... 61
7.3.1 widgets-config.xml ............................................................................................................ 61
7.3.2 LotusConnections-config.xml............................................................................................. 62
7.3.3 Create and adjust string property files.............................................................................. 63
7.3.4 Publish configuration......................................................................................................... 64
7.4 XCC Flyout mode configurations ............................................................................................... 64
7.5 XCC Mobile mode configurations.............................................................................................. 65
7.6 License key................................................................................................................................. 67
7.7 Adding a new link to the IBM Connections header navigation................................................. 68
7.8 People Birthday Widget............................................................................................................. 69
7.9 Customize XCC labels for different languages........................................................................... 69
7.10 Adjust the attributes for personalization.................................................................................. 70
7.11 IBM Connections Proxy Configuration ...................................................................................... 71
7.12 IHS XCC landing page configuration .......................................................................................... 72
7.13 (Re-)Building the search index of IBM Connections.................................................................. 72
7.14 Import and export of XML files ................................................................................................. 73
7.14.1 Import of XML files ............................................................................................................ 73
7.15 Export of XML files..................................................................................................................... 73
8 Uninstall XCC ........................................................................................................... 75
9 Operation ................................................................................................................ 76

XCC_R_10.0.0
4 / 79
9.1 Access XCC application (on premise mode) .............................................................................. 76
9.2 Access XCC application (flyout mode)....................................................................................... 76
9.3 Access XCC application (cloud mode)........................................................................................ 77
9.4 Access XCC application (community mode).............................................................................. 77
9.5 Access XCC application (anonymous mode).............................................................................. 78
9.6 Access XCC application (mobile mode) ..................................................................................... 79

XCC_R_10.0.0
5 / 79
1 Requirements
1.1 IBM Connections versions
This version of XCC supports IBM Connections version 4.5 (CR1, CR2, CR3, CR4 and CR5) and 5.0 (CR1,
CR2, CR3).
1.2 Browser
Microsoft Internet Explorer
Supported versions: 8, 9, 10 and 11
Older versions may lead to different UI layout.
1.2.1 Mozilla Firefox
Supported versions: all major builds from 32.0 to 42.0
Older versions down to 10.0 are still compatible but not supported.
1.2.2 Google Chrome
Supported version: 33.0 to 43.0
1.2.3 Apple Safari
Supported version: all major versions greater than 5.1.6
1.3 Mobile devices
Currently we support mobile devices with iOS and Android as operating system for XCC integrated in
the IBM Connections mobile application.

XCC_R_10.0.0
6 / 79
2 Prerequisites
2.1 Files needed for installation
XCC release package includes:
− XCC documentations
− mobile icons
− SQL scripts (DB2, MSSQL, Oracle, MySQL)
− xcc-ear<VERSION>.ear
2.2 System Requirements
Single sign-on integration between IBM Connections applications must be configured. Single sign-on
for the Windows desktop with Kerberos is also supported but is optional.

XCC_R_10.0.0
7 / 79
3 Architectural Information
3.1 XCC Runtime Modes
Depending on the environment and requirements, XCC can be executed in 5 different modes:
3.1.1 On-premise mode (Desktop mode)
This is XCC standard mode that XCC provides since the version 1.0.0. In this case XCC will be
integrated with a given IBM Connections System and can be set up as the start page for your
Connections environment.
3.1.2 Flyout mode (new since 9.0.0)
You can configure a XCC page as Flyout page to get quick access to this page within Connections.
3.1.3 Community mode (new since 8.0.0)
This mode provides XCC integration for IBM Communities. You may configure a XCC page to be
displayed within any IBM Connection Community. It is also possible to configure XCC page as a
Community Start Page.
3.1.4 Anonymous mode (new since 8.0.0)
You can set up XCC pages to be accessible publicly to unauthenticated users. In this case, only public
Connections Content can be referred within XCC Widgets. Further limitation apply (like commenting
being disabled).
3.1.5 Cloud mode (new since 8.0.0)
This mode provides integration of XCC with IBM Connections Cloud (IBM Connections Cloud). In this
case, XCC can be installed as a separate environment in order to reduce System footprint. XCC is
using OAuth2 authentication mechanisms and the IBM Social Business Toolkit Proxy in order to
retrieve IBM IBM Connections Cloud organization contents.
3.1.6 Mobile mode
This mode provides integration of XCC with the IBM Connections Mobile App. You can set up XCC
pages to be displayed within the iOS and the Android Connections App.

XCC_R_10.0.0
8 / 79
3.2 XCC Authorization
XCC distinguishes the following roles:
- READER - this Java EE security role controls which users should be able to access XCC in
„READ“-mode, i.e. not being able to perform any changes.
- CONTENT MASTER (PAGE EDITOR) - this security role can be assigned in the XCC UI in your
browser. Users can be assigned as „PAGE EDITOR“ for a specific page.
- ADMIN (WEB MASTER) - This Java EE security role controls which users should be able to
access XCC in „ADMIN“-mode, i.e. having rights to perform content configuration and
customization on all XCC pages.
3.3 XCC Authorization in the Runtime Modes
The following schemes illustrate XCCs authorization concept in terms to the different XCC modes.
3.3.1 On Premise Mode (Desktop Mode)

XCC_R_10.0.0
9 / 79
3.3.2 Flyout Mode
3.3.3 Community Mode

XCC_R_10.0.0
10 / 79
3.3.4 Anonymous Mode
3.3.5 Cloud Mode (IBM Connections Cloud Mode)

XCC_R_10.0.0
11 / 79
3.3.6 Mobile Mode
3.4 XCC startup background work
The following tasks will be executed by XCC automatically during application start up.
1. personalization.properties file creation. This file contains information that will be used for
widgets and pages personalization (IBM Connections profile fields).
- Will be created in the database if not existing.
- Will be copied from <CUSTOMIZATION_PATH>/xcc path in case
<CUSTOMIZATION_PATH> is already configured on page GlobalSettings.
- Will not be created in Cloud Mode (not required).
- Go to Customize > XCC Settings and verify that the file was successfully created.
2. internalization (i18n) files create:
- Will be copied from <CUSTOMIZATION_PATH>/xcc if existing or from the
<INSTALLED_APPS>/xcc.ear to the database.
- Only the template file “xcc-template.json” is always overwritten after XCC start, other
files only if they don’t exist in the database
- Go to Customize > XCC Settings and verify that the files were successfully created.
3. Grid template files update:
- The list of templates will be updated after application restart.
4. All files from <CUSTOMIZATION_PATH>/xcc/custom will be copied to the XCC database
- Only if the <CUSTOMIZATION_PATH> was configured on page GlobalSettings.
- Go to XCC Settings and verify that the file was successfully created.
- If custom.css / custom.js do not exist, both are created.
- You can go to Customize > XCC Settings and verify that the file was successfully created.
5. Database contents are backed up in XML format
- If backup functionality is activated for XCC and <CUSTOMIZATION_PATH> was
configured on page GlobalSettings.
- ZIP file containing XML files (XCC pages) will be created in <CUSTOMIZATION_PATH
>/xcc/export directory.

XCC_R_10.0.0
12 / 79
- ZIP Files have the pattern “export<TIMESTAMP>” where TIMESTAMP is a UNIX
timestamp of the export time, that is: a 12digit number representing the milliseconds
that have passed from 1.1.1970 to the time represented.

XCC_R_10.0.0
13 / 79
4 Installation
4.1 Installation Prerequisites
The XCC Application can be installed on any given WebSphere Application Server (version 8+) as well
as on a WebSphere Application Cluster.
If you want to have XCC logs separated from any other IBM Connections logs, you may create a new
WebSphere Application Server.
4.1.1 Creating a new Application Server (optional)
Step Instructions
1 Open the Integrated Solutions Console (ISC) of your Deployment manager and perform the
following steps.
2 Navigate to “Servers > Add a server”.
2 Click “Next”.

XCC_R_10.0.0
14 / 79
3 Please enter a server name of your choice and click "Next".
4 Select „default“ and click „Next“.

XCC_R_10.0.0
15 / 79
5 If you select „Generate Unique Ports“ it may happen that you need to adjust the virutal
ports. Click „Next“.
6 Click „Finish“ and after page reload „Save directly to the master configuration“. To finish
this process you have to synchronize the nodes first and start the server afterwards.

XCC_R_10.0.0
16 / 79
4.1.2 Enable trace logs to analyze errors (optional)
In order to analyze errors, we will ask you to enable trace logs on your server. These logs are not
configured to “Finest” level by default to increase the servers performance. By following the
following instructions, you enable trace logs at finest level. These settings are discarded after the
next Cluster / AppServer restart automatically for making sure your applications performance is
maximized.
Step Instructions
1 Please open the ISC ("WebSphere Integrated Solutions Console") and log in as an
administrative user.
2 Click on the left side on Troubleshooting > Logs and trace.

XCC_R_10.0.0
17 / 79
3 Now click on the Cluster/ AppServer, where you have mapped and installed the XCC
application.
4 Click on Diagnostic Trace under General
Properties.
5 Now click on the Runtime Tab (we do not
recommend to use XCC in production
with trace level set to FINEST, so please
make sure XCC WebSphere Application Server is be
restarted after
you are done with analyzing errors).
6 In the Additional Properties section
please click on Change log detail levels.
7 On the next page please open the Components
and Groups section.

XCC_R_10.0.0
18 / 79
8 In the list that appears, please search the list
section de.timetoact.*.
9 Click with the left mouse key on de.timetoact.* and a drop down menu will appear.
Sometimes it may happen that you have to scroll to the bottom of the page to see the popup
window.
Now click on Message and Trace Levels first and than on finest.
10 Now you have to apply your changes by clicking on
the Apply Button at the bottom of the page.
11 Now you have to go to your XCC page and try to reproduce the issue to be traced. Please
make sure that the page will be loaded completely once so that the trace logs are written.
Now you have to open the logs archive of your Cluster / AppServer on your server.

XCC_R_10.0.0
19 / 79
Please copy the files SystemOut.log, trace.log and SystemErr.log and add these files to your
email.

XCC_R_10.0.0
20 / 79
4.1.3 WebSphere Application Server configurations (required)
The only WebSphere Application Server configuration that needs to be done is to disable the Security
integration for Web container. In order to do so, click on your XCC server, go to Web Container
Settings > Web container > Session management and make sure the Security Integration checkbox is
unchecked!
4.2 XCC Installation
Attention: The XCC has to be installed into a WebSphere Application Server process running within
your IBM Connections system!
Step Instructions
following steps.
2 Navigate to “Applications > WebSphere enterprise applications”.

XCC_R_10.0.0
21 / 79
3 Click „Install“
4 Enter the path to xcc-ear-<version>.ear and click "Next".

XCC_R_10.0.0
22 / 79
5 Select Fast Path and click „Next“.
6 You can change the application name if you like to. By default the installation routine uses
the name xcc-ear. Scroll to the bottom of the page and click "Next".
7 Map the application module to your webserver and to the WebSphere Application Server.

XCC_R_10.0.0
23 / 79
8 Click „Finish“ and after page reload „Save directly to the master configuration“.
9 After saving the configuration go to Servers > Server Types > Web servers, generate and
propagate the HTTP Server Plug-In and restart the HTTP Server.
Afterwards you have to start the installed XCC application, therefore go to Applications >
Application Types > WebSphere enterprise applications and select the checkbox for "xcc-
ear" and click "Start".

XCC_R_10.0.0
24 / 79
4.2.1 Map user to security roles
Step Instructions
following steps.
2 Navigate to “Applications > WebSphere enterprise applications”.
3 Click on XCC.

XCC_R_10.0.0
25 / 79
4 Click Detail Properties > Security role to user / group mapping.
5 Map users to the XCC application (roles are explained in chapter 3.2). Please select the Role
checkboxes for which you want to map users or groups. Then click on the Map Users… or
Map Groups… Button.
After this you can search for users / groups and selecting them by click on the button
[ ].
Finish this process with a click on “Ok”. Save your changes to the master configuration and
wait until the XCC application has been restarted automatically.

XCC_R_10.0.0
26 / 79
5 Update
Updating the XCC application on a WebSphere Application server is not really different to an update
of other enterprise applications on a WebSphere Application server.
Important: We implemented a feature to import and export pages from the database as XML files.
Please make sure that you make a backup of XCC your pages before you start the update procedure.
In order to do so, please follow the instructions in this documentation, described in chapter 7.14
Import and export of XML files.
We only support an update to XCC version 10.0.0 from version >= 9.0.X. If you need to update from
an earlier version you have to update that version to XCC v9.0.X first and afterwards to XCC 10.0.0.
Step Instructions
1 Open the Integrated Solutions Console (ISC) of your Deployment Manager and navigate to
Applications > Application Types > WebSphere enterprise applications, select the XCC
application and click on „Update”.
2 Select „Replace the entire application” and use the „Browse” button to navigate to the
update ear file on your file system.
Click „Next”.
3 Choose the „Fast Path” installation option and click "Next".
4 Step 1: Select installation options: click "Next"
5 Step 2: Map modules to servers: click "Next"
6 Step 3: Summary: click „Finish”.
7 Click “Save directly to the master configuration”.
After an update:
Restart the XCC application using the ISC. Please also clear the cache of your browser. If you have
modified one or more of the i18n files, please back them up. Then delete all files and restart the XCC
application. New versions of XCC will bring newer versions of the predefined language files and the
template file. In case you have modified any of the languages or created a new language file, please
compare your modifications to the newly created files and re-apply your modifications or
complement your created language files with the new keys missing in your older version files. After
this you have to upload the new versions of the i18n files. Further details on this topic can be found
in chapter 7.9.

XCC_R_10.0.0
27 / 79
5.1 MSSQL update script (required)
If you use MSSQL as database for XCC, you have to follow this step to adjust the existing database
scheme:
Please execute the „MSSQL_migration_script.sql“ from the XCC release package SQLScripts
folder.Please restart the IBM WebSphere Application Server / IBM WebSphere Cluster, which you
used for the XCC.

XCC_R_10.0.0
28 / 79
6 Database
6.1 Create Derby database
XCC supports a Derby databases only for test purposes! This makes the installation easier.
Important: XCC does not support Derby database in a production environment. Furthermore a Derby
database does not support a XCC application installed in a clustered environment.
Step Instructions
1 Open the Integrated Solutions Console (ISC) of your Deployment manager and perform the following
steps.
2 Navigate to Resources > JDBC > Data sources.
3 Select node scope and click "New".

XCC_R_10.0.0
29 / 79
3 Enter a data source name of your choice and as JNDI name please enter “jdbc/xcc”.
Click "Next"
4 Select "Create new JDBC provider", if you do not have an existing JDBC provider and want to use
this instead.
5 Create new JDBC provider and click "Next"

XCC_R_10.0.0
30 / 79
7 Enter as database name "XCC;create=true" and click "Next".
8 You may reuse an existing security alias like "activitiesJAASAuth". Please select one and click "Next".
9 Verify the summary and click "Finish".

XCC_R_10.0.0
31 / 79
10 Save your changes directly to the master configuration and synchronize the nodes. Afterwards
please check that a connection to the data source can be established successfully.
Important: Please restart the XCC application after configuring the database, because it may happen
that the XCC caches the database connection. Open the XCC in your browser, now you should be
able to configure XCC.
6.2 Using DB2 as database
Important: You MUST be logged in into the operating system as DB2 administrator when you create
the database (normally: db2admin)!
6.2.1 Create DB2 database
We have included a SQL script file for each supported RDBMS into the XCC Release Package zip file.
The SQL scripts can be found in the subdirectory "SQLScripts".
Step Instructions

XCC_R_10.0.0
32 / 79
1 Open IBM DB2 "Command Window -
Administrator":
2 Run the following command:
db2 -tvf <XCC_PACKAGE_PATH>/Create_XCC_DB2_Database.sql
Important: We use the default user "LCUSER" within this script file to grant the necessary access
rights to the database. If you want to use another DB2 user you MUST change the GRANT
instructions in the script file before running it!
3 Close the command window.
6.2.2 Create DB2 JDBC provider (optional)
You may reuse an existing JDBC provider e.g. "activitiesJDBC". If you want to have a clear separation
for the XCC database follow these instructions.

XCC_R_10.0.0
33 / 79
Step Instructions
following steps.
2 Navigate to “Resources > JDBC > JDBC Provider”.
3 Select cell scope and click "New".

XCC_R_10.0.0
34 / 79
4 Select following configurations and click „Next“.
5 Important: Please make sure that the variables are set in the Environment - WebSphere
variables.
Click “Next”

XCC_R_10.0.0
35 / 79
6 Verify the summary, click "Finish" and “Save your changes directly to the master configuration”.
6.2.3 Create DB2 data source
Step Instructions
steps.
3 Select cell scope and click "New".

XCC_R_10.0.0
36 / 79
4 Enter a data source name of your choice and as JNDI name please enter “jdbc/xcc”.
Click "Next"
5 Select a JDBC provider: If you already have a “DB2 Universal JDBC Driver Provider” use this one,
otherwise create one. Click “Next”

XCC_R_10.0.0
37 / 79
6 Enter host name, driver type and port for your DB2 server and your XCC database and click “Next”.
7 Select a security authentication alias for example activitiesJAASAuth, make sure that the database
user, you selected in the XCC create database script (default LCUSER), is mapped to this alias.
Click „Next“ on the following screen and „Finish” on the summary screen.

XCC_R_10.0.0
38 / 79
8 Open the data source XCC and navigate to Additional Properties > Custom Properties
9 Change property resultSetHoldability to value 1 (type: Integer)
10 Create a new property downgradeHoldCursorsUnderXa and set its value to true (type: Boolean)
11 Open the data source XCC and navigate to Connection Pool Properties
11 Change the value of Maximum connections to 100 and the value of Minimum connections to 10.

XCC_R_10.0.0
39 / 79
12 Open the data source XCC and navigate to WebSphere Application Server data source properties.
Activate “Validate existing pooled connections”.

XCC_R_10.0.0
40 / 79
6.3 Using MSSQL as database
6.3.1 Create MSSQL database
Step Instructions
1 You might want to change the script file to better fit into your system:
Change the file & path of the database in the script file:
change line 4: "C:DataMSSQLXCC_DATA1.mdf"
Change the file & path of the log in the script file:
change line 6: "C:DataMSSQLXCC_LOG"
Change the user for accessing the XCC database:
change XCCUSER in section “-- create user”
2 Open a command window and run the following command:
sqlcmd -S <yourserver> -i <path>/Create_XCC_MSSQL_Database.sql
Close the command window.
6.3.2 Create MSSQL JAAS security alias
The JAAS (or J2C) security alias holds the credentials that are used to access the XCC database on the
database server. It is referenced in the XCC data source.

XCC_R_10.0.0
41 / 79
Step Instructions
following steps.
2 Navigate to “Security > Global security”.
3 In section "Java Authentication and Authorization Service" select "J2C authentication data"
4 Click "New":

XCC_R_10.0.0
42 / 79
5 Enter the values and click "OK". Afterwards safe your changes directly to the master configuration.
6.3.3 Create MSSQL JDBC provider (optional)
Step Instructions
following steps.

XCC_R_10.0.0
43 / 79
2 Navigate to „Resources > JDBC > JDBC Provider“.
3 Select cell scope and click „New“.

XCC_R_10.0.0
44 / 79
5 Important: Please make sure that the variables are set in the Environment > WebSphere
variables.
Click „Next”
6 Verify the summary, click „Finish“ and save your changes directly to the master configuration.
6.3.4 Create MSSQL data source
Step Instructions
steps.

XCC_R_10.0.0
45 / 79
4 Enter a data source name of your choice and as JNDI name please enter „jdbc/xcc”.
Click „Next“

XCC_R_10.0.0
46 / 79
5 Select a JDBC provider: If you already have a “MSSQL JDBC Provider” use this one, otherwise create
one. Click „Next”
6 Enter host name, driver type and port for your MSSQL server and your XCC database and click
„Next“.
7 Select the previously created JAAS alias in the field „Component-managed authentication alias” and
click „Next“.
8 Click „Finish” on the summary screen.

XCC_R_10.0.0
47 / 79
6.4 Using Oracle as database
6.4.1 Create Oracle database
Step Instructions
1 Run the SQL Plus tool available from your Oracle installation:
2 Log into the system and run the following command:
@<path to XCC install files>/Create_XCC_Oracle_Database.sql

XCC_R_10.0.0
48 / 79
Important: If you do not want to use the SQL script please make sure that the user XCC has the
necessary access rights to the database.
Please make sure that we only allow XCC as user id!
Close the command window.

XCC_R_10.0.0
49 / 79
6.4.2 Create Oracle JAAS security alias
The JAAS (or J2C) security alias holds the credentials that are used to access the XCC database on the
database server. It is referenced in the XCC data source.
Step Instructions
following steps.
2 Navigate to „Security > Global security”.
3 In section „Java Authentication and Authorization Service“ select „J2C authentication data“
4 Click „New“:

XCC_R_10.0.0
50 / 79
6 Enter the values and click „Ok“.
Important: The user id of your database MUST be XCC, the same applies for the User ID in the JAAS
security alias.
7 Save your changes to the master configuration.
6.4.3 Create Oracle JDBC provider (optional)
Step Instructions
following steps.

XCC_R_10.0.0
51 / 79
2 Navigate to „Resources > JDBC > JDBC Provider“.

XCC_R_10.0.0
52 / 79
5 Important: Please make sure that the variables are set in the Environment > WebSphere
variables.
Click „Next”
6 Verify the summary, click „Finish“ and save your changes directly to the master configuration.
6.4.4 Create Oracle data source
Step Instructions
steps.

XCC_R_10.0.0
53 / 79
4 Enter a data source name of your choice and as JNDI name please enter „jdbc/xcc”.
Click „Next“

XCC_R_10.0.0
54 / 79
5 Select a JDBC provider: If you already have a “Oracle JDBC Provider” use this one, otherwise create
one. Click „Next”
6 Enter host name, driver type and port for your MSSQL server and your XCC database and click
„Next“.
7 Enter the URL: jdbc:oracle:thin:@<your_server_ip/dns_name>:<your_port>:<your_SID>
Click “Next”
8 Click „Finish” on the summary screen.

XCC_R_10.0.0
55 / 79

XCC_R_10.0.0
56 / 79
7 Configuration
7.1 General XCC configuration
Step Instructions
1 After installing XCC you will see a configuration page (since release 6.0.0). Here you can set up XCC
configurations in your browser. If you want to make changes later, you can open the configuration
page manually https://<your_server>/xcc/templates/GlobalSettings.html and edit your settings.
1. Customization Path:
The customization path is required for backing up XCC pages in XML format. Please note that this
path should be the same path that you configured in your system’s WebSphere Environment
Variables under CONNECTIONS_CUSTOMIZATION_PATH.
Windows:
file system: C:IBMConnectionsdatasharedcustomization
network path: sharednetwork.cnx.localicsharecustomization
Linux:
file system: /opt/IBM/Connections/data/shared/customization
network path: //sharednetwork.cnx.local/icshare/customization
2 2. Context Roots:
The Context Roots of IBM Connections Applications are required for accessing the IBM Connections
APIs. Default values are proposed automatically by XCC. If you have customized your IBM
Connections system to use a different context root, you will need to adjust these values accordingly.

XCC_R_10.0.0
57 / 79
3 3. Connections Settings:
In order to allow XCC adopting your Connections layout, please fill out the fields “Connections
Version” (only necessary, if we cannot get the information automatically) and “Connections Theme”.

XCC_R_10.0.0
58 / 79
Connections Themes:
Here are some example screenshots of Connections layouts, which you can refer to while selecting
your theme.
defaultTheme:
gen4:
4 mailNext (Verse):

XCC_R_10.0.0
59 / 79
5 4. Automatic Backup:
Check the “Enable Backup” property if you want to enable the automatic backup feature. Select one
of three options: Daily, weekly or monthly to set up the backup schedule respectively.
By default, automatic backup is disabled for the XCC application.

XCC_R_10.0.0
60 / 79
7.2 XCC Anonymous mode configurations
6 6. Anonymous Configurations:
You have to configure the XCC page you want to be accessed anonymously as public.
Attention: Please make sure that Connections Hostname must have the schema https://<YOUR
SERVER>/. If you have changed context roots e.g. /connections/<APPNAME>, then you have to use
them here as well e.g. https://<YOUR SERVER>/connections/).
7 Please make sure that you need to restart the XCC application after changing settings in
GlobalSettings.html in order to take these changes effect.

XCC_R_10.0.0
61 / 79
7.3 XCC Community mode configurations
If you want to use the XCC Community iWidget, you need to perform the following instructions.
7.3.1 widgets-config.xml
Step Instructions
1 Open a Windows shell (cmd.exe) and execute following script (Alternatively you may adjust the
widgets-config.xml manually and synchronize the nodes afterwards in the ISC):
cd C:IBMWebSphereAppServerprofilesDmgr01bin
wsadmin -lang jython -user <wasadmin> -password <password>
execfile("communitiesAdmin.py")
CommunitiesConfigService.checkOutWidgetsConfig("<TEMP_DIRECTOR
Y>", AdminControl.getCell())
2 Do not close the shell window
Please open the just checked out widgets-config.xml file in an XML editor of your choice and add the
following code to the <resource type=“community“ …> node.

<widgetDef defId="XCC"
description="XCC.desc"
bundleRefId="XCC"
primaryWidget="false"
modes="fullpage"
showInPalette="true"
uniqueInstance="true"
iconUrl="/xcc/css/images/XCCLogo_S.png"
url="/xcc/templates/iWidgetXCCCommunityDefinition.xml?etag={version}">
</widgetDef>

XCC_R_10.0.0
62 / 79
3 Execute the following script:
CommunitiesConfigService.checkInWidgetsConfig()
7.3.2 LotusConnections-config.xml
Step Instructions
1 Open cmd and execute following script (Alternatively you can adjust the
LotusConnectionsConfig.xml manually and synchronize the nodes afterwards in the ISC):
execfile("connectionsConfig.py")
LCConfigService.checkOutConfig("<TEMP_DIRECTORY>",
AdminControl.getCell())
2 Do not close the CMD window
Please open the just checked out LotusConnectionsConfig.xml file in an XML editor of your choice
and add the widgetBundle section to the resources node.
<resources>
<widgetBundle name="de.timetoact.resources.XCC" prefix="XCC"/>
</resources>
3 Execute the following script:
LCConfigService.checkInConfig()
LCConfigService.updateConfig("versionStamp", "")

XCC_R_10.0.0
63 / 79
7.3.3 Create and adjust string property files
Step Instructions
1 You have to create property files for internationalization in <CUSTOMIZATION_DIR>/strings, with
the following name de.timetoact.resources.XCC{_language}.properties.
Label XCC for the side menu:
Label XCC.desc for the description text in the „Add apps“ menu:
Template:
XCC=Community Home (XCC)
XCC.desc=XCC - the Web Content Management Extension enhances IBM Connections with classic
Web CMS capabilities and thus creates a beautifully integrated Social Intranet.

XCC_R_10.0.0
64 / 79
7.3.4 Publish configuration
Step Instructions
1 Open a Windows shell (cmd.exe) and execute following script (Alternatively you may clear widget
caches in Connections with an Connections administrative account and synchronize the nodes
afterwards in the ISC. Afterwards you will need to restart all Connections servers):
''' clear widgets cache '''
execfile("newsAdmin.py")
NewsWidgetCatalogService.clearWidgetCaches()
''' synchronize active nodes '''
dmgr = AdminControl.queryNames("type=DeploymentManager,*")
if dmgr:
print "Please wait, until the nodes have been
synchronized."
nodes = AdminControl.invoke(dmgr, "syncActiveNodes",
"true")
print "The following nodes have been sucessfully
synchronized. - " + str(nodes)
else:
print "An error occured please check your server, whether
there is an active node."
Afterwards please restart all Connections servers to publish the configuration to the Connections
applications.
7.4 XCC Flyout mode configurations
If you want to integrate the XCC into the Connections Top Navigation you need to configure a custom
drop menu in the header.jsp in the <CUSTOMIZATION_DIR/>.
Step Instructions
1 Copy (if not already done so) the header.jsp file into Connections customization
folder under ‘common/nav/templates/’.
2 Add the following markup to the header.jsp (for example after --%><li>[...]</li><%--):
# Start XCC FLYOUT PAGE
--%><c:if test="${hasUsername || fn:indexOf(appName, ':search:') ==
-1}"><%--
--%><li id="lotusBannerFlyout"><%--

XCC_R_10.0.0
65 / 79
--%><a id="lotusBannerFlyoutLink"
class="lotusBannerFlyout"
onmouseover="dojo.require('lconn.core.header');
lconn.core.header.menuMouseover(this);"
onclick="dojo.require('lconn.core.header');lconn.core.header.menuCli
ck(this);"
onfocus="dojo.require('lconn.core.header');lconn.core.header.menuFoc
us(this);" role="button"
src"/xcc/rest/public/getFlyoutConfigs?lang=<c:out
value="${locale.language}" />&_<%= System.currentTimeMillis()
%>" href="javascript:;"><%--
--%><img role="presentation" alt="" src="<lc-
ui:blankGif />" class="xccTHIcon" /><%--
--%>≡<%--
--%></a><%--
--%></li><%--
--%></c:if><%--
# END XCC FLYOUT PAGE
3 Add the following CSS to your Connections theme and copy the sprite file from the
XCC package into your <THEME_FOLDER />/sprite folder.
.lotusui30 .lotusBanner .xccTHIcon {
background-image: url("<THEME_FOLDER/>/sprite/sprite16.png");
background-position: -675px 0;
background-repeat: no-repeat;
height: 16px;
margin: 2px 0 0 0;
width: 16px;
}
.lotusui30 #lotusBannerFlyout.lotusSelected .xccTHIcon,
.lotusui30 #lotusBannerFlyout.lotusHover .xccTHIcon,
.lotusui30 .lotusBanner .xccTHIcon:hover,
.lotusui30 .lotusBanner .xccTHIcon:focus,
.lotusui30 .lotusBanner .xccTHIcon:active {
background-position: -692px 0;
}
4 Restart the Connections servers in order to publish the changed header.jsp to all
Connections applications.
7.5 XCC Mobile mode configurations
If you want to integrate XCC in the Connections Mobile App you need to configure the “mobile-
config.xml” file on the Deployment Manager.

XCC_R_10.0.0
66 / 79
Step Instructions
1 Open a command prompt (cmd.exe) and then change to the following directory of the system on
which you installed the deployment manager:
app_server_root/profiles/dm_profile_root/bin
2 Enter the following command to start the wsadmin client:
wsadmin -lang jython -user {admin_user_id} -password
{admin_password} -port {SOAP_CONNECTIOR_ADRESS_PORT}
3 Enter the following command to access the IBM Connections configuration
execfile("mobileAdmin.py")
4 Check out the mobile config file to a directory of your choice and make a backup of this file.
MobileConfigService.checkOutConfig ("<directory>", "<cell-
name>")
5 Open the "mobile-config.xml" file and search for <Applications></Applications>.
Now you need to replace <Applications></Applications> with the following configuration or if you
have already integrated another, please add the XCC configuration at the end of the
<Applications> section.
<Applications>
<Application name="xcc-app" enabled="true">
<ApplicationIcon>
<Android>
<Hdpi>/homeWhite72.png</Hdpi>
<Mdpi>/homeWhite48.png</Mdpi>
<Ldpi>/homeWhite24.png</Ldpi>
</Android>
<IOS>
<Reg>/homeWhite24.png</Reg>
<Retina>/homeWhite48.png</Retina>
</IOS>
<BB>
<HighDensity>/homeWhite72.png</HighDensity>
<MedDensity>/homeWhite48.png</MedDensity>
<LowDensity>/homeWhite36.png</LowDensity>
</BB>
<DefaultLocation>/homeWhiteBG64.png</DefaultLocation>
</ApplicationIcon>
<ApplicationLabel>{label for XCC}</ApplicationLabel>
<ApplicationURL>https://{YOURURL}/xcc/mobile?page=mobile</ApplicationURL>
</Application>
</Applications>
6 Open the "mobile-config.xml" file and search for the application list section, please add the XCC
application to this list.
<ApplicationsList>xcc-
app,profiles,communities,files,filesync,wikis,activities,forums,blogs,boo
kmarks</ApplicationsList>

XCC_R_10.0.0
67 / 79
7 Furthermore you may select the XCC as Default Application in the Connections Mobile App. In
order to do so, you have to search in the mobile-config.xml for

<DefaultApplication>Updates</DefaultApplication>
and replace "Updates" with the name you chose by <Application enabled="true" name="xcc-
app">.
8 Then you have to "check in" the configured file.
MobileConfigService.checkInConfig("<directory>", "<cell-
name>")
9 Please open the "<CUSTOMIZATION_DIR/> /mobile" directory, then copy the icons from the
mobile folder from the XCC package to the customization mobile folder.
10 After the configuration you have to full synchronize the nodes first and restart the IBM
Connections servers then.
11 Then you should be able to use the XCC in the IBM Connections Mobile App on iOS and Android
devices.
7.6 License key
XCC is protected by a license key. If you need one, please contact our Sales Team
(sales@timetoact.de) for further assistance. For information about our license key please read our
XCC documentation.
Step Instructions
1 Enter a valid license key:
If your license key has been expired or you open the XCC in your browser the first time after the
installation, you will see this panel (only users with the J2EE role ADMIN can change the license key):
Please enter the license key that you received from TIMETOACT into the input field and click on
button Submit. (You should keep in mind that you need a new XCC license key for XCC greater
equals 9, each key is now mapped to a specific hostname.)

XCC_R_10.0.0
68 / 79
2 View properties of the current license key:
If you want to see the information stored in your license key please click on the „Customize“ button
in the XCC page and then on the „About“ tab.
You will see this panel:
Please change your license key in this panel before it expires.
7.7 Adding a new link to the IBM Connections header navigation
Step Instructions
1 Copy (if not already done so) the header.jsp file into IBM Connections’ customization folder
under “/common/nav/templates/”.
2 Add the following markup to the header.jsp <ul> node:
--%><li id="lotusBannerXCC" class="<c:if
test="${first}">lotusFirst</c:if>"><%--
--%><a href="/xcc/main?page=xcc "><%--
--%><img alt="" role="presentation" src="<lc-ui:blankGif
/>" class="lconnBannerIcon lconnSprite lconnSprite-
iconHomeBlue16"><%--
--%>XCC<%--
--%></a><%--
--%></li><%--
3 The ID "lotusBannerXCC" of the li tag is important, because the XCC will set this menu item
as selected, if you are on a XCC page. We currently support only one menu item in the top
navigation, which is instantly highlighted as selected. You can have further menu items in
the header.jsp, therefore please use different ID's for the LI elements, but these will not be
highlighted as selected.
4 Restart the Connections servers in order to publish the changed header.jsp to all
Connections applications.

XCC_R_10.0.0
69 / 79
7.8 People Birthday Widget
For the people birthday widget it is necessary to modify your IBM Connections Profiles configuration.
The People Birthday Widget searches for all profiles, which have a profile extension field [name =
"birthday"] and value with the actual date. In date format "* -MM-DD" e.g. *-10-16 for the 16th
October. Instead of the asterisk you can enter for example YYYY, if you do not save this information
you can change the input to “-MM-DD”. TIMETOACT offers this configuration as an additional service.
If you need assistance to modify the profile fields, please send us an email (xcc-
support@timetoact.de).
7.9 Customize XCC labels for different languages
You can customize XCC labels for all languages that are supported by IBM Connections. The XCC
automatically creates both files xcc-de.json and xcc-template.json in the directory
customization/xcc/I18n.
Example:
Using an example, we want to show you how the XCC language fallback works. Please open the XCC
page with a browser and a language cookie, which has the value „pt” for Portuguese language. The
XCC will search for a file with the name „xcc-pt.json” in the directory „customization/xcc/I18n”. If this
file is found, the XCC will output the labels contained in this file. Otherwise XCC will search for the file
„xcc-en.json”. If this file does also not exist then the XCC will fall back to English labels included in the
XCC source code.
Workflow:
You can use the „xcc-template.json” file to translate XCC into your desired language. After
customization of this file, you have to rename it. Therefore please save the file as xcc-
<LANGUAGE>.json where <LANGUAGE> is replaced with the shortcut of your desired language (for
example en, de, pt, zh etc.). You can up- and download the language files on your XCC page in the
customization panel under the XCC Settings tab.

XCC_R_10.0.0
70 / 79
Structure of JSON:
XCC language files are stored in JSON format. These JSON files contain key-value pairs embarced in
quotes and separated by a colon. Multiple key-values are separated by a comma and a newline. For
example:
"ee_pager_next" : "Next",
"ee_pager_prev" : "Prev"
Some entries need placeholders for values to be computed. These entries contain placeholders like
$1, $2, $3 and so on. Array entries are separated by a comma "a,b,c,d,e". Entries specific to dates
and times are used with a SimpleDateFormat like placeholder structure like TT for the Day in Month,
MM for the Month in Year as a zero filled Number MMM or a shortcut of the Months name MMMM
for the Months full name and so on.
7.10Adjust the attributes for personalization
Since Release 4.0, we have introduced a way to change the personalization attributes to increase the
usability for the Content Master. You can reduce the number of personalization attributes, change
the display name in the widget edit mode and change the order of the attributes.
Important: To personalize an XCC Widget for IBM external users you have to choose the
"prof_mode" key with value 1 for external users and 0 for internal users.
Step Instructions
1 After an application restart the XCC will create a file with the name <personalization.properties> in
the XCC database, if it does not exist. If you want to adjust the personalization attributes please
download this file under XCC Settings and open the file in an editor of your choice.
The file looks like:
#Timestamp (creation time of <personalization.properties> file)
<key1> = <value1>
<key2> = <value2>
...
In this property file you will see the table key on the left side, which was read from the IBM
Connections database programmatically and on the right side the value that shows up in the
Widget Editors. Please do not change the key on the left side otherwise the XCC can no longer

XCC_R_10.0.0
71 / 79
connect between the database and the personalization attributes. Upload the configured file and
the changes will have an immediate effect.
Changing the frontend value:
E.g. if you want to display "Display Name" instead of "display_name" in the personalization
dropdown, please change the line "prof_display_name=display_name" to
"prof_display_name=Display Name".
7.11IBM Connections Proxy Configuration
For the Clipping and the IFrame widget it is necessary to configure the Connections Ajax Proxy. Start
the wsadmin client by completing the following steps (the following example is for a windows server,
for other operating systems please refer to the IBM documentation).
Step Instructions
1 Open a command prompt and then change to the following directory of the system on which you
installed the deployment manager:
<app_server_root>/profiles/dm_profile_root/bin
2 Enter the following command to start the wsadmin client:
wsadmin -lang jython -user {admin_user_id} -password
{admin_password} -port {SOAP_CONNECTIOR_ADRESS_PORT}
3 Enter the following command to access the IBM Connections configuration
execfile("connectionsConfig.py")
4 Check out the Proxy Config File to a directory of your choice and make a backup of this file.
LCConfigService.checkOutProxyConfig("<directory>", "<cell-
name>")
5 Open the "proxy-config.tpl" file and search for .
Now you need to comment in this section:
<proxy:policy url="{URL}" acf="none" basic-auth-support="true">
<proxy:actions>
<proxy:method>GET</proxy:method>
</proxy:actions>

XCC_R_10.0.0
72 / 79
<proxy:headers/>
<proxy:cookies/>
</proxy:policy>
Instead of {URL} you have to use your URL, which you want to whitelist. For further information use
the IBM Documentation (link).
6 Then you have to "check in" the configured file.
LCConfigService.checkInProxyConfig("<directory>", "<cell-
name>")
After the configuration you have to full synchronize the nodes first and restart the Application
server(s) then.
7 After successful configuration of the Ajax Proxy, you will be able to use this URLs for example:
https://<YOUR_SERVER>/communities/ajaxProxy/http/google.de
https://<YOUR_SERVER>/communities/ajaxProxy/https/google.de
7.12 IHS XCC landing page configuration
If you want to redirect all requests for the server root (https://<your_server>/) to XCC, you may use
the following template for addition / modification of you httpd.conf file. Please adjust this template
according to your specific needs.
LoadModule rewrite_module modules/mod_rewrite.so
#SSL Rewrite
RewriteEngine On
RewriteRule ^/$ https://HOSTNAME/xcc/main [NE,L,R]
RewriteRule ^/?(.*) https://%{SERVER_NAME}/$1 [L]
<IfModule mod_ibm_ssl.c>
Listen 0.0.0.0:443
<VirtualHost *:443>
ServerName HOSTNAME
RewriteEngine On
RewriteRule ^/$ https://HOSTNAME/xcc/main [NE,L,R]
...
</VirtualHost>
</IfModule>
After editing, please restart your IHS service.
7.13(Re-)Building the search index of IBM Connections
XCC is using IBM Connections API's heavily for its operation. This requires the IBM Connecitons
search index to be intact and operating well. Please check whether your search index is working
correctly. If not, please follow these instructions of IBM to rebuild the search index (7.13 (Re-
)Building the search index of IBM Connections).

XCC_R_10.0.0
73 / 79
7.14 Import and export of XML files
It is possible to import and export XCC page configurations to and from XML files. This feature allows
you to switch between different databases or to make a backup of your XCC database.
7.14.1 Import of XML files
Open the XCC in your browser as an administrative user and click on Customize. Go to the Tab Page
Management. Here you will find the Import Pages button. Click on this button and you will open a
modal dialog. In this popup window you are able to upload single XML files or multiple xml files as zip
file. After an upload they will be migrated into the XCC database.
7.15Export of XML files
Single page(s):
Open XCC in your browser as an administrative user and click on Customize. Go to the tab Page
Management. You will find the export link on the right side of each page in the list. With a click on
the download icon you will download the page as XML file.

XCC_R_10.0.0
74 / 79
All pages:
You can also export all XCC pages as a zip file. To do so, please open XCC in your browser as an
administrative user and click on Customize. Go to the tab Page Management and click on Export all
pages.

XCC_R_10.0.0
75 / 79
8 Uninstall XCC
This guide is not a complete step-by-step guide, because the uninstallation steps depends on the XCC
version. Here are some hints on what you should pay attention.
Step Instructions
1 Open the Integrated Solution Console and uninstall the XCC application under (Applications >
WebSphere Enterprise Applications > Applications Types).
2 If you have created a separate WebSphere Application Server / Cluster for the XCC, you should
remove this server under (Servers > Server Types > WebSphere application servers / Servers >
Clusters > WebSphere application server clusters).
3 Generate and propagate the webserver plugin and restart the webserver afterwards under (Servers
> Server Types > Web servers).
4 If you have created a JDBC provider, data source and JAAS security alias, you should remove them.
5 Drop the XCC database.
6 Full resynchronize the nodes first and restart the Connections Application server(s) then.
7 Remove the <CUSTOMIZATION_DIR/>/xcc folder.

XCC_R_10.0.0
76 / 79
9 Operation
9.1 Access XCC application (on premise mode)
You can access XCC in your browser with the following URL:
https://<YOUR_SERVER>/xcc/main?page=<PAGENAME>
If you have the role CONTENT MASTER or ADMIN, you will see the Customize button.
9.2 Access XCC application (flyout mode)
You can access XCC in your browser with the following URL:
https://<YOUR_SERVER>/xcc/flyout or by using the configured Connections flyout menu.

XCC_R_10.0.0
77 / 79
9.3 Access XCC application (cloud mode)
You can access XCC4Cloud in your browser with the following URL:
https://<YOUR_SERVER>/xcc/cloud?page=<PAGENAME>.
9.4 Access XCC application (community mode)
You can access XCC4Communities in your browser with the following URL:
https://<YOUR_SERVER>/communities/service/html/communitystart?communityUuid={commId}#
fullpageWidgetId={wId}.
Create XCC Widget using Community Actions link or select it in the left navigation.

XCC_R_10.0.0
78 / 79
9.5 Access XCC application (anonymous mode)
You can access a XCC4 Anonymous in your browser with the following URL:
https://<YOUR_SERVER>/xcc/global?page=<PAGENAME>.
Please note that global page should be already created and configured as public page.

XCC_R_10.0.0
79 / 79
9.6 Access XCC application (mobile mode)
You can access a mobile page in your browser / mobile app with the following URL:
https://<YOUR_SERVER>/xcc/mobile?page=<PAGENAME>.

XCC Documentation

Recommended

Recommended

More Related Content

What's hot

What's hot (20)

Similar to XCC Documentation

Similar to XCC Documentation (20)

More from TIMETOACT GROUP

More from TIMETOACT GROUP (15)

Recently uploaded

Recently uploaded (20)

XCC Documentation