About URL Syntax

You can apply one or more parameters to the URL foundation. In either case, the syntax of the URL differs.

Multiroute URLs

You can add multiple routes to a URL. A URL in GE Digital APMregularly consists of the URL foundation, and the structure #<X>;rte=home;rte=assets/hierarchy;, where <X> is a number corresponding to the active route (i.e., the tab you are using).

• rte=<route>: ...where <route> is the location in GE Digital APM that will be accessed by the URL. Generally, routes will consist of one or more elements. These are found in the documentation for each work process. For example, rte=tm/asset/2509505.

A complete URL with multiple routes might look like the following: http://<ApplicationServer>/meridium/index.html#2;rte=home;rte=assets/hierarchy;rte=tm/asset/2509505. In this example, because 2 follows #, the tm/asset/2509505 route is displayed as the active tab. Note again that each parameter is separated by a semicolon.

Single Route URLs

In the case of a single route, you only need to specify #<route> following the URL foundation, where <route> is the location in GE Digital APM that will be accessed by the URL. For example, the URL http://<ApplicationServer>/meridium/index.html#catalog, where the route is catalog, accesses the Catalog page. Generally, routes will consist of one or more elements. These are found in the documentation for each work process.

GE Digital APM automatically reformats URLs that use a single parameter, so the URL you enter will not be identical to the URL that appears in the address bar. For example, http://<ApplicationServer>/meridium/index.html#query will be automatically reformatted to http://<ApplicationServer>/meridium/index.html#2;rte=home;rte=assets/hierarchy;rte=query. In this example, because 2 is automatically set to follow #, the query route is displayed as the active tab.

Invalid URLs

If you enter an invalid route after the URL foundation, the URL Not Supported page appears as the active tab.

Each URL route may accept one or more elements, which further define the feature or item that will be accessed by the URL. Sometimes route itself is associated with a specific location, and no additional information is needed to open the feature. For example, the route #query will open the Query page. No additional information is needed.

Elements are usually optional. This means that it is possible to provide additional information to access a specific location, but that if specific information is not provided, then the system will access the root location without generating errors.

When a URL contains multiple elements, the elements are separated by a / (forward slash). For example, tm/asset/2509505, where tm is the route, and asset and 2509505 are elements.

Using Keys as Elements

Every stored GE Digital APM object has an internal system-assigned numeric key that identifies the item within the system. For example, when you create a chart and save it to the Catalog, GE Digital APM assigns a key to that chart. Many URL elements accept keys as values to let you access specific items. For example, if a dataset is assigned the key 1002527, the following internal URL would open that dataset:

• #dataset/1002527

Different URLs support the use of different keys, depending on what they are designed to access. The following keys are used most commonly in URLs:

• Family Key (FMLY_KEY): The numeric value assigned to an entity or relationship family.
• Entity Key (ENTY_KEY): The numeric value assigned to a specific record.
• Relationship Definition Key (RLDF_KEY): The numeric value assigned to a relationship definition.