Viewconfig JSON Schema

This page describes the JSON format of the i·views viewconfig.

View: object

View is the base class for all displayable views.

builtInActions: object

Contains all actions associated with the current view. The action is displayed, if they are visible. A Boolean value represents the response from the rights system.

actionGroups: object[]

Array of menus

additionalConfig: object

Add configured elements to json

viewType: string

Type determining the view kind

viewId: string

View configuration id

searchType: string

Search type

elementLabel: string

Element label

label: string

View label

elementType: string

Element type

elementId: string

Element id

actionResponse: object

customVariables: object

Contains the custom variables of a session

session: object

Contains session data of the action response

defaultViewContexts: object[]

Contains optional default values for views

globalContext: object[]

Contains the global context of the action response

data: object

Contains the data of the action response

notification: object

Notification of an action

message: string

Message of an action notification

type: string

Type of an action notification

followup: string

Contains the followup string of the action response

alternative:

An alternative represents a view with different tabs.

subView: object , x ∈ { alternative , group , hierarchy , list , KEditors.KStaticTextEditor , table }

Attach the child object

alternatives: object[]

Array of alternatives

application:

Representation of an application

viewType: string

Type determining the view kind

attribute:

Attribute

blob:

Blob attribute

translations: object

Object with language and value

fileName: string

File name of blob attribute

fileId: string

File ID of blob value

blobLocator: string

Blob locator

mimeType: string , x ∈ { text/html , text/plain }

Mime type

storeId: string

Store ID of blob value

fileSize: string

File size of blob attribute

boolean:

Boolean attribute

cause-composite: object

Hit cause with hit type

cause-custom: object

Hit cause with hit type

cause-direct: object

Hit cause with hit type

cause-external: object

Hit cause with hit type

cause-folder: object

Hit cause with hit type

cause-semantic: object

Hit cause with hit type

choice:

Choice attribute

options: object

Show all options

choiceValue: integer

Display string of choice

choiceId: integer

Internal representation of choice

viewType: string

Type determining the view kind

collection-ref:

Collection reference attribute

color:

Color attribute

container:

Container attribute

date:

Date attribute

dateTime:

Date and time attribute

dateTime-interval:

An interval with value range for dates and times

min: dateTime

Min value of an interval

max: dateTime

Max value of an interval

edit:

A group view can contain several views displayed in a grouped view.

editCustomButtons: boolean

If true show only custom actions

extension: object

Instance or extension

extensionRelation:

Extension Relation attribute

flexTime:

Flex time attribute

minutes: integer

Flex time minutes value

day: integer

Flex time day value

year: integer

Flex time year value

hours: integer

Flex time hours value

month: integer

Flex time month value

allowsFuture: boolean

If the flex time value in the future? Default is true.

formats: object[]

Array of allowed formats

flexTime-interval:

An interval with value range for flex time values

min: flexTime

Min value of an interval

max: flexTime

Max value of an interval

float:

Float attribute

viewType: string

Type determining the view kind

float-interval:

An interval with value range for floats

min: float

Min value of an interval

max: float

Max value of an interval

folder: object

Folder

folder-ref:

Folder reference attribute

geo:

Geo attribute

graph:

Representation of an graph

group:

A group view can contain several views displayed in a grouped view.

hierarchy:

Hierarchical structure containing nodes and leafs. It also contains a view which represents the selected node is data.

nodes: object[]

Array of nodes

subView: object , x ∈ { alternative , group , hierarchy , list , KEditors.KStaticTextEditor , table }

Attach the child object

builtInActions: object

Contains all actions associated with the current view. The action is displayed, if they are visible. A Boolean value represents the response from the rights system.

html:

A generated by a script HTML description appears.

mimeType: string , x ∈ { text/html , text/plain }

Mime type

viewType: string

Type determining the view kind

value: string

Value as string

instance: object

Instance or extension

integer:

Integer attribute

integer-interval:

An interval with value range for integer

min: integer

Min value of an interval

max: integer

Max value of an interval

layout: object

A layout panel consists of sub-panels and layout panels.

layoutPanel: object

A layout panel consists of sub-panels and layout panels.

list:

List of properties

mapping-ref:

Mapping reference attribute

menu:

View containing static menu.

node: object

selectAction: object[]

Array of actions

nodes: object[]

Array of nodes

elementType: string

Element type

searchType: string

Search type

nodeId: string

Node id

label: string

View label

elementId: string

Element id

hasChildren: boolean

Node has children

obsolete: object

Instance or extension

panel:

A panel may contain a sub-view.

viewType: string

Type determining the view kind

parameters: object

<name>: object

Parameter name and values as object

possibleOperators: object[] , x ∈ { containsPhrase , covers , distance , equal , equalBy , equalCardinality , equalGeo , equalMaxCardinality , equalMinCardinality , equalPresentTime , equalsTopicOneWay , fulltext , greater , greaterOrEqual , greaterOverlaps , greaterPresentTime , isCoveredBy , less , lessOrEqual , lessOverlaps , lessPresentTime , notEqual , overlaps , range , regexEqual , regexFulltext , unmodifiedEqual , words }

Possible operator of a table column

parameterValues: object[] , x ∈ { string , locator , registeredUID }

Parameter values

parameterValueDisposition: string , x ∈ { parameterValueDispositionOptional , parameterValueDispositionMandatory }

Parameter value disposition

parameterName: string

Parameter name

parameterValueDetermination: string , x ∈ { parameterValueDeterminationScript , parameterValueDeterminationScriptRewritable , parameterValueDeterminationUserInput }

Parameter value determination

parameterType: string , x ∈ { k:element , xsd:base64Binary , xsd:boolean , xsd:date , xsd:dateTime , xsd:decimal , xsd:duration , xsd:integer , xsd:language , xsd:string }

Parameter type

mandatory: boolean

Is parameter mandatory

password:

Password attribute

oldPassword: string

Value of old password

newPassword: string

Value of new password

plain:

View containing plain content: text / image / image+text / nothing

viewType: string

Type determining the view kind

property: object

Property

minOccurrences: integer

This attribute reflects the schema setting "minOccurs guideline" for the attribute type. Empty if there is no such restriction.

modNum: integer

Flag for version number. This is important for writing actions as this action is only performed if the backend modNum is not higher than the given one (meaning element data has already been altered).

status: string , x ∈ { deleted , new }

Status

viewId: string

View configuration id

searchType: string

Search type

schema: object

Schema for the current property. Only given if levelOfDetails is set to schema.

label: string

View label

elementType: string

Element type

maxOccurrences: integer

This attribute is only set if the schema restricts the number of attribute values.

elementId: string

Element id

query:

Integration of a query. This configuration is used to configure the query and tabular view.

query-ref:

Query reference attribute

queryFacets:

Show the facets. Configured by sub configuration of a search.

queryParameters:

Show the search parameters. Configured by a search.

queryResults:

Show the search result. Configured by sub configuration of a search.

relation:

Relation

Schema: object

Schema

typeId: string

Type id

typeName: string

Type name

rdf-id: string

RDF-Id

internalName: string

Internal Name of an type

script-ref:

Script reference attribute

staticImage:

View containing static content.

staticText:

View containing static content.

string:

String attribute

translations: object

Object with language and value

string-interval:

An interval with value range for strings

min: string

Min value of an interval

max: string

Max value of an interval

switchingPanel:

A switching layout panel consists of sub-panels of which only one is active at a time.

viewType: string

Type determining the view kind

table:

View containing table data.

builtInActions: object

Contains all actions associated with the current view. The action is displayed, if they are visible. A Boolean value represents the response from the rights system.

context: object

Table context of a table

elementTypes: object[]

Element types

totalCount: integer

Number of total found results

configuredProtos: object[]

Configured protos of a table

rows: object[]

Rows of a table

columnDescriptions: object

Column descriptions of a table

columnIndex: integer

Column id of a column

width: integer

Column width in percent

additionalConfig: object

Add configured elements to json

tableContext: object

Table context of a table

sortIndices: object[]

An Array of numbers that describe the sort order

parameters: object

Parameter object

query: string

Name of the search that is used to determine search results.

startIndex: integer

Start value of the included elements

createHits: boolean

If true create hits instead of elements. Default: false

contents: object

Contents object of a table context

elementId: string

Element id

viewId: string

View configuration id

pageSize: integer

Page size of a table

stopIndex: integer

Stop value of the included elements

maxResultsExceeded: boolean

The value is true if max results exceeded

filter: object

Filter of a table context

withoutSorting: boolean

If true do without sorting. Default: false

possibleTargets: object[]

Possible targets array

time:

Time attribute

url:

Url attribute

translations: object

Object with language and value