Structure of the URLs

The paths in the Automic Web Interface URLs provide detailed information about the content of their destination pages. Because URLs identify exactly what you see, AWI can provide proper browser history, you can bookmark the URLs, copy and paste them in different browser windows, share them with your coworkers, and so forth. It is important that you understand the structure of the URLs. When you share an URL, you or your coworker can change it. Some parts of the URL are mandatory, though. If you manipulate any of the mandatory parts, the view cannot be displayed.

The minimum path necessary to open a view in AWI has the following structure:

http(s)://[AWI Base URL]#[FRAGMENT]

[AWI Base URL]

The base URL consists of the hostname and the application name where AWI is installed.

Example: localhost/awi
[FRAGMENT]

The fragment is the URL structure that contains the parameters that allow deep linking within AWI. The URL structure of a fragment consists of three parts:

[Automation Engine connection information]@[PATH]&[PARAMETERS]
- [Automation Engine connection information]
  
  Mandatory. It defines the Automation Engine system name and the Client. This is a static URL element per system and Client.
  
  If you copy the URL and paste it to a different browser window, you do not have to log in again. The login information is taken from this element in the URL. This is especially helpful when you are working with many clients because it ensures that you are using the correct system and the correct client.
  
  Example:
  
  AE10LLV:99
  
  AE10LLV is the name of the Automation Engine system and 99 is the Client.
- [PATH]
  
  The path defines the perspective and the view within the perspective.
  
  Example:
  
  pa/explorer
  
  pa stands for Process Assembly and explorer for the Explorer list.
- [PARAMETERS]
  
  Additional parameters that further define settings (applied filters, for example) or that navigate to a specific location within a view.
  
  Example:
  
  folder=5310054&item=6482244
  
  item indicates the object located in the folder.

Examples

The following URL examples cover all view types in AWI. Optional parameters means that these parameters are not necessary to successfully open a view, but that they provide additional navigation details.

Explorer view

http(s)://localhost/awi/#AE10LLV:0099@pa/explorer&folder=1945701&item=7368576

Optional parameters: folder, item parameters. They let you select a specific object.

Object view

http(s)://localhost/awi/#AE10LLV:0099@pa/view/JOBS.WIN.TEST

Optional parameters: id, src, type, editable, navigation

Use the navigation parameter to define a specific area in a view. For example, navigation=sheet.attributes points to the Attributes page in the object definition.

Monitor View

http(s)://localhost/awi/#AE10LLV:0099@pm/monitor/JOBP.UX-321.WEB.NOTIFICATION.GENERATOR&id=58836086&src=eh

id refers to the runID of the monitor that you want to link to.

Optional parameters: type, editable, navigation

Report View

http(s)://localhost/awi/#AE10LLV:0099@pm/report/JOBP.WEB.NOTIFICATION&idnr=8160679&src=eh

Optional parameters: Filter parameters (if set)

The idnr parameter sets the runID for which you want to load the report.

Advanced Search

http(s)://localhost/awi/#AE10LLV:0099@pa/searchresult&object_name=JOBS.WIN.TEST

Optional parameters: Filter parameters (if set). Each set filter in the advanced search adds a parameter to the URL. Use these parameters to predefine a filter using the fragments.

Request View

http(s)://localhost/awi/#AE10LLV:0099@rv&runId=58819075

Optional parameters: runID

With the runID parameter you can select active requests (requests that are displayed in the left pane in the Requests view. You can set one or more runIDs. If you want to select more than one using the fragment, separate the runIDs with commas (runId=58819078,58819075).

Search for Use View

http(s)://localhost/awi/#AE10LLV:0099@pa/usage&usage=JOBS.WIN.TEST

The parameter (usage&usage=JOBS.WIN.TEST in our example) indicates the objecjt for which you have started the search for use.

Executions

http(s)://localhost/awi/#AE10LLV:0099@pm/executions/EXECUTION/JOBP.WEB.NOTIFICATION

Optional parameters: id, src, type

Activator Executions

http(s)://localhost/awi/#AE10LLV:0099@pm/executions/ACTIVATOR_EXECUTION/CALL.MAIL&id=58819078&src=eh

Optional parameters: id, src, type

The id parameter is the runID of the task for which you want to get the activator.

Child Task Executions

http(s)://localhost/awi/#AE10LLV:0099@pm/executions/CHILD_EXECUTION/JOBP.WEB.NOTIFICATION&id=58836086&src=eh

Optional parameters: id, src, type

The id parameter is the runID of the task for which you want to get the child tasks.

Parent Task Executions

http(s)://localhost/awi/#AE10LLV:0099@pm/executions/PARENT_EXECUTION/CALL.MAIL&id=58819078&src=eh

Optional parameters: id, src, type

The id parameter is the runID of the task for which you want to get the parent task.