UserRegistrationAdd URL

Use this URL with SSL (Secure Sockets Layer) to ensure that the user's information is encrypted. To do so type the URL with the HTTPS secure protocol.

URL structure

http://host_name/path/

The fully qualified name of your Transaction server and the configuration path.

Parameter values

URL

Required: The URL to be called when the command completes successfully.

logonId

Required: The registrant's logon ID.

Leading and trailing spaces are trimmed. When the system is configured with LDAP, the following characters are not allowed since the logonId is part of the distinguished name:

• A # character that occurs at the beginning of the logon ID.
• Any of the following characters: = , + " \ < > ;

logonPassword

Required: The registrant's password. In database mode, the password is encrypted before it is saved in the database. In LDAP mode, the password is only stored on the LDAP server.

logonPasswordVerify

Required: The registrant's password, entered a second time.

storeId

The identifier of the store to which the user is registering.

parentMember

The parent organization of the new user. If parentMember is null, the parent is Default Organization. If parentMember is not null, it is one of the following types of values:

• Encrypted orgEntityId (using "wcs_encrypt orgentityId") See Generate encrypted data (wcs_encrypt) for the command syntax.
• DN of orgEntity (for example "o=default organization,o=root organization")

profileType

Indicates the type of registration:

C

Business-to-consumer registration profile data, authentication data, and also data for the USERPROF table (this value is the default). If the profileType is null and the parentMember is the Default Organization, by default, the profileType is "C". A user of this type is visible from the Accelerator, in the store where the user registers.

B

Business-to-business registration profile data, authentication data, and also data for the BUSPROF table. If the profileType is null and the parentMember is not the Default Organization, by default, the profileType is "B". A user of this type is visible from the Organization Administration Console.

preferredCurrency

The registrant's preferred currency for transactions; a foreign key that references the SETCCURR column of the SETCURR table.

preferredLanguage

The registrant's preferred language; a foreign key that references the LANGUAGE_ID column of the LANGUAGE table.

userField1, userField2, userField3

Customizable fields.

challengeQuestion

Challenge question for verbal confirmation of the registrant's identity.

challengeAnswer

Answer to the challenge question.

description

A description of the registrant.

displayName

Name that is used when the name of the registrant displays in a summary list.

userProfileField1, userProfileField2

Customizable fields.

photo

URL or path to a photo of the registrant.

preferredCommunication

The preferred phone for the registrant (stored in the ADDRESS table), for example:

P1

phone 1

P2

phone 2

preferredDelivery

The registrant's preferred mode of delivery.

preferredMeasure

The registrant's preferred unit of measure.

taxPayerId

A string that is used to identify the user for taxation, especially useful with tax software.

alternateId

A special ID assigned by the registrant's business organization or organizational unit to this particular registrant.

departmentNumber

The department identifier for the registrant.

employeeId

The registrant's ID with their employer.

employeeType

The registrant's status as an employee (for example, regular, permanent, contractor, or part time).

manager

The name of the registrant's manager.

secretary

The name of the registrant's secretary.

age

The registrant's age.

children

The number of children the registrant has.

companyName

The company name of the organization that the registrant represents, obtained completing the demographic information.

dateOfBirth

Date of birth. The format is yyyy-mm-dd, for example: 1980-01-01.

demographicField1, demographicField2, demographicField3, demographicField4

Customizable fields for demographic information; these fields are single-character fields.

demographicField5

Customizable field for demographic information; a field of 254 characters.

demographicField6

Customizable field for demographic information; an integer field.

demographicField7

Customizable field for demographic information; a field varchar, length 64.

gender

The registrant's gender.

hobbies

The registrant's hobbies.

household

The number of people in the registrant's household; the default is 1.

income

The registrant's annual income.

incomeCurrency

The currency in which the registrant's income is paid.

maritalStatus

The registrant's marital status.

orderBefore

Whether the registrant previously placed an order. This value is supplied by the registrant.

timeZone

The time zone in which the registrant does business (report as GMT +/- hours).

address1, address2, address3

The registrant's street address, to a maximum of three lines of information.

addressField1, addressField2, addressField3

Customizable fields.

addressType

The purpose of the address. The following values are valid for this parameter:

S

shipto

B

billto

SB

shipto and billto (The default value.)

bestCallingTime

The following values are valid for this parameter:

D

An indicator that daytime is the best time to call the registrant.

