Overview

This guide provides an overview of all available floor plan (page) templates and explains at a high level when a particulate template is used.

Floor Plan Template and Floor Plans

Floor Plan Template

It is a term used to define a type of view or page template

The following templates are currently available:

  • Search Object - List View

  • Search Object - Table View

  • View and Edit Object - Recursive

  • View and Edit Object - List

  • List of Values

Floor Plans

  • A floor plan is an instance of a floor plan template used to describe an actual page and stored in form JSON

  • Each JET page is based on a floor plan, so when a user opens a page, a floor plan is used to render the page.

  • These contain the structure of a UI page which can be further customized as required

  • Along with floor plan, metadata and actual data from a resource are used to render a UI page

  • Floor plans are delivered as part of the application installation

  • For page customization users can make a copy and change it or add a floor plan

Floor Plan Templates Overview

Search Object - List View

This floor plan template applies to search pages which requires the results to be displayed in form of a list. The search page allows user to query on a specific resource defined in the floor plan.

This template is most often used to search relevant items by specifying search, filter and sort criteria and thereby get a status summary of a set of list items (e.g. claims, messages, integrations etc.)

It provides an entry to create a new object or to navigate to the details of a single item to view or update them. It is also possible to delete an item directly from the page using this template.

From this page the user can:

  • go to the edit mode

  • delete the object

  • add, remove or edit details

Few examples of pages that currently use this template are:

  • Enrollment Product Search (Policies)

  • Integration Search (OIG)

For details refer Search Object - List View

Search Object - Table View

This template describes a search page with a table and filter options. This search page is used when:

The expected size of the resource list is large (1000+ results)

Individual objects should be displayed in a separate page

Few attributes are required for the search page (10 or less) and the majority of rows have a value

The result list is composed of operational results without explicit unique keys

Few example pages that currently use this template are:

  • Exchange Search (OIG)

  • Event Search (OIG)

For details refer Search Object - Table View

View and Edit Object - Recursive

This floor plan template can be used to view, edit or create an object (resource) and is typically opened from the result list page. Specific detail objects (sub resources) are often not immediately displayed, and the user has to navigate to a sub page, which also follows the same template definition.

This template is commonly used for large objects

It is also used for objects which support customization using time valid dynamic fields and/or dynamic records

Where tabbed layout is required i.e. giving user capability to view, add or update the sub-resources

Giving user capability to view/edit one record at a time

Few examples of pages that currently use this template are:

  • Dynamic Logic

  • Messages

  • Integrations (OIG)

For details refer View and Edit Object - Recursive

View and Edit Object - List

This floor plan template can be used to view, edit, remove or add an object to an object list. Specific detail objects (sub resource or multi value properties like dynamic records) are not immediately displayed but are available in the overflow area for each record. This search page is used when:

The View and Edit Object - List floor plan is used to provide user with the ability to view, search and edit data on the same page i.e. to provide ability to add and edit multiple objects at the same time

This template is especially designed for handling DML operations on an object list, and can be used for simple entities

Individual objects with all their attributes should be displayed on the same page

Used for objects with limited number of properties

Pages that currently use this template are:

  • Titles

  • Prefixes

  • Currencies

For details refer View and Edit Object - List

Configuring Floor Plans

A customer can change certain aspects of a page or application by changing or updating the floor plans and its properties. These may include:

  • Adding or removing elements from the page including dynamic fields and records

  • Re-ordering the elements on the page or the tabs within the page

  • Updating the search criteria e.g. adding additional search component to the page or expanding existing quick search criteria

  • Updating existing sort or adding additional sort criteria giving user the ability to re-order the results based on a criterion

  • Adding pre-filters to limit the number of search results

  • Loading a different floor plan based on a condition

A floor plan can be configured by using

Floor plan configuration page within the UI

Navigation Path (Policies and OIG JET UI): Configuration → System → Floor plans

This page provides users option to:

  • Create a new floor plan

  • Edit existing user defined floor plans

  • Enable/Disable floor plans

  • Change existing floor plan’s priority

Using the API on the floor plans resource

For customizing a floor plan:

  • Create a copy of existing system floor plan with updated details mentioned in the next section or use an existing user defined floor plan

  • Customize the JSON to update the components within the floor plan, for more details refer Customizing Floor Plan Components page

  • Set the priority and conditions based on the requirements, refer Presentation Configuration page for more details

For creating or updating a floor plan the following properties needs to be defined

  • Code

  • Description

  • Page Name: Use the same as the existing system floor plan

  • Payload: The updated payload containing the JSON structure that describes how the page should be rendered, refer the Customizing Floor Plan Components for detail

  • Context based Condition: The context object condition under which the floor plan is used, add if required

  • Role based Condition: The role condition under which the floor plan is used, add if required

  • Priority: The relative priority when evaluating the floor plan conditions, add a numeric value else the plan will be given least priority

  • For Template and Resource properties use the same values as defined in the system floor plan, using a different value may cause floor plan to not load or default to the system floor plan

For more details on JSON structure and available components for each template type refer the detailed template pages