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

  • Article
  • 1 minutes to read

Description

This type defines properties of a related entity

Properties

Name Type Occurrence Description
entityName xs:string Required The name of the entity
relationshipType entityRelationshipType Required The type of relationship this entity has with the primary entity
relationshipName xs:string Required The unique name within the primary entity of this specific relationship
relatedEntity xs:string Required The entity that is related to the primary entity
foreignKey xs:string Required The name of the column in the primary (referencing) table that identifies record(s) in the related entity. To clarify this see here http://en.wikipedia.org/wiki/Foreign_key for more detail
referenceKey xs:string Required The name of the column on the related (referenced) entity that is used to identify it’s relationship with the primary entity
mandatory xs:boolean Optional
Default=false		 Indicates that the related record is mandatory when creating a primary record. In other words, when a primary record is being added/edited any relationships ManyToOne must exist
managed xs:boolean Optional
Default=false		 Indicates that the related record is managed by this entity. If set to ‘true’ then the related record will be deleted when the primary record is deleted
mappedValue Array<entityMappedValueType> Optional Mapped/copy values from the related table back to the primary entity table
linkingTableName xs:string Optional Fields for SelfManyToMany reference type
leftColumnName xs:string Optional Fields for SelfManyToMany reference type
rightColumnName xs:string Optional Fields for SelfManyToMany reference type
dynamicValueColumn xs:string Optional Fields for DynamicOneToOne reference type
dynamicRelatedEntities Array<entityDynamicRelatedEntityType> Optional Fields for DynamicOneToOne reference type
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document