1. SuiteCloud Platform
  2. SuiteScript
  3. SuiteScript 2.x
  4. SuiteScript 2.x Script Types
  5. SuiteScript 2.x Portlet Script Type
  6. SuiteScript 2.x Portlet Script Reference
  7. Creating and Deploying a Portlet Script

Creating and Deploying a Portlet Script

The following is a basic process flow for creating and deploying a portlet script, including a Dashboard SuiteApp portlet script:

  1. Create a portlet script and upload the file to your File Cabinet.

    For more information about this process, see SuiteScript 2.x Script Creation Process.

  2. Create a script record for your portlet script, and ensure that the Portlet Type field is set to the correct portlet type used in your script.

    For more information about this process, see Creating a Script Record.

  3. Create a script deployment record for your portlet script.

    If you are creating a script to be used for a SuiteApp portlet, check the Dashboard SuiteApp box. This option will let you access the portlet from the SuiteApp tab of Personalize Dashboard.

    Note:

    After you have saved the script, you will not be able to clear the Dashboard SuiteApp box and make the portlet accessible from the Standard Content tab.

    When you check the Dashboard SuiteApp box you can upload an image to the File Cabinet that represents the SuiteApp icon shown for the portlet in the Personalize Dashboard window. Note that only SVG images are supported for the icon. SVG is a vector format, so it assures perfect image scalability. For more information about icon guidelines, see Guidelines for Creating a Dashboard SuiteApp Icon.

    The following image indicates where the Dashboard fields are located:

    Script deployment record for a porlet with Dashboard SuiteApp and Icon highlighted.

    For more information about the script deployment process, see Methods of Deploying a Script.

Related Topics

General Notices