Accessing topologies via direct-launch URL string

You view specific topologies using a direct-launch URL by setting the topology navigation settings in the URL parameters to directly load a specific topology configuration within DASH. This gives you and others quick access to specific views. You can obtain a direct-launch URL string from a defined topology in Topology Viewer, or create it manually.

Before you begin

To obtain a direct-launch URL from the Topology Viewer accessed through DASH, you must have the appropriate DASH user roles. You must also complete the process of visualizing a topology. To share a direct-launch URL with others, they must be DASH users with the appropriate user roles.

Restriction: When launching a direct Netcool Agile Service Manager window in your browser, you must log onto DASH and keep the DASH window open as a separate tab in your browser. If you close the DASH browser tab, your DASH session will expire after the session timeout period, and you will be logged out of Agile Service Manager.

About this task

From version 1.1.9: The URL has changed. From Version 1.1.9 onwards a typical URL starts with the Agile Service Manager core host URL and the tenant ID:

https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer

Example:

https://asm.example.host.com/aiops/cfd95b7e-3bc7-4006-a4a8-a73a79c71255/federated/topology-viewer?resourceId=sl1RQ5NCR_ykgciQCTkFGA&hops=1&layoutType=5&refreshTime=30000

This example includes the resourceId to identify the seed resource, hop for the number of hops from the seed to be included in the topology, layoutType to specify the type of display, and refreshTime to specify how often the view is refreshed. In this case the hop number is set at 'one' (note that the hop type is 'element-to-element', which does not have to be specified as it is the default). The layout type is five, and the refresh time is set at 30000 ms (30 seconds).

Tips:

Supported parameters: For a list of supported parameters, see the following topic: Launch-in-context parameters.
Filtering a topology: By specifying 'type', you can include 'Advanced' resource or relationship filters in your URL (not available for 'Simple' filters).; See the following topic for more information on topology filtering.
Setting conditions for filters: Any filter conditions you set on the Resource management page are maintained in the URL, and can therefore be shared.; See the following topic for more information on setting filter conditions.

Procedure

To obtain a topology URL from Topology Viewer in DASH

Once you have rendered a topology in the Topology Viewer, use the Additional Actions drop-down on the Navigation bar to obtain a direct launch URL string.

To define a URL manually

You can define a URL by editing the parameters, as shown in the following examples.
Empty topology URL
To open the Topology Viewer page directly with no configuration, use this type of URL.
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer
```
Specify seed resource by ID in the URL

To open the page and create a visualization from a specific seed resource by ID, use this format.
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceId=<resource_id>
```
Specify seed resource by name in the URL

To open the page and create a visualization from a specific seed resource by name, use this format.
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>
```
Specify seed resource and hops URL

To open the page and create a visualization from a specific seed resource with a specific number of hops and hop type, use this format.
The hopType parameter is only required if you wish to use the host-to-host (that is, host) hop type (element-to-element is the default).
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>&hops=<hops>&hopType=<host>
```
Specify focus areas for large topologies in the URL

When loaded, this topology view zooms in on the area specified, thus preventing very large topologies from being displayed with potentially too much information on view.
The focusId parameter is required for the topology view to zoom into the area of a given resource.
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceId=<resource_id>&hops=<hop number>&focusId=<resource_id>
```
Specify additional resources to be highlighted in the URL

Specify an array of resource IDs to highlight additional resource in the topology view. These selections override any already selected seed resource.
The selectedIds parameter is required for the topology view to highlight non-seed resources when the topology is loaded.
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceId=<resource_id>&hops=<number>&selectedIds=["<resource_id>" "" …]
```
Specify seed resource, hops and get neighbor expansions URL

To open the page and create a visualization from a specific seed resource with a specific number of hops, as well as resource neighbors, use this format.
This example sets the hop type as element-to-element, and it uses the parameter neighbourRequests, which expects an array of space separated id strings.
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>&hops=<hops>&neighbourRequests=["<resource_id>" "<resource id>" …]
```
Specify search parameter (partial resource name) in the URL
To open the page and create a visualization from a specific resource search value, use this format.
- If a single resource is found that matches the search parameter, the resource is used as a seed and the topology is drawn.
- If more than one resource is found that matches the parameter, the Search Results page is displayed listing possible results, including their names, types and other resource properties.
- If no matches are found, an error message is displayed.
This example searches for a resource by name, and will return results that match the name either fully or partially.
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?search=<name>
```
Load topology using unique ID to set seed
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceUniqueId=<unique id>
```
Load topology using advanced resource filters
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceFilter=["Type1" "Type2"]
```
Load topology using advanced relationship filters
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?relationFilter=["Type1" "Type2"]
```
Show topology at a given time point
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>..<any other configuration>..&time=<unixTimeMilliseconds>
```
Show topology in delta history mode, with 'time' as a reference point and deltaTime as the point to delta against
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>..<any other configuration>..&time=<unixTimeMilliseconds>&deltaTime=<unixTimeMilliseconds>
```
Load topology with side toolbar hidden
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?hideToolbar=<true>
```
Load topology with top search bar hidden
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?hideSearch=<true>
```
Load topology using simple filters in the URL
You can use simple filters to include specific resource or relationship types, or severities.
simpleResourceFilter

https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>..<any other configuration>..&simpleResourceFilter=type1,type2

simpleRelationshipFilter

https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>..<any other configuration>..&simpleRelationshipFilter=type1,type2

simpleSeverityFilter

https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>..<any other configuration>..&simpleSeverityFilter=clear,critical
You can extend the use of these simple filters by activating 'Include mode' for a group using the following parameters:
- includeResourceType
- includeRelationshipType
- includeSeverityType
Examples:
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>..<any other configuration>..&simpleResourceFilter=type1,type2&includeResourceType=true
```
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>..<any other configuration>..&simpleRelationshipFilter=type1,type2&includeRelationshipType=true
```
```
https://<ASM CORE HOST>/aiops/<TENANT ID>/federated/topology-viewer?resourceName=<name>..<any other configuration>..&simpleSeverityFilter=clear,critical&includeSeverityType=true
```

What to do next

Having created direct-launch URL topology visualizations, you can save them for quick access to specific views, or share them with others to provide them with specific, instant information.