Configuration of the Sponsored Links Function

As the administrator, you must perform the following configuration steps, in order to be able to use the Sponsored Links function.

• You create a folder and an index.
• You copy and configure different elements for the user interface.
• You extend the context menus with new commands.

Standard Use of the Sponsored Links Component

You carry out the following steps:

1. You create a folder for storing the sponsored links.
   1. Navigate to the /documents repository and create the Sponsored Links folder.

       

   2. Set permissions for the folder. For example, only administrators and content managers should have write permission for this folder. Assign all other users read permission.

      If required, you can also use permissions to limit the visibility of the sponsored links to specific users.

2. Create an index.
   1. Call up the Index Administration iView as follows: In the portal, choose System Administration → System Configuration → Knowledge Management → Index Administration.
   2. Create an index with the following values:

      ID = sponsored_links

      Name = Sponsored Links Index

      Group = No entry necessary

      Crawler Parameter = No entry necessary

      Service = TREX Search

      What to Index = Documents

   3. So that the XML documents that are stored in the /Sponsored Links folder do not appear as hits in the search results, you must create the following additional property:

      Name = searchhidden

      Value = true

      Choose Add and then Create Index.

   4. Then choose the folder /documents/Sponsored Links from the data sources and save the index.

      As soon as a sponsored link has been created in this folder, it is indexed automatically and can be displayed in the search results list.

      Note

      If you do not want to create the folder in the /documents repository, you must make sure that the Send Events parameter is activated in the repository used.

3. You create a copy of the SponsoredLinksComponent component and specify the parameters.
   1. Call up the Configuration iView as follows: In the portal, choose System Administration → System Configuration → Knowledge Management. Here you choose Content Management → User Interface → Mapping → Component.
   2. Select the SponsoredLinksComponent component. Choose Duplicate. Specify a name for the copy (for example, My_SponsoredLinksComponent_1). In the Parameters field, you can enter the following parameters:

Parameters for the SponsoredLinksComponent component

For example:

Parameters = Indexes=sponsored_links, Style=NONE, MinWidth=200

1. You copy and configure the collection renderer for the search results.
   1. Call up the Configuration iView as follows: In the portal, choose System Administration → System Configuration → Knowledge Management. Here you choose Content Management → User Interface → Settings → Collection Renderer Settings  → Search Result Renderer Settings.
   2. Select the entry StandardSearchResultRenderer. Choose Duplicate. Specify a name for the copy (for example, My_StandardSearchResultRenderer). Add the entry My_SponsoredLinksComponent_1 to the Components parameter:

      Components = SearchHeaderComponent,My_SponsoredLinksComponent_1,Pager(alignCenter),this,Pager(alignCenter)

      You can use modifiers to fix the position of the components used in the search results list. For example, to have the sponsored links appear on the right-hand side of the search results list, you must enter the following:

      Components = SearchHeaderComponent([1;1-2]),Pager([2;1]/alignCenter),this([3;1]),My_SponsoredLinksComponent_1([3;2]),Pager([4;1])/alignCenter)

      For more information about the syntax of the modifiers that are used to display the search components in a table, see Displaying Properties .

2. You enter the copy of the collection renderer in the layout set SearchResultLayoutSet.
   1. Call up the Configuration iView as follows: In the portal, choose System Administration → System Configuration → Knowledge Management. Here you choose Content Management → User Interface → Settings → Layout Set.
   2. Choose the entry SearchResultLayoutSet.Choose Edit.
   3. Enter the new collection renderer (see step four, My_StandardSearchResultRenderer) in the Collection Renderer parameter and remove the previous collection renderer. Choose OK.
3. You extend the context menu in the Navigation iView by one command.
   1. Call up the Configuration iView as follows: In the portal, choose System Administration → System Configuration → Knowledge Management. Here you choose Content Management → User Interface → Commands → UI Command Groups.
   2. Open the command group AdminResourceCommandGroup. At the end of the Command List parameter, add the command edit_xml_forms_properties:

      Command List = [...],edit_xml_forms_properties

      In the context menu for a document, you can now choose the command Add To Sponsored Links.

      Note

      During configuration of the command edit_xml_forms_properties, you enter the path to the folder /documents/Sponsored Links and the associated XML forms project name in the Parameters field as a fixed value. If you are not using the default path and the default XML form, you must change the parameters of the command accordingly.

4. You extend the context menu in the Portal FavoritesiView by one command.
   1. Call up the Configuration iView as follows: In the portal, choose System Administration → System Configuration → Knowledge Management. Here you choose Content Management → User Interface → Commands → UI Command Groups.
   2. Open the command group LinkListMntcResourceCommandGroup. In the Command List parameter, add the command edit_xml_forms_properties as follows:

      Command List = change_link, rename, OrderedListGroup, move, edit_xml_forms_properties, ClipboardCommandGroup(expanded), SingleDeleteGroup(expanded), SingleDetailsGroup(expanded)

   3. To save your entries, choose OK.

      In the context menu for the portal favorites, you can now choose the command Add To Sponsored Links.

Optional: Reuse of the Sponsored Links Component

In the search results list, you can not only use a component to display sponsored links, you can also use several components that each contain different links. For example, you can display one component for displaying internal news above the search results list and another component on the right-hand side of the screen that contains external links.

To do this, you must work through the steps listed above again:

1. Create a new folder and another index.
2. Create a copy of the component (for example, My_SponsoredLinksComponent_2), enter the new index, and use a different style, if required.
3. For example, you can configure the collection renderer for the search results as follows:

   Components = SearchHeaderComponent([1;1-2]),My_SponsoredLinksComponent_2([2;1-2]/alignleft),Pager([3;1-2]/alignCenter),this([4;1]),My_SponsoredLinksComponent_1([4;2]),Pager([5;1-2])/alignCenter)

4. Create a copy of the command edit_xml_forms_properties and change the folder information in it.
5. Edit the command description as well.
6. Add the command to the relevant command group.

You can now create different sponsored links in each folder, depending on the link content.

You have worked through all necessary configuration steps and can now use the sponsored links function. For more information, see Creating and Managing Sponsored Links .