E

An indicator that evening is the best time to call the registrant.

billingCode

The registrant's organization's code to identify the shipping or billing addresses and cost center.

billingCodeType

Code designating the method of code structure that is used for the billing code. The default value is D, assigned by buyer.

city

The name of the city where the registrant resides.

country

The name of the country or region where the registrant resides.

email1

The registrant's primary email or web address.

email2

The registrant's secondary email or web address. By default, this parameter is not used for notifications to the member.

receiveEmail

Determines whether the registrant wants to receive marketing email activities for the current store (or all stores if no stores are visited during the session):

true

The user wants to receive email activities.

false

The user does not want to receive email activities (the default).

receiveSMS

Specifies whether the registrant wants to receive marketing SMS messages for the current store (or all stores if no stores are visited during the session). Valid values are true or false (default).

receiveSMSNotification

Indicates whether the user wants to receive order notification SMS text messages. Valid values are true or false (default).

fax1

The registrant's primary facsimile number.

fax2

The registrant's secondary facsimile number.

firstName

The first name of the registrant.

lastName

Required if the authentication mode is LDAP: The last name of the registrant. If the authentication mode is LDAP, this parameter is mandatory.

middleName

The middle name of the registrant.

organizationName

The name of the organization that the registrant represents.

organizationUnitName

The name of the unit within the organization that the registrant represents.

packageSuppression

The following values are valid for this parameter:

1

An indicator to include package inserts when the order is shipped.

0

An indicator to not include package inserts when the order is shipped There is no default for this field. If the field is left unused, it remains null in the database.

personTitle

The title of the user whose address is being entered (for example, Dr., Rev., Mr., or Ms.).

phone1

The registrant's primary phone number.

phone1Type

The type of phone that is used for the registrant's primary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.

phone2

The registrant's secondary phone number.

phone2Type

The type of phone that is used for the registrant's secondary phone number, for example TTY for hearing impaired, PCM for pulse-coded modulation, or CEL for mobile. This is a field of 3 characters.

publishPhone1

The following values are valid for this parameter:

1

An indicator that the registrant's primary phone number is listed.

0

An indicator that the registrant's primary phone number is unlisted There is no default for these publishPhone fields. If the field is left unused, it remains null in the database.

publishPhone2

The following values are valid for this parameter:

1

An indicator that the registrant's secondary phone number is listed.

0

An indicator that the registrant's secondary phone number is unlisted.

mobilePhone1

The registrant's mobile phone number that is used for SMS, for example, 4161235555.

mobilePhone1Country

The country code that is used for the registrant's mobile phone number, for example, CA for Canada.

shippingGeoCode

A shipping code that is based on geographical region, especially useful with tax software.

state

The name of the state, province, or equivalent where the registrant resides.

taxGeoCode

A tax code that is based on geographical region, especially useful with tax software.

zipCode

The ZIP or postal code of the registrant's address.

Custom member attributes

You can manage custom member attributes (MBRATTRVAL table) for this user using the following syntax: &attributeName_storeId_action_number=value

Where:

attributeName

The name of the custom attribute that is defined in the NAME column of the MBRATTR table.

storeId

The store ID of the store for which the attributeName applies. Specify "null" if the attribute is not store specific

action

Specifies the action to perform with the value:

a

Add the value.

r

Replace the value.

d

Delete the value.

number

In the case of multi-valued attributeNames, specify this parameter to assign multiple entries with the same attributeName, storeId, or action.

value

The value that you want to assign to the attribute.

The following are examples of syntax for customer attributes or parameters:

• Updates the database with the value of red for a defined customer attribute for the user's favorite color within store 10001: &favoritecolor_10001_r_1=red
• Updates two attributes: In store 10001, the user's favorite color is red, and in store 10002, the user's favorite color is blue: &favoritecolor_10001_r_1=red&favoritecolor_10002_r_1=blue
• Deletes an attribute from store 10001: &favoritecolor_10001_d_1=red

rememberMe

Optional. Specifies to remember the user after they close the browser. This parameter works only if a persistent session is enabled.

Example 1

The following example registers a B2C user

https://myhostname/webapp/wcs/stores/servlet/UserRegistrationAdd?
   
logonId=user1&logonPassword=pass&logonPasswordVerify=pass&URL=MallFrontView

Example 2

The following example registers a B2B user under the Default Organization by specifying the DN as the value for the parentMember parameter.

