Product documentation Docs
    • English
    • Deutsch
    • 日本語
    • 한국어
    • Français
  • More Sites
    • Now Community
    • Developer Site
    • Knowledge Base
    • Product Information
    • ServiceNow.com
    • Training
    • Customer Success Center
    • ServiceNow Support Videos
  • Log in

Product documentation

  • Home
How search works:
  • Punctuation and capital letters are ignored
  • Special characters like underscores (_) are removed
  • Known synonyms are applied
  • The most relevant topics (based on weighting and matching to search terms) are listed first in search results
Topics are ranked in search results by how closely they match your search terms
  • A match on the entire phrase you typed
  • A match on part of the phrase you typed
  • A match on ALL of the terms in the phrase you typed
  • A match on ANY of the terms in the phrase you typed

Note: Matches in titles are always highly ranked.

  • Release version
    Table of Contents
    • Now Platform capabilities
Table of Contents
Choose your release version
    Home New York Now Platform Capabilities Now Platform capabilities Agent Workspace Agent Workspace administrator configuration Declarative Actions in Agent Workspace Assign a Declarative Action in Agent Workspace

    Assign a Declarative Action in Agent Workspace

    • Save as PDF Selected topic Topic & subtopics All topics in contents
    • Unsubscribe Log in to subscribe to topics and get notified when content changes.
    • Share this page

    Assign a Declarative Action in Agent Workspace

    Associate a defined Declarative Action to a form, list, or field in Agent Workspace to add custom functionality to your workspace.

    Before you begin

    Role required: admin

    Procedure

    1. Navigate to Declarative Action > Action Assignment.
    2. Click New.
    3. On the form, fill in the fields.
      Table 1. Assign a Declarative Action form
      Field Description
      Action Name Unique name for your action.
      Action Label Action label that displays on the form when a user hovers over the field. For field decorators, the label serves as the tooltip. For list and form buttons, the label serves as the text for the button.
      Note: You can add syntax {{}} for an unknown value to evaluate at runtime. Example: {{count}}.
      Action Option that you can select for an available action from the action definition table.
      Action Model Action model to designate where your action appears.
      • Field: The action appears as a decorator next to a field.
      • Form: Where on a form (contextual sidebar, related item) that the action renders.
      • List: The action only appears in the header of a the list.
      • Related List: The action only appears in the header of the list.
      Model Fields required Fields that are required to display.
      Description Summary of the action assignment.
      Tooltip Text that displays when a user hovers over the field name. If a user leaves this blank, the Action Label text appears.
      Note: You can add syntax {{}} for an unknown value to evaluate at runtime. Example: {{count}}.
      Form position For the form action model, select either Contextual Side Bar or Related List.
      Table Table that you can select with the form action model.
      View UI view that you want to associate with the action assignment.
      Application Application that the action runs in.
      Workspace Workspace that the action runs in.
      Active Option that you can select. You can use this assignment if you also use Enabled.
      Note: If theActiveoption is not available, the system falls back to the parent's table declarative action, if applicable.
      Enabled Option that you can select. If you do not select the Enabled option, the assignment is not available and does not render.
      Note: Selecting the Active option does not override this setting to make the assignment available.
      Order Order that applies if multiple actions are selected per model.
      Icon Icon that is used on the field action.
    4. Depending on the action assignment, you need to fill in the fields for a related list:
      • Action Attributes
      • Server Conditions
      • Server Script
      • Client Conditions
      On the form, fill in the fields.
      Table 2. Action Assignment Related Lists form
      Related List Field Description
      Action Attributes Action Payload Payload that you define to dispatch to an internal event when an action triggers. For example: {"table":"{{table}}","row":{"sys_id":{"value":"-1"}},"parent_table":"{{parentTable}}","additional_data":{"query":"{{query}}"}}
      Server Conditions Record Conditions Condition builder that you use to add conditions that must be met before the action displays.
      Note: You can add syntax {{}} for an unknown value to evaluate at runtime. Example: {{count}}.
      Server Conditions Script Condition Script that you add conditions that must be met before the action displays.
      Server Conditions Required Roles Role and access that you assign to view the action. Roles can require:
      • Create access
      • Delete access
      • Read access
      • Write access
      Server Script Server Script Script to execute when an action triggers. The server script uses the same environment and variables as a UI action server script.
      Client Conditions Client Conditions on Fields Field or fields to add conditions.

    Tags:

    Feedback
    On this page

    Previous topic

    Next topic

    • Contact Us
    • Careers
    • Terms of Use
    • Privacy Statement
    • Sitemap
    • © ServiceNow. All rights reserved.

    Release version
    Choose your release version

      Assign a Declarative Action in Agent Workspace

      • Save as PDF Selected topic Topic & subtopics All topics in contents
      • Unsubscribe Log in to subscribe to topics and get notified when content changes.
      • Share this page

      Assign a Declarative Action in Agent Workspace

      Associate a defined Declarative Action to a form, list, or field in Agent Workspace to add custom functionality to your workspace.

      Before you begin

      Role required: admin

      Procedure

      1. Navigate to Declarative Action > Action Assignment.
      2. Click New.
      3. On the form, fill in the fields.
        Table 1. Assign a Declarative Action form
        Field Description
        Action Name Unique name for your action.
        Action Label Action label that displays on the form when a user hovers over the field. For field decorators, the label serves as the tooltip. For list and form buttons, the label serves as the text for the button.
        Note: You can add syntax {{}} for an unknown value to evaluate at runtime. Example: {{count}}.
        Action Option that you can select for an available action from the action definition table.
        Action Model Action model to designate where your action appears.
        • Field: The action appears as a decorator next to a field.
        • Form: Where on a form (contextual sidebar, related item) that the action renders.
        • List: The action only appears in the header of a the list.
        • Related List: The action only appears in the header of the list.
        Model Fields required Fields that are required to display.
        Description Summary of the action assignment.
        Tooltip Text that displays when a user hovers over the field name. If a user leaves this blank, the Action Label text appears.
        Note: You can add syntax {{}} for an unknown value to evaluate at runtime. Example: {{count}}.
        Form position For the form action model, select either Contextual Side Bar or Related List.
        Table Table that you can select with the form action model.
        View UI view that you want to associate with the action assignment.
        Application Application that the action runs in.
        Workspace Workspace that the action runs in.
        Active Option that you can select. You can use this assignment if you also use Enabled.
        Note: If theActiveoption is not available, the system falls back to the parent's table declarative action, if applicable.
        Enabled Option that you can select. If you do not select the Enabled option, the assignment is not available and does not render.
        Note: Selecting the Active option does not override this setting to make the assignment available.
        Order Order that applies if multiple actions are selected per model.
        Icon Icon that is used on the field action.
      4. Depending on the action assignment, you need to fill in the fields for a related list:
        • Action Attributes
        • Server Conditions
        • Server Script
        • Client Conditions
        On the form, fill in the fields.
        Table 2. Action Assignment Related Lists form
        Related List Field Description
        Action Attributes Action Payload Payload that you define to dispatch to an internal event when an action triggers. For example: {"table":"{{table}}","row":{"sys_id":{"value":"-1"}},"parent_table":"{{parentTable}}","additional_data":{"query":"{{query}}"}}
        Server Conditions Record Conditions Condition builder that you use to add conditions that must be met before the action displays.
        Note: You can add syntax {{}} for an unknown value to evaluate at runtime. Example: {{count}}.
        Server Conditions Script Condition Script that you add conditions that must be met before the action displays.
        Server Conditions Required Roles Role and access that you assign to view the action. Roles can require:
        • Create access
        • Delete access
        • Read access
        • Write access
        Server Script Server Script Script to execute when an action triggers. The server script uses the same environment and variables as a UI action server script.
        Client Conditions Client Conditions on Fields Field or fields to add conditions.

      Tags:

      Feedback

          Share this page

          Got it! Feel free to add a comment
          To share your product suggestions, visit the Idea Portal.
          Please let us know how to improve this content

          Check any that apply

          To share your product suggestions, visit the Idea Portal.
          Confirm

          We were unable to find "Coaching" in Jakarta. Would you like to search instead?

          No Yes
          • Contact Us
          • Careers
          • Terms of Use
          • Privacy Statement
          • Sitemap
          • © ServiceNow. All rights reserved.

          Subscribe Subscribed Unsubscribe Last updated: Tags: January February March April May June July August September October November December No Results Found Versions Search preferences successfully updated My release version successfully updated My release version successfully deleted An error has occurred. Please try again later. You have been unsubscribed from all topics. You are now subscribed to and will receive notifications if any changes are made to this page. You have been unsubscribed from this content Thank you for your feedback. Form temporarily unavailable. Please try again or contact  docfeedback@servicenow.com  to submit your comments. The topic you requested does not exist in the release. You were redirected to a related topic instead. The available release versions for this topic are listed There is no specific version for this documentation. Explore products Click to go to the page. Release notes and upgrades Click to open the dropdown menu. Delete Remove No selected version Reset This field is required You are already subscribed to this topic Attach screenshot The file you uploaded exceeds the allowed file size of 20MB. Please try again with a smaller file. Please complete the reCAPTCHA step to attach a screenshot
          Log in to personalize your search results and subscribe to topics
          No, thanks Login