Keywords are case insensitive, but their values (such as the table or field name) are case sensitive. To find the correct case for your table, navigate to Setup > Tables, select your table, click Edit, and look for the Logical Table Name. To find the correct case for a field, edit its parent table, and then edit the field. Remember to use the field name, and not the label. |
&keyword1=value1&keyword2=value2... |
Keyword | Allowed Values and example | Comments |
---|---|---|
keyID | 0 | The key/value pair keyID=0 is required for all login hyperlinks. |
kb, project, product | Any knowledgebase name | These keywords specify the name of the knowledgebase that the user is logging into. They all mean exactly the same thing and are interchangeable. There is more than one keyword with this meaning for historical reasons. |
table | Any table name | This keyword specifies the name of the table that the user should view. In this example, it is as if the user logged on and then clicked the Cases tab. |
state |
New:$table_name State=New:contact OR New:$table_name.$subtable
State=Charts
State=Main&search=MyAssigned
example: State=FAQ
State=FAQItem
State=Convert:case | This keyword specifies what action should be performed automatically. |
record, id | Any valid record id id=123 | This parameter is mandatory for state=Edit. It identifies the record to be opened for editing. |
expiration | Any future date expiration=05/31/2025 | This keyword defines an expiration date (MM/DD/YYYY) for anonymous links. Use it together with state=Edit |
field | $fieldname:fieldvalue field=summary:test_summary | This keyword allows you to set field values for a record in state=Edit. A hyperlink may contain several "field" parameters. |
exiturl | Any url | When the user logs out from , go to the specified URL |
loginurl | Any url | If the user is unable to login to because of an invalid username/password combination, go to this URL. |
timeouturl | Any url | If the user's session times out due to inactivity, go to this URL. |
logouturl | Any url | If the user is manually logged out of , go to this URL |
cancelurl | Any url | If the user clicks the Cancel button when GUI is set to No, return to this URL. |
euiurl | Any url | When the user logs into the End User Interface via single-sign on, this URL specifies where to redirect the user. For other ways to create a hyperlink to log into the end user interface, see the Examples section. |
gui |
gui=no gui=no/enduser | "no" or "No" mean that only the new/edit record screen, together with any pre and post HTML is shown. The rest of the interface is not displayed.
"no/enduser" or "no/staff" are just like no, but explicitly specify whether the record should be shown using the end user layout or the staff layout.
"staff" is the default and indicates the full staff interface should be shown. "LowRes" forces the user to log into the low resolution/ADA interface for mobile devices. |
$notmobile | true $notmobile=true | Use the parameter $notmobile to force a mobile device to access the normal desktop interface, either staff or end user depending on permissions. The notmobile parameter can also be used in login page buttons, to be sent to the browser with the login request. For example:
|
field= hide_btn:true | Prevents display of the Finish&New button | This keyword is used in conjunction with GUI=No when you want the user to provide a single record, such as an employment application |
user | Any valid user login name | The keyword parameter provides the user login name |
passwd, password | Any valid password for the specified user | "passwd or password" values provide the provide the password part of a user/password combination. |
search | Any valid saved search name | This keyword parameter provides the name of a saved search that is automatically executed when the user logs on. |
customsearch | Any valid search | This keyword allows the user to specify the field names and values within the hotlink itself. The search uses the standard syntax ==, >=, >, <=, <, !=, (,), && and ||. However, many of these symbols have reserved meanings in HTML so they have to be expressed using% N equivalents. For example CustomSearch=State% 3E=Closed%26%26Severity==Critical |
record_access | View, view | This keyword is only used together with a search or a customsearch that returns just one record and Edit state. It causes the specified record to be opened for viewing or editing. |
locale | de | This keyword is used to define the language in which the interface should be shown to the user. |
Additional examples are provided at [your URL]/gui2/hotlinks/test.jsp.
For example: https://support.agiloft.com:8080/gui2/hotlinks/test.jsp.
Action | Hotlink |
Go to the Legacy End User Interface. | |
Go to the staff (Main) interface and select the Cases table | http://test.agiloft.com/gui2/login.jsp?keyID=0 &kb=demo&user=admin&passwd=1 &State=Main&table=cases |
Log in to the When the user exits, go to the URL https://www.agiloft.com | |
Try to go to a non-existent table (deliberate error) | |
Go to the contacts table | |
Go to "contracts" table and perform the Saved Search named "company name" | |
Go to "contacts" table and search for the "test" keyword | |
Submit a new bug without showing the GUI, logoff on finish | |
Submit a new bug and show the GUI | |
Go to Reports for the contact table and show the GUI | |
Go to Reports for the contact table without showing the GUI | |
Submit a new bug without showing the GUI, set the"description" and "solution" fields | |
Submit a new bug without showing the GUI, set the" description "and" solution" fields and immediately exit to the specified URL without giving the user the opportunity to make any changes to the record | |
Open a bug (ID=2) in edit mode | |
Open a bug (ID=2) in view mode | |
Open a bug (ID=2), set priority=low and exit | |
Open a bug (ID=3) in edit mode and change the summary and priority fields | |
Open a bug (ID=1) in edit mode using a temporary password that expires on 10/25/09 |
Related articles |