Portal Development

CollaborationPDF download from SAP Help Portal:http://help.sap.com/saphelp_nw73ehp1/helpdata/en/36/4b6fb2265e4afda9b5f8c3895d9807/frameset.htm

Created on July 08, 2014

The documentation may have changed since you downloaded the PDF. You can always find the latest information on SAP Help Portal.

NoteThis PDF document contains the selected topic and its subtopics (max. 150) in the selected structure. Subtopics from other structures are not included.The selected structure has more than 150 subtopics. This download contains only the first 150 subtopics. You can manually download the missing subtopics.

2014 SAP AG or an SAP affiliate company. All rights reserved. No part of this publication may be reproduced or transmitted in any form or for any purposewithout the express permission of SAP AG. The information contained herein may be changed without prior notice. Some software products marketed by SAP AGand its distributors contain proprietary software components of other software vendors. National product specifications may vary. These materials are provided bySAP AG and its affiliated companies ("SAP Group") for informational purposes only, without representation or warranty of any kind, and SAP Group shall not beliable for errors or omissions with respect to the materials. The only warranties for SAP Group products and services are those that are set forth in the expresswarranty statements accompanying such products and services, if any. Nothing herein should be construed as constituting an additional warranty. SAP and otherSAP products and services mentioned herein as well as their respective logos are trademarks or registered trademarks of SAP AG in Germany and othercountries. Please see www.sap.com/corporate-en/legal/copyright/index.epx#trademark for additional trademark information and notices.

Table of content

PUBLIC 2014 SAP AG or an SAP affiliate company. All rights reserved.

Page 1 of 115

Table of content1 Collaboration2 Collaboration Architecture3 Administration Guide3.1 Collaboration Configuration3.1.1 Wizard-Based Basic Configuration for Collaboration3.1.1.1 Assigning Portal Roles for Collaboration To Users3.1.1.2 Activating the Minimal Grouping of Collaboration Services3.1.1.3 Activating the Link for Launching the Collaboration Launch Pad3.1.1.4 Defining the Web Address and Automatic E-Mail Dispatch for Rooms3.1.1.5 Importing Content for Standard Room Templates3.1.1.6 Configuring E-Mail Connectivity3.1.1.6.1 Creating a System3.1.1.6.2 Implementing the Transport3.1.1.6.3 Creating an E-Mail Transport3.1.1.6.4 E-Mailing Service3.1.1.6.5 Mapping Your User3.1.2 Completing the Basic Collaboration Configuration3.1.2.1 Activating the Complete Grouping of Collaboration Services3.1.2.2 Activating Services for Real-Time Collaboration3.1.2.3 Activating Synchronous Collaboration Service Types3.1.2.4 Configuring Real-Time Collaboration3.1.2.4.1 Configuring the Polling Type3.1.2.4.2 Configuring the RTC Application Sharing Server3.1.2.4.2.1 Enabling / Disabling the RTC Application Sharing Server3.1.2.4.2.2 Setting RTC Application Sharing Server Parameters3.1.2.4.2.3 Configuring Thread Settings for RTC Application Sharing Server3.1.2.4.2.4 Running Application Sharing Server in a Clustered Environment3.1.2.4.2.5 Monitoring the Application Sharing Server (RTC)3.1.2.4.2.6 Configuring Client Browsers to Accept the RTC ActiveX Control3.1.2.4.3 Configuring Maximum Numbers of Sessions and Users Allowed3.1.2.5 Installing and Configuring Calendar Connectivity3.1.2.5.1 Creating a System3.1.2.5.2 Installing and Configuring Microsoft Exchange Connectivity3.1.2.5.2.1 Microsoft Exchange Connectivity Architecture based on WebDAV Protocol3.1.2.5.2.1.1 Implementing the Exchange Transport3.1.2.5.2.1.2 Installation Steps3.1.2.5.2.1.2.1 Installing the MSX-A Components3.1.2.5.2.1.2.2 Creating an IIS Web Site3.1.2.5.2.1.2.3 Configuring Microsoft OWA 5.5 SP43.1.2.5.2.1.2.4 Testing the MSX-A Setup3.1.2.5.2.1.3 Configuration Steps3.1.2.5.2.1.3.1 Creating an Exchange Transport3.1.2.5.2.1.3.2 Calendar Repository Manager3.1.2.5.2.2 Microsoft Exchange Connectivity Based on CDO - Troubleshooting3.1.2.5.2.3 Integrating MS Exchange Outlook Thick Client Using OWA3.1.2.5.2.3.1 Displaying Contents Using Thick Client3.1.2.5.2.3.2 Installing and Configuring the Active-X Control3.1.2.5.2.3.3 Displaying Contents Using Outlook Web Access3.1.2.5.2.3.4 Configuring Outlook Web Access 5.53.1.2.5.2.3.5 Creating an iView for Outlook Web Access3.1.2.5.2.3.6 Configuring Outlook Web Access iViews3.1.2.5.3 Installing and Configuring Lotus Domino Connectivity3.1.2.5.3.1 Lotus Domino Connectivity Architecture3.1.2.5.3.1.1 Implementing the Lotus Transport3.1.2.5.3.1.2 Installation Steps3.1.2.5.3.1.2.1 Installing the LDS-D Component3.1.2.5.3.1.2.2 Creating a Lotus Transport3.1.2.5.3.1.2.3 Configuring the Calendar Repository Manager3.1.2.5.3.2 Lotus Domino Connectivity Troubleshooting3.1.2.5.3.3 Lotus iNotes


Page 2 of 115

3.1.2.5.3.4 Integrating Lotus Domino Using iNotes3.1.2.5.3.4.1 Creating an iView for iNotes3.1.2.5.3.4.2 Accessing iNotes Data in the Portal3.1.2.5.3.5 Ticket Verifier for Lotus Domino3.1.2.5.3.5.1 Ticket Verifier Architecture3.1.2.5.3.5.2 Ticket Verifier Process Flow3.1.2.5.3.5.3 Ticket Verifier Technical Components3.1.2.5.3.5.4 Lotus Domino Server Configurations3.1.2.5.3.5.5 Lotus Domino Directory and Users3.1.2.5.3.5.6 Lotus Domino Web Server API (DSAPI)3.1.2.5.3.5.7 Implementing the Ticket Verifier3.1.2.5.3.5.7.1 Installing the Ticket Verifier3.1.3 Making Collaboration Capabilities Company-Specific3.2 Providing Collaboration Services in the Portal3.2.1 iViews with Collaboration Services3.2.2 Configuring Collaboration Services in the Portal3.2.3 Making Services Available: Standard Configuration3.3 Searching and Displaying User Data3.3.1 User Search Function3.3.1.1 Configuration of the User Search Function3.3.1.1.1 Configuring the UME Based Search for the User Search Function3.3.1.1.2 Enabling the TREX Search Engine for the User Search Function3.3.2 Who's Who iView3.3.2.1 Configuration of the Who's Who iView3.3.3 User Details iView3.3.3.1 Configuration of the User Attributes in the User Details iView3.3.3.2 Photo Maintenance for the User Details iView3.3.3.3 Integrating User Photo Maintenance (Self-Service) in the Portal Menu3.3.3.4 Hiding User Photographs in the User Details iView3.3.4 Availability Status3.3.4.1 Predefining the Default Setting of the Availability Status3.3.4.2 Hiding the Availability Status Setting in the CLP3.4 Making Rooms Available in the Portal3.4.1 Preparing Rooms for Use3.4.1.1 Giving Users Permission to Use Rooms3.4.1.2 Defining Categories and Relationship Types for Rooms3.4.1.3 Enabling Detailed Navigation for Rooms in the Light Framework Page3.4.1.4 Providing the Light Room Directory3.4.1.5 Providing an iView with a Link for Calling the Member List3.4.1.6 Integrating iViews in Rooms on a Role-Specific Basis3.4.1.7 Configuring the Room Directory Layout and Properties3.4.1.8 Changing the Room Member List3.4.1.9 Deactivating Groups in the Room Member List3.4.1.10 Configuring the Search for Rooms3.4.1.11 Configuring the Search for Room Content3.4.1.12 Changing E-Mail Texts for Rooms3.4.1.13 Providing Information In the Event of Problems Accessing Rooms3.4.1.14 Defining the Web Address and Automatic E-Mail Dispatch for Rooms3.4.1.15 Mapping of User Groups for Rooms3.4.2 Providing Templates for Rooms3.4.2.1 Planning Room Templates3.4.2.1.1 Standard Templates for Rooms3.4.2.1.2 Room Types3.4.2.1.3 Extensions for Room Templates and Room Part Templates3.4.2.2 Providing Initial Content for Rooms3.4.2.3 Defining the Structure of Rooms3.4.2.4 Creating Templates3.4.2.4.1 Defining General Properties for Templates3.4.2.4.2 Defining Room Roles and Page Permissions in Templates3.4.2.4.3 Defining Room and Room Part Folders in the CM Room Extension3.4.2.4.4 Providing Target Folders for Room Documents3.4.2.4.5 Embedding Room Parts in Room Templates


