To define general wizard information

1. Access the General tab of the wizard screen by following the instructions in Opening the Wizard Screen.
   The General tab of the wizard screen opens by default.
2. Define the information on the General tab according to the information in the General Tab on Wizard Screens table.
   

The following table describes the items on the General tab of the Wizard screen.

Note: The fields in the table below are the default fields that appear for all object definitions. You may see additional fields that only apply to the selected object definition.

Wizard Pages Tab

To define a page component in a wizard

1. Open the appropriate wizard and select the Page Components tab.
   
2. Select the wizard page you want to add components to from the Current Page drop-down list.
3. From the Component list, select the component you want to add to the selected page.
   The available components and their values are described in the Wizard Page Component Value Fields table.
4. In the Order field, enter an integer to indicate the order in which the component must appear in the wizard page.
5. In the Value area, enter or select the appropriate values for the selected component. Different fields appear based on the Component that you selected.
6. Click add more.
7. Repeat steps 3 through 6 to add other components to the selected page and click Save.

Repeat steps 2 through 7 for each page in the wizard.

For an example of how the components shown in the Wizard Page Components Tab image appear in the resulting wizard page, see the Wizard Page Component Value Fields table.

The following image describes the fields in the Page Components tab.

Wizard Page Components Tab

The following table describes the component values available on the Page Components tab.

Wizard Page Component Value Fields

Defining Wizard Parameters

Parameters allow you to add items to be used as qualifiers for page transitions or to perform operations on the object attributes. Parameter data is not stored in the database and is only used within the wizard. Parameters may be simple, such as Number, String, or List, or use functionality that is stored in the database.

For each parameter that you add on the Page Components tab of the wizard definition, you may enter:

• A Label (required)
• The Type (required)
• A unique Name (required)
• Custom Lookup Table (required for check-boxes, radio buttons, and drop-down lists)
• The Default Value (optional)

The unique name is used in the following locations in the wizard screen:

• On the Qualifier tab of the page transition rules in the drop-down list for the Left Argument
• In the Right Argument if you select Attribute
• On the Actions tab in the Parameter drop-down list
• In the name attribute of the <tc:wizardParameter name> and <tc:wizardParameterLabel name> tags, when the parameter is included in a custom block. For details, see Block Tags.

Caution: When you are including a parameter in a custom block that also contains custom fields, the parameter names and field names must be unique. Otherwise, errors may occur in page transition rules.

If you plan to include the parameter in a custom block, make sure to select the Display in blocks only check-box, or it appears twice on the wizard page.

Database Parameters

Complex parameter values are stored in TeamConnect's database. The following parameter types used in wizard page components are mostly system lookup tables that appear in drop-down lists in the wizard:

• Activity Item
• Address Type
• Area Item
• Category
• Check-Box List
• Contact Relation Type
• Country Item
• Drop Down List
• Email Type
• Fax Type
• Group
• Internet Address Type
• Invoice Rejection Reason
• Integration Message Queue
• Phone Type
• Project Relation Type
• Radio Button List
• Resource Type
• Skill Type
• String
• Territory Type
• User

Depending on system and user preferences, these items may also appear in an applet. The User parameter type may appear in a search module.

If you select any of these parameter types, the Default Value field in the Value column on the Page Components tab appears a drop-down list with the corresponding lookup table items so you may select a default value. In the resulting wizard page, the selected parameter is represented by the same drop-down list, applet, or search module with its respective items.

The following parameter types used in wizard page components are used to create a corresponding search module field, where the user may select the necessary record:

• Account
• Contact
• Custom Object

Transient Parameters

The following parameter types used in wizard page components have transient values. That is, they are not stored in the database and are created within the wizard itself:

• Simple types—Depending on the type of user input, select the appropriate parameter to create the corresponding type of field in the wizard page.
  • Boolean
  • Date
  • Date&Time
  • Decimal
  • Integer
  • Memo Text
  • (Text) String
