Sheet Component

In the Lightning Experience environment, you can use the "Sheet component", which allows you to place your created sheet as a screen component in a page. This makes it possible to use the interface for viewing and editing records in Mashmatrix Sheet on the home screen or record detail page.

Placing Sheet Components in Lightning Page

To place a Sheet component in a Lightning page, follow the steps below.

1. Check and note down the book ID and/or sheet ID from the settings of the book or sheet you want to place in the page.

2. Go to the Lightning Application Builder and open the page where you want to place the Sheet component.

3. Find "Mashmatrix Sheet" in the component list on the left side of the screen, and drag and drop the component onto the area of the page.

4. With the dropped component selected, enter the ID you wrote down earlier as "Book ID" in the property settings on the right.

5. If you want to display only a specific sheet in the book, enter the sheet ID you just noted as "Sheet ID".

6. If you want to specify the height of the component, enter the height in "Height" field.

7. If necessary, enter a title for the component header in "Title".

Sheet Component Properties

• Title - Set the title to display on the Sheet component. If no title is set, only the specified book/sheet content will be displayed.

• Book ID - Set the ID of the book to display as a component.

• Sheet ID - Specify the ID of the sheet to display. If omitted, the entire book will be displayed.

• Record ID - Specify the ID of the record that serves as the context (can only be entered when placed on an Experience Cloud site)

• Height - Specify the height of the component. The Height field accepts number with unit, which is the format used in CSS. Supported units are px, em, rem, %, vh, and vw. If the unit is omitted, it will be treated as px (pixels).

• Publish Events - Check this when developing/using components that integrate with events generated from this component using Message Channel API or dynamic interaction.

• Component ID - Specify an arbitrary string to identify the component. This can be used to identify the event source in Message Channel API, etc.

• Parameters - Specify parameter name and value pairs passed to the component in URL query parameter format (e.g., param1=value1&param2=value2). The specified parameter values can be referenced from column filters as filter reference values.

Filter Settings for the Sheet Placed in a Record Page

When placing a Sheet component on a record page, in order to ensure that only items related to the record are displayed in the sheet, the sheet to be placed must be properly filtered beforehand.

To set up a filter so that only items related to the record are displayed, follow the steps below.

1. Add a column to the sheet with a reference ID field that refers to the object of the record page.

2. Select "Filter" from the column menu of the column added in 1).

3. In the Filter Settings dialog, click the "Select Reference Value" button to the right of the filter value input box to display the Select Reference Value dialog.

4. Select "Context Record ID" as the reference type from the dialog, and apply the filter.

5. If necessary, set the column added in 1) to be hidden.

For example, if you want to place an Opportunity sheet on the customer record page, add a "Account ID" field as a column to the Opportunity sheet. Select "Context Record ID" as the reference value in the filter settings of the added "Account ID" column.

Auto-Association Setting for New Records

When creating new records in the Sheet component placed in the record page, the ID of the currently displayed record will be automatically set to the new records if both of the following are satisfied.

1. The reference ID field in the column where the filter is set is a field that directly belongs to the primary object displayed in the sheet.

   • For example, when a sheet that lists Cases is displayed on the Account record page, a filter on the "Account ID" field will be applied, but filters on the "Account > Account ID" field or the "Parent Case > Account ID" field will not be applied.

2. The reference ID field in the column where the filter is set is editable.

Legacy Sheet Component

In addition to the current "Mashmatrix Sheet" component, the Sheet component from before Release 34.0 is available in the component list as "Mashmatrix Sheet (Legacy)". This legacy Sheet component uses Lightning Aura technology in some parts and had limitations for use in the latest Lightning platform.

The new Sheet component has the following features compared to the legacy Sheet component.

	New Sheet Component	Legacy Sheet Component
Implementation Technology	Lightning Web Component	Lightning Web Component + Lightning Aura Component
Use in Experience Cloud	LWR Site + Aura Site	Aura Site Only
Dynamic Interaction	Supported	None
Parameter Specification	Supported	None

For pages that have been using Sheet components from before Release 34.0, "Mashmatrix Sheet (Legacy)" will continue to be used unless the page is edited and modified. Operational support for legacy Sheet components will continue, but new features added in the future may only be added to new Sheet components. When adding new pages, please use the new Sheet component.