This service stores the properties for metadata wizards in Aptify. See Administering Metadata Wizards for details.

Top Area

Name (Required)

The name of the wizard. This also appears in the caption for the wizard dialog.

Name Culture String

If using localization, this identifies the Culture String used to display the wizard's name to localized users. See Working with Culture Strings for details.

Description

A description of the wizard.

Description Culture String

If using localization, this identifies the Culture String that can be used to display the wizard's description to localized users. See Working with Culture Strings for details.

Target Entity (Required)

Identifies the type of record the wizard can create or modify. For example, if the Target Entity is Persons, then the wizard is designed to create and/or modify Persons records.

...

Identifies the Groups that can access this wizard when the Allow Everyone to Run option is cleared.

Help Tab

This tab stores fields related to the availability of Help information concerning the wizard.

Show Help

When selected, a Help button appears in the button bar along the bottom of the wizard. If a user clicks this button, the system opens the Help file specified in the Help Object field at the location specified by the Help URL field.

Help Object

This field specifies the Object Repository location of a Microsoft CHM Help file that contains information about this entity. This field is used in conjunction with Help URL to specify a particular page in an online help file that should open when a user clicks the Help button on this entity's form.

Help URL

This field specifies an HTML file in the Help Object that corresponds to information about this wizard. If a user clicks the Help button on the wizard, Aptify will open the Help Object at the specified location.

...

This tab specifies the actions the wizard should perform when a user clicks Finish or Cancel. It also stores the reference to any organization-specific logic added to modify the standard wizard execution behavior.

Image RemovedImage Added

Finish Mode

Specifies what action to take when a user clicks the Finish button on the wizard. The available options are:

• Save Entity: Save the record that the user is creating or updating via this wizard.
  
  
• Run Process Flow: Run the specified Finish Process Flow. When this step is selected, the new or existing record loaded into the wizard is not saved before running the process flow. In this case, the process flow will perform a save operation to commit information to the database (based on the wizard's design).
  • Note that if you select this option, the specified process flow must save the record stored in the wizard's GE Object (to successfully create or update the record). For example, you could use the Run Process Flow option to execute a process flow that creates a sub-type record for the wizard's record (via a standard Aptify sub-type CRUD component) and then saves the top level record as part of that operation.
  • If you select the Run Process Flow option, the final step of the Process Flow should close the wizard using a Set Wizard Result step. The wizard will not close automatically.
    
    
• Save and Run Process Flow: Save the record that user is creating or updating via this wizard first and then run the specified Finish Process Flow.

Finish Process Flow

If Finish Mode is set to Run Process Flow or Save and Run Process Flow, this field specifies the process flow to execute when a user clicks the Finish button on the wizard. The wizard can pass its GE object, which contains all user inputs, to the process flow as an Input Property called GEObject. This field links to the Process Flows service.

...

• Close Form: Close the wizard without performing any additional actions.
• Run Process Flow: Run the specified Cancel Process Flow. When this step is selected, the process flow runs before the wizard is closed.
• Close Form and Run Process Flow: Close the wizard and then run the specified Cancel Process Flow.

Cancel Process Flow

If Cancel Mode is set to Run Process Flow or Close Form and Run Process Flow, this field specifies the process flow to execute when a user clicks the Finish button on the wizard. The wizard can pass its GE object, which contains all user inputs up to the point when it was cancelled, to the process flow as an Input Property called GEObject. This field links to the Process Flows service.

Processor Sub-Class Area

Object

This field specifies the Object Repository location of a wizard-specific or organization-specific processor. Aptify includes a standard processor that provides the business logic for the wizard (this logic applies regardless of whether the wizard is run from the Windows application or from the Aptify Web Accessweb interface). If necessary, a developer can implement his or her own processor object to change any of this logic. Note that any new processor object should be sub-class of the base AptifyWizardProcessor object. See the Aptify Software Development Kit (SDK) for information on this object.

...

Class

This field specifies the fully qualified namespace/class name that provides the processor logic contained in the Processor Object.

...

Assembly

This field specifies the name of the Processor Object's assembly.

Start Mode

This field specifies what action to take when a user clicks the Cancel button on the wizard. The available options are:

• Start Form: Start the wizard without performing any additional actions.
• Run Process Flow: Run the specified Start Process Flow. When this step is selected, the process flow runs before the wizard is started.
• Start Form and Run Process Flow: Start the wizard and then run the specified Start Process Flow.

Start Process Flow

If Start Mode is set to Run Process Flow or Start Form and Run Process Flow, this field specifies the process flow to execute when a user clicks the Start button on the wizard. The wizard can pass its GE object, which contains all user inputs up to the point when it was started, to the process flow as an Input Property called GEObject. This field links to the Process Flows service.

Rendering Tab

Aptify provides a standard user interface model for rendering metadata wizards within Aptify's Windows application and Aptify Web Access. This tab also stores the reference to any organization-specific rendering behavior added to modify the standard wizard appearance either within the Windows application or within Aptify Web Access.

...

This field specifies the Object Repository location of a wizard-specific or - organization-specific user interface design for the wizard when using the Aptify Web Access. Note that this field is reserved for future use. (As of the release of Aptify 4.5, Aptify Web Access does not support wizards.)

Web Class

This field specifies the fully qualified namespace/class name that provides the logic contained in the Web rendering object.

...

When selected, the wizard can be accessed from the view toolbar of a prompted list view.

Application

When Scope is set to Application, this field specifies the application from whose dashboard this wizard can be added as button. In other words, this wizard can only be added as a dashboard button for dashboards linked to the specified application. This field links to the Applications service.

Entity

When Scope is set to Entity, this field specifies the service from whose list view toolbar this wizard is available. Typically, this entity is the same as the wizard's Target Entity but it can be different if applicable. 

User Experience Tab

Modal

When selected, the wizard is modal and is displayed at the front of the application (cannot be sent behind another window). This is suitable if you believe a user needs to complete the wizard once launched.

...

Identifies the Users that can access this wizard when the Allow Everyone to Run option is cleared. The sa user has a User Permissions record by default.

Wizards UI Platforms Tab

This tab, added in Aptify 5.5.1, displays a list of the UI platforms identified using the UI Platforms form. See About the UI Platforms Form for details.