The GridConfiguration object is located in ATG Service Agent classes and extends the TableConfiguration class by allowing for additional customization using Dojo. The columns are defined in order in an array of ColumnConfiguration components. Refer to the Customization Best Practices section before modifying configuration files.
The properties for GridConfiguration are:
Property | Description |
|---|---|
| The array of |
| The page fragment component that contains the data model (for example, JSON). Include the full Nucleus path to the component. |
| The DOM ID of the form node to submit to retrieve an item detail. |
| The Nucleus path to the form handler that renders the results. |
| The value assigned to the height CSS style for the table to determine its visible height. |
| The JavaScript variable name that should be unique for each instance of the table in the application. |
| The page fragment containing the grid implementation. |
| The Nucleus path to the grid configuration component. |
| The Dojo ID of the table widget that should be unique for each instance of the grid in the application. |
| The file name of image to render when the grid item detail is not visible or closed. |
| The file name of image to render when the grid item detail is visible or open. |
| The URL path to the images. |
| The page fragment component containing the item details (currently implemented as a hover pop-up). |
| The base of the paging: |
| The element name of the page index form input. |
| The optional ID for a DOM node to render status messages, such as ‘search in progress...’ or ‘No results found.’ etc. |
| The size of the result to send back from the form handler in each page. |
| The DOM ID of the form node to submit to retrieve orders. |
| An anchor tag template with pattern replacement for selecting the item in the application. |
| An anchor tag template with pattern replacement for viewing the item in the application. |
The following is an example of the /atg/svc/agent/ui/tables/tables/ticket/ file, which uses the
CustomerTicketGrid.propertiesGridConfiguration class:
$class=atg.svc.agent.ui.tables.GridConfiguration columns=\ /atg/svc/agent/ui/tables/ticket/ViewLink,\ /atg/svc/agent/ui/tables/ticket/Description,\ /atg/svc/agent/ui/tables/ticket/CreatedDate,\ /atg/svc/agent/ui/tables/ticket/Age,\ /atg/svc/agent/ui/tables/ticket/Status,\ /atg/svc/agent/ui/tables/ticket/Id,\ /atg/svc/agent/ui/tables/ticket/SelectLink rowsPerPage=10 gridHeight=450px gridInstanceId=atg.svc.agent.ticket.historyGridInstance gridPath=/atg/svc/agent/ui/tables/ticket/CustomerTicketGrid gridWidgetId=atg_svc_agent_ticket_historyTable progressNodeId=atg_svc_agent_ticket_historyGridStatus searchFormId=ticketHistoryListForm dataModelPage=/atg/svc/agent/ui/tables/ticket/TicketDataPage gridPage=/atg/svc/agent/ui/tables/ticket/TicketGridPage
Each of the columns is configured using a property file, which identifies column properties. For example, the ViewLink.properties file that is referenced in the CustomerTicketGrid file:
$class=atg.svc.agent.ui.tables.ColumnConfiguration defaultSort=ascending field=viewLink sortField=id width=6em resourceBundle=atg.svc.agent.ui.UserMessages resourceKey=view-ticket isVisible=true dataRendererPage=/atg/svc/agent/ui/tables/ticket/ColumnRendererPage
These configuration files allow you to make specific changes to individual columns within the grid.
