Custom Help Documentation

Not sure if this is the right place for this, but I'm trying to figure out how to have our process documentation show up in the help screen when you press "F1".  I've added it to the TR_Help_Document_Custom table and the Help_Link_Custom table, but can't seem to make it work.

Any tips?

Thanks!

Parents
  • Former Member
    Former Member $organization

    We're a RAMP client and not sure if we can make this work.  Our documents are on a sharepoint site,  I had the same problem you did as far as my test link showing up, but I just had to exit and re-login to Tess after adding my rows to TR_Help_Document_Custom table and the Help_Link_Custom.  I can see the link in the F1 help, and I can click it, but it then throws a "this is an unsafe site" message, and when I click through that, it tells me that internet links are blocked.

    Was wondering if you ever got this working, and whether or not you are a Ramp client.

  • We're not a RAMP client, so I'm not sure how that would play into it, but I wonder if there is something in your defaults that is blocking that sort of link?

  • Former Member
    Former Member $organization in reply to Brandi Cline

    Thanks Brandi.  I'll dig into it a bit more when I get time and I'll likely need to talk to someone at Tess.  It's a great feature so I'm hoping we can get it working.

  • We are looking to move to a Sharepoint site soon, so I would certainly be curious to hear the results of your investigation.

  • Hi Brandi, 

    I recently had to add some myself, this worked for me.

    • Check that the path listed in HELP_DOCUMENT_CUSTOM_PATH (where your documents are saved) in T_Defaults is accessible to the application e.g
      • T:\Software\Tessitura_Live\Documentation_Local....We saved our local documentation here as the rest of the application components lived here so it was accessible... :-).
    • Confirm your document name etc is correct in TR_HELP_DOCUMENT_CUSTOM ....E.G
      • Description - DES 1 - Creating a Customer Record 
      • Document type - Other
      • Document Name - \DES\DES 1 - Creating a Customer Record.pdf
      • Leave absolute path unchecked and it will concatenate the path for you using the custom path entry from T_defaults and the rest of the document name e.g 
        • T:\Software\Tessitura_Live\Documentation_Local\DES\DES 1 - Creating a Customer Record.pdf
      • If you are using a URL - create the document as Document_Type HTML, Tick absolute path and then enter a fully accessible URL link.
    • In TR_Help_link_custom add a new entry to allow the document entry from TR_HELP_DOCUMENT_CUSTOM to show up in a keyword search from the F1 help menu e.g
      • Help Keyword No - (all keywords)
      • Doc No - DES 1 - Creating a Customer Record  (populated from the description entered in TR_HELP_DOCUMENT_CUSTOM )
    • Make sure that all documents are accessible for application. If the document link is a URL, ensure that it can be reached from all computers using Tessitura on your network - i.e if they can not navigate to the url from their local browser they can not get to it from within Tess.

    To test if this worked you may also need to close the application and reopen it or try "Clear Defaults Cache" from Debug tools under the main Help Menu.

    Fingers crossed this helps you troubleshoot.

    Thanks

    Louise

  • Louise,

    This was very helpful! 

    Thank you,

    Ashley

Reply Children
No Data