Dynamically Add Custom Button Using User Event Scripts

A user wants to dynamically add a button in a record using a User Event script.

1. Deploy User Event script that will display the button

   1. Create JavaScript file with the following code:

      /**
       * @NApiVersion 2.x
       * @NScriptType UserEventScript
       * @NModuleScope SameAccount
       */
      define([], function () {‌
          function beforeLoad_addButton(scriptContext) {‌
              var form = scriptContext.form;
      
              form.addButton({‌
                  id : 'custpage_buttonid',
                  label : 'Test',
                  functionName : 'clientButton()'
              });
      
              form.clientScriptFileId = 7018; //internal id of the script file in the file cabinet
          }
          return {‌
              beforeLoad: beforeLoad_addButton
          }
      });

      Copy

   2. Navigate to Customization > Scripting > Scripts > New

   3. Click +

   4. Select File: Click Browse...

   5. Select JavaScript file
      Note: Select JavaScript file created from Step 1.1.

   6. Click Open

   7. Click Create Script Record

   8. Basic Information:

      • Name: Enter Add Button
      • ID: Enter _add_button

   9. Deployments tab:

      • Applies To: Select Employee
      • ID: customdeploy_add_button
      • Status: Select Released

   10. Click Save

2. Upload Client script that serves as the custom button's logic

   1. Create JavaScript file with the following code:

      /**
       * @NApiVersion 2.x
       * @NScriptType ClientScript
       * @NModuleScope SameAccount
       */
      define([], function() {‌
          function pageInit(context) {‌
          }
          function clientButton() {‌
              alert('Called by a Client Script!');
          }
          return {‌
              pageInit: pageInit,
              clientButton: clientButton
          };
      });

      Copy

   2. Navigate to Documents > Files > SuiteScripts

   3. Click Add File

   4. Select JavaScript file
      Note: Select JavaScript file created from Step 2.1.

   5. Click Open