cspace-config Structures

What is a Structure

Structures are used in creation of the UISPEC.

  • It allows for easy addition/removal of sections to the UIspec
  • It also will in future allow different UIspecs for different output formats e.g. print vs screen. tab vs main
  • the allow advanced search to work - as that has a different uispec. 
    • if you want advanced search to work you must include
      <structure id="search">
          <view>
              <label-section id="messagekeys" show="true"></label-section>
          </view>
      </structure>
      

Where are Structures

Structures are part of the record element of the cspace-config

Structure of Structures

<structures>
	<structure id="screen">
		<view>
		<titlebar show="false"></titlebar>
		<sidebar show="false"></sidebar>
		<edit-section id="details" show="true"></edit-section>
		<list-section id="list" show="true"></list-section>
		</view>
		<repeat id="list" asSibling="true">
			<selector>.csc-recordList-row:</selector>
			<field id="number" ui-type="list">
			<selector>.csc-user-roleList-name</selector>
			</field>
			<field id="csid" ui-type="list">
			<selector>.csc-user-userList-csid</selector>
			</field>
		</repeat>
	</structure>
</structures>

structure

repeatable item to allow multiple structures to be defined

view

attribute: id
  • string
  • no default - required

elements within view are simple definitions of what should and should not show within the uispec

titlebar
  • String
  • default "titlebar"
attribute: show
  • Boolean true|false, 1|0, yes|no
  • default true
sidebar
  • String
  • default "sidebar"
attribute: show
  • Boolean true|false, 1|0, yes|no
  • default true
edit-section
attribute: id
  • String
  • default "recordEditor"
attribute: show
  • Boolean true|false, 1|0, yes|no
  • default true
list-section
attribute: id
  • String
  • default "list"
attribute: show
  • Boolean true|false, 1|0, yes|no
  • default false

repeat within a structure

works like a normal repeat but if the id matches the id of the list-section or the edit-section then that structure is used instead of the default structure