• List types—Add list parameters to present the user with simple options on the wizard page, such as Yes, No, or Unknown.
  • Check-Box List
  • Drop Down List
  • Radio Button List

To define simple list type parameters

On the Page Components tab of the wizard definition, select an option in the Custom Lookup Table drop-down list.

Tip: Automated actions may populate a list parameter with values retrieved from records in the database. For example, you might display a list of outside counsel with certain rates and skills next to corresponding radio buttons.

Points To Remember

The following list summarizes wizard parameters:

• All parameters have transient values that exist only within the wizard in which they are defined.
• Parameter data is not stored in the TeamConnect database.
• Use its value to perform certain actions or as a qualifier for page transitions.
• Parameter values may be used in the wizard page for which you defined it and a any of the subsequent pages in the wizard for actions or page transitions.
  For example, if you add a parameter of type Integer to page 3 to obtain the number of days required to complete a task, on page 6, you may use its value to create an action to set the Due On date for the task.
• Parameters types are listed in the Type drop-down list in the Value column of the Page Components tab.
• Like custom fields, you may include wizard parameters in custom blocks to control their layout on the page.
  You may do this by using the <tc:wizardParameter> and <tc:wizardParameterLabel> tags. For details, Block Tags.

Important: If you intend to use a parameter in a custom block, make sure the Display in blocks only check-box is selected. Otherwise, the parameter appears twice on the page, in the block and as an individual field.

Applying Automated Actions

Automated actions may perform any operations on record values without limitation. In wizards, these actions include initial actions and page actions.

You must define automated actions in their respective Java class or JavaScript files and upload them to the appropriate directory in the Documents area. Otherwise, they are not available on the Actions tab of the wizard screen.

Although automated actions may perform simple operations, you may use them to create more complex logic that may not be defined through the user interface, such as:

• Validating or verifying information entered by the user
• Opening existing records at the end of a wizard
• Inserting values in parameters of the type List.

Note: When you insert values in these parameters, you insert data gathered through the wizard into the appropriate screens of the object record. By default, duplicate contact checking is not performed when custom Java code creates or updates contacts. See the ContactService.readDuplicateContacts() method in the API Javadocs to use duplicate contact checking functionality.

To apply an automated action to a page in a wizard

1. Upload the Java class or JavaScript files to the Automated Actions folder.
2. Open the Actions tab in the appropriate wizard.
3. In the Page Actions section, select the wizard page you want to apply the action to in the Current Page drop-down list.
4. Select the Use Automated Action radio button. The Use Automated Action drop-down list opens.
5. From the Use Automated Action drop-down list, select the file with the action you want to be applied to the selected wizard page.
6. Click Save.
   

Points To Remember

• You may use only one automated action file per page.
• Automated actions are optional.
• The Automated Actions folder location in the Documents area is:
  Top Level/System/Object Definitions/objectName/Rules/Automated Actions/

For information on how to create automated actions, see Writing Automated Actions.

Specifying Initial Actions

Initial actions are used to run an initialization routine when a wizard is started by the user but before the first page of a wizard opens. For example, these actions may compute the values inserted from the template associated with the wizard.

To specify the initial action for a wizard

1. Make sure the necessary files are uploaded to the Automated Actions folder of the object definition.
2. Open the Actions tab in the appropriate wizard.
3. In the Initial Action section, from the Use this action when the wizard is started drop- down list, select the file with the action that you want to be executed.
4. Click Save.
   

Points To Remember

• Initial actions are optional and depends on your wizard design.
• Initial actions must be defined as automated actions.
• You may only define one initial action per wizard.

See also Execution and Population Order.

Defining Simple Actions

Simple actions are operations, such as calculations, string concatenation, and so on, that allow you to assign specific values to object attributes. These actions are always defined through the user interface and are limited to the number of the predefined operators available for each value type.

You may assign values to object attributes belonging to the object's related or child objects— provided you have defined the objects in a template and associated the template with the wizard. Once defined in the template, the sub-objects are listed in the Object drop-down list of the Actions tab.

You may assign the following types of values:

• Static values
• Values of wizard parameters
• Values of other attributes using a path in the object model Use simple actions in a wizard when:
• You want to populate certain fields in the main record or its associated records with the values of parameters.
• When you want to overwrite the values assigned in a template with the ones specified on the Actions tab.
• You are not planning to use templates with your wizard, yet need to have certain fields of the main record prepopulated with default values.

Important: Without a template you may not assign values to related objects or sub-objects.

Simple actions are performed with the help of operators preselected for each value type. Depending on the attribute type, these operators may include the values shown in the following image and listed in the Operator Options for Different Attribute Types table.

To define a simple action for a page in a wizard

1. Open the Actions tab in the appropriate wizard screen.
   
2. In the Page Actions section of the Actions tab, select the appropriate pa ge from the Current Page drop-down list.
3. Select the Use actions defined below radio button.
   The screen refreshes to display data entry fields necessary for defining a simple action.
4. In the Order field, enter a number to indicate the order in which the action must be executed.
5. From the Object drop-down list, select the appropriate object for which this action is being defined.
   If you have associated a template with the wizard that defines child objects, these objects are listed in the Object drop-down list. They are numbered the same way as they are in their respective template screens, for example, Task 1, Task 2.
   
6. From the Attribute and Operator drop-down lists, select the appropriate attribute and the operator.
   Depending on the attribute type, operators may include a set of operators listed in the Operator Options for Different Attribute Types table, in addition to another set of the same operators using the value of a parameter. For example, instead of Path or X, the operators could be Set to Parameter, Set to Value of Parameter, Subtract X from Value of Parameter.
7. Depending on the field value type of the selected attribute, enter the appropriate values for X, Parameter, or Path.
   To learn more about setting a path, see Paths.
8. Click add more.
9. Repeat steps 4 through 7 to add other actions to the selected page, if necessary, and click Save.

The following table describes the Action options on the Actions tab.

Simple Actions Options on Wizard Actions Tab

The following table lists possible options for different attribute types and examples of how they might be used.

Operator Options for Different Attribute Types

To define page transition logic

Note: This procedure assumes that the wizard is open to its tabbed pages.

1. Click the Page Transitions tab for the appropriate wizard.
   
2. From the Current Page drop-down list, select the page for which you want to define the transition logic.
3. Complete the following information:
   • If the selected page is the last page of the wizard, click the This is a final page check- box.
     
     Caution: If you select the This is a final page check-box, the Create the record on finish check-box appears. If you do not check the Create the record on finish check-box, when you reach the end of the wizard, all of the information may be discarded.
      
   • If you want to add a Finish button to the selected wizard page, click the Show finish button check-box.
4. In the Order field, enter a number to indicate the order in which the rule must take effect in the wizard page.
5. Select one of the following options:
   • To select an existing rule, click the appropriate rule in the Rule drop-down list.
     You may view the details of a rule by selecting it and clicking Open, which displays the Rule screen where the qualifier and action are defined.
   • To create a new rule, see Creating Page Transition Rules.
     The newly created rule is now displayed in the Rule drop-down list.
6. Click add more.
   The selected rule is added to the list of rules defined for the page.
7. Repeat steps 2 through 6 to add other rules to the page, if necessary, and then click Save.

To display another wizard after a user completes the first wizard

Note: You can only add another wizard to wizards for custom objects.

1. From the Page Transition tab of a wizard, place a checkmark in the This is a final page checkbox.
   The Pick Wizard to launch on finish options appear.
2. Select the Object Definition with the second wizard.
3. Select the wizard name from the Wizard drop-down list.

The following table describes the items on the Page Transitions tab.

Page Transitions Tab

Creating Page Transition Rules

Page transition rules allow you to specify alternative flows in response to user input and other qualifiers, so the wizard displays the appropriate pages to the user. Otherwise, all pages follow each other in the order specified on the wizard's Pages tab.

