Creating or Modifying URL Actions

To add or modify URL actions, complete the following instructions: 

Step 1            Select URL Actions from the Admin menu.

Step 2            Click Add to create a new action, or select an existing action and click Edit.

Step 3            In the resulting Add URL Actions or Edit URL Actions window, specify the basic properties.
add_url_actions.png

a.  Name: type a unique descriptive name for this URL action.

b.  Action type: specify a type of URL action to be performed.

c.  Description: type a short description of the rule.

d.  Method: select the method (Get or Post) the listening server will implement.

e.  Protocol: Select the connection protocol (Http or Https) that will be used. The ICPAM default for secure connections is to present a client certificate, and accept all secure certificates.

f.  Type the URL base.

This is the URL of the system that will be triggered. For example: http://www.identiv.com

Note   Enter the URL exactly as it appears in the browser after URL encoding. Special characters in URLs, such as spaces, are replaced with the HTML encoding of the corresponding ASCII character when entered in a Web browser. Enter the URL in a browser first, and then copy and paste the encoded URL in the URL base field.

For example, the URL http://www.yahoo.com?thread=Wall Street includes a space between Wall and Street. When entered in a web browser, the URL is converted to http://www.yahoo.com?thread=Wall%20Street
Copy and paste this converted URL into the URL base field.

g.  Select or deselect the Enabled check box to enable or disable this URL action.

Step 4            (Optional) Enter any additional URL paths.

In the final URL, these values are separated from the base URL (and from each other) with a forward slash (/). The additional path value can be fixed text or an event attribute.

a.  Select the Additional Path tab.

b. To enter a Value, select one of the following:

        Fixed: enter the fixed text.

        Event attribute: select an attribute from the drop-down menu.

Attributes include: Unique Event ID, Event Type/LogCode, Event Source, Device Type, Device Address, Location Site, Location Campus, Location Building, Location Floor, Location Area Name, Location Sub Area Name, Location Fully Qualified Name, Priority, Badge ID, User ID, Personnel ID, Person's Name (Last, First), Credential Watch Level, and Associated Camera ID.

c.     Click Add.

The additional path appears in the list.

d. Repeat these steps to create additional paths, if necessary.

e.  Click Preview to view the complete URL.

Tip           Always preview the URL before saving the URL action. Any dynamic elements in the URL are displayed in brackets (<>), and are replaced by the corresponding event used at run time.

For example, enter sample_action in the Fixed field. Click Add to add it to the list, and then Preview to view the URL: http://www.cosco.com/sample_action.

Next, select the Event attribute button and select Device Type from the drop-down menu. Click Preview to view the new URL: http://www.cosco.com/sample_action/<Device Type>

Step 5            (Optional) Enter the parameters used to construct the URL.

URL parameters consist of a name and a value, and are separated from the URL with a question mark (?).

a.  Select the Parameters tab.

b. Enter a Name for the parameter. The name is always fixed.

c.  Select a Value option and enter one of the following. The value can be fixed or dynamic:

        Fixed: enter the value text.

        Event attribute: select an attribute from the drop-down menu. The parameter is captured from the specified event.

Attributes include: Unique Event ID, Event Type/LogCode, Event Source, Device Type, Device Address, Location Site, Location Campus, Location Building, Location Floor, Location Area Name, Location Sub Area Name, Location Fully Qualified Name, Priority, Badge ID, User ID, Personnel ID, Person's Name (Last, First), Credential Watch Level, and Associated Camera ID.

        Complete event: Available for Post actions only. The entire event information is included as an xml segment in the data posted to the URL

d. Click Add. The parameter appears in the list.

e.  Create additional parameters, if necessary. Parameters are separated in the URL with an ampersand (&).

f.  Click Preview to view the complete URL.

In the following example, the Parameter entries are shown after the question mark, and are separated by an ampersand (&). http://www.identiv.com/sample_value/ <Device Type>?Fixed_Text=text_sample&Event_Attr=<Device Address>

Step 6            (Optional) Enter the username and password required to access the URL.

Note  The username and password is used for servers requiring authentication. If authentication is unsuccessful, the server returns the response code of 401: Unauthorized. This code is placed in the data field of the event generated from executing the URL action.

Step 7   When you are finished, click Save and Close.

 

See also:

Configuring URL Actions

System Integration