Note: This documentation gets updated only when necessary, as the product is in sustained mode. For product updates see the Release Notes.

SmartObject Event Wizard

What does the SmartObject Event do?

The SmartObject Event wizard adds information contained within a SmartObject to a new or existing data field or XML field for use in the workflow. When configuring the SmartObject Event Wizard, use the SmartObject browser to select the SmartObject that is used by the event.

Why use the SmartObject Event Wizard?

The SmartObject Event wizard makes SmartObject data available for reuse throughout the workflow.

Considerations when using the SmartObject Event Wizard

The SmartObject fields displayed in the Input Mapping and Return Mapping wizard pages are not refreshed automatically during the process. When SmartObject fields are changed or updated, the SmartObject fields need to be updated manually by editing the workflow and selecting Refresh.

Note: The SmartObject Event wizard can only be used to execute a single method. Multiple methods are not supported.

Prerequisites

To use the SmartObject Event wizard, you must have a SmartObject available and listed in the SmartObject browser, locally or on the K2 server. The SmartObject does not need to be deployed yet.

Using the SmartObject Event Wizard

Once you configure the event, you can modify it by clicking on the wizard icon within the workflow activity window.

Event Name and SmartObject Method

The Event Name and SmartObject Method page allows you to select a SmartObject as well as provide the event with a name.

A SmartObject method needs to be selected in the SmartObject Method text box and only one method is supported at a time.

Field	Description	Sample Value
Event Name	Provides the name for the new SmartObject event	Specify a name for the SmartObject event in the text box
SmartObject Method	Provides the SmartObject method that needs to be used in the SmartObject Event. The single method selected, will perform a single action on the SmartObject, i.e. load one entry or save one entry.	Select the required SmartObject method by clicking on the ellipse button and browsing to it

Input Mapping

The Input Mapping page maps SmartObject input fields to data fields. Both input properties and parameters can be required or optional. They are grouped together on this page. Parameters are listed first, then properties.

Note: Repeating XML cannot be used on this page.

Field	Description
Name	Displays the input fields by name
Type	Displays the input field type. This can be a property or parameter of the SmartObject
Data Type	Displays the data type of the SmartObject property or parameter
Required	Displays whether the value is required for the method
Value	Displays the value of the SmartObject property or parameter
Assign	Click Assign to manually map a property or parameter to a value, another SmartObject property, parameter, data field, or XML field
Clear	Removes the selected field's configured mapping
Clear All	Removes all the configured mappings
Refresh	Refreshes the SmartObject fields
Auto Map	Automatically maps existing SmartObject fields to existing data or XML fields. You could instead use the Automatically Create option to create the fields automatically Map Only - Creates a mapping between any properties or parameters that have the same name, for example Id and ID Map and Create - Same as above, but also creates fields for those that don't already exist

Tip: Drag data and XML fields from the context browser to the relevant SmartObject value to assign the value.

Return Mapping

The return properties for the SmartObject are listed in the Return Mapping page. These mappings are used to store any return values from the SmartObject method. The return property can be mapped to a Data field, XML field or another SmartObject property.

Repeating XML is supported on this page.

Field	Description	Sample Value
Assign	Click Assign to manually map a property to a value, another SmartObject property, data field, or XML field	Select a field and click Assign
Clear	Removes the selected field's mapping	Click on the configured setting and select this option
Clear All	Removes all the configured mappings	To remove all the configured document settings, select this option
Refresh	Refreshes the SmartObject fields	Click Refresh to refresh the SmartObject fields
Auto Map	Automatically maps existing SmartObject fields to existing data or XML fields. You could instead use the Automatically Create option to create the fields automatically Map Only - Creates a mapping between any properties or parameters that have the same name, for example Id and ID Map and Create - Same as above, but also creates fields for those that don't already exist	Click the relevant option
Property Name	Displays the Input properties by name
Property Type	Displays the SmartObject property type
Required	Displays whether the value is required
Value	Displays the value of the SmartObject property

Tip: Drag data and XML fields from the context browser to the relevant SmartObject value to assign the value.

Assign Mapping

You use the Assign Mapping dialog to assign values to input and return mappings. The information displayed on the Assign Mapping dialog is context-sensitive and displays fields relevant to the selections made in the input and return mapping pages.

Field	Description	Sample Value
Value	Assigns a value to the specified mapping	Either type in a value, or click on the ellipse button to select a data or XML field as a value