Skip to content

Custom Documentation

Adding Custom Documentation

To get started:

  1. Go to Administration > Edit Reference Tables > Client Help Docs

    Integrated Docs Image

  2. This will bring you to the reference table for client documents.

  3. Click ‘Add Record’ on the bottom right-hand corner.

  4. This will open a blank Client Help Doc Record.

    Integrated Docs Image

  5. Fill in the following fields.

    1. Title and Short Description. Should make the document clearly recognizable and explained in the help system. When you search to filter all available docs, it filters on title, short and long descriptions so definitely include relevant keywords.  Any client documents will automatically receive the star icon next to their name so that they stand out that way as well.

    2. Long Description. This field is optional.

    3. Document URL. This needs to be a full URL to the document where it is available on the internet. 

      1. There are a few options for this – if you use Google Drive or Dropbox, you might have you documents there, in which case you should be able to embed them easily by grabbing the share links. If you want to host the documents in CV, you should potentially create a record in the system that can have docs attached (like a product or maybe your record) and just attach all your help files there and make them available in the system by linking to the document preview like this: 
        https://{your organization’s domain}/office/cgi-bin/documentdll.dll/view?DOCUMENTNUM=607

  6. Placement Context List. List out all the help points that docs can be attached to, (instructions on how to locate the helps points document is listed below). You will need to put the value in this field that is a comma-separated list of help point IDs with no spaces. If you don’t put any contexts, it will still be findable in the document browser, but it just won’t show up from any help contexts.

    1. For example, if you upload a custom document related to awards, you might want to attach it to these interfaces (UI_TOP will be at the top-level point):

      UI_TOP,AWD_NB,AWD_LST

  7. Help Points Document. To navigate to the help points reference list:

    1. Click the CV Help Guides button on the top left corner of CVO.

    Integrated Docs Image

    1. Select the Search All Help Resources button on the bottom left-hand corner of the window.

    2. Search ‘Custom Documentation Help Points Reference.’

    3. Click on the guide to open it in a new browser.

  8. Click the blue Save button once you’ve filled out all the fields. The document should be available in the system once you refresh CVO.