Page transition rules are similar to TeamConnect rules located on the Rules tab of an object definition screen. However, page transition rules are wizard-specific, so you may only create and access them from the Page Transition tab of the corresponding wizard screen.

Page transition rules have the following tabs:

• General—General information about the rule, including its name, whether it is active, and its trigger. The rule's Type field has the value Wizard Page Transition, which cannot be changed.
• Qualifier—Allows you to define the qualifier that must be met in order for the rule to take effect. Wizard parameters may serve as qualifier items.
• Action—Allows you define which page comes next, if a specified condition exists.

When the user clicks next, page transition rules display the appropriate page based on the specified conditions. Like validation rules, they may check the values entered in certain fields, check who the user is, and so on.

Wizard parameters that you add on the Page Components tab of the wizard screen become available on the Qualifier tab of the page transition rule screen. That way, user entries in the wizard may be used as qualifiers in the rule.

To create a page transition rule

1. Open the Page Transitions tab of the appropriate wizard.
2. In the Current Page drop-down list select the wizard page for which you want to define the rule.
3. In the rule column click New.
   The General tab of the wizard page transition rule screen opens.
   
4. In the Description field, enter a self-explanatory name for the rule.
5. Click Save to allow you to add qualifiers.
6. Select the Qualifier tab.
   
7. Select the appropriate Left Argument, Operator, and Right Argument for the rule you are creating.
   The Left Argument list includes all parameters that have been added to the wizard.
8. Click add more.
9. Select the Action tab.
   
10. From the Next Page When Condition Verified field, select the page that is next if the qualifiers are met.
11. Click Save.
    The rule is now available in the Rule list on the Page Transitions tab.

Points To Remember

Keep in mind the following important information about page transition rules:

• Page transition rules are executed on a per-page basis—that is, when the user clicks next in the wizard, not on Create when the user clicks finish.
• The Action tab of a page transition rule allows you to specify the page to which the wizard must direct the user, if the conditions on the Qualifier tab is verified.
• When a user clicks next in a wizard page for which a rule is defined, page transition rules are executed on a per-page basis according to the Order numbers you assign to each rule.
• Page transition rules are wizard-specific and may be created and accessed only from the Wizard screen of the object for which the wizard is created, not from the object's Rules tab.
• To direct a user to a specific page depending on the rights of their user group, check the current user in the page transition rule. The Current User option is available from the Left Argument drop-down list on the Qualifiers tab.
• You may add wizard parameters as page transition qualifiers on the Qualifier tab. Select them from the Left Argument drop-down list. Parameters are also available when you select Attribute from the Right Argument list.
  

Page Transition Rule Example

Assume there are five pages in a wizard regarding view obstructions that a claimant and insured might have had. The user must provide the following information in each subsequent page depending on the answers:

Page Transition Rule Example

For example, to create a rule to skip to Page 6 from Page 3 when neither Insured nor Claimant had any view obstructions, you have to do the following actions:

1. On the Qualifier tab of the rule, you must specify the following conditions:
   1. Select Parameter1 in the Left Argument drop-down list and set it equal to No.
   2. Select Parameter2 in the Left Argument drop-down list and set it equal to No.
2. On the Action tab of the rule, you must select Page 6.

Checking Page Order in Wizards

To determine the page order, alternate flows, and final pages in a wizard, refer to the Page Transitions tab of the corresponding wizard screen.

The Page Transitions tab does not list all page transitions at once. Instead, you select each wizard page in the Current Page drop-down list to determine which page follows it, based on the default page transition order or the selected page transition rules.

To check the page order in a wizard

1. Open the Page Transitions tab in the appropriate wizard.
2. From the Current Page drop-down list, select the wizard page for which you need to check the page order.
   The screen either displays the page that follows the selected page, or informs you that the selected page is a final one, as shown in the following images.
   
   
3. Repeat the previous step for all wizard pages you need to know the transition order for and write down the page transition sequence for each.
4. Make any necessary changes and close the wizard screen when you are done.

You may use the list of page transitions to help you avoid breaking wizard flows when making changes to the page transitions.