Skip to main content
System StatusContact Support
VersionOne Community

Deploy UI Javascript Reference

This feature is available in Ultimate edition only.

editions-u.png

Overview

One of the 'libs' available in a Layout is maestro. This library includes helper functions for interacting with the Deploy API.

The Deploy UI exposes certain components and features via HTML5 Cross Window Messaging.

The features in the maestro lib are dependent on the Canvas being executed inside the Deploy UI. As such, these features will work on the reports embedded in Deploy, but not in Canvas applications hosted inside another UI.

Since features are exposed via messaging between the Canvas and whatever page hosts it, the scope of these features is of course limited to the containing page.

References

maestro.addDetailItem

Several pages in the Deploy UI have a Details section. This section of the page has additional screen real estate, and can be augmented by any of the Canvas items on the page via this helper function.

maestro.addDetailItem(label, value);

maestro.runAction

The Deploy UI has a built-in dialog for kicking off an Action, and includes a feature for prompting the user for required arguments. This function will raise the Run Action dialog for the specified Action.

maestro.runAction(args);

The runAction command requires an args object in the following format. For example, to raise the Run Action dialog for the 'Backup' Action:

maestro.runAction( { "action_name" : "Backup" } );

The Run Action dialog supports a few options to prefill, lock or hide certain parameters.

  • set_params - this argument will pass a list of parameter Names and desired Values.

  • hide_params - a list of parameters to hide on the dialog.

  • lock_params - a list of parameters to lock, preventing user entry, but are still visible.

For example, to display the Run Action dialog, setting a parameter, hiding another and locking a third:

var args = {};
args.action_name = "Backup";
args.set_params = [{
        "name" : "dbname",
        "values" : ["mydb"]
    }];
args.hide_params = ["parameter_to_hide"];
args.lock_params = ["dbname", "some_other_parameter"];

maestro.runAction(args);

maestro.runSequence

The Deploy UI has a built-in dialog for kicking off an Sequence, and includes a feature for prompting the user for required arguments. This function will raise the Run Sequence dialog for the specified Sequence.

maestro.runSequence(args);

The runSequence command requires an args object in the following format. For example, to raise the Run Sequence dialog for the 'Terminate' Sequence:

maestro.runSequence( { "sequence" : "Terminate" } );

The Run Sequence dialog supports a few options to prefill, lock or hide certain parameters.

runSequence supports the same options as the runAction command.

  • Was this article helpful?