Page 3 of 115

3.4.2.4.6 Creating Room Properties in Templates3.4.2.4.7 Configuring the Use of Information in Rooms3.4.2.4.8 Assigning Permissions for Using Templates3.4.2.4.9 Changing the Room Structure for Existing Templates3.4.2.5 Checking Templates3.4.2.6 Transporting Templates3.4.2.7 Hiding SAP Standard Templates3.4.3 Administrating Rooms3.4.3.1 Checking the Use of Rooms3.4.3.2 Controlling the Use of Rooms3.4.3.3 Checking the Data Consistency of Rooms and Room Content3.4.3.4 Transferring Changed Property Values to Rooms or Room Parts3.4.3.5 Displaying the Room Inventory List3.4.4 Managing the Archiving of Collaboration Rooms3.4.4.1 Defining Collaboration Rooms for Archiving3.4.4.1.1 Marking Rooms for Archiving Automatically3.4.4.1.2 Marking Rooms for Archiving Manually3.4.4.2 Managing the Archiving Approval Workflow for Rooms3.5 Making Functions for Asynchronous Collaboration Available3.5.1 Making Tasks Available3.5.2 Making Discussions Available3.5.2.1 Configuring Discussion Groups3.5.2.2 Configuring Discussions for Documents and Folders3.5.2.3 Discussion Service3.5.2.4 Data Consistency Check for Comments on Folders and Documents3.5.3 Making Forums Available in the Portal3.5.4 Configuring and Managing Wikis in the Portal3.6 Groupware


Page 4 of 115

1 Collaboration

UseWith the collaboration capabilities, SAP NetWeaver allows communication and collaboration in the portal. This allows SAP NetWeaver to bring together membersof project groups regardless of time and of their geographic location. Users can use virtual rooms for common access and organization of documents, applications,and ideas.

IntegrationThe entire functional scope and configuration of the Collaboration capabilities are available in portal iViews.

FeaturesThe following table explains the functions included in Collaboration:

More InformationPortalKnowledge Management

2 Collaboration Architecture

UseLike the Portal and Knowledge Management, Collaboration is part of Enterprise Portal (EP). From a technical perspective, Collaboration is based on the systemcomponents of the portal and Knowledge Management.Overview of the System ArchitectureThe graphic below depicts the fundamental system components that Collaboration is based on and shows the system components that Collaboration consists of.

Function DescriptionMaking Services Available You can configure how the system makes services available for collaboration. You can

make services available in the following applications:In the Collaboration Launch Pad , which allows central access to contacts andservices in the portal headerIn the Member List of roomsIn the context menu for user namesIn the User Details iView

Virtual Rooms Based on predefined templates, you can create virtual rooms for collaboration withinteams and project groups. A room allows the members access to shared data andservices independent of their location.

Groupware Integration For collaboration in the portal, you can integrate the e-mail and scheduling services(Microsoft Exchange) used in your company.

Asynchronous Collaboration For asynchronous collaboration, the following functions are available:Online discussionsOnline management of tasks, sessions, and documentsOnline entry of feedback, ratings, and commentsInformation sharing in forumsInformation sharing in wikis

Real-Time Collaboration (RTC) For real-time collaboration, the following functions are available:Interactive online access to applications (application sharing)interactive online exchange of information (instant messaging)

NoteThe RTC capabilities in SAP NetWeaver are recommended for scenarios thatinclude the occasional use of instant messaging, and application-sharing services bya specific group of company-internal portal users-more specifically, one-to-oneapplication sharing sessions and chat sessions with up to eight users. For largeportal installations, the performance and sizing impacts of RTC should beconsidered. For more information, see SAP Note 948298 .For the intensive use of RTC services, third-party integration is recommended. Formore information, see 1038125 .

Integration of Third-Party Services In addition to the services provided by SAP for real-time collaboration, you can alsointegrate third-party services, for example, WebEx, in the portal.


Page 5 of 115

Figure 1: Collaboration Architecture

System ComponentsIn the tables below you can find the descriptions of the system components that are displayed in the graphic.

Component DescriptionUser Management You can manage users and groups in the user management of the Application Server

Java (AS Java).User Management of the AS Java enables you to manage users and roles for access toapplications of the AS Java and the data which the applications require.

HTMLB HTMLB (HTML Business for Java) forms the technical basis of a standard design-orientated page layout. HTMLB provides a full set of easy to use Web controls based onservlets and Java Server Pages (JSP). The components and JSP tags used bydevelopers are translated into HTML commands using renderer classes.

Component DescriptionPortal Catalog The Portal Catalog allows you to access the Portal Content Directory (PCD) and to edit

portal content objects. The structure of the worksets for rooms (pages and iViews) isdefined using the Portal Catalog.

Configuration This component enables the configuration of components used in the portal. Thisincludes the following settings:

Definition of roles and permissions.Configuration of Collaboration (specifying backend systems for Groupwareintegration or for the integration of synchronous services, and so on).

Navigation Service Programming model for defining the navigation in the portal

Component DescriptionRepository Framework The repository framework provides the technical basis for KM applications. It includes the

central Java classes and interfaces of the Knowledge Management Platform. Therepository framework also provides services for dealing with content.Documents are physically stored in a virtual hierarchy and a namespace in the repositoryframework. They can be stored on different systems such as Windows, WebDAV, andHTTP. Access to these systems is controlled using repository managers. For moreinformation, see Repositories and Repository Managers in the KM administration guide.

Content Management Content Management (CM) offers services for managing content in KnowledgeManagement (KM). Global services carry out tasks required by all applications orrepository managers, such as creating caches or properties. For more information, seeGlobal Services .

Configuration This component enables configuration of Knowledge Management. It comprisesconfiguration tasks for Collaboration, Content Management, TREX, UWL, and so on.

KM iViews KM iViews allow you access to documents, applications, and configuration data fromportal pages.

Component DescriptionPeople-Centric Components These components provide iViews that can be used in Collaboration and Knowledge

Management applications for the collaboration of portal users through services.


Page 6 of 115

More InformationKnowledge Management Architecture

3 Administration Guide

UseThe Collaboration administration guide explains the activities that administrators of the SAP NetWeaver Collaboration capabilities may have to perform.For more information, see Collaboration .

IntegrationCollaboration is closely linked to the Portal and Knowledge Management. The portal allows users personalized access to company-specific information andservices for collaboration. Knowledge Management allows access to information services.The graphic below contains an overview of the Collaboration functions and shows their integration with the Portal and Knowledge Management.

The People Picker offers a standard user interface for searching for portal users,user groups, or roles.The People Renderer offers a standard user interface for displaying portal users inapplications. This includes displaying the availability status (using icons), detaileddata for users, and available services for collaboration.

Room Infrastructure This component controls the life cycle of rooms. It is contained in both the portal layer andthe KM layer. The Room Infrastructure offers functions for editing rooms, such ascreating, changing, and deleting them.

Asynchronous Tools and Components This component provides the technical prerequisites for functions that enableasynchronous collaboration between portal users. This includes online discussions, andonline management of tasks and documents such as feedback, rating, and commentsservices.

Synchronous Collaboration Framework This component provides the technical prerequisites for the integration of synchronousservices. SAP delivers Real-Time Collaboration (RTC) as a standard service forsynchronous collaboration. You can also integrate synchronous services from third-partyproviders, such as WebEx online sessions.

Real-Time Collaboration RTC enables users of SAP NetWeaver Portal to communicate through interactive onlinemeetings and to exchange information.

Instant messaging: Enables portal users to communicate with one another in realtime by means of instant text-based messages.Application sharing: Enables portal users to share and interact directly withapplications running on a user's desktop.

NoteDue to ActiveX requirements, the instant messaging and application sharingcapabilities provided by RTC are only supported in a Microsoft Internet Explorerbrowser.

Groupware Framework This component enables the integration of e-mail and scheduling services such asMicrosoft Exchange and Lotus Domino.

Component DescriptionSearch and Classification (TREX) The Search and Classification (TREX) component enables various types of search and

classification operations.TREX is a standalone engine. Therefore, if you want to use the search functions, youneed to install and configure TREX.For more information about Search and Classification, see the TREX documentation.


Page 7 of 115

Figure 1: Collaboration Overview

FeaturesThe following table provides information about the relevant functions for the administration of Collaboration:

3.1 Collaboration Configuration

UseTo make the corresponding collaboration capabilities available following the installation of the SAP NetWeaver Enterprise Portal (EP) usage type, execute theautomatic basic configuration and complete the configuration by carrying out manual configuration steps as required.Basic Configuration

Function DescriptionServices By working through the configuration for making services available, you determine

which collaboration services are available to the portal users. You can make collaborationservices available as follows:

In the Collaboration menu of the Collaboration Launch Pad (CLP) and the roommember listOn the user interface of the User Details iViewIn the context menu for the users or user groups displayed

For more information, see Providing Collaboration Services in the Portal and iViewswith Collaboration Services .

Virtual Rooms A room is a virtual working environment in the portal. In a room, the members of a teamor project group can collaborate and access shared applications and information.As an administrator, you configure the templates for rooms and manage existing rooms.For more information, see Making Rooms Available in the Portal .

Groupware Integration The groupware framework provides the technical prerequisites for integrating third-partygroupware applications for e-mail and scheduling. This allows you to integrate thegroupware used in your company, for example Microsoft Exchange, in the portal.For more information, see Groupware .

Asynchronous Functions Asynchronous functions allow asynchronous cooperation with other users. You can usediscussions and manage tasks, attachments to tasks, and documents. You can also usethe forums and wikis applications for information sharing.Users can also use Knowledge Management functions such as discussion groups,feedback, ratings, and comments for asynchronous collaboration.For more information, see Making Functions for Asynchronous Collaboration Available .

Integration of Services for Synchronous Collaboration The Synchronous Collaboration Framework (SCF) provides the technical prerequisitesfor the integration of synchronous collaboration services, for example WebEx onlinesessions.For more information, see Synchronous Collaboration Framework .

Services for Real-Time Collaboration SAP delivers Real-Time Collaboration (RTC) as a standard service for real-timecollaboration. This service allows interactive online sessions ( application sharing ) andinstant messaging ( instant messaging ).For more information, see Real-Time Collaboration .


Page 8 of 115

The basic configuration for collaboration capabilities comprises the following activities:Automatic basic configurationA wizard controls the automatic execution of the required steps. This process makes basic collaboration functions available in the portal. Users can work invirtual rooms and use collaboration services in the portal.For more information, see Wizard-Based Basic Configuration for Collaboration .Optional: Additional manual basic configurationTo activate other collaboration services, carry out the required configuration steps manually. You can enable real-time collaboration services (instantmessaging and application sharing), integrate calendar functions into the portal, and make third-party services available in the portal.For more information, see Completing the Basic Collaboration Configuration .

Company-Specific ConfigurationThe basic configuration steps make the collaboration capabilities available on the basis of the default settings delivered by SAP.You can modify collaboration functions and services in line with the requirements of your company.For more information, see Making Collaboration Capabilities Company-Specific .

3.1.1 Wizard-Based Basic Configuration for Collaboration

UseAfter installing the SAP NetWeaver Enterprise Portal (EP) usage type, you carry out basic configuration steps to make collaboration capabilities available in theportal. To keep the configuration effort low, SAP provides a wizard-based minimal configuration that is limited to the following collaboration services:

Send e-mailsCreate virtual roomsCreate tasks

If required, you can add services for real-time collaboration - instant messaging and application sharing - and calendar functions. You can also create newcommand groups (groups of menu items for launching services).Wizard-Based ConfigurationYou can work through most configuration tasks automatically using the functional unit configuration tool.

NoteOnly work through the wizard-based functional unit configuration if your system has not yet been configured.

You use the functional unit automated configuration to carry out the steps listed in the table below for Collaboration. For more information, see Java Functional UnitConfiguration .If you do not want to use the wizard-based configuration option, you must work through these steps manually.

If you want to use the search function in conjunction with collaboration capabilities, carry out the wizard-based basic configuration for TREX (Search andClassification), too.

3.1.1.1 Assigning Portal Roles for Collaboration To Users

Use

Configuration Task DescriptionAssigning Portal Roles for Collaboration To Users By assigning corresponding portal roles, you give portal users permission to

administrate or use collaboration functions.Activating the Minimal Grouping of Collaboration Services SAP delivers preconfigured command groups that you can integrate into applications as

menu items or links. To do so, you assign the relevant command group to eachapplication.There is a minimal grouping available for the wizard-based basic configuration. Itcontains commands for creating rooms, sending e-mails, and creating tasks.

Activating the Link for Launching the Collaboration Launch Pad The Collaboration Launch Pad (CLP) allows portal users to manage their contacts andlaunch collaboration services.To make the Collaboration link available in the portal header, activate it in the tool area ofthe default framework page.

Defining the Web Address and Automatic E-Mail Dispatch for Rooms To make rooms accessible through their Web address (URL), you must specify theproperties of the server on which the portal is installed in the settings for rooms. Inaddition, you can decide whether the system is allowed to send automatic e-mailnotifications to room members.

Importing Content for Standard Room Templates SAP delivers predefined content for standard room templates. To make this contentavailable.For example, to make the title of an iView and other texts belonging to it available inrooms - import the relevant content package (ICE package) into the repository directory ofyour standard room templates.

Configuring E-Mail Connectivity To make e-mail-functions from your Groupware server available in SAP NetWeaverPortal, you need to configure e-mail connectivity.The Collaboration Groupware Framework provides the necessary APIs for integratingdifferent groupware applications such as Microsoft Exchange Server or Lotus Dominointo SAP NetWeaver.


Page 9 of 115

Permissions for activities in the portal are stored in portal roles. SAP delivers predefined portal roles in the Portal Content Directory (PCD). To give userspermission to configure or use Collaboration capabilities in the portal, you assign the corresponding portal roles to them.

NoteYou can tailor the portal roles delivered by SAP and their permissions to suit the requirements of your company

RecommendationTo prevent the portal roles modified to suit company requirements being overwritten during upgrades, you should copy the roles required to your ownnamespace.

PrerequisitesThe users are created in the portal user administration.

ProcedureAssign the corresponding portal roles to the users or user groups. For more information about the complete procedure, see Assigning Portal Roles to Users andGroups .

More InformationManaging the PortalDelegating Administration TasksPortal Permissions

3.1.1.2 Activating the Minimal Grouping of Collaboration Services

Portal Role DescriptionContent Administration Administration role: Gives permission to access content objects in the portal. The content

objects relevant for Collaboration are stored in the following areas:Collaboration Content

This area provides access to template maintenance, to room administration, andto administration for the Collaboration Launch Pad.In addition, Collaboration content contains links to all activities in the systemconfiguration that are relevant for Collaboration.Portal Content

This area provides access to editing content objects in the Portal Content Directory(PCD) that are relevant for Collaboration. The worksets that define the structure ofrooms are stored in the PCD.

NoteTo allow maintenance of PCD objects (worksets and pages for rooms), theContent Administration role must have write permission for the

Collaboration folder in the PCD ( com.sap.ip.collaboration).

Role ID:pcd:portal_content/administrator/content_admin/content_admin_role

System Administration Administration role: Gives permission to access all activities in the systemadministration. This role allows access not only to the system configuration forCollaboration but also to the configuration objects in Knowledge Management that arerelevant for Collaboration.Role ID:pcd:portal_content/administrator/system_admin/system_admin_role

Collaboration ( Room Creation ) User role: Gives permission for the following activities:Creating roomsManaging a user's own rooms (in which the user is the room owner or roomadministrator)

This role is relevant for power users.Role ID:pcd:portal_content/specialist/Collaboration/com.sap.netweaver.coll.CollaborationRoomCreation

Collaboration User role: Gives permission to use rooms as virtual working environments in the portal.This role provides access to the following applications:

Room directory (entering rooms)My tasks (managing a user's tasks)My sessions (managing the session records of a user)

Role ID:pcd:portal_content/specialist/Collaboration/com.sap.netweaver.coll.Collaboration


Page 10 of 115

PrerequisitesThe Content Administration portal role is assigned to your user.

ContextTo make collaboration services available, SAP delivers predefined command groups. The command groups contain commands for launching the services. Theapplications that provide collaboration services are represented by configuration objects (types). To make the required services available as menu items or linksin the applications in question, you must assign the corresponding command group to each of the following types:

NoteThe minimal grouping of collaboration services is intended for the mandatory basic configuration of the collaboration capabilities.

Procedure1. In the portal, choose Content Administration Collaboration Content Collaboration Launch Pad Administration Command Group .

For the minimal basic configuration of collaboration services, the following command groups are relevant:clpMinimalGroupuserMinimalGroupuserDetailsMinimalGroup

Each of these groups contain the following commands: Send E-mail , Create Room , and Ceate Task .

NoteCopy the existing command groups to a new namespace. In this way, you prevent any changes to the command groups in the SAP namespace beingoverwritten during the next system upgrade.

2. Below Collaboration Launch Pad Administration , choose the class Type .3. One after another, call up the types listed below in editing mode and assign the corresponding command group to each one in the

contextmenu_commandgroup field:

NoteThe command groups delivered by SAP are listed in the table above. If you have copied these command groups, the corresponding names of thecopies apply instead.

ResultsThe Collaboration menu, the context menu for user names, and the user interface of the User Details iView provide the assigned services for collaborationbetween portal users.

Next StepsProviding Collaboration Services in the Portal

3.1.1.3 Activating the Link for Launching the CollaborationLaunch Pad

UseThe Collaboration Launch Pad (CLP) allows portal users to manage their contacts and launch collaboration services. Users use the Collaboration link in the toolarea of the masthead to launch the CLP.To make the Collaboration link available, activate the corresponding property in the Tool Area iView of the Classic Framework Page and in the AFP MastheadiView of the Ajax Framework Page.

Type Application (iView) Launch of ServicesclpType Collaboration Launch Pad (CLP) or Room Member List Menu items in the Collaboration menu

userType Any application that displays users with the context menu Menu item in the context menu

userDetailsType User Details iView Links to the user interface of the User Details iView

Type Command group for the minimal basic configurationclpType clpMinimalGroup

userType userMinimalGroup

userdetailsType userDetailsMinimalGroup


Page 11 of 115

PrerequisitesThe Content Administration role is assigned to your user.

ProcedureActivating the Link for Launching the CLP in the Ajax Framework Page

1. In the portal, choose Content Administration Portal Display Framework Page Configuration .2. In the Masthead section, locate the Show Link in Masthead: Collaborate property.3. To activate the link for launching the CLP, select the Show Link in Masthead: Collaborate checkbox.4. Save your changes.

Activating the Link for Launching the CLP in the Classic Framework Page1. In the portal, choose Content Administration Portal Content Management .

You reach the Portal Content Studio.2. In the Portal Catalog, choose Portal Content Portal Users Standard Portal Users .3. To prevent the system overwriting your settings during the next update, copy the Classic Framework Page object.4. To open the (copy of the) Classic Framework Page for editing in the page editor, choose Open Page in the context menu.

NoteIf you use variants of the classic framework page for different user groups, make sure that the settings are changed in all variants. Otherwise, thecorresponding services are not available for all portal users.

5. Select the Tool Area iView and choose Open .The property editor for the tool area appears.

6. In the upper right-hand corner of the property editor, choose Modify Properties .7. Choose All , and then choose All Properties from the Show Properties dropdown list.8. Activate the Enable Collaboration Launch Pad property.9. Optional: Specify the required value for the Cache Validity Period property.

NoteThe activation of the CLP takes effect only after the cache validity period has expired. In case the cache validity period is longer than the requiredwaiting time you can reduce this time by entering the required value in second, for example 10 seconds.

10. Save your entries.

CautionThe cache validity period affects system performance. If you have reduced the cache validity period as described above, you should re-enter the originalvalue as soon as the link for launching the CLP appears.

ResultThe portal masthead contains the link for launching the CLP.

More InformationActivating the Minimal Grouping of Collaboration Services

3.4.1.14 Defining the Web Address and Automatic E-MailDispatch for Rooms

ContextTo make rooms accessible through their Web address, you must specify the properties of the server used as the backend system in the settings for rooms. Inaddition, you can decide whether the system is allowed to send automatic e-mail notifications to room members and you can also limit the maximum number ofusers that can be invited to a room.These settings are required after installation of the SAP NetWeaver usage type Enterprise Portal as well as in routine operations in the event of changes to yoursystem landscape.

Procedure

1. In the portal, choose Content Administration Collaboration Content (Related Links) Configure Room Backend Room Backend Properties .2. Launch the roombackend configuration object for editing.3. Optional: To suppress automatic sending of e-mails to room members, set the Automatically Send Mails property to No .

Note


Page 12 of 115

The default setting is Yes . You can choose Not set to ensure compatibility with rooms from earlier releases, for which you could not configureautomatic sending of e-mails.

4. Enter the components of the Web address for rooms.

NoteIf you display the advanced options, the system displays additional properties whose values are predefined.

5. If you want to limit the maximum number of users that can be invited to a room, you have to specify the number in the Maximum Allowed Users property.

NoteBy default the Maximum Allowed Users property is with negative value (for example, -1 ) and in this way there is not a limitation of users that can beinvited to a room.

ResultsIn accordance with the example values above, users can use the following web address to enter rooms in the portal:https://Portalserver1:50000/...

3.1.1.5 Importing Content for Standard Room Templates

UseFor the standard templates for rooms, SAP delivers predefined content. For more information, see Standard Templates for RoomsThis content is made available in a content package (ICE package) that you must import to the repository directory for your standard room templates.For example, the content package contains the following:

Banner documents with the predefined banner texts for the iViewsThe banner text for an iView contains the following information that appears in the iView header (banner): title, subtitle, description, and graphic icon. Youcan change this information in the portal.Default setting of the KM folders with regard to manual sortingPossibly more predefined contentPossibly more predefined content

Because the banner documents are stored together with the remaining content for the standard templates, but should not appear in the iViews as content, they arehidden by default (status Hidden).

ProcedureTo import the content for standard room templates to your system, proceed as follows:

1. If the content for the standard templates has already been changed in your enterprise portal (in the repository folder room_extensions cm_stores TEMPLATES , save the existing documents to your namespace.

2. In the portal, navigate to the content package (ZIP file) that contains the predefined content from SAP for standard templates. To do so, choose ContentAdministration KM Content root etc ice home_area_content_templates_fullupdate.zip .

3. Save the content package (ZIP file) on the local file system on your computer.4. Import the contents of the content package. For more information, see Importing an Offline Package .

The function for importing content packages uploads the content for standard templates that the package contains to the repository folder named in step one.

3.1.1.6 Configuring E-Mail Connectivity

PrerequisitesYou have installed the collaboration capabilities of SAP NetWeaver as part of Enterprise Portal. You have access to the System Configuration iView in your portal. By default, this iView is assigned to the System Administration portal role.

Property Value ExampleServer address Complete network address of the server that the portal is

installed on. If you have a cluster installation, specify theaddress of the server that is responsible for distributingthe load.

Portalserver1

Server port Number of the port that was defined for the server duringinstallation.

50000

Web protocol Web protocol that has been set up for the server: http orhttps

The Internet protocol https provides greater securitythrough data encryption and is suitable for use withSingle Sign-On.

https://


Page 13 of 115

ContextTo integrate e-mail-functions from your groupware server with the implemented SAP NetWeaver scenarios, you need to configure the e-mail connectivity. TheCollaboration groupware framework provides the necessary APIs for integration of different groupware applications, such as Microsoft Exchange Server or LotusDomino, with SAP NetWeaver. The groupware application can be integrated by implementing the corresponding set of APIs called transports.

NoteThe configuration of e-mail connectivity is mandatory for the minimal implementation of Collaboration capabilities. The minimal implementation is recommendedfor scenarios, which do not require the full implementation of Collaboration capabilities. The minimal implementation comprises the following Collaborationfunctions:

Send E-MailCreate RoomCreate Task

CautionWith the minimal implementation of Collaboration capabilities the calendar and scheduling functions within rooms are not available.Within the full implementation of Collaboration capabilities you also need to implement the calendar connectivity. For more information, see Installing andConfiguring Calendar Connectivity .

ProcedureCreate a system in the portal system landscape.For more information, see Creating a System .You have preformed the required checks for implementing the transport.For more information, see Implementing the Transport .Create an E-Mail Transport.For more information, see Creating an E-Mail Transport .Configure the E-Mailing service.For more information, see E-Mailing Service .Map your user.For more information, see Mapping Your User .

ResultsYou are now able to use the e-mailing functions provided by Groupware in your enterprise portal.

3.1.2.5.1 Creating a System

UseA system allows you to maintain the credentials for a transport.

ProcedureTo create a system, proceed as follows:

1. Select System Administration System Configuration System Landscape Portal Content Content Provided By SAP.2. In the context menu of Collaboration select New From PAR System.3. Select com.sap.netweaver.col.appl.gw and then Next.4. Select a server (for example, Microsoft_Exchange_Server) and then choose Next.5. Enter the system name and ID (for example, Exchange or Lotus or DAVXchg), and then choose Next and then Finish.6. Call up System Aliases for this system using the Edit dropdown box in the top right-hand side of the iView, and create a new alias according to the system

you are using (Exchange or Lotus or DAVXchg).

3.1.1.6.2 Implementing the Transport

PurposeThe table below contains all prerequisites for implementing the transport for e-mail connectivity.

Transport ChecklistNumber Prerequisite Comments1. You have configured the SMTP server appropriately. If you want to allow users to send e-mails outside the

company domain using the portal, this server must be


Page 14 of 115

3.1.1.6.3 Creating an E-Mail Transport

PurposeThe e-mail transport defines the SMTP server and other configurations required for sending e-mails.

Process FlowCarry out Groupware configuration steps in the configuration iView. To configure an e-mail transport, choose System Administration System Configuration from the top-level navigation area and then choose KnowledgeManagement Collaboration Groupware Transports Mail Transport. Create an instance of the transport by choosing New and update the instance createdwith appropriate values as described in the table below.

Note

3.1.1.6.4 E-Mailing Service

UseThe e-mailing service provides the activation mechanism for sending e-mails.

IntegrationThis is a collaboration service that is required for sending e-mails.

PrerequisitesYou have already created an e-mail transport. For more information, see Creating an E-Mail Transport .

Features

configured to relay e-mails outside the domain.2. The groupware server supports IMAP protocol. Optional. Messages sent from the portal can be stored on

the groupware server only if the server supports IMAPprotocol.If the groupware server does not support IMAP protocol,users cannot save copies of their messages in the sentmessages folder.

3. All users have valid e-mail addresses in the portal LDAP. Every portal user must have a valid e-mail address. E-mailmessages cannot be sent for users without an e-mailaddress.

Attribute Description CommentsName Instance name of the transport. You cannot edit this

attribute. It is automatically filled when a new instance iscreated.

Javamail Transport

SMTP server Address of the SMTP server for sending e-mails. mysmtp.sap.corpSystem alias name Alias that you defined for the groupware server in the

system configuration. For more information, see Creatinga System .

Exchange, Lotus

Transport class name You cannot edit this attribute. It is automatically filled whena new instance is created.


Page 15 of 115

Features

Parameters of the E-Mailing Service

Note

ActivitiesTo configure the e-mailing service, choose System Administration System Configuration Knowledge Management Content Management GlobalServices E-Mailing Service from the configuration iView. You then edit the default instance created and update the parameters appropriately as described inthe table above.

Mapping Your User

UseYou have to map your user so that copies of e-mails that you send can be saved in your sent messages folder and, in the case of Exchange, appointments canbe retrieved.

Procedure 1. Click on Personalize in the portal masthead, and choose User Mapping . 2. Select the appropriate system from the System dropdown box (for example, Exchange ). 3. Enter your user and mail server. 4. If single sign-on is not available or not yet implemented, or if you want to save sent e-mails on your mail server, enter your password. 5. Save your entries.

Re-enter your password before saving your entries every time you change the user or mail server.

3.1.2 Completing the Basic Collaboration Configuration

PrerequisitesThe Wizard-Based Basic Configuration for Collaboration is complete.

ContextTo use the full offering of services for the Collaboration, you need to carry out the following configuration steps in addition to the automatic basic configuration.

Procedure1. For each application that provides collaboration services, activate the complete grouping of commands.

For more information, see Activating the Complete Grouping of Collaboration Services .2. In order to use synchronous collaboration services (RTC, WebEx) in the portal, activate the corresponding service types in the Synchronous Collaboration

Framework.For more information, see Activating Synchronous Collaboration Service Types .

3. To allow use of the standard SAP services for synchronous collaboration (instant messaging and application sharing) in the portal, activate and configure thetechnical RTC component.For more information, see Activating Services for Real-Time Collaboration and Configuring Real-Time Collaboration .

4. To make the calendar and scheduling functions of the groupware used in your company available, configure calendar connectivity.For more information, see Installing and Configuring Microsoft Exchange Connectivity , Installing and Configuring Lotus Domino Connectivity , and Installing

Parameter Value DescriptionName E-mailing service Name of the serviceActive Checked Specifies if the service is active


Page 16 of 115

and Configuring Calendar Connectivity .

3.1.2.1 Activating the Complete Grouping of CollaborationServices

PrerequisitesThe Content Administration portal role is assigned to your user.

ContextTo make collaboration services available, SAP delivers predefined command groups. The command groups contain commands for launching the services. Theapplications that provide collaboration services, are represented by configuration objects (types). To make available the required services as menu items or linksin the applications in question, you must assign the corresponding command group to each of the types described in the following table.

NoteThe complete grouping for collaboration services is intended for the completion of the basic configuration of the Collaboration capabilities.

Procedure1. In the portal, choose Content Administration Collaboration Content Collaboration Launch Pad Administration Command Group .

For the complete basic configuration of collaboration services, the following command groups are relevant:clpGroupuserGroupuserDetailsGroup

These groups contain the complete range of commands for launching collaboration services.

NoteCopy the existing command groups to a new namespace. In this way, you prevent any changes to the command groups in the SAP namespace beingoverwritten during the next system upgrade.

2. Below Collaboration Launch Pad Administration , choose the class Type .3. One after another, call up the types listed below in editing mode and assign the corresponding command group to each one in the

contextmenu_commandgroup field:

NoteThe command groups delivered by SAP are listed in the table above. If you have copied these command groups, the corresponding names of thecopies apply instead.

ResultsThe Collaboration menu, the context menu for user names, and the user interface of the User Details iView provide the assigned services for collaborationbetween portal users.

Next StepsProviding Collaboration Services in the Portal

3.1.2.2 Activating Services for Real-Time Collaboration

Use

Type Application (iView) Launch of ServicesclpType Collaboration Launch Pad (CLP) or Room Member List Menu items in the Collaboration menu

userType Any application that displays users with the context menu Menu item in the context menu

userDetailsType User Details iView Links to the user interface of the User Details iView

Type Command group for the complete basic configurationclpType clpGroup

userType userGroup

userdetailsType userDetailsGroup


Page 17 of 115

To make services for real-time collaboration available, activate the Real-Time Collaboration (RTC) technical component. RTC provides the standard servicesinstant messaging and application sharing.

NoteWith these technical components, you also activate the Real-Time Messaging Framework (RTMF). In the portal, the RTMF is the technical infrastructure fortransferring real-time event between servers and clients.

ProcedureActivating Services for Real-Time Collaboration in the Classic Framework Page

1. In the portal, choose Content Administration Portal Content Management .You reach the Portal Content Studio.

2. In the Portal Catalog, choose Portal Content Portal Users Standard Portal Users .3. To prevent the system overwriting your settings during the next update, copy the Classic Framework Page object.4. In the context menu of the (the copy of the) Classic Framework Page object , choose Open Page .

NoteIf you use variants of the Classic Framework Page for different user groups, make sure that the settings are changed in all variants. Otherwise, thecorresponding services are not available for all portal users.

5. Select the Tool Area iView and choose Open .The Property Editor for the tool area appears.

6. Choose Modify Properties in the upper right-hand corner of the Property Editor.7. Choose All , and then select the All Properties category from the Show Category dropdown list.8. Set the following properties as described in the table below:

9. Save your entries.

CautionThe cache validity period affects system performance. If you have reduced the cache validity period as described above, you should re-enter the originalvalue as soon as the link for launching the CLP appears.

Activating Services for Real-Time Collaboration in the Ajax Framework Page1. In the portal, choose Content Administration Portal Content Management .

You reach the Portal Content Studio.2. In the Portal Catalog, choose Portal Content Portal Users Standard Portal Users Ajax Framework PAge .3. To prevent the system overwriting your settings during the next update, copy the Ajax Framework Page .4. In the context menu of the (the copy of the) Ajax Framework Page object, choose Open Page .

NoteIf you use variants of the Ajax Framework Page for different user groups, make sure that the settings are changed in all variants. Otherwise, thecorresponding services are not available for all portal users.

5. Choose Properties All , and then select the All Properties category from the Show Category dropdown list.6. Choose Modify Properties in the upper right-hand corner of the Property Editor.7. Activate the Enable Real-Time Collaboration property.8. Optional: Specify the required value for the Cache Validity Period property.

NoteThe activation of the CLP takes effect only after the cache validity period has expired. In case the cache validity period is longer than the requiredwaiting time you can reduce this time by entering the required value in second, for example 10 seconds.

9. Save your entries.10. To display the page content and layout settings for the Ajax Framework Page , choose Page .11. Select the AFP Masthead iView, and then choose Open in the context menu.12. Choose All , and then select the All Properties category from the Show Category dropdown list.13. Activate the Show Link in Masthead: Collaborate property, and save your entries.

CautionThe cache validity period affects system performance. If you have reduced the cache validity period as described above, you should re-enter the original

Property ValueEnable Collaboration Launch Pad True

Enable Real-Time Collaboration True

Cache Validity Period Optional: Specify the cache validity period in seconds.

NoteThe activation of the CLP takes effect only after the cache validity period hasexpired. In case the cache validity period is longer than the required waiting timeyou can reduce this time by entering the required value in second, for example10 seconds.


Page 18 of 115

value as soon as the link for launching the CLP appears.

ResultThe portal masthead contains the link for launching the CLP. The services for real-time collaboration (instant messaging and application sharing) that are providedin the CLP Collaboration menu have been activated.Follow-on steps: To be able to use the RTC services, you must activate the RTC service type in the Synchronous Collaboration Framework and configure Real-Time Collaboration (see the link list below).

More InformationClassic Framework PageActivating Synchronous Collaboration Service TypesConfiguring Real-Time Collaboration

3.1.2.3 Activating Synchronous Collaboration Service Types

ContextThe Synchronous Collaboration Framework (SCF) allows the integration of synchronous collaboration services. The following synchronous collaboration serviceproviders can be used:

Real Time Collaboration (RTC)RTC - the default SAP service provider for synchronous collaboration - provides the application sharing and instant messaging services.WebExA separate license is required to use WebEx. During installation of the collaboration capabilities (with the SAP NetWeaver usage type Enterprise Portal),the services for synchronous collaboration are not activated automatically. You need to activate the corresponding service types manually as describedbelow.

Procedure1. In the portal, choose System Administration System Configuration Collaboration Synchronous Collaboration Services Activated Service

Types 2. Activate the following service types:

RTC Application SharingWebEx Meeting Center

Next StepsSynchronous Collaboration Framework

3.1.2.4 Configuring Real-Time Collaboration

UseAfter installing the Collaboration component in SAP NetWeaver, you need to complete a number of configuration steps to fully implement Real-Time Collaboration(RTC) in the portal. RTC provides both application sharing and instant messaging in the portal.

PrerequisitesEnable the Collaboration Launch Pad (CLP) and the RTC in the portal desktop.More information: Activating Services for Real-Time Collaboration

Process Flow1. (Optional) Configure the polling type settings.

More information: Configuring the Real-Time Messaging Framework (RTMF)Polling affects both user experience and system performance.

2. Configure the RTC Application Sharing Server.More information: Configuring the RTC Application Sharing Server .Configure the RTC Application Sharing Server only if you intend to use the application sharing functionality of Real-Time Collaboration.

3. Configure the maximum number of concurrent application sharing and instant messaging sessions permitted to run concurrently in the cluster.More information: Configuring Maximum Numbers of Sessions and Users Allowed

4. Configure the maximum number of users permitted per session.More information: Configuring Maximum Numbers of Sessions and Users Allowed

3.1.2.4.1 Configuring the Polling TypePUBLIC 2014 SAP AG or an SAP affiliate company. All rights reserved.

Page 19 of 115

3.1.2.4.1 Configuring the Polling Type

UseFor security reasons, the Internet imposes certain limitations on server-client interactions; for example, a server cannot initiate contact with a client. To overcomethis restriction in the Collaboration environment, a polling type was developed to support certain components, such as RTC. Polling enables clients (portal endusers) to interact with one another using the RTC as an intermediary point of contact.RTC uses the Real-Time Messaging Framework (RTMF) as an infrastructure for transferring messages between clients and servers in the portal environment.Portal clients are connected to the RTMF through an RTC client running in a hidden frame in their portal browser.Examples of events controlled by RTMF:

Instant messaging.Messages are sent from user to user via the RTC. The sender's message is stored in the server. The targeted recipient picks up themessage from the server. See figure below for an example.Session invitations.Portal users send invitations to other users to join application sharing sessions. The session host's invitation is stored in the portal server.The targeted participants pick up the invitation from the server. Each participant's reply is sent back to the host via the RTC in the same manner.Availability status. Portal users register to an event. RTMF monitors which user is registered for the duration of the session.Session-specific tasks. For example, during an application sharing session, a participant's request to take control of the host's cursor and the subsequentresponse by the host is also controlled by the polling type via the portal server.Online/offline status. Via RTMF, the portal server tracks which users are logged on.

RTMF does not affect the Application Sharing Server. The streaming of data in an application sharing session is managed solely by the Application SharingServer.Every RTMF-based client sends an automated request to the RTMF every number of seconds to check if messages have been sent to it. The time between eachcheck is commonly referred to as the polling interval. The polling type, if not configured properly, has the potential to generate load on the portal server as the totalnumber of users increases.

The figure above illustrates two clients communicating through instant messaging. The events are logged chronological from top to bottom. In this example, eachclient polls the portal server, via the RTMF, at regular 3 second intervals. You can configure the polling interval and what to consider to vary and limit the load generated by the polling type. You choose the polling policy which best suitsyour environment, and then configure the parameters relevant to that scenario. While configuring the polling settings so that the system does not become overloaded, you need to make sure that end users do not notice a major decrease inperformance over time. Keep in mind that the greater the polling interval, the less frequently users receive updates.


Page 20 of 115

ProcedureMore information: Configuring the Real-Time Messaging Framework (RTMF) .

3.1.2.4.2 Configuring the RTC Application Sharing Server

UseAfter installing the collaboration capabilities in SAP NetWeaver, you need to complete a number of one-time configuration steps in order to fully implementapplication sharing functionality in the portal.

Process Flow1. Enable the the RTC Application Sharing service. See Enabling / Disabling the RTC Application Sharing Server .2. Define general parameters for the RTC Application Sharing Server. See Setting RTC Application Sharing Server Parameters .3. Optional. Define specific parameters for running RTC Application Sharing Server in a clustered environment. See Running RTC Application Sharing Server

in a Clustered Environment .4. Optional. Configure AS Java and application thread settings. See Configuring Thread Settings for RTC Application Sharing Server .5. Monitor the RTC Application Sharing Server to verify the RTC Application Sharing Server configuration at setup, and to subsequently troubleshoot any

problems that may occur during application sharing. See Monitoring the RTC Application Sharing Server .6. Configure browser settings on client machines to accept the RTCActiveX control. See Configuring Client Browsers to Accept the RTC ActiveX Control .

3.1.2.4.2.1 Enabling / Disabling the RTC Application SharingServer

UseBy default, the RTC Application Sharing Server is not activated. If you intend to use application sharing functionality, you must start the RTC Application SharingServer service.

Procedure1. Open SAP NetWeaver Administrator.2. Select Operations Systems Start & Stop.3. Choose the Java Applications tab.4. In the Application list, select the following component: sap.com/com.sap.netweaver.coll.appl.rtc.streamsrv5. To enable the RTC Application Sharing Server, click the Start button.

To disable the RTC Application Sharing Server, click the Stop button.

3.1.2.4.2.2 Setting RTC Application Sharing Server Parameters

UseBefore making the application sharing capabilities of Real-Time Collaboration in the portal, you need to configure the RTC Application Sharing Server settingsavailable to business users at runtime.This procedure is mandatory only if you intend to integrate the application sharing capabilities of RTC.

PrerequisitesYou have access to the Collaboration Launch Pad Administration component in the portal.

Procedure1. In the portal, navigate to Content Administration Collaboration Content Collaboration Launch Pad Administration. Then, under Related Links, choose

Configure Real-Time Collaboration Application Sharing Application Sharing.Alternatively, you can navigate to System Administration System Configuration Collaboration Configuration. Then, under Folders, navigate to Real-Time Collaboration Application Sharing Application Sharing.

2. Configure the following configuration objects, as needed. To edit an existing configuration object, select its checkbox, and then click Edit.

NoteIf the following configuration objects do not exist, you need to create them. The name of each configuration object must be defined exactly as shown inthe table below; names are case-sensitive. To create a configuration object, click New.

Configuration object (name) Description (value)


Page 21 of 115

3.1.2.4.2.3 Configuring Thread Settings for RTC ApplicationSharing Server

UseTo optimize performance of the Real-Time Collaboration (RTC) Application Sharing Server, you need to optimize the application thread settings (for ICM andserver) of AS Java using the Config Tool (refer to Config Tool ). This topic also discusses additional parameters in the Config Tool on AS Java and ApplicationSharing Server descriptor file ( web.xml ) that need to be considered. In addition to the optimization settings described in this topic, you can also specify the maximum number of concurrent application sharing sessions (and instantmessaging sessions) allowed and also the maximum number of users allowed per session. For more information, see Configuring Maximum Numbers ofSessions and Users Allowed .

ServerName Enter the host name of the RTC Application Sharing Server. (Do not enter the fullqualified host name.)If the RTC Application Sharing Server is running in a clustered environment, enterthe host name of the server acting as the entry point to the cluster.For example: ethan

ServerPath This configuration object specifies the path to the host servlet providing applicationsharing capabilities.Enter the following value:streamingserver/servlet/streamingserver

CautionDo NOT change this value.

ServerPort Enter the port number of the server acting as the entry point to the cluster.

SecureMode Specify the secure mode in which the RTC Application Sharing Server sends data.RTC uses a binary format that is compressed when sending streamed data duringapplication sharing sessions. Data streaming through the RTC Application SharingServer is possible in SSL or non-SSL mode. The secure mode of the portal itselfdoes not require that the RTC Application Sharing Server runs in the same mode-ifthe portal is running in SSL mode (HTTPS) the RTC can stream data in non-SSLmode (HTTP) or vice versa.

NoteIf your portal is running in SSL mode, you should set RTC to stream data inthe secure SSL mode, as well. Note that the usage of the SSL may downgradeperformance of a collaborative session with application sharing.

Enter one of the following values to specify the appropriate secure mode:1 (for non-SSL mode) 3 (for SSL mode)

Version Specifies the version number of the Real-Time Collaboration ActiveX control thatshould be running on portal client machines. This ActiveX control is required for allportal users intending to run application sharing in a collaboration session.This property ensures that all portal clients use the same and most up-to-dateActiveX version when they participate in an application sharing session. If they donot have the same version defined by this property they are automatically given thecurrent version. If the version number does not appear, perform the following tospecify a version value.To determine the version of the current RTCActiveX control:

1. On the portal machine, locate the exp.cab file in the following folder:\usr\sap\< SAP AS Java instancename>\JCj2ee\cluster\apps\sap.com\irj\servlet_jsp\irj\root\portalapps\com.sap.netweaver.coll.appl.ui.rtc\activeX

2. Open the CAB file and locate the exp.inf file within it.3. Open this file in any text editor.4. Locate the FileVersion attribute. The last set of digits denotes the ActiveX

version.For example: If the attribute is FileVersion=1, 0, 0, 1730 , then theversion you enter for the Version value should be 1730 .

5. Close the exp.inf file.Standalone Specify the run mode of the RTC Application Sharing Server.

The RTC Application Sharing Server can run in one of two modes; as a standaloneunit on a dedicated machine outside the clustered environment, or inside eachserver node located inside the cluster.Enter one of the following values to specify the appropriate run mode:

true (to run on a dedicated machine)false (to run as a single server instance). The is the default option.


Page 22 of 115

Before a new participant can join an existing application sharing session or start a new session, the system first verifies if the maximum number of concurrentsessions or the maximum number of users for that particular session has been reached. If the user is allowed to join the session or start a new one, only then arethe thread setting limitations verified. When a session cannot be started or a user cannot participate in an existing session because of the defined limitations, anotification appears on the screen.

ProcedureConfigure System and Application Thread Settings in AS JavaThe number of threads that each machine is capable of supporting depends on the amount of available memory, CPU, and other system resources. You need toconduct a number of performance tests to obtain the correct settings for a specific machine.To run the RTC Application Sharing Server in an optimal manner, you need to optimize the application following parameters in the Config Tool on AS Java:

System thread parameters (under ThreadManager on server only)Application thread parameters (under ApplicationThreadManager on server only)Request queue (RQ) parameters (on server only)Connection manipulator parameters (on dispatcher) only)

NoteWhen optimizing the thread count settings in the AS Java, take into consideration that an individual thread is dedicated to each user running an RTCApplication Sharing session. Each thread is maintained for the entire duration of the session; a thread is released when the user ends their participation in thesession. For a dedicated machine, we recommend allocating the majority of the application threads to the RTC Application Sharing Server.

For more information about this parameter, see the following documentation:AS Java Configuration Thread System

Configure the RTC Application Sharing Descriptor File (web.xml)The web.xml file is located at:

To specify the runtime allocation and thread count usage, you need to configure the following parameters in the RTC Application Sharing descriptor file, web.xml :

Based on the above values, the RTC Application Sharing Server at runtime calculates the actual percentage values ( ServerMaxSystemThreadsInPercentand ServerMaxClientThreadsInPercent ), compares them to one another and then to the fixed values ( ServerMaxSystemThreads andServerMaxClientThreads ). The lowest number of threads by four-way comparison is then defined as the overall maximum number of threads used by theRTC Application Sharing Server for a given session (the same value is used for both system and applications threads).For example, if the values in the following table are defined in the RTC Application Sharing web.xml file and the Config Tool on AS Java, the maximum numberof system and application threads used by the RTC Application Sharing Server is 100, since this is the lowest value by comparison:

Platform PathUNIX /usr/sap//JC/j2ee/cluster/server0/apps/sap.com/com.sap.netweaver.coll.appl.rtc.streamsrv/servlet_jsp/streamingserver/root/WEB-INF/

Windows \usr\sap\\JC\j2ee\cluster\apps\sap.com\com.sap.netweaver.coll.appl.rtc.streamsrv\servlet_jsp\streamingserver\root\WEB-INF\

Parameter Default Value DescriptionServerMaxSystemThreads 200 Specifies the maximum number of Java EE system

threads that can be allocated to the RTC ApplicationSharing Server.This number should not be larger than the maximumsystem thread count defined in the ThreadManager withinthe Config Tool on AS Java.

ServerMaxSytemThreadsInPercent 50 Specifies the percentage of the maximum system threadcount (defined in the ThreadManager within the AS Java)that is allocated to the RTC Application Sharing Server.

ServerMaxClientThreads 200 Specifies the maximum number of Java EE applicationthreads that can be allocated to the RTC ApplicationSharing Server.This number should not be larger than the maximumapplication thread count defined in theApplicationThreadManager within the Config Tool on ASJava.

ServerMaxClientThreadsInPercent 50 Specifies the percentage of the maximum applicationthread count (defined in the ApplicationThreadManagerwithin the Config Tool on AS Java) that is allocated to theRTC Application Sharing Server.

Max Thread Count in AS Java Max Thread Count in RTC ApplicationSharing Descriptor File (web.xml)


Page 23 of 115

3.1.2.4.2.4 Running Application Sharing Server in a ClusteredEnvironment

UseIf you are running the RTC Application Sharing Server on a single server instance with multiple server nodes, you need to configure the Standalone parametermentioned below.You may skip this section if you have disabled the RTC Application Sharing Server, or installed it as a standalone unit on a dedicated machine outside theclustered environment (and the machine does not comprise multiple server nodes).

PrerequisitesThe RTC Application Sharing Server is installed on a portal machine in a clustered environment.You are using a software-based load balancer. Currently, only the SAP Web Dispatcher (see SAP Web Dispatcher ) has been tested and qualified. If youare using a load balancer solution from a different vendor, it must be software-based, and support session stickiness and traffic load balancing through theuse of a URL prefix.If you are running a single server instance only with multiple server nodes, this prerequisite is not relevant.The RTC Application Sharing Server must be enabled on all server nodes on each server instance (see Enabling / Disabling the RTC Application SharingServer ).

ProcedureRefer to the Standalone parameter, in the Application Sharing configuration settings, as described in Setting RTC Application Sharing Server Parameters .

3.1.2.4.2.5 Monitoring the Application Sharing Server (RTC)

UseYou can use the Application Sharing Server monitor to verify the Application Sharing Server configuration at setup, and to periodically check the status of theApplication Sharing Server. Additionally, if you experience any problem with application sharing, this monitor may provide information to help you troubleshoot theproblem.

PrerequisitesTo verify the Application Sharing Server configuration at setup, and to periodically check the status of the Application Sharing Server, you must have at leastAdministrator read permissions. For more information, see Permission Levels .

ProcedureOpening the Application Sharing Server MonitorTo open the Application Sharing Server monitor, launch the following URL: http://:/streamingserver/servlet/streamingserverFor example: http://machine1.tlvp.sap.corp:50000/streamingserver/servlet/streamingserverWhen formulating the URL, use the ServerName and ServerPort parameters defined for the Application Sharing Server. See Setting RTC Application SharingServer Parameters .The monitor window does not appear if:

The parameters of the URL you used to connect to the server are incorrect.The Application Sharing Server cannot be accessed from your location (due to incorrect browser settings or routing problems).Trying the following may provide information about the cause of the problem:

Unselect the Use Automatic Configuration Script setting in your browser. If unselecting the browser setting resolves the issue, then a client problem isindicated.As well, if a portal client sees a blank window instead of the application sharing session in the Application Viewing area of the Application SharingConsole, unselecting the Use Automatic Configuration Script setting in your browser may resolve the problem.Ping the RTC Application Sharing Server machine. If the ping fails, then a router problem is indicated.

Fixed value Percentage valueApplication thread count 400 400 threads 80% (=320 threads)System thread count 200 100 threads 80% (=160 threads)


Page 24 of 115

The RTC Application Sharing Server is stuck, and needs to be restarted.The RTC Application Sharing Server is not installed.

Reading the Data Displayed in the MonitorThe monitor displays the following information:General Information

Ongoing Session Information

NoteIf the displayed parameters do not match your expectations, verify that you specified the correct RTC Application Sharing Server in the URL used to launchthe monitor.

Thread Count Properties

3.1.2.4.2.6 Configuring Client Browsers to Accept the RTCActiveX Control

UsePortal users that want to use the RTC application sharing tool need to have the RTC ActiveX control on their system.

NoteThe ActiveX control is installed the first time a user initiates or participates in an application sharing session on a given machine.

The system administrator needs to make sure that the browser security settings of each user are appropriately configured so that they can accept the ActiveXcontrol. Browsers can be configured to accept ActiveX controls either with or without the user's confirmation. We recommend the former configuration to protectuser's systems from unsolicited and harmful ActiveX installations.This topic describes how to configure a browser's security settings so that it can accept ActiveX controls. Alternatively, your IT department may use other

Server Version The version of RTC Application Sharing Server installed.Registered Sessions The number of sessions currently being handled by the RTC Application Sharing Server.

This number includes ended sessions that have not yet been deleted. Details about eachsession appear in the Ongoing Sessions Information table (described in the followingtable).

Session ID Real-Time Collaboration internal session ID.Status Waiting sharer to join

Invited participants have joined the session before the session host, and are waiting forthe session host to join.Waiting viewers to joinThe session host has opened the session, no participants have joined yet.Session StartedSession host and participants are currently in an active session.Session endedBoth the session host the invited participants have left the session, and the session ismarked for delete.

Sharer name Name of the user sharing his or her application.Participant count Number of participants (excluding the session host) currently in the session.

SAP AS Java Engine max application thread count Maximum application thread count defined in the RTC Application ThreadManagerwithin the AS Java.

SAP AS Java Engine max system thread count Maximum system thread count defined in the ThreadManager within the AS Java.Application Sharing Server max thread count Maximum number of AS Java threads that can be allocated to the RTC Application

Sharing Server.Application Sharing Server currently in use thread count Number of AS Java threads currently being used by the RTC Application Sharing Server

(each user = 1 thread). If this line is marked in red, the RTC Application Sharing Serverhas reached its thread usage limit.If the RTC Application Sharing Server reaches its thread limit, it cannot open a newsession.See Configuring Thread Settings for RTC Application Sharing Server for details aboutoptimizing performance of the Application Sharing Server.


Page 25 of 115

appropriate methods to deliver the necessary ActiveX control to the client machines.

PrerequisiteThe user logged onto the machine to which the ActiveX control needs to be installed must be defined as a Windows administrator.

Procedure1. In Microsoft Internet Explorer, from the Tools menu, choose Internet Options.2. Choose the Security tab.3. Choose either the Internet or Local Intranet icon (depending on the zone providing access to your organization's portal).4. Choose Custom Level.5. Under ActiveX controls and plug-ins Download signed ActiveX controls, choose one of the following:

Prompt: To be prompted before ActiveX controls are installed on your system. (Recommended)Enable: To allow ActiveX controls to be installed on your system automatically without your prior consent.

6. Under Run ActiveX controls and plug-ins, choose either Enable or Prompt.7. Choose OK to close the Security Settings window.8. Choose OK to close the Internet Options window.

ResultTo determine if the RTC ActiveX control has been installed on a user's system, note the following:

If a user initiates an application sharing session, and the first dialog displays the list of applications currently active on his or her desktop, then the controlhas been downloaded.If a user has been invited to participate in a sharing session, and can see the host's shared application on his or her desktop, then the control has beendownloaded.

You can also verify the download as follows:1. In the Web browser of the user, from the Tools menu, select Internet Options.2. In the General tab, click the Settings button.3. In the Settings window, click the View Objects button.4. In the Download Program Files window, if any of the following appear in the Program Files list, then the ActiveX control was downloaded:

ExpBaseNegotiatorExpApplSelectExpApplShareX

3.1.2.4.3 Configuring Maximum Numbers of Sessions and UsersAllowed

UseYou can improve system performance by limiting the load generated by RTCcollaborative sessions. RTC provides parameters that enable you to specify thefollowing:

The maximum number of instant messaging and application sharing session that can run concurrentlyThe maximum number of users that are allowed per instant messaging and application sharing session

Before a new participant can join an existing RTCsession (application sharing or instant messaging) or start a new session, the system first verifies if themaximum number of concurrent sessions or the maximum number of users for that particular session has been reached. If the user is allowed to join the sessionor start a new one and the session is an application sharing session, the system then also verifies if the maximum number of allowed threads in the AS Java hasbeen reached (see Configuring Thread Settings for RTC Application Sharing Server ). In the event a session cannot be started or a user cannot participate in anexisting session because of the set limitations, the user is notified on the screen.

Procedure1. In the portal, navigate to Content Administration Collaboration Content Collaboration Launch Pad Administration. Then, under Related Links, choose

Configure Real-Time Collaboration RTCEngine RTCEngine.Alternatively, you can navigate to System Administration System Configuration Collaboration. Then, under Folders, navigate to Collaboration Real-Time Collaboration (RTC) RTCEngine RTCEngine.

2. Configure the values of the following configuration objects, as needed. To edit an existing configuration object, select its checkbox, and then click Edit.

NoteCertain parameters are tagged as advanced parameters. To display advanced parameters with the basic parameters, you need to switch the view ofthe configuration editor. See Normal and Advanced View in the Configuration iView .


Page 26 of 115

3.1.2.5 Installing and Configuring Calendar Connectivity

PurposeThe Groupware framework provides an abstraction for the Calendar APIs of different vendors. Depending on the groupware system used in your organization, youconfigure the appropriate transport in order to integrate scheduling functionality in your portal.

Implementation ConsiderationsFor more information, see Installing and Configuring Microsoft Exchange Connectivity and Installing and Configuring Lotus Domino Connectivity .

IntegrationSAP provides out-of-the-box integration for Microsoft Exchange and Lotus Notes.

FeaturesConfiguring multiple calendar repositories.Merging scheduling information from multiple repositories for display.

3.1.2.5.1 Creating a System

UseA system allows you to maintain the credentials for a transport.

ProcedureTo create a system, proceed as follows:

1. Select System Administration System Configuration System Landscape Portal Content Content Provided By SAP.2. In the context menu of Collaboration select New From PAR System.3. Select com.sap.netweaver.col.appl.gw and then Next.4. Select a server (for example, Microsoft_Exchange_Server) and then choose Next.5. Enter the system name and ID (for example, Exchange or Lotus or DAVXchg), and then choose Next and then Finish.6. Call up System Aliases for this system using the Edit dropdown box in the top right-hand side of the iView, and create a new alias according to the system

you are using (Exchange or Lotus or DAVXchg).

3.1.2.5.2 Installing and Configuring Microsoft ExchangeConnectivity

PurposeYou can integrate the scheduling capabilities of Microsoft Exchange server with the SAP NetWeaver portal using the Microsoft Exchange server transport.The portal provides the following transports for accessing data from-and-to the exchange server.

Configuration Object (Parameter) Default Value DescriptionMaximumApplicationSharing Sessions 10 Specifies the maximum numbers of concurrent application

sharing sessions permitted per cluster.MaximumChatSessions 100 Specifies the maximum numbers of concurrent instant

messaging sessions permitted per cluster.MaximumUsersPerApplication SharingSession 5 Specifies the maximum numbers users permitted per

application sharing session.MaximumUsersPerChatSession 8 Specifies the maximum numbers users permitted per

instant messaging session.


Page 27 of 115

Microsoft Exchange Transport based on Collaborative Data Objects (CDO), henceforth called as Exchange Transport.Microsoft Exchange Transport based on WebDAV protocol, henceforth called as WebDAV Transport.

The following versions of Microsoft Exchange server are supported:Exchange Server 2000Exchange Server 2003

In addition to this the Exchange Transport also supports Exchange server 5.5 SP4.

FeaturesMicrosoft Exchange connectivity provides the following scheduling features:

Creating non-recurring appointmentsCreating daily/weekly recurring appointmentsSending non-recurring meeting requestsSending daily/weekly meeting requestsReading, modifying, deleting appointmentsModifying and deleting entire series of recurring appointmentsModifying and deleting current instances of recurring appointmentsSending meeting requests with attachmentsScheduling online meetingsChecking Availability Information

ConstraintsThe Microsoft exchange connectivity currently only supports items with the type appointment, and meeting request. Other types, such as discussion, arenot currently supported.Calendar items in personal folders are not supported. Users can only view and modify items located on the Exchange server from the iViews.Public folders on the Exchange server are not supported.Calendar items are delivered as such if sent to recipients within the intranet. If the recipient is in a different domain than the sender, the format in which theitems are delivered depends on the server responsible for sending the items in question.Users cannot access calendar information from multiple logins of the same user in the portal.In Exchange Transport the attachments are stored temporarily in the folder in which the MSX-A component is installed. Attachments are deleted as soon asthe read, save, or send action is performed.

3.1.2.5.2.1 Microsoft Exchange Connectivity Architecture basedon WebDAV ProtocolMicrosoft Exchange server 2000, 2003 and 2007 support Web Distributed Authoring and Versioning (WebDAV) protocol via Outlook Web Access (OWA) toaccess a Mailbox on a Exchange server.Microsoft Exchange server 2007 has limited features to support WebDAV. Refer to SAP Note 1368473 for details.

TransportThe WebDAV transport consists of only a Java component that runs on the portal server. The WebDAV transport and DAVXchg transport are usedinterchangeably but they both mean the same.

Architecture and Deployment RequirementsThe figure below illustrates architecture and deployment requirements.

1. The Java component makes an HTTP(S) request to the Exchange server via OWA. It passes user credentials using basic authentication.2. The Exchange server retrieves the relevant data and returns it to the Java component as an XML stream.

PUBLIC 2014 S