Configuring the CM Room Extension 

Use

The CM Room Extension (CMRoomExtension) is a standard extension delivered by SAP for rooms and room parts. It manages folders for data in the rooms and room parts in the Content Management (CM) repository. This includes the following activities:

●      Creating folders

●      Assigning permissions for accessing folders

●      Linking folders with rooms   

●      Deleting folders

Extension Points

You must create the CM room extension for each of the following extension points and define the input and output parameters required in each case.

Since the system passes on parameter values, for example, the Room ID or the room folder, to the other extension points, you do not have to define input and output parameters for each extension point. 

Type of Template	Required Extension Points
Room template	●      Room creation (ON_CREATE_ROOM) ●      Room deletion (ON_DELETE_ROOM)
Room part template	●      Room part creation (ON_CREATE_ROOMPART) ●      Room part deletion (ON_DELETE_ROOMPART) ●      Addition of a room part to a room (ON_ADD_ROOMPART_TO_ROOM) ●      Removal of a room part from a room (ON_REMOVE_ROOMPART_FROM_ROOM)

Folders for the CM Room Extension

SAP delivers preconfigured folders for the CM Room Extension in the Content Management repository, in which the extension can create room-specific and room part-specific subfolders. In the portal, you can see and configure the following folders at Content Administration ® Collaboration Content ® Room Template Administration or Room Part Template Administration ® Configure Extension Stores: cmBanner, cmDocuments, cmEvents, cmFaq, cmForms, cmInternalWorkingDocuments, cmItems, cmLinkList, cmMilestones, cmNews, cmQuickpoll

These folders are necessary for use with XML forms.
Otherwise, you can create folders for data for rooms and room parts at Content Administration ® KM Content ® documents.

Prerequisites

●      You have completed the configuration of the room infrastructure.

●      You have called a template to be maintained  in template administration.

You cannot change the templates delivered by SAP. However, you can duplicate these templates and modify the duplicates to suit your company’s requirements.

Procedure

...

...

 1.  In the room template or room part template data, open the Extensions tab page.

A list of the assigned extensions appears. The list contains all entries for the extension at certain extension points. Each entry has a unique name (see the graphic): 

 2.  Select one of the following options:

Target	Procedure
Adding the CM Room Extension	... ... ...        1.      Choose Add Extension. The initial screen for adding an extension appears (see graphic below).        2.      Enter a meaningful name for this entry, for example, “Documents“, if you want to use this extension configuration to create folders for documents. The name is the unique ID for the entry (extension input and output parameters at a specific extension point).        3.      In the Extension field, choose the CM Room Extension.        4.      Choose the extension point that you want to configure the extension for.        5.      Choose Add. The system displays the dialog for defining the planned input and output parameters (see step three).
Adding an extension point to the CM Room Extension	... In the context menu for the extension, choose Add ® <extension point>. The system displays the dialog for defining the planned input and output parameters (see step three).

 3.  Define the input and output parameters for the extension.

The input and output parameters defined in the extension are listed in the Name column (see the graphic below).

This procedure describes the input and output parameters for the CM room extension at the point of creating a room or room part. The other extension points have fewer or no parameters because the system can automatically pass on certain parameter values.
Example: when a room part is deleted, the CM room extension uses the room ID to access the folder created with the room part through the link structure, and deletes the folder. (See the folder and link structures at the end.)

○       You use the input parameters to define how the folder should be created and used.

○       You use the output parameters to define which values the extension returns to the room or room part.

                            a.      Define the input parameters for the extensions as follows:

Under Parameter Assignment, you can find parameters that are defined for variable determination of values in the extension; under Entries Help, entry values are available for selection (for example, the available folders in CM); under Fixed Values, you can enter a value manually.

                                                  i.       Store

Use the entry help to choose one of the preconfigured folders in the CM repository, in which the extension creates the subfolders for data from rooms or room parts.

In the portal, you can use the following link to launch the iView for creating and configuring folders for storing data from rooms and room parts: Content Administration ® Collaboration Content (® Related Topics) ® Configure Extension Stores.
The complete path is System Administration ® System Configuration ® Knowledge Management ® Collaboration ® Room ® Extensions ® Cm ® Stores.

As soon as you have created rooms or room parts based on the template, you must not move these folders again (to ensure that the room can still find them).

                                                ii.       Template

If you want to fill the folder with predefined content (for example, with documents), use the entry help to choose the required content templates.

In the portal, you can create content templates at the following path:
System Administration ® System Configuration ® Knowledge Management ® Collaboration ® Room ® Extensions ® Cm ® Templates.

The predefined content from the folder is copied to all newly created rooms based on the template. Since the predefined content only affects new rooms that are created, you can change content templates at any time.  

                                               iii.       Folder name

Specify the name of the subfolder that is created for each room or room part for storing data.
You can select a predefined parameter (room or room part parameter) or enter a fixed value.

                                               iv.       Access

You can define the permission for access to the folder and the documents it contains as follows:
– Private: Only room members have access (read-write permission) to the folder.
– Public: As for private, plus all portal users receive read-permission for the folder.

                                                 v.       Entry Point

You can use input help to determine whether the folder that the extension generates appears as a subfolder of the entry points Current Rooms and My Room Folders (see Providing Target Folders for Room Documents).
– Yes: The folder appears. (For reasons of downwards compatibility, every folder is allowed to be displayed among the entry points by default. If you do not enter a value here, Yes applies.)
– No: The folder does not appear.

                                               vi.       Dependency

You can choose an entry (extension point with parameters) that the system is forced to take into account before this entry. The syntax of the selection options is: <entry name (ID)>:<extension name>.
For example, this input parameter allows you to ensure that the folder is already created before the system sets the corresponding permissions.

                            b.      Define the output parameters for the extensions as follows:

You use the Assigned flag to activate output parameters for use within the template.
Under Parameters, you can enter an appropriate variable or a fixed value for each output parameter activated.

                                                  i.       Folder

You only require this parameter in exceptional cases. Specify the ID of the folder created.

                                                ii.       Path to folder

You require this parameter to assign the parameters to iViews. Specify the complete path to the folder.

 4.  Choose Save.

Result

When the extension point is reached, the system executes the CM room extension in the rooms or room parts that are based on the template. The values of the input parameters are taken into account and the values of the output parameters are returned to the rooms or room parts.

You can use the output parameters in the extension for the assignment to iViews or as input parameters for other extensions.

After adding room parts, you can configure the isFinished parameter as an input parameter for extensions to be subsequently executed.
Example: Since the discussion extension supplements the folder configuration of the CM Room Extension, it requires the information that the CM Room Extension has completed its activities.

Activities at the extension point

Depending on the extension point defined, the CM Room Extension performs the following activities:

Extension Point	Activities for the CM Room Extension
Room creation (ON_CREATE_ROOM)	●      Create a room-specific subfolder in the preconfigured folder (see the graphic below). ●      Assign full access to the room-specific subfolder for the member group for the room and assign this group to the groups of owners of the subfolder.  ●      If access is defined as public: Assign the read-permission for the room-specific subfolder to the “Everybody” group (all portal users). ●      Create a link to the room-specific subfolder in the room structure (see the graphic below).
Room deletion (ON_DELETE_ROOM)	●      Delete the links to the room-specific subfolder in the room structure. ●      Delete the room-specific subfolder.
Room part creation (ON_CREATE_ROOMPART)	●      Create the room part-specific subfolder in the preconfigured folder. ●      Copy the predefined content to the room part-specific subfolder. ●      If access is defined as public: Assign the read-permission for the room part-specific subfolder to the “Everybody” group (all portal users).
Addition of a room part to a room (ON_ADD_ROOMPART_TO_ROOM)	●      Assign full access to the room part-specific subfolder for the member group for the room and assign this group to the groups of owners of the subfolder. ●      Create a link to the room part-specific subfolder in the room structure.
Removal of a room part from a room (ON_REMOVE_ROOMPART_FROM_ROOM)	●      Revoke full access to the room part-specific subfolder for the member group for the room and revoke the assignment of this group to the groups of owners of the subfolder. ●      Delete the links to the room part-specific subfolder in the room structure.
Room part deletion (ON_DELETE_ROOMPART)	●      Delete the room part-specific subfolder.

Folder and Link Structures for the CM Room Extension

The graphic below shows the folder and link structures that the CM Room Extension creates in the CM repository. The system automatically creates a subfolder for each room or room part in the (standard) folder for the room or room part structure. This folder forms the structure of the respective room or room part by means of the following links:

●      Room part links (links to the associated room parts)

●      Folder links (links to the folders of the respective room or room part)

The folder that forms the structure of a room contains links to the entire content of the room and can therefore be used as the entry point for copy and insertion functions. Due to this link mechanism, you can store folders for the room or the room parts in different folders or repositories.