Develop > Integrate the OMi UI with other applications > Parameters and parameter values

Parameters and parameter values

Parameters for the URL Launch of the Event Browser contains the parameters available for the URL launch of the Event Browser:

Parameters for the URL Launch of the Event Browser

Parameter

Description

Possible Values

Default Values

activeUpdates

Specifies whether the Event Browser gets updates periodically from the server. Without periodic updates, be aware that you may not get all data into the browser.

One of:

  • true
  • false

true

checkParams

Determines whether unknown URL launch parameters are validated.

If you do not specify the checkParams parameter, unknown parameters (for example, misspelled parameters) are not validated; the Event Browser ignores unknown parameters and opens without error notifications. Known parameters are always validated.

If you set the checkParams parameter to true, the Event Browser validates all parameters and reports unknown parameters as errors.

One of:

  • true
  • false
false

columns

Defines the columns to be displayed in the Event Browser.

One or more of: <Column key> (see Fixed Columns Keys to Define Which Columns are Displayed)

Default set of columns

context

Defines the context of the browser settings. Editing browser settings (for example, visible columns or column widths) when a context is selected, means that the settings are saved under the given context. The next time you open the browser with the same context, the browser settings are restored.

If you do not specify the context parameter, the browser settings are not saved.

Example: context=myOwnContext

Any user-defined string

No default value set

filterID

Filters the events displayed in the Event Browser according to a specified filter.

You can find the ID of an event filter as follows: in the Event Filter Manager, select the filter you are interested in, and click Preview Matching Events. The ID is displayed as part of the URL's query. If the browser you are using does not display the full URL by default, use the Network tab in the browser Developer Tools to view the ID.

<filterID>

No default value set

headerText

Sets a header text for the Event Browser.

Any user-defined string

Event Browser

include_child_cis Launches the Event Browser with events that are related to the given event's related CI and any of its child CIs.

One of:

  • true
  • false
false
preview Hides the filter selection and view selection options in the Event Browser interface, so that filtering cannot be changed after creation.

One of:

  • true
  • false
false
readOnly

Launches the Event Browser in read-only mode.

In read-only mode, most icons, buttons, and menus are hidden to prevent the user from performing actions on an event. Users can show and hide event details, refresh the browser, search events, and open OMi Help.

One of:

  • true
  • false
false

showClosed

Launches the Closed Events Browser configuration when the system starts.

One of:

  • true
  • false

false

showDetails

Launches the Event Browser with embedded event details already open.

One of:

  • true
  • false

false

sortField

Defines the column by which the Event Browser is sorted.

One of: <Column key> (see Fixed Columns Keys to Define Which Columns are Displayed)

timeReceived

sortOrder

Defines the sort order of the column specified by the sortField parameter, in either ascending or descending order.

One of:

  • asc
  • desc

desc

symbol_id

The symbolic CI ID in a view. The symbolic ID is made up of the view root ID 1 followed by the IDs of the given CI's parent CIs. The IDs must be separated with two semicolons (;;).

Example: 1;;decafc0ffeefacedbabef00ddeadbeef;;0019bbcaedc44a2eea884a4110a4c38a

In this example, 1 is the ID of the view root, decafc0ffeefacedbabef00ddeadbeef is the ID of the parent CI, 0019bbcaedc44a2eea884a4110a4c38a the ID of the given CI.

 Symbolic CI ID representing the CI in a view No default value set
viewName

Filter the events displayed in the Event Browser according to a view. Only events related to configuration items included in the specified view appear in the Event Browser.

<viewName> No default value set

Send Help Center feedback