Cisco Prime Network Customization Guide, 5.1

ID / OID

Examples:

For network elements:

For tickets:

The OID contains the context and unique name of the external launch point.

It defines the IMO type on which the external launch point is defined, for example:

• IManagedElement—Network elements.
• IEvent (or any other subtype, like ISyslogAlarm)—Events and their subtypes.
• ITicket—Tickets.
• ITopologicalLink—Links.

FilterParameters / String

Example:

Enables you to apply a filter to narrow down the instances on which the external launch point will be available. For example, you can use this filter if you want only IMOs with specific properties to have the external launch point, rather than all IMOs of the specified type.

You can use any of the IMO’s properties in the filter.

The filter property value can be:

• Numbers—a pipe-delimited list of numbers and ranges, such as: "1|4-6|8"
• Strings and other scalar properties—a Java regular expression ( reg-exp) that is checked for containment, i.e., a full match is not required. Scalar properties are converted to string values, and null values are converted to empty strings ("").
• Enum properties—either the enum number or string value.
• Arrays—value is one of the above, with the option to specify whether any (at least one) or all of the items must match the filter value.

Multiple filter criteria are also supported. The match any or match all option should include the logical condition between the criteria elements.

ExternalBatchToExecute / String

Examples:

• Specifying a batch file located on the client machine:

• Specifying a batch file located on the gateway machine, this batch file will be automatically downloaded from the gateway machine:

• Specifying a URL:

• Passing an environment variable:

Defines the details of the executable steps or batch file to be invoked. You:

• Must specify the parameters as an array when using a script.
• Cannot pass any parameters in the URL. You must use batch files or LineToExecute to pass the parameters.
• Can include more commands as part of a batch file.
• Can include an environment variable when invoking the batch file.

To define a string that represents the URL or script which is executed along with its parameters, use the LinetoExecute property.

LineToExecute / String

Example:

Launching a URL with the Gateway IP, network element IP, and logged-in username parameters, using / as delimiter:

Example:

Launching a URL from the soft property from the interface of the supported IMO:

Defines a string that represents the URL or script which is executed along with its parameters.

The syntax includes:

• $—Used when you specify an IMO property definition.
• ~—Used when you specify a Soft Property definition.
• $number$—The parameter whose index is a number.
• $USERNAME$—The logged-in username.
• $GW$ —The Prime Network gateway IP address.

Note The & character should be written as & when used inside a BQL command.

You can define the launch point of the external application from a soft property of the supported IMO by using the OID of the supported IMO.

Note The soft property need to be already defined in the IMO of the supported network element.

MenuCaption / String

Example:

<MenuCaption type="String">ping</MenuCaption>

The wording of the right-click menu option to be used for the external launch.

Note Unless you want to create a mnemonic, do not use an underscore (_) character at the beginning of the string. For example, if _Scripts is specified as the menu caption, the result will be having the menu caption as Scripts, where S is the mnemonic.

MenuPath / String

Example:

<MenuPath type="String">external launch demo</MenuPath>

The menu path to be followed to get to the external launch point. You can have a sub-menu separated by a forward slash (/).

Parameters / IMObjects_Array

All external launch parameters must be passed in an array. See management.IExternalLaunchParameter.

Role / String

Example:

Defines the minimum user role required to use the launch point—administrator, configurator, and so on. If this is not defined, all users will have access to the launch point.

Selection Limit / Int

Example:

Defines the number of items that must be selected for the launch point to be displayed. For example, if the selection limit is 2, the right-click menu option will not appear if only one item is selected, or if three items are selected. It will only appear if two items are selected.

ID / OID

{[ExternalLaunchParameter(Index=1)]}

Index value defines the order in which the parameters will be passed to the script.

IMOType / String

Example 1:

Example 2:

Defines the IMO context type. You can also leave this field empty.

You can pass the parameter not only from the IMO and its parent on which you set the menu but also from the IMO tree up to IManagedElement. It can be the parent or the higher level IMO depending on the IMO that you have selected for your menu.

PropertyName / String

Example 1:

Example 2:

<PropertyName type="String">LatestState</PropertyName>

Example 3 (retrieving properties of a contained IMO):

<PropertyName type="String">ObjectId.Key</PropertyName>

Example 4 (retrieving properties not available at time of execution):

<PropertyName type="String">Port#PortDescription</PropertyName>

Defines the property or soft property name within the IMO context type. This value is used as an argument when invoking the application.

You can also have any constant value.

If the property value is another IMO, you can retrieve the properties of this IMO using a dot notation (see Example 3).

If the property value is an OID, you can retrieve the properties of the referenced IMO using the # notation (see Example 4).

RunSingleCommand / Boolean

Example:

The script will be called once, with the required properties of all selected IMOs passed at the same time.

If the value is set to true, a single script will be run for all the selected objects. If set to false, a script will be run for each of the selected objects.

ReplaceNullWith / String

Example:

If you want a null value not to be ignored or replaced with an empty string, you can use the ReplaceNullWith string. This is optional.

In the example, the null value will be replaced by N/A. See Defining Soft Property Parameters for a BQL Script for more information on the usage of this property.