Type Alias Dashboard

Dashboard: Now.Internal.WithID<
    {
        active?: boolean;
        name: string;
        permissions?: DashboardPermission[];
        tabs?: DashboardTab[];
        topLayout?: DashboardTopLayout;
        visibilities?: DashboardVisibility[];
    },
> & Now.Internal.Meta

Creates a Dashboard (par_dashboard).

See

https://docs.servicenow.com/csh?topicname=dashboard-api-now-ts.html&version=latest

Param: config

an object containing the following properties:

$id - unique id for the record, typically using Now.ID["value"]
name - The name of the dashboard
tabs - Array of dashboard tabs (each with $id, name, and widgets array)
visibilities - Array of visibility rules (each with $id, type, and value)
permissions - Array of user permissions (each with $id, user, can_read, can_write, can_share, owner)

Example

Dashboard({
  $id: Now.ID['my-dashboard'],
  name: 'My Dashboard',
  tabs: [
    {
      $id: Now.ID['tab-1'],
      name: 'Overview',
      widgets: [
        {
          $id: Now.ID['widget-1'],
          component: 'component-id',
          componentProps: { key: 'value' },
          height: 12,
          width: 12,
          position: {
             x: 0,
             y: 0,
         }
        },
      ],
    },
  ],
  permissions: [
    {
      $id: Now.ID['perm-1'],
      user: 'user-sys-id',
      canRead: true,
      canWrite: true,
      canShare: true,
      owner: true,
    },
  ],
  visibilities: [],
})

Type Alias Dashboard

See

Param: config

Example

Settings