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

  • Article
  • 1 minutes to read

Description

This object represents a lifecycle phase definition

Properties

Name Type Occurrence Description
id bpmIdType Required The id of the phase - used to store against records what phase the record is on
label Array<bpmLabelType> Optional The phase of this lifecycle.
icon xs:string Optional icon class to display in phase breadcrumb next to label
workflow Array<lifecyclePhaseWorkflowType> Optional Workflows associated with this phase of the lifecycle that are run from drop down menu manually - index is order shown in menu.
onStartWorkflow Array<lifecyclePhaseWorkflowType> Optional Workflows associated with this phase of the lifecycle that are run when the phase start - index is the order in which workflows are run
scheduledWorkflow Array<lifecyclePhaseWorkflowType> Optional Workflows associated with this phase of the lifecycle that are scheduled to run at given time/interval while phase is active
  • Version {{docApp.book.version}}
  • Node {{docApp.node}} / {{docApp.build}}
In This Document