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 - workspaceCustomizedHeaderConfigType

  • Article
  • 1 minutes to read

Description

Information related to the configuration of a workspace.

Properties

Name Type Occurrence Description
enabled xs:boolean Optional
Default=false		 Show/hide the customized header
logo xs:anyURI Optional Path to the logo image (URN or Absolute URL Path to an http image resource)
backgroundImage xs:anyURI Optional Path to the background image (URN or Absolute URL Path to an http image resource)
backgroundImagePositionX percentageValueType Optional
Default=50		 Horizontal focal point (0-100%) used by the client to render the header background image with object-fit: cover. Maps to the first value of the CSS object-position property. Defaults to 50 when omitted.
backgroundImagePositionY percentageValueType Optional
Default=50		 Vertical focal point (0-100%) used by the client to render the header background image with object-fit: cover. Maps to the second value of the CSS object-position property. Defaults to 50 when omitted.
backgroundColor xs:string Optional Any valid web color value
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document