SmartWizard Example

Two examples of custom SmartWizards are provided to demonstrate the basics of the SmartWizard framework. These examples do not cover all use cases or potential uses of the controls, data definitions or events available in SmartWizards, but they provide a starting point for understanding how the controls, data definitions, and events work together to create a SmartWizard.

. The sections in this topic describe the sample project in more detail:

• Project Setup
• Create Employee SmartWizard
• Update Employee SmartWizard
• Demo Workflow Process

Project Setup

• Install the custom SmartWizards
  • Unzip the demo project to your C:\Users\Administrator\Documents\Visual Studio 2010\Projects folder, and then copy the Create Employee and the Update Employee folders to %PROGRAMFILES%\K2\Bin\DesignTemplates\SmartWizards\Employee (this adds them to the Thick Client designers).
• Deploy the SmartObject
  • Start the K2 Designr for Visual Studio
  • Open the K2Employee.k2proj project
  • Open the Employee.sodx SmartObject file
  • Exclude the K2 Process file (EmployeeProcess.kprx) from the build
  • Click on the Deploy button and follow the full deploy sequence
• Reset the Visual Studio K2 ToolBox in order to load the two new custom SmartWizards
  • Select the EmployeeProcess.kprx file and include it in the build
  • Open the EmployeeProcess.kprx file (opening this file will open the K2 ToolBox)
  • Right click on the ToolBox and select the reset option

The sample project is now ready to be used to demonstrate the two custom SmartWizard definitions.

Create Employee SmartWizard

The function of this custom SmartWizard is to add user data (ID, Name, and Email Address) to the Employee SmartObject.

This sample code demonstrates the use of the Runtime action to run the CreateEmployee event, which is mapped to the Create_Employee SmartObjectMapping data object that performs the Create SmartObject Method for the Employee SmartObject. It also demonstrates the use of the Label and K2Textbox controls, with a Validation event being called by the third K2Textbox object. Finally, a Reference Item is created using the input data so that this information can be easily used by another wizard.

Update Employee SmartWizard

The function of this SmartWizard is to update the data of the Employee SmartObject.

This custom SmartWizard will demonstrate the use of a K2ReferenceList for a drop down control that calls the data from the Reference created in the first SmartWizard (using the SmartBox ServiceType), the Reference definition to load that data, various Label, K2Textbox, and Checkbox controls, and finally a Runtime event to update the SmartObject data when the workflow step runs.

Demo Workflow Project

The Workflow Process file contains a demonstration of the two custom SmartWizards in use. The following screen shots present a view of the process being created:

This screen shows the Create Employee WizardPage with the four Label and associated K2Textbox controls. Clicking on the Finish button will created the Reference item that the second SmartWizard will use.

The second screen shows the Update Employee SmartWizard, with the Reference data loaded and the various other controls filled in.