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)://[BASE URL]/[AE CONNECTION]@[PATH]
Example: http(s)://localhost/awi/AUTOMIC/0100@pa/explorer
Additional parameters after the point to a specific item in a view:
http(s)://[BASE URL]/[AE CONNECTION]@[PATH]?[PARAMETERS]
Example: http://awi.0151060333.ap.automic/awi/AUTOMIC/0100@pa/explorer?folder=1000001&item= 1000122
Description of the URL Elements
-
[BASE URL]
Hostname and application where AWI is installed. For example, localhost/awi.
-
[AE CONNECTION]
Automation Engine system name and Client separated by a slash. This element is mandatory and static 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: AUTOMIC/0100, where AUTOMIC is the name of the Automation Engine system and 0100 is the Client.
-
[PATH]
Perspective and view within the perspective. For example, pa/explorer.
-
[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, where item indicates the object located in the folder.
-
pm/schedule_monitor/JSCH.DEMO?item=2 in the Schedule monitor, where item=2 indicates the line that is selected in the list of tasks
-
pm/monitor/AE.UI.JOBP.SIMPLE?id=1010138&src=eh&type=JOBP&editable=true&navigation=default&view=graphical, where id indicates the task runID, view=graphical indicates that the monitor is opened in the graphical view, and so on
-
Examples
The following table provides URL examples that cover most view types in AWI. In these examples, the base URL and the AE connection are always the same (http(s)://localhost/awi/AUTOMIC_0100). They are not included in the table.
Sample URL: http(s)://localhost/awi/AUTOMIC/0100@pa/explorer?folder=1001001&item=5533516
View | @[PATH] | ?[PARAMETERS] | Comment |
---|---|---|---|
Explorer | pa/explorer | ?folder=1001001&item=5533516 | The folder and item parameters open a specific object in a folder |
Object | pa/view/JOBP.DEMO | ?id=7314443&src=oh&type=JOBP&editable=true&navigation=sheet.attributes |
JOBP.DEMO is the object name. The navigation parameter points to a specific page in the object definition. For example, navigation=sheet.attributes opens the Attributes page. |
Workflow monitor | pm/monitor/JOBP.DEMO | ?id=9511034 | 9511034 is the runID. It lets you open the monitor of a specific execution. |
Schedule monitor | pm/schedule_monitor/JSCH.DEMO?item=2 | item=2 | Schedule monitor where the second line is selected. |
Report | pm/report/JOBP.DEMO | ?idnr=8160679&src=eh | idnr sets the runID for which you want to load the report |
Advanced search | pa/searchresult | ?object_name=JOBP.DEMO | Each filter that is set in the advanced search adds a parameter to the URL. Use these parameters to define filters using the fragments. |
Requests | rv | ?runId=58971326 | runID selects a specific request in the Requests view. You can enter more than one runIDs here. Example: runId=58819078,58819075 |
Search for use | pa/usage | ?usage=JOBP.DEMO | usage defines the object where you start the search for use function |
Executions | pm/executions/EXECUTION/JOBP.DEMO | ?id=9511034&src=oh&type=JOBP | id indicates the runID of the task for which you want to access the list of executions |
Activator executions | pm/executions/ACTIVATOR_EXECUTION/JOBP.DEMO | ?id=58971387&src=eh&type=JOBP | id indicates the runID of the task for which you want to access the list of activator executions |
Child task executions | pm/executions/CHILD_EXECUTION/JOBP.DEMO | ?id=58974262&src=eh&type=JOBP | id indicates the runID of the task for which you want to access the list of child task executions |
Parent task executions | pm/executions/PARENT_EXECUTION/JOBP.DEMO | ?id=58976149&src=eh&type=JOBP | id indicates the runID of the task for which you want to access the list of parent task executions |
See also: