ANS-0385 · CUSTOM FIELDS, RECORDS & FORMS

How to Implement Custom Help Documentation in NetSuite?

NetSuite offers custom records and Suitelets as flexible solutions for creating detailed, custom help documentation beyond standard field labels.

Short answer

To provide enhanced user guidance in NetSuite, consider using custom records to store help content or developing Suitelets for highly customized help pages. Custom records allow for structured data and file attachments, while Suitelets offer maximum flexibility in design and content presentation.

Scenario

NetSuite users often require more comprehensive help documentation than what standard field labels provide. The need arises for richer content, custom formatting, and the ability to attach supplementary files directly to help resources, improving user understanding and efficiency within the system.

Solution

NetSuite offers two primary methods for implementing custom help documentation:

  1. Custom Records

    • Utilize custom records to store detailed help information. Each custom record can correspond to a specific page or area requiring documentation.
    • Store rich text content within a long text field on the custom record, allowing for formatted information. While inline HTML fields on standard forms are being deprecated, rich text fields offer similar capabilities.
    • Attach relevant files, such as PDFs or Word documents, directly to the custom record for users to download.
    • Implement a button on the target NetSuite page or record that, when clicked, opens the associated custom record, displaying the help content.
  2. Suitelets

    • Develop a Suitelet to serve as a custom help page. This method provides extensive flexibility in design, layout, and dynamic content presentation.
    • Suitelets allow for highly detailed and visually appealing help interfaces, tailored precisely to user needs.
    • Note: External Suitelet URLs have changed as of May 9, 2024. Any hardcoded links to Suitelets must be updated to reflect the new URL structure to ensure continued functionality after an account is upgraded to NetSuite 2024.2.
    • While requiring more development effort, Suitelets offer the most robust solution for complex help documentation requirements.

Expert NetSuite Support

Need help with this NetSuite issue?

Custom Fields, Records & Forms consulting and configuration support

Talk to a consultant