Programming Guides › Programming Guide for Perl › CLI Policy Management Methods › Session Methods › CreateRegScheme Method—Creates Registration Scheme

CreateRegScheme Method—Creates Registration Scheme

The CreateRegScheme method creates and configures a registration scheme.

Syntax

The CreateRegScheme method has the following format:

Netegrity::PolicyMgtSession‑>CreateRegScheme(regName, userDir[, regDesc][, welcomeURL][, templatePath][, enableLogging])

Parameters

The CreateRegScheme method accepts the following parameters:

regName (string)

Specifies the registration scheme's name.

userDir (string)

Specifies the user directory associated with the registration scheme.

regDesc (string)

(Optional) Specifies the registration scheme's description.

welcomeURL (string)

(Optional) Specifies the URL for the welcome page.

Note: Users are redirected to this page after successfully registering.

Example: http://my.acme.com/hr/welcome.htm

templatePath (string)

(Optional) Specifies the path where the registration templates are located.

Note: For more information about the templePath parameter, see Remarks.

enableLogging (int)

(Optional) Specifies whether to enable logging.

• value = 1

  Specifies enabling logging.

• value = 0 (default)

  Specifies disabling logging.

Return Value

The CreateRegScheme method returns one of the following values:

• PolicyMgtRegScheme (object)
• undef if the call is unsuccessful or the registration scheme name already exists

Remarks

When you install a SiteMinder Web Agent, the registration templates are installed in the samples/selfreg subdirectory of the Web Agent installation directory by default. During SiteMinder installation, the virtual directory /siteminderagent is created and pointed to the samples directory in the Web Agent installation directory. Therefore, when using the default directory, specify templePath as follows: /siteminderagent/selfreg (without the final slash).

If you are using SSL for registration, you must provide the absolute path for the registration templates. The default paths are as follows:

• Windows platforms: install-dir\Netegrity\Siteminder Web Agent\Samples\SelfReg\
• Solaris/Hpux platforms: install-dir/netegrity/siteminder/webagent/samples/selfreg/