cspace-config Repeat

Owned by Chris Martin (Unlicensed)
Aug 14, 2013
3 min read

What is a Repeat

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 Repeats

Structure of Repeats

<repeat id="permissions" exists-in-services="false" as-expander="true" has-primary="false">
    <selector>.csc-permissions-record-row:</selector>
    <field id="permission" ui-type="radio" as-expander="true">
    <options>
        <option id="none">none</option>
        <option id="read">read</option>
        <option id="write">write</option>
        <option id="delete" default="yes">delete</option>
    </options>
    </field>
    <field id="resourceName">
    </field>
</repeat>

Repeat

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 false (unless id is a path and then it is true)
  • affects the way the list is shown to the ui in the uispec
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
services-readonly
  • boolean true|false 1|0 yes|no
  • default false
  • if true, the repeat is omitted from XML payloads sent to the services layer

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