When to use these helpers
Use these helpers only with the planning fields and relation shapes they expect. Test every combination of plan category, type, framework, and target class that your service supports.Calling style
Call a helper asplanningJourneyKey($.plan_category, $.plan_type, $.base_framework, $.target_entity_class, $.overlay_frameworks). Not every helper is available everywhere: validation, form, and document-template helpers have distinct context contracts. Editor suggestions are not proof that a helper is supported at runtime.
Complete function reference
planningAllowedTargetRecordTypes
Returns allowed target record types for one planning relation entity key.
Signature: planningAllowedTargetRecordTypes(planType, targetEntityClass, relationEntityKey)
Example:
value | planningAllowedTargetRecordTypes(...).
planningBaseFrameworkValidation
Compatibility form of planningFrameworkValidation for a base framework.
Signature: planningBaseFrameworkValidation(planType, framework, targetEntityClass)
Example:
value | planningBaseFrameworkValidation(...).
planningExecutionProgress
Returns journey progress for the configured planning context.
Signature: planningExecutionProgress(planCategory, planType, baseFramework, targetEntityClass, overlayFrameworks, inverseRelations)
Example:
value | planningExecutionProgress(...).
planningFrameworkValidation
Validates a base framework against the selected plan type and target class.
Signature: planningFrameworkValidation(planType, framework, targetEntityClass)
Example:
value | planningFrameworkValidation(...).
planningHasOverlayFrameworkOptions
Returns whether any overlay frameworks are available for the selected plan context.
Signature: planningHasOverlayFrameworkOptions(planType, targetEntityClass)
Example:
value | planningHasOverlayFrameworkOptions(...).
planningIsPlanContext
Returns whether a relation value or record resembles a plans context.
Signature: planningIsPlanContext(value)
Example:
value | planningIsPlanContext(...).
planningJourneyDefaultTab
Returns the default tab key for the selected planning journey.
Signature: planningJourneyDefaultTab(planCategory, planType, baseFramework, targetEntityClass, overlayFrameworks)
Example:
value | planningJourneyDefaultTab(...).
planningJourneyKey
Returns the configured planning journey key.
Signature: planningJourneyKey(planCategory, planType, baseFramework, targetEntityClass, overlayFrameworks)
Example:
value | planningJourneyKey(...).
planningJourneyProgress
Returns the selected journey’s 0–100 progress score.
Signature: planningJourneyProgress(planCategory, planType, baseFramework, targetEntityClass, overlayFrameworks, inverseRelations)
Example:
value | planningJourneyProgress(...).
planningJourneyTabVisible
Returns whether one journey tab is applicable to the selected planning context.
Signature: planningJourneyTabVisible(planCategory, planType, baseFramework, targetEntityClass, overlayFrameworks, tabKey)
Example:
value | planningJourneyTabVisible(...).
planningKeyResultIndicatorValidation
Requires an indicator in indicator tracking mode and rejects it in manual mode.
Signature: planningKeyResultIndicatorValidation(trackingMode, indicator)
Example:
value | planningKeyResultIndicatorValidation(...).
planningOverlayFrameworksValidation
Validates that every selected overlay framework is allowed.
Signature: planningOverlayFrameworksValidation(planType, overlayFrameworks, targetEntityClass)
Example:
value | planningOverlayFrameworksValidation(...).
planningPlanHealthStatus
Returns the calculated planning health state or null when there is no meaningful journey signal.
Signature: planningPlanHealthStatus(planCategory, planType, baseFramework, targetEntityClass, overlayFrameworks, inverseRelations)
Example:
value | planningPlanHealthStatus(...).
planningPlanTypeValidation
Returns true when the plan type is allowed for the selected category, otherwise a validation message.
Signature: planningPlanTypeValidation(planCategory, planType)
Example:
value | planningPlanTypeValidation(...).
planningPrimaryTargetEntityClass
Single-target form of planningTargetEntityClass.
Signature: planningPrimaryTargetEntityClass(relation, target, planType)
Example:
value | planningPrimaryTargetEntityClass(...).
planningPrimaryTargetValidation
Single-target form of planningTargetValidation.
Signature: planningPrimaryTargetValidation(planType, relation, target)
Example:
value | planningPrimaryTargetValidation(...).
planningRelationEntityKey
Extracts a supported planning relation entity key from a qualified value.
Signature: planningRelationEntityKey(value)
Example:
value | planningRelationEntityKey(...).
planningReviewCadenceValidation
Requires review cadence for resource and risk-resilience plan categories.
Signature: planningReviewCadenceValidation(planCategory, reviewCadence)
Example:
value | planningReviewCadenceValidation(...).
planningTargetEntityClass
Derives one target entity class from configured target relations and IDs.
Signature: planningTargetEntityClass(relations, targetIds, planType)
Example:
value | planningTargetEntityClass(...).
planningTargetValidation
Validates that one compatible target is selected for the plan type.
Signature: planningTargetValidation(planType, relations, targetIds)
Example:
value | planningTargetValidation(...).
planningTimelineValidation
Validates chronological and horizon-specific planning dates.
Signature: planningTimelineValidation(startDate, endDate, planningHorizon)
Example:
value | planningTimelineValidation(...).
Before you publish
- Start with a known value and confirm the expected result.
- Handle null, empty text, and empty lists deliberately.
- Do not place secrets, access tokens, or sensitive personal data in an expression.
- Read expression contexts and availability before copying an expression between features.
