Table of Contents

Search

  1. Preface
  2. Using the Designer
  3. Working with Sources
  4. Working with Flat Files
  5. Working with Targets
  6. Mappings
  7. Mapplets
  8. Mapping Parameters and Variables
  9. Working with User-Defined Functions
  10. Using the Debugger
  11. Viewing Data Lineage
  12. Comparing Objects
  13. Managing Business Components
  14. Creating Cubes and Dimensions
  15. Using the Mapping Wizards
  16. Datatype Reference
  17. Configure the Web Browser

Creating Links to Documentation Files

Creating Links to Documentation Files

You can create links in repository objects to documentation files. Click these links in the Properties or Edit dialog box of each object to view the business documentation.
The links must be a valid URL or file path to reference a business document. Use either of the following formats:
  • Root variable.
    Use the string “file://$docroot” to refer to the documentation root you have specified in the documentation path field.
    For example, if a document root is http://internal.company.com/doc, the Designer points to http://internal.company.com/doc/finance/vendors_help.html, but displays file://$docroot as part of the link.
  • Complete file path or link.
    Precede the file path with ://, such as file://c:\doc\help\ or http://internal.company.com/doc/help/. A file path must be preceded by file:// to be valid.
To create a link, edit the properties of the object. How you do this depends on the type of object you want to document.
The following table summarizes how to create a link for repository objects:
Repository Object
How to Create Documentation Links
Table/Transformation
  • Double-click the table/transformation in the workspace to open it.
  • Enter the documentation link in the Description window.
Mapping/Mapplet
  • Open the mapping/mapplet in the workspace.
  • Click Mappings > Edit or Mapplets > Edit.
  • Enter the documentation link in the comment field.
Business Component Directory
  • Select the business component directory in the Navigator.
  • Click Repository > Business Component > Edit Properties.
  • Enter the documentation link in the comment field.
To add comments to individual business components, edit the properties of the original object it references.


Updated July 02, 2020