Logging In and managing access
This guide covers logging into the Lab, managing your session, updating your password
in the UI, and triggering automated password resets with the ResetPassword
URL command.
Overview
The Lab is a web-based tool for managing the business features of your site. All Lab URLs are protected, so visiting the base URL or a bookmarked page without being signed in redirects you to the login page. Once you sign in successfully, you land on the Lab Dashboard.
Sign In
- Open your browser and go to
https://<host_name>:7443/tooling/login, where host_name is your organization's Commerce+ Transaction Server address. - Enter your Commerce+ Transaction Server username and password.
- Select Sign In.
If this is your first time logging in, you are prompted to change your temporary password before continuing.
After signing in, the tools available to you in the Lab menu depend on your assigned role or persona. Select the tool you want to use, then choose which store to manage:
- If you have set a default store in your preferences, it is preselected (you can still pick a different one from the Store list).
- If you have not set a default store, choose one from the Store list. Which stores you can see depends on your access permissions.
The login page also includes a Change password option and a Forgot password link, covered below.
Session Management and Re-Login
Your session expires after 30 minutes of inactivity. When that happens, a Re-login dialog overlays your current screen. The dialog is modal, meaning you cannot interact with the rest of the application until you deal with it: you can either enter your password to resume where you left off (your username cannot be changed here), or use the dialog's close option to exit to the standard login page instead. Re-login happens against the same environment that originally accepted your credentials.
You can open multiple browser tabs to work in the Lab, and you can navigate to any application URLs you have access to from those tabs. Your session is shared across tabs in the same browser, so you do not need to log in separately on each one. If your session expires in one tab and you log back in, the new session becomes active across all tabs opened under that same domain. Logging off in one tab logs you out of all tabs sharing that session, and likewise logging in from a login page open in multiple tabs logs you into all of them.
Session sharing only applies within the same browser. Logging out of Chrome, for example, does not affect a separate session open in Firefox or Edge.
When you are finished, save any work in progress, then click Log Out from the side menu or the drop-down in the top-right corner of the header, rather than simply closing the browser.
Changing Your Password
Use this when you know your current password but want or need to update it, for example due to expiration or security policy.
- Go to
https://<host_name>:7443/tooling/loginand click Change password. - Enter your username, current password, and a new password.
- Re-enter the new password to confirm it.
- Click Submit to save the new password and log in.
Resetting a Forgotten Password (UI)
Use this if you do not remember your password at all.
- Go to the Lab login page and click Forgot password.
- Enter your username and click Submit.
- Click Enter Validation Code, then check your registered email for the code (click Re-Send Code if it does not arrive). If your environment uses a standalone Identity service, you instead receive a reset link by email to follow.
- Enter and confirm a new password, then click Set Password. You are returned to the login page to sign in.
Password requirements differ depending on your environment's authentication mode:
- Legacy Inventory users (standalone inventory, no transaction server)
- Minimum of eight characters; no more than three consecutive identical characters; no more than four total occurrences of the same character; at least one letter and one digit.
Password policy is configurable by an administrator, so your organization's actual rules may be adjusted from these defaults.
Examples
Example 1 – Reset while unauthenticated (emails a temporary password; deprecated)
PUT https://myhostname/wcs/resources/store/{storeId}/person/@self
Content-Type: application/json
{
"resetPassword": "true",
"logonId": "a",
"challengeAnswer": "a"
}
If the challenge answer matches, the system generates a password, updates the database, and emails it to the user.
Example 2 – Reset while authenticated
PUT https://myhostname/wcs/resources/store/{storeId}/person/@self
Content-Type: application/json
{
"resetPassword": "true",
"logonPassword": "b",
"xcred_logonPasswordOld": "a",
"xcred_logonPasswordVerify": "b"
}
Verifies the old password, checks the new password against the password policy, then updates the database.
Example 3 – Reset while unauthenticated (emails a validation code), in two steps
Step 1 – request a code (must first obtain a guest identity):
PUT https://myhostname/wcs/resources/store/{storeId}/person/@self
Content-Type: application/json
{
"resetPassword": "true",
"logonId": "jsmith",
"challengeAnswer": "TheRedFoxFlies"
}
If the challenge answer matches, a validation code is emailed to the user.
Step 2 – submit the code with a new password (must be completed within the expiry window, which defaults to 30 minutes):
PUT https://myhostname/wcs/resources/store/{storeId}/person/@self
Content-Type: application/json
{
"resetPassword": "true",
"logonPassword": "Just4Fun!",
"xcred_logonPasswordVerify": "Just4Fun!",
"xcred_validationCode": "289213"
}
inSessionValidationCode=true in the
CMDREG.PROPERTIES section of the
ResetPasswordGuestCmd file.Resetting user passwords with administrative REST APIs
Use the administrative REST APIs to reset customer passwords as a Customer Service Representative (CSR), Customer Service Supervisor (CSS), or Site Administrator.
POST https://myhostname/wcs/resources/store/{storeId}/person/updateMemberPassword?mode=resetPasswordAdmin
Content-Type: application/json
{
"logonId": "jsmith",
"logonPassword": "NewPwd123!",
"logonPasswordVerify": "NewPwd123!"
}POST https://myhostname/rest/admin/v2/users/{userId}/password-reset
Content-Type: application/json
{
"logonPassword": "NewPwd123!",
"logonPasswordVerify": "NewPwd123!"
}The mode parameter can be
resetPasswordAdmin (default) or
resetPasswordOnBehalf.Error handling: If you supply a reLogonURL, errors redirect there with an error code attached to the request. Otherwise, the command throws an ECApplicationException and redirects to a default error view based on the user's identity (ResetPasswordRegisterErrorView for registered users, ResetPasswordGuestErrorView for guests). Error codes can be read via the ErrorDataBean class.
| Error condition | Error code | Applies to |
|---|---|---|
| Missing URL parameter | ERR_MISSING_REDIRECTURL (1000) | Guest or logged-in user |
| Missing logonId | ERR_MISSING_LOGONID (2000) | Guest |
| Invalid logonId | ERR_INVALID_LOGONID (2010) | Guest |
| Missing challenge answer | ERR_MISSING_CHALLENGEANSWER (1010) | Guest |
| Incorrect challenge answer | ERR_INVALID_CHALLENGEANSWER (1020) | Guest |
| Missing email address for logonId | ERR_MISSING_EMAIL (2100) | Guest |
| Account disabled | ERR_DISABLED_ACCOUNT (2110) | Guest or logged-in user |
| Invalid validation code | ERR_INVALID_VALIDATION_CODE (2190) | Guest |
| Expired validation code | ERR_EXPIRED_VALIDATION_CODE (2195) | Guest |
| Missing old password | ERR_MISSING_OLDPASSWORD (2040) | Logged-in user |
| Incorrect old password | ERR_INVALID_OLDPASSWORD (2050) | Logged-in user |
| Missing new password | ERR_MISSING_NEWPASSWORD (2060) | Guest or logged-in user |
| Missing new password verification | ERR_MISSING_NEWPASSWORDVERIFY (2070) | Guest or logged-in user |
| New password and verification do not match | ERR_MISMATCH_PASSWORDS (2080) | Logged-in user |
| Password too short | ERR_MINIMUMLENGTH_PASSWORD (2200) | Logged-in user |
| Too many consecutive characters of one type | ERR_MAXCONSECUTIVECHAR_PASSWORD (2210) | Logged-in user |
| Too many instances of one character type | ERR_MAXINTANCECHAR_PASSWORD (2220) | Logged-in user |
| Not enough letters | ERR_MINIMUMLETTERS_PASSWORD (2230) | Logged-in user |
| Not enough digits | ERR_MINIMUMDIGITS_PASSWORD (2240) | Logged-in user |
| Password matches the user ID | ERR_USERIDMATCH_PASSWORD (2250) | Logged-in user |
| Password reuses a previous password | ERR_REUSEOLD_PASSWORD (2260) | Logged-in user |
The overall error handler class is ECConstants.EC_ERROR_CODE.
After You're Logged In
You can expand the navigation menu on the left by hovering over or clicking it; it shows only tools you have access to. Use the search field, available from the menu icon, to quickly find a specific tool or task; results are limited to what you are permitted to use.