Layouts

Description

The Layouts module allows you to manage the layout of reports, create and design the report layout in the Layout Designer.

Module Interface

Interface Description Required Privilege
Layouts Allows access to Layouts page. mod-layout
Layout Designer Allows access to Layout Designer page. mod-layout-designer

Add

This function allows you to add a new layout.

To add a new layout, click on the “Add” button at the upper right corner of the page. The “Add Layout” dialog box will appear.

Key in an unique name for the new layout in the “Name” field. In the “Copy From” field, you can select either a blank layout or copy from an existing layout from the drop-down list. Click on the “OK” button to add the new layout. Click on the “Cancel” button to abort the action. If the name of the layout already exist, an error message will appear.

Once the new layout has been added, the Layout Designer page will appear.

Refer to Layout Designer for more details.

Refresh

After performing actions on the browser/tab, the list is reloaded to display the list of layouts. The manual “Refresh” button is available and is particularly useful if there are others making changes on the same page.

The “Refresh” button is found on the upper right corner of the page. Clicking on it reloads the list.

Upload

This function allows you to upload an existing layout onto the Layouts page.

To upload a layout, click on the “Upload” button at the upper right corner of the page.

The “Upload Layout” dialog box will appear.

Browse to the location of the layout to be uploaded. The “Name” field uses the filename of the file selected by default. You can change the name as desired, then click on the “OK” button to upload the layout. If the layout already exist, an error message will appear.

If the layout to be uploaded is to overwrite an existing layout, select the “Overwrite” field before clicking on the “OK” button.

Once the layout is uploaded successfully, a notification will appear.

Edit

This function allows you to edit the properties of the layout, such as name of the layout, the roles that can access the layout and to enable or disable the layout.

To edit a layout, click on the “Edit” icon under the “Actions” column corresponding the desired layout.

The “Edit” panel will appear.

In the “Properties” section, you can change the name of the layout. The name must be unique or an error message will appear. You can also enable or disable the layout be selecting or de-selecting the “Enabled” field.

In the “Roles” section, select the desired roles by selecting the checkboxes in the section to allow them to access the layout. Alternatively, you can search for the role by using the search function at the top of the section. There are options to select all, select none and invert selection by clicking on the respective icons next to the search function.

To save the changes, click on the “OK” button on the upper right corner of the panel. To abort the action, click on the “Cancel” button.

Open Layout Designer

The Layout Designer allows you to edit existing layout.

To open the Layout Designer, click on the “Open” icon under the “Actions” column corresponding the desired layout.

The “Layout Designer” page will appear.

Refer to Layout Designer for more details.

Download

To download the layout, click on the “Download” icon under the “Actions” column corresponding to the desired layout.

The downloaded layout has the following filename format <filename>.layout.json.

Delete

This function allows you to delete a layout from the Layouts page.

To do so, click on the “Delete” icon under the “Actions” column corresponding the desired layout.

There is an option to undo the deletion. A notification with an “Undo” button appears right after clicking on the “Delete” icon.

Upon clicking on the “Undo” button, the deleted layout is restored and is added back to the list of layouts. Do note that the notification will disappear after five seconds.

Search

There is a cross-field search function for the list of layouts. It is located at the upper left corner of the page.

This provides an easy way to search through the report layouts. It is case-insensitive and displays files that have the entered search value in any of the values of the fields below:

  • Name
  • Owner
  • Roles