External Component

Overview

Inserts one or more components from an external file. This is useful for reusing components that are the same across many reports.

The external file must include an array of components and use the .cmp.json file extension. To render a report with external components, each component file must be included in the report resources.

Schema

key	type	required	description
type	string	required	A string defining the component type as a External.
filename	string	required	A string that includes the name of the rpt file that contains the external component. The rendered report will insert all components defined in the components array of the rpt file.
condition	Conditional	optional	The component will not be rendered in the report if a condition is present and it evaluates to false. For more information on conditions, see Conditionals.

Example

An example of an External Component:

{
    "type": "External",
    "filename": "common-components.cmp.json"
}