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.

Attachments Tab

This tab stores any files relevant to this record.

Comments Tab

This tab stores any optional comments concerning this record.

Group Permissions Tab

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.

Pages Tab

This tab displays information about the pages that comprise the wizard. Each Page corresponds to a Pages record. See About the Wizard Pages Form for details.

Processor Tab

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.

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.

Cancel Mode

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

• 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 the Aptify web 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.

Note that any new rendering object should sub-class the base Aptify GenericWizardForm class. See the Aptify Software Development Kit (SDK) for information on this class

Windows Object

This field specifies the Object Repository location of a wizard-specific or organization-specific user interface design for the wizard when using the Aptify Windows application.

Windows Class

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

Windows Assembly

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

Web Object

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.

Web Class

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

Web Assembly

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

Scope Tab

Scope

Determines from where users can access the wizard. The options are:

• Global: The wizard should be available from a button on any dashboard.
• Application: The wizard should only be available from a button on a dashboard linked to the specified application.
• Entity: The wizard should be available from the specified entity's view toolbar.

Note that wizards that are based on a user's view selection must be entity-scoped.

Run From Entity Browser

When selected, the wizard can be accessed from a service's toolbar (that is, the toolbar that appears in the main display window when a service is selected). Note that any wizard that pulls data from a view should not have this option cleared.

Run From Temporary View

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

Run From Prompted View

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.

Show In Task Bar

When selected, the wizard is added as an item in the Windows task bar at the bottom of the user's screen. This is only applicable when a user runs the Windows Desktop client.

Resizable

When selected, the user can resize the wizard dialog.

Height

When greater than 0, this field specifies the height of the wizard dialog in pixels. However, if left at 0, the recommended and default value, the system automatically calculates the height by choosing the maximum height required to properly display the tallest page within the wizard.

Width

When greater than 0, this field specifies the width of the wizard dialog in pixels. However, if left at 0, the default value, the system automatically calculates the width by choosing the maximum width required to properly display the widest page within the wizard.

Show Minimize Button

When selected, the minimize button appears in the upper right corner of the wizard dialog and the user can minimize the wizard.

Show Maximize Button

When selected, the maximize button appears in the upper right corner of the wizard dialog and the user can maximize the wizard so it fills the entire screen.

Show Step List

When selected, the wizard includes a step list on its left side that indicates each step in the wizard (it displays the name of each page specified on the wizard's Pages tab). Within the step list, the current step is displayed in bold.

Allow Modify Records

When selected, the wizard can modify existing records (as well as create new records if applicable).

Show First Step to Select Record

This option is only available when Allow Modify Records is selected. When selected, the wizard displays a link box dialog after the user launches the wizard for the first time. The link box is linked to the wizard's target entity. The user can then enter the existing record to modify. Note that if a user selects a record from a view before launching the wizard, then the wizard pre-populates the link box with that record, assuming the wizard is launched from the target entity's view toolbar.

If this option is cleared and Allow Modify Records is selected, the user selects a record from the list view. This record's information is then passed into the wizard. However, the wizard will display the link box for subsequent runs of the wizard (if Ask User To Repeat? is enabled).

Image Display Mode

Determines when the specified Wizard Image is displayed within the wizard. When applicable, the wizard image appears in the upper left corner of the wizard dialog. The options are All Pages (on every page), First Page Only (only on first page), and None (do not display a wizard image).

Wizard Image

The Object Repository location of the image to display in the wizard. For best results, a typical wizard image should be around 125 pixels wide by 150 pixels tall.

Show Icon

When selected, the specified icon appears in the caption in the wizard dialog's upper left hand corner (to the left of the wizard name). If not specified, the wizard uses the default Aptify A as its icon. The text box to the right of the check box identifies the Object Repository location of the icon to display. Note that even if Show Icon is cleared, Aptify will use the specified image as the icon for the wizard when it is available on a view toolbar.

Ask User To Repeat?

When selected, the wizard asks the user if he or she wants to rerun the wizard again after completing an iteration.

Note that for wizards that have the Allow Modify Records option enabled, the wizard displays a link box to let the user specify another record in the Target Entity to update (or create a new record by leaving the link box blank).

Show Cancel

When selected, the Cancel button appears in the wizard's button bar across the bottom of the dialog.

Show Finish

When selected, the Finish button appears in the wizard's button bar across the bottom of the dialog.

Show Back

When selected, the Back button appears in the wizard's button bar across the bottom of the dialog.

Show Next

When selected, the Next button appears in the wizard's button bar across the bottom of the dialog.

Allow Everyone to Run

If you want this wizard to be available to all users, select the Allow Everyone to Run option. If the wizard should only be available to a sub-set of users, clear the Allow Everyone to Run option and specify the appropriate Groups and/or Users on the Group Permissions and User Permissions tabs.

Status

When set to Active, the wizard is available for the users who have permission to it. When set to Inactive, the wizard is unavailable for all users.

User Permissions Tab

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.