Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Show Page Sections

download

Using the Wizard Component Library

The Configurable Wizard offers a tab from which you can manage libraries of both Steps and Inputs. When you create a step or input from a Wizard Design, that step or input is available to that specific wizard design only. In many cases, you will want to create steps or inputs which can be used by more than one Wizard. Use the Wizard Component Library to create reusable steps and inputs.

The Wizard Component Library is comprised of two tables: Steps and Input Controls.

Information displayed in table columns comes directly from Input or Step Setting details.

You can take the following actions on tables in the Wizard Component Library:

Action

Description

New Step

Click New Step to create a new step in the Steps Library. See Creating Steps for more information.

New Input Control

Click New Input Control to create a new input in the Inputs Library. See Creating Inputs for more information.

Edit

Edit an existing step or input. Edited steps and inputs will only apply to newly-created Wizard Designs and do not affect steps or inputs for existing Wizard Designs.

Delete

Delete an existing step or input. Deleted steps and inputs will only apply to newly-created Wizard Designs and do not affect steps or inputs for existing Wizard Designs.

Search

Use the type-ahead feature to narrow the list of displayed inputs or steps you want to edit, delete or view.

Tip: Limitation: When a user uses the type-ahead search feature in the Wizard Component Library, the resultant text is sometimes deleted as it is being typed.

Creating Steps

Steps are used to designate the actions that occur when end-users use the Wizard. Steps use common elements, like actions and rules, to define the flow of your Wizard. Each step represents a screen in the wizard runtime.

When you create a new step in the Wizard Component Library and save it, it becomes available for use in Wizard Designs which match the Context Type and Object specified when you define it (if any). Please note that any modifications to the step from within a Wizard Design will not affect the properties of a step saved in the library.

To create a new Step from the Wizard Component Library

  1. From the Wizard Component Library, click on New Step.
    The Step Settings form is displayed.
  2. Enter the following properties into the form:

    Step Setting

    Description

    Step Name

    Enter a name for your Step. This name can be internal but is used in the runtime banner when the user is interacting with the Wizard if Banner Statement (below) is not defined. Note: You cannot add any inputs to your step until you choose a Step Name.

    Banner Statement

    Enter a Banner Statement to display at Wizard runtime when the user is interacting with the Wizard. If left blank, the Step Name will be used instead.

    Description

    Enter a description for your step which describes its intended use (for example, "Define business details in this step.")

    Keywords

    Enter a list of keywords which can be used to search for this step.

    Category

    Choose an option from a drop-down list of pre-defined Step Categories (define picklist values on the Wizard Step object).

    Sub Category

    Choose an option from a drop-down list of pre-defined Step Sub Categories (define picklist values on the Wizard Step object).

    Runtime Help Text

    Enter text to display when the user clicks the help icon at the top of the Step page.

    Context Type

    Define whether your Step will apply to All objects or a specific Object.

    Context Object

    Choose the specific context Object for your Step. This option is only available if you specified "Object" for Context Type. (e.g., "Agreement")

    Input Group Option

    Select an option from the drop-down list to choose how Inputs will be displayed in the Step (as groups):
      • None – Select this option to display all Inputs for the step in the sequence listed in the Inputs pane.
      • Repeatable – Select this option to allow the end user to add multiple records for selected Inputs in list format. User can click the Add Item button to add additional values for the same group of Inputs (e.g., multiple Addresses).
      • Table Layout – Select this option to allow the end user to add multiple records for selected inputs in tabular format. User can click the Add Item button to add additional values for the same group of Inputs (e.g. Agreement Line Item Products, Quantity, List Price, etc.)
  3. Drag-and-drop an Input from the Inputs Library to the Inputs pane. If you do not see your Input listed, use the type-ahead feature in the Search box to locate the Input you want to use.
    Tip: You cannot add inputs to a step unless the Step Name has been entered.
  4. You can take the following actions on Inputs you have added:

    Add more inputs from the Inputs Library in the sequence you want them to appear in the step.

    • Hover over an Input in the list and click Edit to edit the input settings for this step only.
    • Hover over an Input in the list and click Delete to remove an Input from the step.
    • Click and drag Inputs in the Inputs pane to reorder them.

  5. If you do not find the correct input in the library and need to create a new one to use in your step, see Creating Inputs from the Wizard Designer.
  6. To create rules which govern inputs for the current step, click on Input Rules (see Configuring Step Input Rules from the Wizard Designer).
  7. Click Save to save your changes or click Cancel to discard changes and return to the Wizard Design form. The new step is now available from the Wizard Component Library.

Creating Inputs

Input controls are the primary components of any wizard. They are the questions and instructions that you provide to the end users of your wizard. For example, you might create an input control that requires users to select picklist options, such as Business Function or Agreement Start and End dates. Input controls are reusable, so you can use them in as many steps as you want to.

Please note that any modifications to the input from within a Wizard Design will not affect the properties of an input saved in the library.

To create a new Input from the Wizard Component Library

  1. From the Wizard Component Library, click New Input Control.
    The Input Settings page is displayed.
  2. Enter the following properties into the form:

    Input Setting

    Description

    Control Name

    Enter a name for your Input.

    Question/Instruction

    Enter a question or instruction which the end user will see in the runtime wizard.

    Description

    Enter a description for the input which describes its intended use (for example, "Use this Wizard to create MSA Agreements for Acme."

    Keywords

    Enter a list of keywords which can be used to search for this Input.

    Category

    Choose an option from a drop-down list of pre-defined Input Categories (define picklist values on the Wizard Input Control object).

    Sub Category

    Choose an option from a drop-down list of pre-defined Input Sub Categories (define picklist values on the Wizard Input Control object).

    Runtime Help Text

    Enter text to display when the user hovers over the help icon next to the question/instruction.

    Runtime Input

    Determine how the end user can interact with this Input at wizard runtime:

    Allow Comments and Attachments – Select this check box to enable the end user to add comments and/or attachments in addition to the input control value. Comments are entered into a text area field and are limited to 500 characters. There is no limit to the number of files a user can attach.

    Required – Select this check box if a value is required for the input. An end user will not be able to complete the current step without entering a value for this input.

    Read Only – Select this check box if you plan to have the input value set by Step Input rules in all cases. The end user will not be able to change the value of this input.

    Field Class

    The Field Class defines the type of response you expect for the input.
      • Wizard Input Field – Use this field class when you want the response to indirectly set other Wizard values. Wizard input fields values are only used to affect the value or state of other input controls using Step Input Rules. When you choose this field class, you must specify one of the following data types:
          • Checkbox
          • Date
          • Number
          • Picklist
          • Picklist Radio Button
          • Multi Picklist
          • Text
          • Text Area
        If you choose to make the Wizard Input field a Picklist type, you must also enter valid values to be used as input responses.
      • Object Field – Use this field class when you want the response to directly set a field value on the Salesforce object which is created from the Wizard (e.g., the "Agreement Start Date" field on the Agreement object). Use the drop-down list under Input Control to choose the Object Name, then choose the Field Name based on the object chosen.
  3. When you are finished creating your Input, click on the Preview tab to show how the input will appear at Wizard runtime.
  4. Click Input Settings to return to the Input form.
  5. Click Save to save your new Input or Cancel to discard changes and return to the Wizard Component Library.