Reference Information for Subject Area Classes

Requirements for a Subject Area Class

To define a subject area, create a class that meets the following requirements:

• It must extend %DeepSee.SubjectAreaOpens in a new tab.

• It must contain an XData block named SubjectArea

• For this XData block, XMLNamespace must be specified as follows:

  XMLNamespace = "http://www.intersystems.com/subjectarea"
  

  

• The root element within the XData block must be <subjectArea> and this element must follow the requirements described in the rest of this page.

• It is useful, but not required, for the class to specify the DependsOn keyword so that this class is compiled only after the cube class is compiled and can be used.

• The class can define the DOMAIN parameter, which specifies the domain to which any localized strings belong. For example:

  Parameter DOMAIN = "PATIENTSAMPLE";

  

  For details, see Performing Localization in Implementing InterSystems Business Intelligence.

For example:

Class BI.Model.SubjectAreas.AsthmaPatients Extends %DeepSee.SubjectArea [DependsOn=Cubes.StudyPatients]
{

/// This XData definition defines the SubjectArea.
XData SubjectArea [ XMLNamespace = "http://www.intersystems.com/deepsee/subjectarea" ]
{
<subjectArea name="AsthmaPatients" 
    displayName="Asthma Patients"
    baseCube="Patients" filterSpec="diagd.h1.diagnoses.asthma" >
    </subjectArea>
}

}

Studio provides assistance as you type.

Common Attributes in a Subject Area

Most of the elements in the subject area have the following attributes, which are listed here for brevity:

<subjectArea>

The <subjectArea> element is the root element in the XData block in a subject area class. This element contains the following items:

Filtering a Subject Area

The filterSpec attribute enables you to specify a filter that applies to the subject area. This attribute must equal a valid MDX set expression. For example:

{AgeD.H1.[10 to 19],AgeD.H1.[20 to 29]}

See Writing Filter Expressions.

Instead of (or in addition to) specifying filterSpec, you can implement the %OnGetFilterSpec callback; see Filtering a Cube or Subject Area Dynamically in Advanced Modeling for InterSystems Business Intelligence.

<measure>

Within a subject area, a <measure> element hides or customizes a measure. This element has the following attributes:

<dimension>

Within a subject area, a <dimension> element hides or customizes a dimension. This element has the following contents:

<hierarchy>

Within a subject area, a <hierarchy> element hides or customizes a hierarchy. This element has the following contents:

<level>

Within a subject area, a <level> element hides or customizes a level. This element has the following contents:

<listing>

Within a subject area, a <listing> element hides, customizes, or adds a listing. This element has the following contents:

<calculatedMember>

Within a subject area, a <calculatedMember> element hides or customizes a calculated member.

<namedSet>

Within a subject area, a <namedSet> element hides or customizes a named set. This element has the following contents: