2022 April Release

Customization Point FSCVENVUI@1.1001:CPMindbreezeFacetDefinitions Permanent link for this heading

Defines a list of facets that should be requested in Mindbreeze search queries.
The customization point is evaluated on the current object the user navigates to on the client.
When defining this customization point the optional keys may be null, therefore a special evaluation mechanism is required. Instead of direct evaluation of the customization point, the action EvaluateCPMindbreezeFacetDefinitions is used.
Examples:
customize CPMindbreezeFacetDefinitions<Folder, null, null> {
  facetdefinitiondicts = expression {
    dictionary[] facetdefinitions = [
      {
        id:"mes:date",
        inputtype:MindbreezeFacetInputType(MBFIT_DISABLED),
        showalways:true
      },
      {
        id:"objclass",
        name:"Type",
        inputtype:MindbreezeFacetInputType(MBFIT_TEXT),
        showalways":true
      },
      {
        id:"objteamroom",
        name:"Contained in Teamroom",
        inputtype:MindbreezeFacetInputType(MBFIT_TEXT),
        defaultopen:false,
        showalways:true
      }
    ];
    facetdefinitions;
  }
}
or
customize CPMindbreezeFacetDefinitions<Folder, null, null> {
  facetdefinitiondicts = expression {
    dictionary[] facetdefinitions = [
      {
        id:"mes:date",
        name:"Select the date",
        inputtype:MindbreezeFacetInputType(MBFIT_DISABLED),
        showalways:true
      },
      {
        id:"objclass",
        name:"Type",
        inputtype:MindbreezeFacetInputType(MBFIT_DISABLED),
        showalways:true
      }
    ];
    facetdefinitions;
  }
}

dictionary[] FSCVENVUI@1.1001:CPMindbreezeFacetDefinitions(
  key ObjectClass objclass,
  key optional ObjectClass roomclass,
  out retval dictionary[] facetdefinitiondicts)

Name

Description

objclass

Customization point applies if the current object belongs to this class.

roomclass

Customization point applies if the current object belongs to a room of this type.

facetdefinitiondicts

Dictionary list containing dictionaries for each facet definition.
Each facet definition dictionary has entries with following keys:
  • id: The name of the property in the Mindbreeze index. This name is either defined in fscmbextref of the Mindbreeze configuration or the simple attribute reference (see interface action CooObject::GetSimpleReference) prefixed with "_". For example, the simple reference of objcategory is _COOTC_1_1001_objcategory.
  • name: The optional name to display for the facet.
  • search: Obsolete. True or false, whether custom facet values can be entered in the UI (clients will handle default as true).
    Replaced by inputtype. Has no effect if inputtype is set.
  • inputtype: Specifies the input type for custom facet values, see MindbreezeFacetInputType.
    Replaces search.
    Note: Currently clients support only MBFIT_DISABLED and MBFIT_TEXT.
  • defaultopen: True or false, whether a collapsible facet is initially open (clients will handle default as true).
  • showalways: True or false, whether the facet is always shown,
    even if Mindbreeze does not provide values for the facet (clients will handle default as false).
  • showondemand: True or false, whether the facet is only shown when the user adds the facet,
    meaning the client will not automatically show the facet even if Mindbreeze provides values (clients will handle default as false)
    Has no effect if showalways is true.

Additional Information