Documentation

    {{docApp.userSession.userId}}
    {{docApp.userSession.userName}}
    {{docApp.userSession.email}}
    Issuer : {{docApp.userSession.issuerInstance}}
    Expires : {{new Date(docApp.userSession.validUntil).toLocaleDateString()}}

{{docApp.title}}

{{docApp.description}}

Connect an AI assistant

Your AI assistant can read this documentation directly, so it answers from the current content instead of guessing. Add one of the servers below to your client — they use the Model Context Protocol (MCP). Each one covers a different body of content, so add the one you need.

The catalog did not load. Refresh the page to try again.

Loading…

How can we help?

{{docApp.searchError}}

Searching in {{docApp.searchFilterBySpecificBookTitle}}

 {{docApp.currentResultsSearchText}}  in {{docApp.searchFilterBySpecificBookTitle}}
Found {{docApp.searchResponse.totalResultsAvailable}} matches. Showing the top {{docApp.searchResponse.results ? docApp.searchResponse.results.length : 0}}. Use a more specific search to further narrow down the results.
No documentation pages match this search, so all content types are shown. Most matches are in {{docApp.searchDocTypeRescue.best.name}}.
There is no book with the ID "{{docApp.searchBookRescue.bid}}", so the book filter from this link was ignored and results from all books are shown.

You have an odd number of " characters in your search terms - each one needs closing with a matching " character!

  • {{resultItem.title}} {{resultItem.matchedBy === 'semantic' ? 'semantic' : (resultItem.matchedBy === 'both' ? 'keyword + semantic' : 'keyword')}}

    {{resultItem.url}}

{{docApp.libraryHomeViewProduct.title || docApp.libraryHomeViewProduct.id}}

{{docApp.libraryHomeViewProduct.description}}

  1. {{book.title}}

Complex Types - configOptionListType

  • Article
  • 1 minutes to read

Description

This type represents an application or system configuration option returned in a list of options.

Properties

Name Type Occurrence Description
key xs:string Required The key name.
value xs:string Optional The value.
defaultValue xs:string Optional The default value.
isDefault xs:boolean Required If set to true, then the value returned is the default value defined by the application out of the box.
editable configOptionEditableType Optional Defines the editable status of this option
dataType configOptionDataType Optional Defines the data type this option supports.
contentType xs:string Optional Defines the type of content stored in this option.
pattern xs:string Optional A RegEx pattern that this value must match in order to be valid.
patternErrorMessage xs:string Optional A message to display to the user when the provided value does not match the specified patteren.
choice Array<xs:string> Optional An array of possible values. If this is defined, then only one of these values are valid for the parameter.
multiChoice Array<xs:string> Optional An array of possible values. If this is defined, then any combination of these values are valid for the parameter.
choiceQuery xs:string Optional The name of a stored query to use to get the list of possible choices for this option’s value.
choiceFlowcode xs:string Optional The name of a flowcode used to get the list of possible choices for this option’s value. appcode:flowcodename
minInclusive xs:unsignedInt Optional If the parameter is a ‘number’ this can specify the minimum allowable value.
maxInclusive xs:unsignedInt Optional If the parameter is a ‘number’ this can specify the maximum allowable value.
description xs:string Optional The text description for this option.
advanced xs:boolean Optional Defines the option as being an advanced option (not generally editable by users)
secure xs:boolean Optional Defines the option as holding informaiton that should be treated as secure.
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document