kb, project, product

Any knowledgebase name

kb=Example

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 logical table name

Table=Case

table=person.employee

state

• New

New:$table_name State=New:contact

OR

New:$table_name.$subtable
State=New:contact.user

• Edit

State=Edit:table_name&record_access=Edit&table=table_name&record=XXX

• Charts

State=Charts

• Main

State=Main&search=MyAssigned

• FAQ

  Open a record (ID=2) in edit mode

example: State=FAQ

• FAQItem

State=FAQItem

• Convert

State=Convert:case

This keyword specifies what action should be performed automatically.
"New:$table_name" creates a new record of specified type, as in the example.

"Edit:$table_name" opens a record for edit in the specified table, and must be used with the parameters "table", "record", and "record_access=Edit".

"Charts" takes the user to the Charts tab of the Power User interface in the table specified by Table parameter.

"Main" takes the user to the main mode of the interface and allows specification of a search that should be automatically executed. Note the case sensitivity for this parameter: Use State=Main or state=Main, since State=main will not work.

"FAQ" takes the user to the FAQ mode of the EndUser interface and allows to specify the table parameter to choose the table that contains FAQ records

"FAQItem" takes the user to the specific FAQ record. table and record parameters are required

"Convert:$table_name" enables a specific record to be converted from a hyperlink. The hyperlink must include the name of a corresponding conversion action.

This functionality offers a way to use template records to create new records with prepopulated fields. For instance, you could provide a user with a hyperlink to "create a password reset ticket" that converts a ticket that already has the category, assigned to, and other fields filled out for a password reset request.

This parameter works not only in external login hyperlinks, but also in the internal hyperlinks available in the hyperlink widget in the power user home page. So you can provide multiple hyperlinks that each convert a different template ticket directly on the home page, such as: Create a Network Outage Ticket, Request a New Employee Setup, Request a Password Reset or Create a new server upgrade task.

record

Any valid record id

record=123

This parameter is mandatory for state=Edit. It identifies the record to be opened for edit by ID.

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.
Use the following format to modify fields:
field=<$field_name> :<$value>

exiturl

Any url, or leaveLoggedIn

exiturl=https://www.sw.com

loginurl

Any url

timeouturl

Any url

logouturl

Any url

cancelurl

Any url, or leaveLoggedIn

If the user clicks the Cancel button when GUI is set to No, return to this URL. If you want to allow the user to remain in the system after exiting the record, use the leaveLoggedIn variable instead. If no cancelurl is provided, the exiturl is used.

euiurl

Any url

euiurl=eui2template/<x.php>

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

• No, no
• EndUser, enduser
• Staff (default)
• No/enduser
• No/staff
• LowRes, lowres, ADA, ada
  

gui=no
gui=LowRes

gui=ada

gui=no/enduser
gui=enduser
gui=staff

true

$notmobile=true

Use the parameter $notmobile to force a mobile device to access the normal desktop interface, either power 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:

<input type="hidden" name="$notmobile" value="true">

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

This keyword is used to define a specific field in the record form that is put in focus upon opening the link. You can specify different locations for power users and end users. For example:

navigateto=%7Bstaff%3A%7Bfield%3A'renewal_notification_date'%7D%2 Cenduser%3A%7Bfield%3A'renewal_notification_date'%7D%7D

This utilizes URL encoding in place of the {} symbols. To make the example more legible, consider how it reads when you remove the URL encoding:

navigateto={staff:{field:'renewal_notification_date'},enduser:{field:'renewal_notification_date'}}

However, the URL encoding is necessary when building the usable hyperlink.

This parameter can also be used in the $returnURL parameter of an EUI macro.

user

Any valid user login name

The keyword parameter provides the user login name.

passwd, password

Any valid password for the specified user
example: passwd=bob

"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.
This parameter is always used together with the table parameter

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

If the URL is used in a return URL or in the value of another query string, the reserved and excluded characters must be doubled encoded, meaning the % in the %N must also be expressed in %N format. To demonstrate, & is single-encoded as %26 and double-encoded as %2526 (%26 is the URL-encode for "&", and %25 is the URL-encode for "%").

Multiple conditions can be joined together using || or && symbols. It is possible to specify whether the data should be sorted in ascending or descending order by using sortasc=$fieldname or sortdesc=$fieldname.

If columns contain spaces, replace them with _ instead, and if names contain spaces, place them in single quotation marks. For example: Name_of_Related_Party='Acme Technologies Inc.'&&Party_Position=Client

record_access

View, view
Edit, edit
none

locale

de
en
es
fr
ru
zh
pt_BR
SW_User_Selected_Lang

This keyword is used to define the language in which the interface should be shown to the user.
Accepted values correspond to supported languages:
German - de
English - en
Spanish - es
French - fr
Russian - ru
Chinese - zh
Brazilian Portuguese - pt_BR
For example:
&locale=fr
A special value SW_User_Selected_Lang allows to log in with the same language as used for last user's session. This value will be used from now on in the email hotlinks as well.
If no value is supplied English is assumed for backward compatibility.