Wiki Delivery Method

The Wiki Delivery Method works with an OIEP configured to deliver metadata to a specified XWiki advanced open source enterprise wiki system. The contents of the wiki can be accessed by clicking a 'Go to Wiki' link from either Web UI or workbench.

The Wiki Metadata functionality is a licensed component and requires a separate installation recipe. For details and the latest recipe, contact Stibo Systems.

Prerequisites

Changes to the properties file, outlined below, are implemented when the server is restarted.

  1. Review the Wiki Metadata (Data Catalog Connector) topic for details on the functionality and setup.

  2. Prior to configuration, clicking the Base URL dropdown parameter displays the required property name. Provide a Base URL selection for the dropdown parameter via the sharedconfig.properties file using the case-sensitive Wiki.WikiUrl property. A protocol (http:// or https://) and an ending slash (/) are mandatory. The following is an example of a property entry for two wikis. 

    Wiki.WikiUrl=1=http://vp487.vps.ohs.ca/,2=https://127.0.0.1:8080/

    If only one URL is required, in the example above, eliminate the ',2=https://127.0.0.1:8080/' text.

    Note: The format for multiple wikis is 1=url1,2=url2,3=url3, where each entry is incremented and unique.

Configuration

For information on a parameter, hover over the parameter field to display help text.

After completing the prerequisite steps, edit the delivery method of the OIEP created during the installation. Use the following steps to configure the OIEP to use the Wiki delivery option.

Important: For the OIEP created automatically upon restarting the server after installing the STEP wiki metadata recipe, most of the following parameters are pre-populated and the default settings should not be changed. Review the parameter details below for more information.

  1. For Select Delivery Method, choose Wiki.

  2. In Base URL, select the URL that points to the wiki that will be used for this STEP system. Refer to the Prerequisites section for information on setup.

  3. In View Path, enter the URL elements between the Base URL and the wiki pages, or main category if defined. This is used for the presentation of wiki pages and allows each user to watch pages they select. The slash at the end is mandatory. As shown in the image above, 'bin/view/' is the view path for the following URL: http://vp487.vps.ohs.ca/bin/view/STEP/attribute/

  4. In Main category, enter a name for the main category path. This allows you to organize the metadata pages and can be multiple levels by adding a slash, '/,' between each one. The slash at the end is mandatory. As shown in the image above, 'STEP/' is the main category for the following URL: http://vp487.vps.ohs.ca/bin/view/STEP/attribute/

  5. In API path, specify the path for the wiki REST API, which is used to make modifications to the wiki pages. The slash at the end is mandatory.

  6. In User name, enter the user with permission to call the REST API and who can make modifications to it.

  7. In Password, enter the password for the user name.

  8. On the Edit Delivery Configuration dialog, click the OK button to save the delivery method.