Cireson Portal

Custom Grids

Overview

With the OData Table Widget, Administrators have the ability to create their own versions of the My Request, Team Requests, My Work, Team Work, and Active Work grids.

This enables you to create grids that feature information such as the Affected User's Department, a Work Item's File Attachment Counts or even your own class extensions. To construct a new grid, add an OData Table widget to a new or existing Dashboard Page. Then using the Query String field, you can expand relationships as you see fit:

OData Endpoint: /platform/api/

Choose Collection: My Request, Team Requests, My Work, Team Work, or Active Work

Query String: Depending on the endpoint collection you choose, certain options are made available to you such as showing only Active Work Items, Activities, and Inactive Work Items.

 

Query String Details

A comprehensive list of options is seen below:

MyRequest:

  • ?show=active
  • ?show=closed

TeamRequest:

  • ?show=active

MyWork:

  • ?show=workitem
  • ?show=workitem&showinactive=true
  • ?show=workitemwithactivities&showinactive=false
  • ?show=workitemwithactivities&showinactive=true
  • ?show=approval&showinactive=false
  • ?show=approval&showinactive=true
  • ?show=activities&showinactive=false
  • ?show=activities&showinactive=true
  • ?show=manual&showinactive=false
  • ?show=manual&showinactive=true

TeamWork:

  • ?show=workitem
  • ?show=activities&showinactive=false
  • ?show=workitem&showinactive=true
  • ?show=activities&showinactive=true

ActiveWork:

  • ?show=workitem
  • ?show=workitem&showinactive=true
  • ?show=activities&showinactive=false
  • ?show=workitemwithactivities&showinactive=true

 

Once you've defined the type of Work Items you wish to return, paste this into the Query String field.

 

Related Objects

To reveal details about related objects such as the Affected, Assigned, or Created By User you can append values to the query string.

 

To view relationships such as the Affected User's Department, use the first query string listed below. Others have been provided as relevant data you may choose to use.

  • ?expand=System_WorkItemAffectedUser
  • ?expand=System_WorkItemCreatedByUser
  • ?expand=System_WorkItem_TroubleTicketResolvedByUser
  • ?expand=System_WorkItemAssignedToUser
  • ?expand=System_WorkItemRequestedByUser

 

You can even use multiple expands together with the & character. Take the following example where the Affected User, Assigned To User, and Created By User are all used in conjuction with displaying Work Items with Activities including Inactive ones:

  • ?expand=System_WorkItemAffectedUser&show=workitemwithactivities&showinactive=true
  • ?expand=System_WorkItemAffectedUser&expand=System_WorkItemAssignedToUser&expand=System_WorkItemCreatedByUser

 

Once you've defined the relationships you wish to expand, you can now add those columns ending in "_Details" by typing them into the columns you wish to show. 

E.g.

  • System_WorkItemAffectedUser_Details.Department
  • System_WorkItemCreatedByUser_Details.Domain
  • System_WorkItem_TroubleTicketResolvedByUser_Details.Title
  • System_WorkItemAssignedToUser_Details.Username
  • System_WorkItemRequestedByUser_Details.FQDN

 

 

Examples:

 

If you wish to rename a column, you can do that by navigating back into the Widget configuration and entering a Column Translation: