cspace-config Group

Owned by Adaptavist ScriptRunner for Confluence Cloud
Nov 04, 2020
2 min read

What is a Group

repeats are used in creation of the UISPEC.
They connect the service layer definitions with the ui definitions of items and they also help in the creation of the uispec and uischema

Where are Groups

Groups are Repeats that don't repeat
Groups are part of the record element of the cspace-config

Structure of Groups


<group id="account">
     <selector>.csc-accountrole-account-row:</selector>
     <field id="accountId">
           <selector>.csc-accountrole-account-accountid</selector>
     </field>
     <field id="screenName">
           <selector>.csc-accountrole-account-screenname</selector>
     </field>
     <field id="userId">
     <selector>.csc-accountrole-account-userid</selector>
     </field>
</group>

Groups

attributes

MUST HAVE

id
  • string
  • no default - required
  • generally the singular form of the concept
    • id's can be set as paths e.g. objectNameList/objectNameGroup this is used when the service layer has a more complex structure than the ui. This is often found in repeatable groups

CAN HAVE

show
  • boolean
  • default true
  • if set to false the repeat will not appear in uischema/uispec. But it will still be part of the payload for the service layer
asSibling
  • boolean
  • default true
  • no matter what you do it will always be true so don't try and set it
section
  • string
  • default "common"
  • service layer tag - used to define the name of the multipart document
exists-in-services
  • boolean true|false 1|0 yes|no
  • default true
  • allows certain fields to be set as false and therefore ignored by the service layer but exist in the uispecs etc
has-primary
  • boolean
  • default true
  • whether the service/ui layers are expecting a primary flag for one of the items in the repeat block
userecord
  • string
  • default ""
  • used mostly by field/groups/repeats allows a field/groups/repeats to be defined as a record. value should be the id of a record.
as-expander
  • boolean true|false 1|0 yes|no
  • default false
  • used by the ui if expander required in uispec
xxx-hack-authorization
  • boolean
  • default false
  • needs to be set true for most repeats in authorization as the service layer currently has a nonstandard realization of the repeatable group in a few record.
selector-affix
  • string
  • default ""
  • tobe used when you have multiple fields with userecord set to the same record as it allows you to set a affix that will be included into the UI selector for the fields in the schema and spec.
mini
  • set of strings from number|summary|list
  • default {""}
  • defines the fields that are used in find and edit and search results
    • number - only one field can be set as number
    • summary - only one field can be set as summary
    • list - multiple fields can be set as list
      • will be used in Find & Edit page and lists on tabs to set columns required
    • search - multiple fields can be set as list
      • will be used in the search results to set columns required
    • relate - multiple fields can be set as list
      • will be used in the RH related Object and relatedProcedures to set columns required
    • terms - multiple fields can be set as list
      • will be used in the RH side termsUsed section to set columns required

Single Elements

selector
  • string
  • default ".csc-" + parentID + "-" + id
  • UI tag used in uispec creation
services-tag
  • string
  • default id
  • UI used in uispec creation

h4 Complex Elements