https://myhostname/webapp/wcs/stores/servlet/UserRegistrationAdd?
   
logonId=b2buser1&logonPassword=pass&logonPasswordVerify=pass&profileType=B
    &parentMember=o=Default Organization,o=Root
Organization&URL=MallFrontView

Example 3

The following example registers a B2B user under the Default Organization by specifying the encrypted orgEntityId as the value of the parentMember parameter.

https://myhostname/webapp/wcs/stores/servlet/UserRegistrationAdd?logonId=b2buser1
   
&logonPassword=pass&logonPasswordVerify=pass&profileType=B
    &parentMember=fpqG/Uw9Pdw=&URL=MallFrontView

Behavior

• Calls an empty task command called PreUserRegistrationAddCmd. The responseProperties contains the new userId and addressId parameters. Store Developers can override the command to perform more operations.
• Updates the record of the current guest customer in the USERS table and changes the registration type from 'G' (guest) to 'R' (registered) and populates the DN.
• Creates a record in the USERREG table. If the authentication mode is LDAP, the logonId field in the USERREG table stores the DN of the user. The logon password is only stored on the LDAP server, not in the USERREG table. The user's position in the membership hierarchy is stored in MBRREL table.
• If one or more fields that are related to the USERPROF, BUSPROF or USERDEMO tables are specified, a new record is created in these tables; otherwise, no record is created.
• A self address (also called a registration address, with the selfAddress field set to '1' and the nickname the same as the logonId) is created. Each user can have only one self address. To find the selfAddress, use the AddressAccessBean.findSelfAddressByMember(Long memberID).
• If the logonPassword is changed, the URL calls the AuthenticationPolicyCmd task command to verify or update a user's credentials.
• Calls the ProcessParentMemberCmd task command to validate the parentMember. If the parentMember is null, the default parent is the Default Organization (that is, the orgEntityId = -2000). If the parentMember is not null, it can take two different types of values:
  • Encrypted orgEntityId (that is, using "wcs_encrypt -e orgentityId")
  • DN of the organization or organizational unit (such as "o=Default Organization or o=Root Organization").
• Calls the ProcessProfileTypeCmd task command to determine and validate the profileType. If the profileType is not specified, and the parentMember is not specified or if it is the Default Organization, by default, the profileType is set to 'C' and a B2C user is created. If the profileType is not specified and the parentMember is not the Default Organization, by default, the profile type is set to 'B' and a B2B user is created.
• Calls the AuthenticationPolicyCmd task command to verify or update a user's credentials.
• If preferredCurrency is not specified, the default is the preferred currency in command context.
• If a new address needs to be created but the addressType is not specified, the default is 'SB' (shipping and billing address).
• Checks the required registration information parameters.
• Calls the AuditUserRegistrationCmd task command to check more parameters. Store Developers need to add new code to the AuditUserRegistrationCmd task command if they want to customize the check.
• Calls the SetCurrencyPrefCmd task command to set preferred currency to command context.
• Calls the UserRegistrationRoleAssignCmd task command to assign roles during self-registration. This command requires customization needs to be overridden by a Store Developer to enable role assignment during self-registration.
• If the authentication mode is 'LDAP', a user entry is created on the LDAP server.
• Calls an empty task command called PostUserRegistrationAddCmd. Store Developers can overwrite it to perform more operations.
• If the command fails, the UserRegistrationErrorView view command is called. Upon successful completion, the specified URL is called.
• Reads the MemberRegistrationAttributes.xml file. Specifically, it reads the <UserRoles> element and applies the roles that have a qualifier of registrationQualifier="UserRegistration".
• Applies the roles that have the qualifier 'UserRegistration'. The MemberRegistrationAttributes.xml file lists the default roles that the customer plays (for example, a registered customer in the store to which they are registering). The Site Administrator can configure this file to assign roles that are based on the organization to which the user registers and the store from which they are registering. More roles can be applied using the Organization Administration Console.

Another scenario is when businesses use a common user ID for their employees to shop at a B2B store. Only one user should use the common user ID at a time, or each user should be set up with their own user ID. Otherwise, one of the users are likely unable to complete their transaction.

You can enable multiple logon support to allow for the same authenticated user to use the site from multiple browsers or locations. By enabling this support, two or more users can log on using the same user ID. For more information, see Enabling multiple logon support for the same user.

Exception conditions