Skip to main content

Wizards

Introduction​

General​

  • A Wizard is a configurable unit used to define a workflow for users to follow when working with a specific item (publication/document).
  • Different Wizard can be used in different projects, so each Wizard must have a unique ID.
  • A Wizard consists of multiple configurable Steps, which can be dependent or independent of each other.
  • Each Publication type can be configured to use one or multiple wizards.

Publication Template​

  • Publications can be configured with default metadata, static documents, and designated as templates for the Wizards.
  • Publication Templates are identified using a checkbox publication metadata field. The Is Template Metadata can be configured within the Wizard configuration.

Wizard Status​

  • A Wizard includes multiple Steps, and the status of each step can be tracked.
  • Each Step can have a corresponding Status.
  • Status information can be maintained in a Publication Metadata, which should be a Combobox. The Status value will be updated after a step is finished.
  • The Completed Status can be configured to indicate that the publication has finished all steps in the wizard.

Document Selection/Content Selection​

  • Publication Templates can include static documents. After the first step, the Publication Template and its content are duplicated. Users may want to adjust or customize this content through Document Selection.
  • Document Selection/Content Selection is identified via a checkbox metadata field, and the Is Content Selection can be configured within the Wizard configuration.

Configuration​

ISON Configuration Details​

Sample:​

<wizards>
    <wizard id="wizard_1">
        <label>wizard_1_label</label>
        <isTemplateMetadata>is_template_metadata</isTemplateMetadata>
        <contentSelectionMetadata>content_selection_metadata</contentSelectionMetadata>
        <isCompletedMetadata>is_completed_metadata</isCompletedMetadata>
        <countryMetadata>country_cbx</countryMetadata>
        <languageMetadata>language_cbx</languageMetadata>
        <statusMetadata>status_metadata</statusMetadata>
        <completedStatus>completed_status</completedStatus>
        <useMasterDocument>false</useMasterDocument>
        <postfixAutoFillLabelPublication>_{DATE:ddMMyy}_{PUBLICATION_ID}</postfixAutoFillLabelPublication>
        <showStepDescription>true</showStepDescription>
        <steps>
            <step>step_1</step>
            <step>step_2</step>
            <step>step_3</step>
            <step>step_4</step>
            <step>step_5</step>
        </steps>
    </wizard>
</wizards>

Explanation​

  • <wizards>: Wrapper element for Wizards configuration.
  • <wizard>: Each <wizard> element represents the single Wizard configuration.
    • Attributes:
      • id: The unique ID for the Wizard. This attribute is required.
    • Elements:
      • <label>: Descriptive label for the Wizard, supporting language-dependent translations.
      • <isTemplateMetadata>: Metadata identifier for determining if the Publication is a Template. This element is required.
      • <contentSelectionMetadata>: Metadata identifier for Document Selection/Content Selection.
      • <isCompletedMetadata>: Metadata identifier for determining if the publication is completed or not. This element is required.
      • <countryMetadata>: Metadata identifier for country.
      • <languageMetadata>: Metadata identifier for country.
      • <statusMetadata>: Metadata identifier used to store the Wizard Status.
      • <completedStatus>: Status to be applied to the Publication after the final step of the wizard is completed.
      • <useMasterDocument>: A flag indicating whether to use the Master Document when duplicating the publication from the template. The default value is true.
      • <postfixAutoFillLabelPublication>: A postfix which is added to the label of the publication when duplication. The placeholders will be replaced with the current value of date and the ID of the new publication.
      • <showStepDescription>: Decide whether the step description should be displayed if it exists. The default is false, meaning the step description section is collapsed, and the user must expand it to view the details.
      • <steps>: List of steps within the Wizard. This element is required and must contain at least one step.
      • <step>: ID of the Wizard Step.
      • <updateMetadataRecursive>: Decide whether the publication metadata updating should be applied for the sub-folders and document recursively. The default is false, meaning the updating only be applied on the publication level.

This configuration provides a flexible way to define Wizards for managing workflows, templates, and steps in a project-specific way. Each Wizard can be uniquely identified and customized to include multiple steps, statuses, and content selection mechanisms.