If you have a comment on this topic, contact Aptify Documentation. If you want to return to the Aptify Community Site, please click here.

Adding a Code-Based Wizard to Aptify

Owned by admin (Deactivated)
Jan 30, 2018

After you have built the code-based wizard's assembly file, you need to add it to Aptify as an entity action. Follow these steps:

  1. Open the Entities record for the service to which you want to add the wizard.
  2. Click the Configuration > Actions tab.
  3. Open a new Actions sub-type record.
  4. Enter a name for the wizard in the Name field.
    • This is the tool tip text that will appear when a user places the mouse cursor over the wizard's icon.
       
  5. Enter the wizard's .NET assembly name in the Action Assembly field.
  6. Enter the class within the .NET assembly that corresponds to the wizard's form in the Action Class field.
  7. Click the Object Repository icon in the Action Object field to open the Select Object Repository Object dialog.
  8. Browse to the Object Package for your organization where you want to store the wizard (see Best Practices When Configuring Object Repository Objects for information on recommended naming and storing conventions).
  9. Double-click the .NET Assembly (Private Deployment) Object Type.

     Select .NET Assembly Object Type
  10. Click the New button and browse to the location of the object's file.
  11. Select the object you just added and click OK to return to the Actions form. (The Object Name field is automatically populated with the Object Package.Object Name of the object you selected.) 

     Completed Entity Actions Record
  12. Enter a description for the wizard (optional).
  13. Enter or select the Object Repository location for the icon that you want to display for this wizard in the Icon field.
    • This is the icon that the system will use for this wizard. For example, this icon will appear in the service's view toolbar. A user will click this icon to launch the wizard.
    • If you leave this field blank, the system will use the default wizard icon.
    • Note that the Icon Small field is currently not implemented and is reserved for future use.
       
  14. Select or clear the Run From check boxes as necessary.

    • If you want the wizard to appear in the service toolbar (that is, the toolbar that appears in the main display window when a service is selected in the Folder List), select the Run From Entity Browser check box. If you do not want the wizard to appear in the service toolbar, clear this check box.

      This option is suitable for data entry wizards like the Check-Out and Check-In wizards. However, any batch processing wizard that pulls data from a view should have the Run From Entity Browser check box cleared.

    • If you have configured the wizard to support temporary views and want it to appear in the view toolbar for a temporary list view, select the Run From Temporary View check box. If you do not want the wizard to appear for temporary views, clear this check box.

      A temporary view is a list view that is constructed outside of the standard Views entity. This includes: 

      Entity list views that appear under a related service tab of form. One example is the Templates tab on the Form Template Parts form that displays the templates to which the part applies. 

      Dashboard entity list views that are constructed using a custom SQL statement rather than an existing system view.

    • If you have configured the wizard to support prompt views (see Supporting Prompt Views) and you want it to appear in the view toolbar for a prompt list view, select the Run From Prompted View check box. If you do not want the wizard to appear for prompt views, clear this check box.
       
  15. If you are not ready to enable the wizard yet, set the Status to Inactive and users will not be able to access it. If the wizard is ready for deployment, leave the Status as Active.
  16. Configure the security settings to determine who can run the wizard.
    • If the wizard should be available for all users, leave the Allow Everyone to Run check box cleared.
    • If you want to limit access to a particular set of users, clear the Allow Everyone to Run check box. This enables the Group Permissions and User Permissions tabs. Then, specify the Groups and/or Users who should have access to the wizard on the appropriate tab.
    • Note that the sa user has a default User Permissions record for all wizards.
       
  17. Click OK.
  18. Save and Close the Entities record.
  19. Close and reopen the Aptify client.
  20. Open a view of the service to which you added the wizard and confirm that an icon appears for the wizard.
  21. Click the icon and confirm that the wizard launches successfully.

Copyright © 2014-2019 Aptify - Confidential and Proprietary