Custom Documentation
Adding Custom Documentation
To get started:
-
Go to Administration > Edit Reference Tables > Client Help Docs
-
This will bring you to the reference table for client documents.
-
Click ‘Add Record’ on the bottom right-hand corner.
-
This will open a blank Client Help Doc Record.
-
Fill in the following fields.
-
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.
-
Long Description. This field is optional.
-
Document URL. This needs to be a full URL to the document where it is available on the internet.
- 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
- 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:
-
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.
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.
The contexts available are:
Context Description ABS_AUTH_NB Abstract author notebook ABS_DOC_NB Abstract notebook ABS_GRP_LIST Abstract group list ABS_GRP_NB Abstract group notebook ABS_TOP_NB Abstract topic notebook ACC_EXPORT Accounting - export for accounting ACC_INPROG Accounting - view in progress postings ACC_POSTWIZ Accounting - posting wizard ACC_TRIALBAL Accounting - view trial balance ACT_NB Action item notebook APPL_NB Appeal notebook APPLMEM_NB Appeal member notebook APPT_NB Appointment notebook AWD_LIST Award list AWD_NB Award notebook AWD_NOM_NB Award nominee notebook CAM_LIST Marketing and discounts list CAM_NB Marketing campaign notebook CART_CHECKOUT Shopping cart - checkout UI CART_VIEW Shopping cart - view cart UI CERT_NB Certification notebook CERTTYP_LIST Certification type list CERTTYP_NB Certification type notebook CHP_LIST Chapter list CHP_NB Chapter notebook COF_NB Saved payment profile notebook COH_MEM_IMPORT Cohort Member Import UI COH_MEM_NB Cohort Member Notebook COH_NB Cohort Notebook COM_LIST Committee list COM_NB Committee notebook COMP_LIST Company list COMP_NB Company notebook CUSTADDR_NB Address notebook CUSTEDU_NB Education notebook CVPRO CVPro Specific Resource (Pro Tool, etc.) DESIG_NB Designation notebook DISC_NB Discount notebook (discount wizard UI) DOC_NB Document notebook DON_ADD_TO_CART Donation add to cart UI DONTYP_PLEDGE Donation enter pledge UI DUES_TRANS_LIST Dues/sub/don transaction list DUES_TRANS_NB Dues/sub/don transaction notebook EBATCH_LIST Email batch list (email batch manager UI) EBLAST_COM Email blast - email committee members EBLAST_INV Email blast - email invoices EBLAST_REG Email blast - standard EMAILTEMPLATE_LIST Email templates list EMP_LIST Employee list EMP_NB Employee notebook EMPH_NB Employment history notebook EVT_BTH_NB Event booth notebook EVT_CREATE_DUP Event create duplicate UI EVT_CREATE_REG Event create registration UI EVT_FUNC_NB Event function notebook EVT_LIST Event list EVT_NB Event notebook EVT_PRCE_NB Event price notebook EVT_PRCE_NB Event/booth/program price notebook EVT_REG_NB Event registration notebook EVT_TRN_NB Event trainer notebook EVTPKG_LIST Event package list EVTPKG_NB Event package notebook EVTPRG_LIST Event program list EVTPRG_NB Event program notebook GRP_LIST Group List GRP_NB Group Notebook IND_FIND_DUP Find individual duplicates UI IND_LIST Individual list IND_LIST_MERGEDUPS Individual list - merge duplicates UI IND_LIST_REPORTEMAIL Individual list - send report email UI IND_LIST_VERIFYADDR Individual list - verify all addresses UI IND_NB Individual notebook IND_PQ Individual power query INDCOM_NB Committee member notebook INFORMZ_LIST Informz list INFORMZ_NB Informz notebook INV_LIST Invoice list INV_NB Invoice notebook INVADJ_LIST Invoice adjustment list INVADJ_NB Invoice adjustment notebook INVITM_NB Invoice item notebook IOLTA_LIST IOLTA account list IOLTA_NB IOLTA account notebook JOB_POSTING_LIST Job board posting list JOB_POSTING_NB Job board posting notebook JOBOPT_LIST Job board option list JOBOPT_NB Job board option notebook JRNY_LIST Journey list JRNY_NB Journey notebook MCERT_LIST Master certification list MCERT_NB Master certification notebook MEM_DEACT Membership deactivation UI MEM_RENEW Membership renewals UI MEM_TERM Membership termination UI MMC_NB Multicompany membership notebook MMCORG_NB Multicompany org membership notebook OPP_LIST Opportunity overview list OPP_NB Opportunity notebook ORG_FIND_DUP Find organization duplicates UI ORG_LIST Organization list ORG_LIST_MERGEDUPS Organization list - merge duplicates UI ORG_LIST_REPORTEMAIL Organization list - send report email UI ORG_NB Organization notebook ORG_PQ Organization power query PBATCH_LIST Payment batch list PBATCH_NB Payment batch notebook PBATCH_RUNNINGWIN Payment batch - running batch window PGRP_NB Price group notebook PMT_LIST Payment list PMT_LIST_REPORTEMAIL Payment list - send report email UI PMT_NB Payment notebook PRD_CREATE_DUP Product create duplicate UI PRD_LIST Product list PRD_NB Product notebook PUB_ADVORD_LIST Publication advertising order list PUB_ADVORD_NB Publication advertising order notebook PUB_ISS_NB Publication issue notebook PUB_LIST Publication list PUB_NB Publication notebook REL_NB Relationship notebook RELPRD_NB Related product notebook SPKG_NB Event sponsorship package notebook SRV_EXPORT Survey - export response UI SRV_LIST Survey list SRV_NB Survey notebook SRV_RESP Survey - view responses SRV_VIEW Survey - view survey SRVQ_NB Survey question notebook SUBTYP_LIST Dues/sub/don type list SUBTYP_NB Dues/sub/don type notebook TOOLS_SETTINGS Tools menu settings UI UI_ACT_TL Activity timeline UI UI_BUCKET Bucket - view bucket contents UI UI_LOCKBOX Lockbox check import UI_REFTBLS Reference tables admin UI UI_SEARCH_AI Action items search UI UI_TAXONOMY Taxonomy admin UI UI_TOP Top-level CV interface help point USR_LIST Database user list USR_NB Database user notebook
-
-
Click the "Save" button once you've filled out all the fields. The document should be available in the system once you refresh CV.