Advanced Password Services (APS) Guide › Change Password Interface (SmCPW) › Query String Options

Query String Options

When running under a Web Server, the syntax of SmCPW is as follows. Note that APS can and will automatically construct these arguments if the redirection events are properly configured (see Chapter 3, APS Configuration File (APS.CFG).

SmCPW{.exe}?
	[Optional]
	[&][DaysLeft=<daysleft>]
	[&][GraceLogins=<grace logins left>]
	[&][DaysRemaining=<days remaining>]
	[&][CancelTo=<cancelURL>]
	[&][Target=<targetURL>]
	[&][<additional arguments>]

The .exe component is required on Windows.

If Optional is specified, then the default form displayed by SmCPW has a Cancel button. If the user clicks this button, the browser is redirected back to the page that invoked the form (or <cancelURL>, if specified). The Cancel button is dependent on JavaScript support by the browser. If the Browser does not support JavaScript, a standard hyperlink labeled Cancel appears instead.

DAYSLEFT=<daysleft> may be supplied to indicate how long the password has left before it expires. There are two cases:

• The argument is not supplied at all. SmCPW will consider that the password must be changed. By default, no additional messages are displayed a and no Forget It or Cancel buttons appear.
• DAYSLEFT=<daysleft> is supplied. The password may be changed and no time limit exists. The Forget It or Cancel button is displayed (as if Optional were specified) in the default form. A message indicating that the password must be changed within "<daysleft> days" is displayed by the default form.

  http://www.xyz.com/CPW/SmCPW.exe?DAYSLEFT=3

The TARGET=<targetURL> argument identifies the page to which the user should be directed upon completion of the password change. The <targetURL> should be passed in a URL-encoded format to avoid problems with embedded characters.

GRACELOGINS and DAYSREMAINING are used when the password has expired, but a grace period or a number of grace logins is configured. SmCPW will modify its displayed text to communicate these values to the user.

Additional key/value pairs may also be supplied, each set separated from its predecessor by an ampersand ("&"). These key/value pairs will be parsed and saved by SmCPW.

When SmCPW redirects to the next page, either by redirecting the specified target or to a custom message page, these key/value pairs will be used to replace macros in the target of the redirection. The URL is examined for text between < and > (angle brackets). The text and the angle brackets are replaced by the value associated with the text.

For example, if the SmCPW invocation is:

SmCPW?Target=%2FMyPage%2Easp%3F<lang>&Lang=EN

The user is redirected to:

/MyPage.asp?EN

When APS builds the redirection because of an event, it can construct complex URLs with such query strings and can include user attributes in that query string. See the section about Redirections later in this document.