BP Conclusion

BP Conclusion summarizes user progress or completion of a business process.

Usage Guidance

Coming soon!

API Guidelines

Methods

Class name: ConclusionScreen Module name: UIComponentsPlugin

public init(
        featureData: FeatureMetricsData,
        context: SemanticContext = .default,
        statusImageName: String,
        showConclusionHeaderWith conclusionHeaderData: ConclusionHeaderData,
        showAccordionWith accordionData: AccordionData? = nil,
        showUpNextCardWith upNextCardData: UpNextCardData? = nil,
        showActionButtonWith actionButtonData: ActionButtonData? = nil,
        viewButtonAction: @escaping (() -> Void),
        localizer: LocalizationAdapting
    )

Parameters

Name	Description	Default values
featureData	the feature name/context and the screen ID in which the component appears.
context	the SemanticContext.	SemanticContext.default
statusImageName	A string, image name, that confirms that the user has completed their task. Indicates if the BP action was completed, denied, or canceled.
showConclusionHeaderWith	Show the Description of the action just taken and the details the business object and the BP workflow status.
showAccordionWith	Shown when the BP action has been successful, but the API call has returned validation errors after the fact.	nil
showUpNextCardWith	Provides information about the next step in the BP, and link to who it is assigned to.	nil
showActionButtonWith	Button that appears ONLY if the ‘Up Next’ is assigned to the user who just completed the task to continue to the next step.	nil
viewButtonAction	Closure to the entry point view of the full conclusion page and process related to their task.
localizer	Localizer used for localizing strings in the view.

Accessibility Guidelines

Coming soon!

Usage Guidance

Coming soon!

API Guidelines

Methods

fun BPConclusionUiComponent(
    modifier: Modifier = Modifier,
    header: ConclusionHeader,
    alertContainer: AlertContainer? = null,
    actionButton: ActionButton? = null,
    upNextCardDetails: UpNextCard? = null,
    upNextAvatar: Painter = CanvasSystemIcons.Default.User(),
    upNextAvatarBackgroundColor: Color = WorkdayTheme.canvasColors.primary,
    onViewDetailsButtonClick: () -> Unit = {},
    onCloseButtonClick: (() -> Unit) = {}
  )

Parameters

Name	Description	Default values
modifier	The modifier to be applied to the component.	Modifier
header	The header [ConclusionHeader] for the conclusion page specifying title, subtitle and status icon[IconType].
alertContainer	Optional. Container for any errors or warnings [AlertContainer].	null
actionButton	Optional. Button to perform an action [ActionButton].	null
upNextCardDetails	Optional. Values for up next card [UpNextCard].	null
upNextAvatar	Optional. Avatar [Painter] to show inside up next card.	CanvasSystemIcons.Default.User()
upNextAvatarBackgroundColor	Optional. UpNextCard Avatar's backgroundColor.	WorkdayTheme.canvasColors.primary
onViewDetailsButtonClick	onClick listener for view Details button.	{}
onCloseButtonClick	onClick listener for close button. See [BpConclusionFragment] for usage.	{}

Accessibility Guidelines

Coming soon!

Can't Find What You Need?

Check out our FAQ section which may help you find the information you're looking for. For further information, contact the #canvas or #canvas-kitchannels on Slack.

FAQ Section