Below you will find brief information for Xstore Office, Xstore Retail. This guide provides information about creating user security roles and managing user access to Xadmin, setting up the system configuration rules and paths for Xadmin itself, creating and maintaining profile groups and elements for stores, personalities that determine the prioritized profile elements for configuration overrides, and store landscapes used for machine (register) configurations, creating, maintaining and deploying Xstore configuration changes selectively, or globally across the entire organization, creating, maintaining and deploying Xstore data changes, managing the Deployment Manager for uploading files for deployment and tracking the status of configuration, data and file deployments, viewing transactional data from the Xcenter database in a receipt format, running and viewing Xstore reports against the Xcenter (central) database, and using Support Tools to view issues taking place at the store level, to set up email alerts, and to compile the PosLog data from within Xadmin and save it as a file to a specified location or to rebroadcast the PosLog data.
Advertisement
Advertisement
Xstore Retail Xstore Office, User Guide, Release 7.1
Copyright © 2015, Oracle and/or its affiliates. All rights reserved.
This software and related documentation are provided under a license agreement containing restrictions on use and disclosure and are protected by intellectual property laws. Except as expressly permitted in your license agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license, transmit, distribute, exhibit, perform, publish, or display any part, in any form, or by any means. Reverse engineering, disassembly, or decompilation of this software, unless required by law for interoperability, is prohibited.
The information contained herein is subject to change without notice and is not warranted to be errorfree. If you find any errors, please report them to us in writing.
If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalf of the U.S. Government, the following notice is applicable:
U.S. GOVERNMENT END USERS: Oracle programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, delivered to U.S.
Government end users are “commercial computer software” pursuant to the applicable Federal
Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the programs, including any operating system, integrated software, any programs installed on the hardware, and/or documentation, shall be subject to license terms and license restrictions applicable to the programs. No other rights are granted to the U.S.
Government.
This software or hardware is developed for general use in a variety of information management applications. It is not developed or intended for use in any inherently dangerous applications, including applications that may create a risk of personal injury. If you use this software or hardware in dangerous applications, then you shall be responsible to take all appropriate fail-safe, backup, redundancy, and other measures to ensure its safe use. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of this software or hardware in dangerous applications.
Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.
Intel and Intel Xeon are trademarks or registered trademarks of Intel Corporation. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC
International, Inc. AMD, Opteron, the AMD logo, and the AMD Opteron logo are trademarks or registered trademarks of Advanced Micro Devices. UNIX is a registered trademark of The Open Group.
This software or hardware and documentation may provide access to or information on content, products, and services from third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim all warranties of any kind with respect to third-party content, products, and services. Oracle Corporation and its affiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of third-party content, products, or services.
C O N T E N T S
Admin Users - Using Roles to Grant Access to Xadmin ........................................ 17
Assumptions and Requirements for LDAP Users ..................................................... 25
User Guide Version 7.1
Version 7.1
User Guide
Receipt Configuration: System Configuration Options ............................................. 88
Tender Configuration: System Configuration Options ........................................115
User Guide Version 7.1
Editing a Merchandise Hierarchy Level ...........................................................154
Adding to a Merchandise Hierarchy Level ........................................................155
To Add an Organization Hierarchy Level ..........................................................192
To Edit the Description of an Organization Hierarchy Level ................................192
To Delete an Organization Hierarchy Level ......................................................193
To Add an Organization Hierarchy Level to a Node............................................194
To Edit the Value and Manager Information ....................................................195
Version 7.1
User Guide
To Add Unassigned Stores to an Org Node ......................................................195
To Create a New Store and Add It to an Org Node............................................195
To Deploy the Organization Hierarchy Changes ................................................197
File Upload: Removing an Uploaded File From the List ......................................204
User Guide Version 7.1
PosLog Publisher Search Results Page Layout Examples ...................................261
Version 7.1
User Guide
How a Deployment is Downloaded and Applied ................................................. 271
dtv.base.config.path ...................................................275
dtv.config.path ........................................................275
User Guide Version 7.1
C H A P T E R
The rebranding for the latest version of this documentation set is in development as part of post MICROS acquisition activities. References to former MICROS product names may exist throughout this existing documentation set.
Xadmin is a web-based application used to administer corporate-based functions such as
Xstore configuration setup and maintenance, file management for the Xstore suite, viewing the electronic journal, viewing store reports, monitoring Xstore versions in use at the store and register levels, and monitoring alerts.
This guide is intended for technical personnel working with Xadmin and requires a working knowledge of Xstore POS, XML, SQL Server database, the Windows operating system, and the network system being used.
Because Xadmin UI color schemes and menu options are configurable, the page layouts and functions on your system may appear in a different order or have different text than examples shown in this manual.
Since different browsers use different rendering engines, the browser you are using may also affect the way the screens are depicted on your system.
This guide assumes:
You have the privilege-permission level to use Xadmin
CHAPTER 1: Getting Started Version 7.1
Xstore and Xcenter Database are in use
Refer to the Xstore Implementation Guide for detailed information about installing Xadmin and the other required components.
Xadmin supports Internet Explorer web browser, version 9.0 and 10.0, and Firefox running on the Windows 7 or Windows 8 operating systems. Other web browser/operating system combinations may work, but have not been tested.
Xadmin must be set to 100% zoom. To verify the zoom level, click
View-->Zoom on the browser menu and verify the zoom is set to
100%. In IE, make sure the zoom is 100%. In Firefox, choose Zoom ->
Reset.
Xadmin is a web-based application that you can access through an internet browser.
1. Open an internet browser.
2. Enter the server address in the Address field and press [Enter].
Version 7.1
The login page opens.
User Guide
Figure 1-1: Xadmin Login Page
The “Forgot Password” link shown here is not available in a “manually reset” password environment and when using LDAP Authentication. You can only request a forgotten password reset in “static” and “algorithm” password environments. See
“Requesting a Forgotten Password” on page 5 for more information about resetting your password.
3. Type your user name in the User Id field.
4. Type your password in the Password field.
5. Click the Sign In button.
The first time you log in to Xadmin you will be prompted to change your password. Complete the fields as required, then click Submit.
CHAPTER 1: Getting Started Version 7.1
6. The Xadmin Home page displays. Select a menu option from the menu bar, or click a link in one of the Xadmin Panels to continue.
Figure 1-2: Xadmin Home Page
Menu Bar
Breadcrumbs Bar
Logged In User ID
Panels
More Arrow (when applicable)
Navigation...
To log out, click the logged in user ID located in the upper right section of the page.
To return to the Xadmin Home page at any time, click the Home bread crumb.
To display more panels (when applicable), click the “More” arrow.
Version 7.1 User Guide
A default administrator security role account has been set up in the database to allow first-time access to Xadmin.
Using this default user account to log in, click the Xadmin Users link in the System panel or select Xadmin Users in the System menu to set up additional Xadmin user accounts.
MICROS recommends that you set up at least one ADMINISTRATOR
Once this Administrator security user has been set up, delete the initial
(default) administrator user account for security purposes.
See
Chapter 2, “Roles, Users, and Security Access” on page 9 for
detailed instructions.
This change password option is not available if you are using LDAP authentication.
To change the password of another user, see Chapter 2 , “Roles, Users, and Security Access” ,
“Editing Xadmin User Accounts” on page 19 .
1. To change your password, click the Change Password link on the Xadmin Login window
2. At the Change Password window, enter the information as required and click Submit.
The Xadmin Home page displays and your new password is now in effect.
See
“Passwords: Special Characters & Rules” on page 22 for more
information about password validation.
Use the Forgot Password link to request a password reset through email.
This option is not available in a “manually reset” or “LDAP” password environment. See
“Password Options - Non LDAP” on page 21 and
“LDAP Authentication” on page 25 for more information about
password environments in Xadmin.
1. At the Xadmin Login window, or the Change Password window, click the Forgot Password
link ( Figure 1-1 on page 3 ).
2. When prompted, enter your User Id and email address, then click OK.
Xadmin sends an email to your email address containing a temporary password.
CHAPTER 1: Getting Started Version 7.1
3. When prompted, enter your User Id and the temporary password contained in the email, then click Sign In.
4. At the Change Password window, enter the temporary password in the Current Password field, then enter and confirm your new password.
5. Click Submit. The Xadmin Home page displays.
Refer to the following chapters for the information you need to use the Xadmin components:
Chapter 2, “Roles, Users, and Security Access” on page 9 - This chapter provides
information about creating user security roles and managing user access to Xadmin.
Chapter 3, “System Settings” on page 27 - This chapter provides information about the
features used to manage the Xadmin application, including setting up the system configuration rules and paths for Xadmin itself.
Chapter 4, “Profile Management” on page 35
- This chapter provides information about creating and maintaining profile groups and elements for stores, creating and maintaining the personalities that determine the prioritized profile elements for configuration overrides, and creating and maintaining the store landscapes used for machine (register) configurations. After setting up the groups/elements and personalities/landscapes, this chapter explains how to use the information to create
Store Personalities for your stores which allows you to easily maintain portions of your configuration paths.
Chapter 5, “Configurator” on page 51 - This chapter provides information about creating,
maintaining, and deploying Xstore configuration changes selectively, or globally across the entire organization.
Chapter 6, “Data Management” on page 137
- This chapter provides information about creating, maintaining, and deploying Xstore data changes selectively, or globally across the entire organization.
Chapter 7, “Deployment Manager” on page 201 - This chapter provides information
about using Deployment Manager to upload files for deployment and to track the status of all configuration, data, and file deployments.
Chapter 8, “Electronic Journal” on page 229 - This chapter provides information about
using the Electronic Journal to view transactional data from the Xcenter database in a receipt format.
Chapter 9, “Reports” on page 233 - This chapter provides information about running and
viewing any of the Xstore reports against the Xcenter (central) database.
Chapter 10, “Support Tools” on page 239
- This chapter provides information about using the Support Tools component to view issues taking place at the store level, to set up email alerts to be sent to the appropriate personnel when any issues occur, and to compile the PosLog data from within Xadmin and save it as a file to a specified location or to rebroadcast the PosLog data.
Appendix A: “About Deployments” on page 265
- This appendix explains how deployments are created by Xadmin and applied by Xstore and Xenvironment.
Version 7.1 User Guide
Appendix B: “Personality Maintenance & Config Paths” on page 273 - This appendix
explains how the store personalities set up in Xadmin are used to create the config path properties.
Appendix C: “User Interface Configuration” on page 283
- This appendix explains how
Xadmin can be “personalized” by adding a background image, changing the color scheme, and configuring the panel display order and content.
Appendix D: “Glossary” on page 291
- This glossary lists and defines many terms and their definitions used in this guide.
Appendix E: “Revision History” on page 293
- This appendix summarizes the changes to this document for each Xadmin release.
CHAPTER 1: Getting Started Version 7.1
C H A P T E R
This chapter provides information about creating user security roles and managing user access to Xadmin. The User Roles and Users and Security Access features provide the ability to create security roles and to grant privileges to users for one or more areas of
Xadmin based on these roles.
Security Notes
Any users in an Org Node higher than the logged-on user will not be displayed in the Admin Users list. In addition, the logged-on user cannot add Org Nodes that are higher than the org nodes he/she is assigned to.
Security privileges are associated with Xadmin actions.
Administration
Configurator
Data Manager
Deployment Manager
Home Page
Reports
Support
CHAPTER 2: Roles, Users, and Security Access Version 7.1
This chapter contains the following sections:
See
for information about creating the roles used to determine user privileges in Xadmin. Access to different areas of Xadmin is controlled by assigning security Roles to the users.
See
“Admin Users - Using Roles to Grant Access to Xadmin” on page 17 for instructions
on creating new Xadmin User Accounts and controlling user access to Xadmin.
Refer to the Xstore Implementation Guide for information about using
DataLoader to load Xadmin user accounts.
See
“Editing Xadmin User Accounts” on page 19
for instructions on changing an existing user’s account privileges.
See
“Password Options - Non LDAP” on page 21 ,
“Editing Xadmin User Accounts” on page 19
, “Passwords: Special Characters & Rules” on page 22
and
Password” on page 24 for instructions on setting up, changing, or resetting a user’s
password.
If using LDAP Authentication, refer to “LDAP Authentication” on page 25
. LDAP-managed users do not have the ability to manage their passwords from within Xadmin, or the ability to use password reset or password change functionality.
Version 7.1 User Guide
The Role of ADMINISTRATOR is required. This role defaults to access for every privilege and has a rank of 150.
MICROS recommends that you set up at least one ADMINISTRATOR user. Once this administrator user has been set up, delete the initial
(default) administrator user account for security purposes.
Access to different areas of Xadmin is controlled by assigning security Roles to the users.
This section provides information about defining the user roles that will then be used to grant specific privileges to a user.
1. From the Xadmin menu, select System --> Xadmin Users, or click the Xadmin Users link in the System panel.
2. At the Xadmin Users page, click User Roles.
Figure 2-1: Xadmin Users Page
3. At the User Roles page, create a new User Role, edit an existing User Role, or delete an existing User Role:
Figure 2-2: User Roles Page
To create a new Role, click Add New. The User Roles window displays and the fields are blank.
To edit an existing User Role, select the Role from the list. The User Roles window displays and the fields are populated with the current Role information.
4. Complete the required fields. (All fields are required.)
CHAPTER 2: Roles, Users, and Security Access Version 7.1
Figure 2-3: User Roles Window - Add New Role Example
Role ID - Type the role identifier. Spaces and special characters are not allowed in this field. When editing an existing role, this field cannot be changed.
Description - Type a description for the role.
Xadmin Rank - Type a numeric rank number for Xadmin. This rank is evaluated when creating a new Xadmin user in User and Security Access. An Xadmin user cannot assign a role to a new user that has a greater numeric rank than his/her
Xadmin rank. For example, a logged-in user with a rank role of 50 cannot edit or create a rank role of 51 and above.
Xstore Rank - Type a numeric rank number for Xstore. This value is the rank associated to the user within the Xstore application and corresponds to the role the user holds within Xstore. This rank is evaluated when creating or editing an Xstore employee in Data Manager -> Employees. An Xadmin user cannot assign Xstore security groups to an employee that is ranked higher than his/her Xstore rank.
Privileges - Select each role privilege from the list of Available options and click the arrow button to move the role or roles to the Selected window:
Add all privileges
Add selected privilege
Remove selected privilege
Remove all privileges
To select several privileges at the same time, hold down the [Ctrl] key on the keyboard while selecting each privilege you want to assign to the role you are creating or editing. Click the single arrow button to move the privileges from the Available window to the Selected window.
You can also hold down the [Shift] key in the same manner to select all the privileges between the first privilege you select and the last privilege you select.
Click the single arrow button to move the privileges from the Available window to the Selected window.
Version 7.1 User Guide
5. Click Save to create or update the role.
A Delete option is available for Roles you create. However, if a Role has been assigned to a user it cannot be deleted.
The available privileges for Xadmin are grouped by category: Administration
,
,
.
Notes: Make sure you set up Xadmin privileges properly.
• For example, in Deployment Manager, the Deployment Plan privileges for "View
Deployment Plans" and "Create/Edit Deployment Plans" technically work together. If you just have View privilege, you can only view deployment plans
(as expected). However, you must have both privileges (view and create) in order to Create or Edit.
• The same is true for the Configurator privileges. If you just have "Discounts" or
"Menus" etc., you can't do anything. You must also have the "Configurator" privilege and the "Global Configurations" or "Configuration Overrides" privilege to be able to get to the Discounts/Menus/Receipts selection page.
• If a user does not have the privilege for a specific home page panel, then it will not be displayed when the user logs into Xadmin. There are six panels in the
Xadmin base configuration, so there are six privileges available. Also, if the user has access to the home page panel itself, but not to any of the options contained within it, then the panel will not be displayed.
Administration
Table 2-1: Administration Security Privileges
Administration
Available Locales
Lock/Reset Account
User Roles
Users and Security Access
Xadmin Settings
Xadmin Users
CHAPTER 2: Roles, Users, and Security Access Version 7.1
Configurator
Table 2-2: Configurator Security Privileges
Configurator
Code Value Menus
Configuration Overrides
Configurator
Copy Store Configurations
Personality Maintenance
Profile Maintenance
Profile Management
Store Personality Maintenance
Store Specific Overrides
System Config
Tab Configuration
Reason Codes
Receipts
Tender Maintenance
Tender Options Maintenance
Customer Displays
Delete Profile Element
Configurations
Discounts
Global Configurations
Landscape Maintenance
Menu Configuration
Schedule Deployment
Security
Security Groups
Security Privileges
Tender Security Settings
Tenders
DataManager
Table 2-3: DataManager Security Privileges
DataManager
Attached Items
Currency Exchange
Organization Hierarchy Levels
Organization Hierarchy Maintenance
Data Manager
Data Manager Deployment
Data Publisher
Employee
Store Collections
Store Communications
Store Messages
Stores
Employee Tasks
Item Matrix Manager
Item Pricing
Items
Tax Authority
Tax Brackets
Tax Elements
Tax Group
Version 7.1
Table 2-3: DataManager Security Privileges (continued)
DataManager
Merchandise Hierarchy
Merchandise Items
Non Merchandise Items
Organization Hierarchy
Tax Location
Tax Rates
Taxes
Vendor
DeploymentManager
Table 2-4: DeploymentManager Security Privileges
DeploymentManager
Approve Deployment Wave
Cancel Deployment
Create/Edit Deployment Plans
Schedule Planned Deployment
Schedule Single Deployment
Unapprove Deployment Wave
File Deploy
File Upload
Purge Deployment Files
View Deployment Plans
View Deployments
User Guide
Home Page
Table 2-5: Home Page Panel Security Privileges
Home Page
Home Page Config Management Panel
Home Page Data Management Panel
Home Page Deployment Panel
Home Page Reports Panel
Home Page Support Panel
Home Page System Panel
CHAPTER 2: Roles, Users, and Security Access
Reports
Table 2-6: Reports Security Privileges
Reports
Airport Authority Report
Best Sellers Item Report
Best Sellers Style Report
Credit Card Report
Customer Account Activity Summary Report
Customer List Report
Daily Sales Report
Daily Sales Total Report
Daily Sales and Cash Report
Electronic Journal
Employee Performance Report
Employee Tasks Report
Flash Sales By Hour Report
Flash Sales Department Report
Flash Sales Employee Report
Flash Sales Summary Report
Gift Certificate Report
Inventory Stock Cost Report
Item List Report
Journal Report
Layaway Account Activity Detail Report
Layaway Account Activity Summary Report
Layaway Aging Detail Report
Layaway Aging Summary Report
Line Void Report
Version 7.1
No Sale Report
Post Void Detail Report
Post Void Summary Report
Price Change Report
Price Override Report
Receiving Exception Report
Receiving Report
Returned Merchandise Report
Sales By Hour Analysis Report
Sales By Hour Report
Sales Department Employee Report
Sales Department Report
Shipping Exception Report
Special Orders Report
Stock Valuation Reports
Store Locations Report
Suspended Transaction Detail Report
Suspended Transaction Summary Report
Tax Exemption Report
Transaction Cancel Detail Report
Transaction Cancel Summary Report
View Reports
Worst Sellers Item Report
Worst Sellers Style Report
YearEnd Roll-Up Process
Version 7.1 User Guide
Support
Table 2-7: Support Security Privileges
Support
Alert Console
Alert Settings
Deployed Xstore Versions
PosLog Publisher
Replication Status
Once you have created Roles, you can grant user access to Xadmin by assigning a Role—and
its associated privileges—to the user.
Access to this Xadmin User Guide via the System menu is not controlled by role assignment and will be available for all users.
Perform the following steps to grant other users access to Xadmin components. To change an existing user’s account privileges, see
“Editing Xadmin User Accounts” on page 19 .
1. From the Xadmin menu, select System --> Xadmin Users, or click the Xadmin Users link in the System panel.
2. At the Xadmin Users page, click Users and Security Access.
Figure 2-4: Xadmin Users Page
CHAPTER 2: Roles, Users, and Security Access Version 7.1
3. At the Users and Security Access page, click Add New to create a new user account.
Figure 2-5: Users and Security Access Page
If there are more than 200 Xadmin users in your organization, a Search
page displays rather than the employee list as shown in Figure 2-5
above. Click Add New to create a new user account.
4. Enter the information as required to grant security privileges for new users:
a. User Id -
R
EQUIRED
The User Id Minimum Length is set in System-->Xadmin Settings
-->User Account.
b. Authentication Type - If applicable, select the authentication type, Internal
Xadmin directory or LDAP directory.
If using LDAP Authentication you are not prompted for password information. Also, password reset and password change functionality is not available. See
“LDAP Authentication” on page 25
for more information.
c.
First Name -
R
EQUIRED
d. Last Name -
R
EQUIRED
e. Password & Confirm Password -
R
EQUIRED
F
OR
M
ANUAL
P
ASSWORD
M
ETHOD
See “Passwords: Special Characters & Rules” on page 22 for more information about
password validation.
The Password and Confirm Password fields are not available if using the
Static password method or the Algorithm method when creating new user accounts. See
“Password Options - Non LDAP” on page 21 for
more information about static passwords and algorithm passwords.
f.
Security Role -
R
EQUIRED
This list contains the roles defined for your organization.
Only one security role may be assigned.
Version 7.1 User Guide
g. Locale - This list contains the locales defined for your organization; defaults to
English United States.
h. Email - Enter the user’s email address, if applicable.
i.
Account Locked check box - After a configurable number of consecutive unsuccessful login attempts, the user's account will be automatically flagged as locked and the user cannot access the system until you reset the lock flag here. You can also select this check box to lock a user out of the system. This functionality is not available for LDAP users.
j.
Organization Nodes -
R
EQUIRED
1) Click the icon to see the nodes defined for your organization. Select which nodes/stores the user will have access to, then click Add.
A user can have access to multiple Org Nodes; however, the nodes cannot overlap.
2) The nodes you selected are shown, along with a
Delete option you can use if you need to remove access to an Org Node for the user.
5. Click the Save button to create the new user account.
The new user account is added to the list of Xadmin Users. When the new user logs in to
Xadmin, only the components for which the user has been granted access will be active on the Xadmin menu and panel links.
1. From the Xadmin menu, select System --> Xadmin Users, or click the Xadmin Users link in the System panel.
2. At the Xadmin Users page, click Users and Security Access.
Figure 2-6: Xadmin Users Page
CHAPTER 2: Roles, Users, and Security Access
3. At the Users and Security Access page, select a user account from the list.
Version 7.1
Figure 2-7: Users and Security Access Page
If there are less than 200 Xadmin users in your organization, the list of users will be shown automatically without requiring a search.
Otherwise, enter search criteria to find an Xadmin user account.
A Delete option is available to allow you to remove an Xadmin user account. If selected, you will be prompted to confirm the user account should be deleted. Always make sure at least one user has access to the ADMINISTRATOR role before deleting user accounts.
4. The Edit User page provides the fields that can be edited for the selected user account.
Refer to step
for more information about the fields.
Notes: About editing the fields
• The User Id cannot be changed.
• The Authentication Type cannot be changed after setup.
• When editing existing users, a Reset Password option is available for static
and algorithm password methods. See “Resetting a User’s Password” on page 24
.
• If you changed the Security Role setting, the user’s access to Xadmin components is updated accordingly. When the user logs in to Xadmin, only the components for which the user has been granted access will be active on the
Xadmin menu and panel links.
5. Click Save to apply the changes to the user’s account.
Version 7.1 User Guide
There are three options for creating passwords for new users and/or users that request a password reset. These configuration options are set in Xadmin Settings. See
for more information about setting up password options.
Manual Setup - Using this option, the administrator creates each password and then communicates it to the user. When creating a new user, the Password text box must be populated with a password that meets the standards set by other Xadmin password configurations defined in Xadmin Settings, User Accounts section.
Static Passwords - Using this option, the administrator first sets up a static (universal) password within Xadmin Settings for all new users, for example "A@23456". This static password will be temporarily used by new Xadmin users, and users that have requested a password reset. A Password text box is not needed on the Edit User page since a static password is used for all new users. The Xadmin user will be prompted to change this password the first time he/she logs into the system.
Auto-generated Password Via Algorithm - Using this option, the password is created automatically for the user based on a predetermined algorithm. The algorithm contains aspects of the user profile that can be communicated easily. The algorithm currently used is as follows:
The first letter of the user's first name (upper case).
The first letter of the user's last name (lower case).
The @ symbol.
The month and year in which the user record is created (when the password is requested) in MMYYYY format.
The Xadmin user will be prompted to change this password the first time he/she logs into the system.
CHAPTER 2: Roles, Users, and Security Access Version 7.1
}
|
_
{
~
+
]
^
@
[
=
?
*
-
(
)
%
&
#
$
Valid password special characters
!
exclamation point pound or number sign dollar percent ampersand open parenthesis close parenthesis asterisk minus or hyphen equal question mark at open bracket close bracket carat underscore open brace close brace pipe or bar tilde plus
;
/
.
"
>
<
,
:
`
\
'
Invalid password special characters
apostrophe or single quote back quote back slash colon comma greater than less than period quote semi-colon slash or forward slash
Version 7.1 User Guide
Password & User ID settings are configured in System -> Xadmin Settings, User Account category. These settings include the following:
Method of Creating Password for New Users - The method used to create the password
for newly added users. See “Password Options - Non LDAP” on page 21 for more information
about the three options available.
Number of Capital Letters Required for a Password - The minimum number of capital letters that should appear in a password. The minimum number is zero (0).
Number of Changes Before a Password Can Be Reused - The number of password resets within which associates are not allowed to reuse the same password. For example, setting the value to 12 ensures a user's new password cannot match any of his/her 12 previous passwords. A setting of zero (0) means that the same password can always be reused.
Number of Consecutive Characters Allowed in a Password - The maximum number of times that any given symbol or character can repeat consecutively within the password string. The minimum number is one (1).
Number of Login Attempts Before Account Is Locked - The number of times an invalid password can be entered before the account is locked. The minimum number is one (1).
Number of Numbers Required for a Password - The minimum number of digits that should appear in a password (accepted values = 0-9). The minimum number is zero (0).
Number of Special Characters Required for a Password - The minimum number of special characters that should appear in a password. The minimum number allowed is zero
(0). See “Passwords: Special Characters & Rules” on page 22
for a list of valid special characters.
Password Expiration Days - The number of days that a password can be used before it expires. If a user successfully logs into Xadmin (enters valid user name and password), but the password is older than the configured number of days, the user will be rerouted to the
Change Password screen and will not be able to access the system until the password has been successfully changed.
Password Length - The minimum length of a password. If a value of 1 is set, passwords have no minimum length, but cannot be empty/blank.
User ID Length - The minimum number of characters that must be used in order for a user
ID to be valid.
See Chapter 3, “System Settings” on page 27 for more information about the password
configuration options.
A user's password cannot be the same as his/her user ID.
Passwords cannot contain null or "whitespace" characters (space, tab, carriage return,
\0, etc.). Note that leading or trailing null and whitespace characters are silently trimmed by the UI automatically.
CHAPTER 2: Roles, Users, and Security Access Version 7.1
Use the Reset Password function to manually reset user passwords when needed. This option is available with Static and Algorithm password generation methods only.
If Xadmin is configured for Manual password generation, simply change the password in the Password field on the Edit User page:
If you reset your own password, it will not be marked as
temporary in Xadmin.
If you (the administrator) manually reset another user’s password, it will be marked as temporary in Xadmin and the
user must change it during the next login.
1. From the Xadmin menu, select System --> Xadmin Users, or click the Xadmin Users link in the System panel.
2. At the Xadmin Users page, click Users and Security Access.
3. At the Users and Security Access page, select a user account from the list.
4. Click the Reset Password link.
5. When prompted, verify the user account and email address are correct, then click Yes to continue.
If the user does not have an email address on record, you will be prompted whether or not to continue. Click No to return to the Edit
User page and enter an email address, or click Yes to continue without generating an email for the user.
6. The password is reset based on the configured password method, either the static
(universal) password or the algorithm password.
7. An email is generated and sent to the Xadmin user with the details.
Figure 2-8: Password Reset Email Example
Version 7.1 User Guide
LDAP Authentication allows users to log into Xadmin using a "single sign-on" where one password for a user is shared between many services. This feature uses LDAP (Lightweight
Directory Access Protocol) and Microsoft's AD (Active Directory) repository to manage the user Id and password access to the application.
LDAP is used for authentication to Xadmin, but the user information must be set up in the Xadmin database for the users to access the application.
LDAP-managed users do not have the ability to manage their passwords from within
Xadmin, or the ability to use password reset or password change functionality.
A single LDAP server must be configured for the Xadmin instance. Multiple LDAP authentication servers are not supported.
Account locking (for example, after “X” login attempts) and unlocking is not available through Xadmin. It may be available through the LDAP server.
LDAP Authentication settings are configured in System -> Xadmin Settings, User Account category.
Default Domain Name for LDAP - The default domain name to be used when authenticating users using LDAP.
Enable LDAP Authentication Option? - The configuration used to enable Xadmin to authenticate users using LDAP directory.
LDAP Provider URL - The URL to be used to connect to LDAP server.
CHAPTER 2: Roles, Users, and Security Access Version 7.1
C H A P T E R
The System component has many features used to manage the Xadmin application itself, including setting up the system configuration rules and paths, setting up the available locales within Xadmin, viewing Xadmin version information, and setting up Xadmin users and user roles.
For information about the Xadmin system configuration feature, see “Xadmin
. This section provides detailed information about setting configuration parameters for the Xadmin application itself.
For information about controlling the available locales within the Xadmin application
itself, see “Available Locales” on page 33 . These changes are not sent down to Xstore.
For information about the Xadmin version the system is currently running on, see
“Version Display” on page 34 .
For information about the Users and Security Access component, see
“Roles, Users, and Security Access” on page 9 . This component provides the ability to
grant privileges to users for one or more areas of Xadmin as needed based on security
Roles.
For information about the User Roles component, see Chapter 2, “Roles, Users, and
. This component provides the ability to create the security roles that are used to control access to the various areas of Xadmin.
CHAPTER 3: System Settings Version 7.1
Xadmin Configuration provides the ability to set up the configuration options that govern how
Xadmin works. You cannot add or delete Xadmin configuration options.
1. From the Xadmin menu, select System --> Xadmin Settings, or click the Xadmin
Settings link in the System panel.
2. The Settings page displays, showing the configuration options available for Xadmin. The configuration options are arranged by category, in a tree view. Edit the values as needed, then click the Save button to save the changes.
To find configurations containing specific text, enter the search text in the input box, then press [Enter].
The text typed here can be found anywhere within the configuration label or description. The results are shown in the left panel (folder tree). Only those configurations containing the specified text within the label and/or description are displayed. If needed, click “Clear” to remove the search criteria and return to the
Xadmin Configuration page.
See
below for detailed information about the Xadmin configuration options.
Automatically Deploy Data Manager Changes?
If set to true, Xadmin automatically deploys pending Data Manager changes at a
specified time each day. The time of day is determined by the Data Manager Automatic
setting.
Data Manager Automatic Deployment Time
The time of the day to start the auto deployment of undeployed Data Manager changes.
The time should be in the format of HH:MM using the 24 hr clock. This setting is only relevant when the
Automatically Deploy Data Manager Changes?
setting is enabled.
Deployment Download Connection Timeout
The amount of time, in seconds, that Xenvironment will spend attempting to connect to
Xcenter to download a deployment. Once the time has elapsed with no connection detected, the attempt will be considered a failure. This setting is used by Xenvironment at the store.
Version 7.1 User Guide
Deployment Download Retries
The number of times Xenvironment will attempt to download updates from Xadmin before failing. The default value is 10 attempts. A setting of zero (0) means never retry, which is not recommended. This setting is used by Xenvironment at the store.
Deployment Download Retry Interval
The time interval, in seconds, that Xenvironment will wait after a failed deployment download attempt before it tries to download the deployment again. This setting is used by Xenvironment at the store.
Detection Interval for Automatically Deployed Data Files
How often (in milliseconds) the system checks the
Directory for Automatically Deployed
Data Files to be deployed automatically to all stores.
Directory for Automatically Deployed Data Files
The directory into which DataLoader files can be placed for automatic deployment.
Dataloader files placed in this directory will be automatically detected by Xadmin and will be deployed to the appropriate stores that are identified within the file.
Enable Automatic Deployment of Data Files?
If set to true (default), Xadmin automatically detects and deploys DataLoader files. Files
are placed in the directory specified by the Directory for Automatically Deployed Data
Files configuration setting. This directory is checked on a repeating interval determined
by the
Detection Interval for Automatically Deployed Data Files configuration setting.
Once found, the file will be scheduled for deployment based on the information contained within it.
Interval for Checking for Deployment Waves That Require Approval
The time interval, in minutes, for running the Wave Approval email service. The default value is 60 minutes. For example, if set to 60 minutes, the service will run every hour to scan for new waves and send emails. An email will be sent for waves that meet the
Number of Days Before Deployment Wave to Send Notification requirement.
Number of Days Before Deployment Wave to Send Notification
The number of days prior to the projected launch date of a wave with a launch type of
"Approval Required" that an email notification goes out. Valid values are from 1 to 365.
The default value is 3 days.
Number of Records in Deployment Viewer
The maximum number of Deployment records to display per page in the Deployment
Viewer.
Beginning Time of the Business Day
To support alert reporting, this is the time—in hours from 00:00 GMT—that denotes the corporate start time of the business day. (For example, 5 is 05:00 GMT).
Default Deposit Bank Account Number
When creating a new store, this is the default deposit bank account number.
CHAPTER 3: System Settings Version 7.1
Default Deposit Bank Name
When creating a new store, this is the default deposit bank name.
Delete FIFO data after report generation?
When enabled (true), FIFO data is deleted after a FIFO report is generated.
Enable the Option to Create Store-Specific Configurations?
When enabled (true), users have the ability to create or override configurations for a
specific store in Configurator. See “Configurator” ,
“Managing Configurations” on page 53 .
Enable the Option to Delete Configurations?
When enabled (true), configurations for profile or store-specific overrides can be deleted in Configurator. If set to false, all access to this functionality is disabled within Xadmin, regardless of the privileges.
File Upload Directory
The directory in which files are stored that are uploaded by users via the File Upload feature.
Interval for Checking for Missing Registers
How frequently Xcenter checks for missing registers, in minutes. The default value is 15 minutes. The value of this setting should be less than the
Number of Records in POSLog Publisher Result Page
The maximum number of POSLog records displayed per page on the POSLog publisher result page. The minimum value allowed is 1.
POSLog Publish Max Search Results
The maximum number of POSLog records returned from the database for republishing.
Published POSLog Directory
The directory where the published PosLog file will be saved.
Time Before Missing Register Is Ignored
Once a device has been missing for the amount of time specified here (in hours), it is no longer reported as a problem. The default value is 72 hours.
Time Before Register Is Considered Missing
The amount of time—in minutes— that must elapse since a register’s last check-in before it is considered missing. The default value is 61 minutes.
Use Till Based Accountability?
When creating a new store, this option determines whether Till Accountability mode or
Register Accountability mode is used as the default setting.
Version 7.1 User Guide
Default Report Output Format.
The report output format to be used as the default type when running reports. Valid values include:
PDF (Portable Document Format)
HTML (Hyper Text Markup Language)
CSV (Comma-Separated Values)
XLS (Spreadsheet file format created by Microsoft for use with MS Excel)
XLSX (MS Excel 2007 or newer)
PPTX (MS PowerPoint)
RTF (Rich Text Format)
DOCX (Microsoft Office Open XML Format Document)
Enable CSV (Comma-Separated Values) as a Report Output Format?
If true, reports can be produced in CSV format.
Enable DOCX (MS Word) as a Report Output Format?
If true, reports can be produced in DOCX format.
Enable HTML (Hyper Text Markup Language) as a Report Output Format?
If true, reports can be produced in HTML format.
Enable PDF (Portable Document Format) as a Report Output Format?
If true, reports can be produced in PDF format.
Enable PPTX (MS PowerPoint) as a Report Output Format?
If true, reports can be produced in PPTX format.
Enable RTF (Rich Text Format) as a Report Output Format?
If true, reports can be produced in RTF format.
Enable XLS (MS Excel) as a Report Output Format?
If true, reports can be produced in XLS format.
Enable XLSX (MS Excel 2007 or Newer) as a Report Output Format?
If true, reports can be produced in XLSX format.
Default Domain Name for LDAP.
The default domain name to be used when authenticating users using LDAP.
Enable LDAP Authentication Option?
If set to Yes, enables Xadmin to authenticate users using LDAP directory. This is the global on/off switch.
CHAPTER 3: System Settings Version 7.1
LDAP Provider URL.
The URL to be used to connect to the LDAP server.
Method of Creating Password for New Users.
The method used to create the password for newly added users. See “Password Options
- Non LDAP” on page 21 for more information about the three options available.
Number of Capital Letters Required for a Password.
The minimum number of capital letters that should appear in a password. The default value is 1. The minimum number is zero (0).
Number of Changes Before a Password Can Be Reused.
The number of password resets within which associates are not allowed to reuse the same password. For example, setting the value to 12 ensures a user's new password cannot match any of his/her 12 previous passwords. A setting of zero (0) means that the same password can always be reused.
Number of Consecutive Characters Allowed in a Password.
The maximum number of times that any given symbol or character can repeat consecutively within the password string. The default value is 2.
Number of Login Attempts Before Account Is Locked.
The number of times an invalid password can be entered before the Xadmin user account is locked.
Number of Numbers Required for a Password.
The minimum number of digits that should appear in a password
(accepted values = 0-9). The minimum number is zero (0). The default value is 1.
Number of Special Characters Required for a Password.
The minimum number of special characters that should appear in a password. The
default value is 1 special character. See “Passwords: Special Characters & Rules” on page 22
for a list of valid special characters.
Password Expiration Days.
The number of days that a password can be used before it expires. The default value is
90 days.
Password Length.
The minimum length of a password. The default value is 8. Note: If this value is set to less than 1, passwords have no minimum length, but cannot be empty/blank.
User ID Length.
The minimum number of characters in an Xadmin user ID. Valid values are 1 through 30.
Version 7.1
User Guide
This feature is only available from the Xadmin System menu, not from the Home Page panel.
This feature controls the available locales within the Xadmin application itself.
1. From the Xadmin menu, select System --> Available Locales.
2. The Available Locales page displays. Add a new locale, make changes to an existing locale, or delete a locale:
Figure 3-1: Available Locales Page
To add a new locale, click the Add New button.
To make changes to an existing locale, click on an existing locale from the list.
To delete a locale, click the Delete icon associated with the locale. If selected, you will be prompted to confirm the locale should be deleted. Any locale currently assigned to a user record cannot be deleted.
A sorting component is available for columns, when applicable.
3. Complete the fields as required when adding or editing a locale:
Locale - Select a locale from the drop-down list. The locale cannot be changed in edit mode.
Display Order - Enter the display order for the locale.
4. Click the Save button.
If more than one available locale has been defined in Xadmin, certain fields in Configuration
Manager and Data Management will allow the user to enter a translation for any language.
This action creates com_translations records that will be sent down to stores, along with the configuration data.
CHAPTER 3: System Settings
Version 7.1
This feature is only available from the Xadmin System menu, not from the Home Page panel.
Use this feature to view the Xadmin version the system is currently running on. This is a view-only window.
To view the versions of Xstore running in the field, see Chapter 10,
.
1. From the Xadmin menu, select System --> About Xadmin.
The About Xadmin window displays:
Figure 3-2: About Xadmin Window
The following information is shown on this window:
The application version number
Copyright information
MICROS license information
2. Click to close the window.
C H A P T E R
The goal of the Profile Management component of Configuration Manager is to define
“Store Personalities” for your organization. The Store Personalities allow you to easily maintain portions of your configuration paths using a GUI format in Xadmin. Behind the scenes, these Store Personalities are translated into the various configuration paths specified in configPath.properties.
The configuration paths in configPath.properties specify a list of one or more configuration directories to be searched when a property configuration file is needed.
This functionality is controlled by a configuration option in system.properties: dtv.update.configpath.from.Xcenter=true
If configured to use this functionality (true), Xstore will poll Xcenter at startup to determine if any changes were made to the config path (dtv.config.path and dtv.base.config.path) properties. If a configuration path has changed, it will be updated in configPath.properties and loaded during the startup process.
If this configuration is set to false, Xstore will not check Xcenter for updates.
However, the config path can be set manually.
The Configurator component of Configuration Manager is used to create, maintain, and deploy Xstore configuration changes selectively, or globally across the entire organization. Refer to Chapter 5,
“Configurator” on page 39 for more information about making configuration changes and deploying the information to your stores.
CHAPTER 4: Profile Management Version 7.1
Profile Management includes functions for creating and maintaining profile groups and elements for stores and registers, creating and maintaining the personalities that determine the prioritized profile elements for configuration overrides, and creating and maintaining the store landscapes used for machine (register) configurations. After setting up this information, you can assign Store Personalities to your stores.
Figure 4-1: Profile Management Page
Setup Overview
1. First, create Profile Groups and their associated Elements. Follow the steps outlined in
“Profile Maintenance” on page 37
to set up and maintain the Profile Groups.
2. Next, after creating the Profile Group and Element combinations, set up your
Personalities and Landscapes.
A Personality is a grouping of at least one or many Profile Group and Element combinations in an ordered list that work together to define a store. For example,
using the Profile Groups and Elements you set up previously (step 1 above), you can
identify a personality as being "Canadian, Banner, Outlet", in addition to another personality defined as "US, Banner, Flagship, Retail", and so on.
A Landscape is a collection of prioritized profile groups and elements for registerspecific configuration overrides. When assigned to a store, the landscape determines the configurations that are applicable to individual register numbers or ranges of register numbers (for example, “22 - Managers Terminal”, “44 - Lead Register”, etc.).
Follow the steps outlined in “Personality Maintenance” on page 41 and
Maintenance” on page 44 to create Personalities and Landscapes.
3. Finally, set up each Store Personality by assigning the Personalities and Landscapes
you created (step 2 above) to your stores. Follow the steps outlined in
to create Store Personalities.
Version 7.1 User Guide
Summary
The Profile Groups/Elements you create (step 1) will be used to set up Personalities and
Landscapes.
The Personality/Landscape pairs (step 2) will then be used to create a Store Personality
The profiles you set up here will be available as configuration scope overrides for Personality and Landscape group types in the Configurator component, providing the ability to deploy configurations that will override the global layer for specific locations as defined by the Store
Personality. Refer to
Chapter 5, “Configurator” on page 51 for more information about the
Configurator component.
Notes: Profile Groups are used to associate configuration overrides with specific Profile
• A Profile Group is simply a collection of configuration elements by type; for example Location, Register Type, Store Type, etc.
• A Profile Element is the child property associated with the Profile Group; for example, Location= Ohio, California, Iowa, etc.
1. From the Xadmin menu, select Config Manager --> Profile Management, or click the
Profile Management link in the Configuration Manager panel.
2. From the Profile Management page (
Figure 4-1 on page 36 ), select Profile
Maintenance.
3. The Profile Maintenance page displays. Click Add to create a new Profile Group.
Figure 4-2: Profile Maintenance Page
CHAPTER 4: Profile Management Version 7.1
4. At the Create Profile Group window, enter the information required to create a new
Profile Group:
Figure 4-3: Create Profile Group Window
a. Group ID - The profile group identifier. Spaces are not allowed here.
b. Group Type - The type of profile group: Personality or Landscape.
The Group Type selected here determines where the Profile Group will be available for selection when setting up Personalities and Landscapes. Landscape profile groups will only be available for Menu Configuration and System Configuration overrides.
c.
Description - The profile group description.
d. Comments - [
O
PTIONAL
] A comment associated with the Profile Group.
5. Click OK.
The Profile Maintenance window displays the new Profile Group information you added.
Figure 4-4: Profile Maintenance Window - Populated
Notes: About this screen
• The red icon in the tab indicates this Profile Group has not been saved.
• To close the tab, click the close icon . You will be prompted if there are unsaved changes.
• To delete this Profile Group, click Delete. You will be prompted to confirm the deletion.
Version 7.1 User Guide
• If a Profile Group (and its Elements) is being used by a Personality or
Landscape, it cannot be deleted.
6. Click Save to save the Profile Group to the Profile Group list, or continue with step 7
below before saving.
7. Click Add in the Profile Elements section of the window (Figure 4-4) to add elements
to this Profile Group.
8. At the Create Profile Element window, enter the information required to create a new
Profile Element for the Profile Group:
Figure 4-5: Create Profile Element Window
a. Element ID - The element identifier. (Note: Spaces are not allowed here.)
b. Description - The element description.
c.
Comments - [
O
PTIONAL
] A comment associated with the Profile Element.
9. Click OK.
10. Repeat steps 7 through 9 to add additional Elements to the Profile Group.
11. When all Elements have been associated with the Profile Group, click Save.
Figure 4-6: Profile Group and Elements - Before Saving Example
CHAPTER 4: Profile Management Version 7.1
The Profile Group created here will now be available in the Overrides feature in Personality
sections of Profile Maintenance where applicable for the group type. (See
Figure 4-1, “Profile Management Page,” on page 36 .)
Delete Options:
If you need to delete the Profile Group and all the associated
Elements, click the Delete button.
If you need to delete an Element, click the Delete icon .
You will be prompted to confirm your selection.
If a Profile Group (and its Elements) is being used by a Personality or
Landscape, it cannot be deleted.
The version number is shown on the Profile Maintenance page for the Profile Group and
Element (Figure 4-6). This value will be increased by one each time the Profile Group/
Element is deployed, or scheduled for deployment, with a new set of configurations.
Notes: About Profile Group and Element versioning:
• The version number is not increased until the configuration is deployed (or scheduled for deployment). Editing an existing profile element does not increment the version number.
• Rollback is not available at this time.
• Audit logging includes who, when, and in which version the change was made.
Chapter 5, “Configurator” on page 51
.
Version 7.1 User Guide
Use Personality Maintenance to group one or many Profile Group and Element combinations that will be used to define a store.
1. From the Xadmin menu, select Config Manager --> Profile Management, or click the
Profile Management link in the Configuration Manager panel.
2. From the Profile Management page (
Figure 4-1 on page 36 ), select Personality
Maintenance.
3. At the Personality Maintenance page, add a new Personality or edit an existing one:
Figure 4-7: Personality Maintenance Page
To quickly find a Personality, enter text in the Description field. The list will be filtered to show the Personalities with the text in their descriptions.
If adding a new Personality:
a. Click Add New.
b. At the Edit Personality page, use the wizard to complete the information on each
tab, then click Next. See “Personality Setup Options” on page 43 for a list of
Personality options.
c.
Skip to step 4 to review your selections.
If editing an existing Personality:
a. Select the Personality in the list.
b. At the Personality Detail window, click Edit.
c.
d. Continue with step 4 to review your selections.
CHAPTER 4: Profile Management
4. Review the Personality options you selected:
Version 7.1
Figure 4-8: Personality Options Review
To save the Personality, click save. The Personality is added to the list on the
Personality Maintenance page.
To edit the Personality:
Click previous to go back one page , or select a configuration option in the Edit Personality section in the left panel of the window.
After making your changes, click save. The new Personality is added to the list on the Personality Maintenance page.
To discard the Personality, click cancel. When prompted, click Yes to confirm you want to cancel Personality setup.
5. After completing Personality setup, Xadmin returns to the Personality Maintenance page.
To delete a Personality that has been created or updated, click the
Delete icon associated with the Personality on the Personality
Maintenance page.
When prompted, click Yes to confirm the deletion.
If a Personality has been assigned to a Store, it cannot be deleted.
Version 7.1 User Guide
1. General Information
Define the basic information for the Personality, then click Next.
a. Description - Enter the Personality identifier.
b. Comments - [
O
PTIONAL
] Enter additional identifying information for the Personality.
2. Base Features
Select the Xstore features that are active for this Personality, then click Next.
3. Overrides
Select and prioritize the Profile Group and Element combinations:
The Profile Groups and Elements available here are created in
Profile Maintenance. See
“Profile Maintenance” on page 37 for
more information.
Only the Profile Groups with the type “Personality” are available in the drop-down list. (Profile Groups with the type “Landscape” are not available in Personality Maintenance.)
A <Store Specific> override entry is available by default in the drop-down list.
a. Select the Profile Group for this Personality.
b. Select the Profile Element for this Personality.
c.
Click Add Element.
d. Repeat steps a through c as needed to add all the Profile Group and Element
combinations to this Personality.
e. If needed, select a Profile Group and Element combination row and use the up/down arrows to change the priority. Elements at the top of the list have higher priority.
Figure 4-9: Profile Group/Profile Element Combination List
CHAPTER 4: Profile Management Version 7.1
f.
If needed, click the icon to remove the Profile Group and Element combination from the Personality.
g. Click Next.
4. Review
Review the options you selected. Go to
Use Landscape Maintenance to create and edit the register layout portion of configuration paths.
1. From the Xadmin menu, select Config Manager --> Profile Management, or click the
Profile Management link in the Configuration Manager panel.
2. From the Profile Management page (
Figure 4-1 on page 36 ), select Landscape
Maintenance.
3. At the Landscape Maintenance page, add a new Landscape or edit an existing one.
Figure 4-10: Landscape Maintenance Page
If adding a new Landscape, continue with To Add a New Landscape below.
If editing an existing Landscape, skip to “To Edit an Existing Landscape” on page 47 .
1. At the Landscape Maintenance page, click Add New.
2. At the Edit Landscape page, complete the following information:
Figure 4-11: Edit Landscape Page - Add New
Version 7.1 User Guide
a. Description - Enter a short description for the new Landscape.
b. Comments - [
O
PTIONAL
] Enter additional information about the new Landscape.
3. Select a Profile Group from the drop-down list, then click Add New to add the Profile
Group to the Landscape.
The Profile Groups and Elements available here are created in Profile
Maintenance. See “Profile Maintenance” on page 37
for more information.
Only the Profile Groups with the type “Landscape” are available in the drop-down list. (Profile Groups with the type “Personality” are not available in Landscape Maintenance).
4. At the Profile Group page, click Add New to add a Profile Element to the Profile Group.
Figure 4-12: Profile Group Page - Register Types Example
5. At the Add Register Range window, complete the fields, then click OK:
Figure 4-13: Add Register Range Window
a. Profile Element - Select a Profile Element from the drop-down list.
b. Register Range - Enter a starting and ending register range. If there is only one register, enter the register number in both fields.
6. Repeat steps 4 and 5 as needed to add all the Profile Elements and Register Ranges for
the Profile Group.
7. Click Done to return to the Edit Landscape page.
CHAPTER 4: Profile Management Version 7.1
8. You have the following options at the Edit Landscape page before saving the Landscape:
Figure 4-14: Edit Landscape Page
To add additional Profile Groups and Elements to the Landscape, repeat steps 3
To edit the register ranges, select the row to open the Add Register Range window
(Figure 4-13) and make changes as needed.
To delete a register range, select the row and click the Delete icon .
To change the priority, click the selector control icon to select the row and activate the up and down arrows on the right side of the page.
With the row selected, use the up/down arrows to move the row up or down in the list.
Profile Groups at the top of the list have higher priority.
9. When Landscape setup is complete, click Save to return to the Landscape Maintenance page.
Version 7.1 User Guide
1. At the Landscape Maintenance page ( Figure 4-10 on page 44
), select the Landscape in the list.
To delete a Landscape, click the Delete icon .
When prompted, click Yes to confirm the deletion.
If a Landscape has been assigned to a Store, it cannot be deleted.
2. At the Edit Landscape page, edit the Landscape as needed:
Figure 4-15: Edit Landscape Page
To change the Description or Comment, enter the information in the appropriate field.
To add a new profile group perform
.
To edit the register ranges, select the row to open the Add Register Range window
(Figure 4-13) and make changes as needed.
To change the priority, click the selector control icon to select the row and activate the up and down arrows.
With the row selected, use the arrows to move the row up or down in the list.
Profile Groups at the top of the list have higher priority.
3. Click Save when the edits are complete to return to the Landscape Maintenance page.
CHAPTER 4: Profile Management Version 7.1
Store Personalities are used to create the configuration paths specified in configPath.properties.
Store Personality Maintenance is where you assign the Personalities (created in Personality
Maintenance ) and Landscapes (created in
Landscape Maintenance ) to stores.
1. From the Xadmin menu, select Config Manager --> Profile Management, or click the
Profile Management link in the Configuration Manager panel.
2. From the Profile Management page (
Figure 4-1 on page 36 ), select Store Personality
Maintenance.
3. [
O
PTIONAL
] At the Store Personality Maintenance page, use the Filter Criteria and Find a
Node search options to quickly find a store:
Figure 4-16: Store Personality Maintenance Page
To quickly find a store you can:
Select an option from the Filter Criteria drop-down list to filter the nodes displayed in the org hierarchy tree based on assigned personalities and landscapes. The following filter options are available:
No Filter (default): Select this option to remove any filters.
No Store Personality – Select this option to display only the stores that do not have store personalities assigned to them.
Personalities or Landscapes: All the personalities created on the Personalities Maintenance page are listed under the heading “Personalities”, and all the landscapes created on the
Landscapes Maintenance page are listed under the heading “Landscapes”. Select a personality or landscape to display only the stores that have the selected personality or landscape assigned to them.
<OR>
In the Find a Node field, begin typing the node description to search for a specific node in the org hierarchy tree.
Version 7.1 User Guide
4. From the hierarchy tree, select a node to assign a Personality/Landscape pair.
Figure 4-17: Store Personality Maintenance Page - Store Node Selected
If you select a non-store node (for example “District”), all stores contained in that node will be affected by any change made to the personality and landscape. This will remove and replace any personality/landscapes that were previously assigned to stores within that node.
5. Click Edit to modify the personality/landscape assignments for the selected store.
6. At the Edit Store Personality window, select a Personality and a Landscape from the drop-down lists. Both a Personality and a Landscape are required.
Figure 4-18: Edit Store Personality Window
CHAPTER 4: Profile Management
7. Click Save to assign the selected Personality and Landscape to the store.
Version 7.1
Figure 4-19: Store Personality Maintenance Page - Assignment Complete
See also: Appendix B: “Personality Maintenance & Config Paths” on page 273
C H A P T E R
The Configurator component of Configuration Manager is used to create, maintain, and deploy Xstore configuration changes selectively, or globally across the entire organization.
See About this Chapter below for a list of the configuration areas described in this chapter.
The Profile Management component of Configuration Manager is used to define “store personalities” in order to create configuration paths.
Refer to
Chapter 4, “Profile Management” on page 35 for more
information about managing profiles and config paths.
The logged-in user is assumed to represent some tier of the organization. For this reason, the user’s assigned org node hierarchy will determine the information he/she has access to.
See Chapter 2, “Roles, Users, and Security Access” on page 9 for more information about
users and security access.
The following areas can be configured in Configurator:
Codes - Add, edit, and delete configurable codes. See “Configuring Codes” on page 56 .
Discounts - Configure different types of discounts that may be manually applied during a sale transaction. See
“Configuring Discounts” on page 58
.
Reason Codes - Configure common reason codes. See “Configuring Reason Codes” on page 63 .
Menu Configuration - Add, remove and edit options on Xstore menus and tabs.
See “Configuring Menus and Tabs” on page 66
.
Receipt Configuration - Configure common text, such as headers and footers, and
change the logo for your sales receipts. See “Configuring Receipts” on page 81 .
CHAPTER 5: Configurator Version 7.1
System Configuration - Configure behaviors/business rules for Xstore. See
“Configuring Xstore System Config Options” on page 92
.
Security - Configure Xstore security groups and the privileges that are associated with those groups. This option applies to Global configurations only. See
“Configuring Xstore Security” on page 96 .
Tenders - Configure the settings and data related to tenders. See
Customer Displays - Manage the text used on customer-facing displays. See
“Configuring Customer Displays” on page 119 .
Configurator is used to create, maintain, and deploy Xstore configuration changes selectively, or globally across the entire organization. Not all configuration options are available for all scopes. The following configuration scopes are available:
Global Configurations - Change or deploy the global configuration layer which is the foundation for all locations.
Configuration Overrides - Change or deploy configurations that will override the global layer for specific locations (Profile Groups).
Store Specific Overrides - Change or deploy configurations that will override the global layer for specific stores.
Configuration Option Scope Availability
Configure
Deploy
View Configuration Changes
Delete Profile Configuration Changes
2
Global Configurations
Configuration Overrides
Store Specific Overrides
1
Global Configurations
Configuration Overrides
Store Specific Overrides
1
Global Configurations
Configuration Overrides
Store Specific Overrides
1
Configuration Overrides
Store Specific Overrides
1
Copy Store Configurations
Store Specific Overrides
1
1. Store Specific Overrides scope is only available if Xadmin configuration “Enable the Option to Create
Store-Specific Configurations?” is set to Yes.
2. Delete Profile Configuration Changes option is only available if Xadmin configuration “Enable the
Option to Delete Configurations?” is set to Yes.
Version 7.1 User Guide
Xadmin creates and tracks version numbers for each set of configurations deployed via a profile group and element, globally, or a store specific group.
When you create a new configuration set, it is given a version number of 1 (one) to start. The next version number will be increased by one for that specific profile group to be used on the next set of configurations.
When a deployment is scheduled for a profile group and element, the ProfileGroupId,
ProfileElementId and ConfigVersion are recorded in the manifest of the jar file that is produced. This manifest is then used by Xstore to log the version information.
When Xstore starts up, it reads the ProfileGroupId, ProfileElementId and ConfigVersion from the manifest of the jar file, and logs it in the ctl_event_log table with the following information:
Table 5-1: ctl_event_log Table
Column
logger_category log_message
Information logged
dtv.xstore.configversion
ProfileGroupId/ProfileElementId /ConfigVersion
1. From the Xadmin menu, select Config Manager --> Configurator, or click the
Configurator link in the Configuration Manager panel.
2. Select the Configuration Scope:
Figure 5-1: Configuration Scope Options Page
Select Global Configurations to change the global configuration layer which affects all locations. Continue with
<OR>
Select Configuration Overrides to change configurations that will override the global layer for specific locations. The Profile Groups available here are defined in the Profile
Maintenance component of Profile Management. See
Chapter 4, “Profile Management” on page 35
for more information about setting up Profile Groups.
CHAPTER 5: Configurator Version 7.1
a. Select a Profile Group from the list.
b. Select an Element from the list.
c.
Click Next.
d. Continue with step 3 on page 54
.
<OR>
Select Store Specific Overrides to change configurations that will override the global layer for a specific store based on the user's scope.
Store Specific Overrides scope is only available if Xadmin configuration
“Enable the Option to Create Store-Specific Configurations?” is set to
Yes.
a. Type the store number or begin typing a store number or name in the Store # field.
b. Select the store from the store list.
c.
Click Next.
d. Continue with step 3 below.
3. At the Configuration Action page, select the Configure option.
Figure 5-2: Configuration Action Page - Global/Default Scope Example
Version 7.1
4. At the Configuration Options page, select the area you want to configure:
User Guide
Figure 5-3: Configuration Options Page - Global/Default Scope Example
If you selected Codes, see “Configuring Codes” on page 56
.
If you selected Discounts, see “Configuring Discounts” on page 58
.
If you selected Reason Codes, see
“Configuring Reason Codes” on page 63 .
If you selected Menu Configuration, see “Configuring Menus and Tabs” on page 66
.
If you selected Receipt Configuration, see
“Configuring Receipts” on page 81
.
If you selected System Configuration, see
“Configuring Xstore System Config Options” on page 92
.
If you selected Security, see “Configuring Xstore Security” on page 96 . This option is
only available for the Global scope.
If you selected Tenders, see “Configuring Tenders” on page 105
.
If you selected Customer Displays, see “Configuring Customer Displays” on page 119
.
Use the breadcrumbs at the top of the page for navigation.
CHAPTER 5: Configurator Version 7.1
...continued from step 4 on page 55
1. The Xstore codes have been organized by groups. Select a Code Group to view the codes in the group.
Figure 5-4: Code Groups List - Inventory Codes Group Expanded Example
2. Select a code from the expanded Code Groups list to modify.
Figure 5-5: Configure Codes Page - Employee Task Type Code Example
3. Add a new code or edit an existing code:
If adding a new code:
1) Click Add New.
2) Complete the fields as required, then click Save. See
If editing an existing code:
You can only edit global records if you are in a global configuration.
Version 7.1 User Guide
1) Select the code in the list.
2) Edit the fields as required, then click Save. See “Code Configuration Options” on page 57
.
4. After completing code setup, you have the following options:
To deploy your changes, see “Deploying Configuration Changes” on page 120 .
To view a summary list of a profile element's configuration changes to identify how it differs from the global configuration, see
“Viewing Configuration Changes” on page 125
.
[C
ONFIGURATION
O
VERRIDES
& S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To delete the
current profile element configuration changes, see “Delete Profile Configuration
[S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To copy store configurations from another store, see
“Copy Store Configurations” on page 130 .
Figure 5-6: Edit Code Value Window
Value - The name of the code: required, alphanumeric field. In edit mode, this value cannot be changed.
Description - A description of the code: not required, alphanumeric field.
Display Order - Determines the sort order of the code value as compared to other code values for this group.
Locale - If needed, select a translation locale and enter the description for the locale.
Image URL - If applicable, specify the URL of the image file. If this does not apply to the selected code, this option is not displayed.
Rank - If applicable, specify the rank value for this code. If this does not apply to the selected code, this option is not displayed.
Enabled? - Determines whether this code is available for use. A check mark indicates the code is enabled. The Disabled label in the Status column indicates a code is not available for use.
Figure 5-7: Configure Codes Page - Disabled Code Example
CHAPTER 5: Configurator Version 7.1
...continued from step 4 on page 55
1. Maintain discounts or set up system configuration options:
To maintain discounts, select Discount Maintenance and continue with step 2.
To set up system configuration options, select Discount System Configuration and skip to
“Discounts System Configuration” on page 61
.
2. Select the type of discount to configure or set up system configuration options:
Line Item Discounts - Discounts that apply to an individual line item in a sale transaction.
Transaction Discounts - Discounts that apply to all line items in a sale transaction.
Group Discounts - Discounts that apply to a selected group of line items in a sale transaction.
3. Add a new discount or edit an existing discount:
If adding a new discount:
1) Click Add New.
2) Complete the fields as required, then click Next. See
Options” on page 60 for a list of discount configuration options.
to review your selections.
If editing an existing discount:
You can only edit global records if you are in a global configuration.
If you are editing configurations in a specific location (Profile Group or
Store), the Edit button in the Discount Detail window will only be available if you have the proper privileges.
1) Select the discount in the list.
2) At the Discount Detail window, click Edit.
3) Complete the fields as required, then click Next. See
Options” on page 60 for a list of discount configuration options.
4) Continue with step 4 on page 59
to review your selections.
Version 7.1
4. Review the discount options you selected:
User Guide
Figure 5-8: Discount Options Review
To save the discount, click save. The discount is added to the Discount list.
To edit the discount:
Click previous to go back one page.
<OR>
Select a configuration option in the Edit Discount section in the left panel of the window.
After making your changes, click save. The new discount is added to the
Discount list.
To discard the discount, click cancel. When prompted, click Yes to confirm you want to cancel discount setup.
5. After completing discount setup, Xadmin returns to the Discount list page.
To deploy your changes, see “Deploying Configuration Changes” on page 120 .
To view a summary list of a profile element's configuration changes to identify how it differs from the global configuration, see
“Viewing Configuration Changes” on page 125
.
[C
ONFIGURATION
O
VERRIDES
& S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To delete the
current profile element configuration changes, see “Delete Profile Configuration
[S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To copy store configurations from another store, see
“Copy Store Configurations” on page 130 .
CHAPTER 5: Configurator Version 7.1
Basic Information
1. Define the basic information for the discount, then click Next.
Discount Code - The code must be unique, and cannot be changed when editing an existing discount.
Description - Enter a text description for the discount.
Locale for translation - If needed, select a translation locale and enter the description for the locale.
Start Date - Enter or select a starting date.
End Date - If needed, enter or select an ending date.
Discount enabled status check box (enabled by default)
Discounts cannot be deleted. Disable any discounts you do not want to use.
Calculation Information
2. Specify how the discount is calculated, then click Next.
Method - Select a calculation method from the drop-down list.
Amount/Percent - If applicable, enter the amount off or percent off. (This field is not active for discounts without a defined amount or percent off).
For Prompt Amount discounts, select the “Is there a maximum allowed
input amount?" option if there is a limit on the free-format discount amount that can be entered in Xstore and enter the amount when prompted.
For Prompt Percent discounts, select the “Is there a maximum allowed input
percentage” option if there is a limit on the free-format discount percentage that can be entered in Xstore and enter the percent when prompted.
Is there a maximum allowed amount? Select this option if true, and enter the amount when prompted.
Is there a minimum amount to make this discount eligible? Select this option if true, and enter the amount when prompted.
Customized Configuration Options
3. Customize the discount features, then click Next.
Is there a custom message for this discount? - Select this option if true, and enter the custom message when prompted. If needed, select a translation locale and enter the custom message for the locale.
Is it serialized? - Select this option if the discount has an associated serial number.
For example, it may be used with coupon discounts.
Is there a maximum number of times it can be applied in a transaction? -
Select this option if true, and enter the maximum number of times it can be applied in a transaction when prompted.
Version 7.1 User Guide
Is it exclusive? - Select this option if the discount cannot be used with any other discounts.
Can it be modified once it has been applied? - Select this option if the discount can be changed. This option is selected by default (true).
Discount Accessibility Configuration
4. Configure discount accessibility, then click Next.
Is manager clearance required to apply this discount? - Select this option if manager override is required to use this discount.
Eligible Customer Groups. - Select all options that apply. For example:
Elite Program Member
Employee
Employee Family
Normal Level
Eligible Item Types. - Select all options that apply. For example:
Layaway
Order
Sale
Send Sale
Special Order
Work Order
The system configuration options for discounts in this feature are simply a subset of the system configuration options available from
Xstore System Config Options. See “Configuring Xstore System Config
Options” on page 92 for more information.
The following configurations apply specifically to discounts. The categories have been set up as follows:
Discount Options
Enable Discount Threshold Validation? - Determines whether the system validates the total discount amount or percentage against a configured threshold. Note: The thresholds establish maximum allowable amounts or percentages used for discounting; beyond these thresholds, the DISCOUNT_EXCEED_MAX_THRESHOLD privilege is activated.
CHAPTER 5: Configurator Version 7.1
How Should Price Be Rounded After Discount Applied? - The local currency amount rounding method used for determining the price after a discount is applied:
Half Up - Round to the nearest neighbor unless equidistant, then round up.
Half Down - Round to the nearest neighbor unless equidistant, then round down.
Half Even - Round to the nearest neighbor unless equidistant, then round to even neighbor. Example: 2.5 rounds to 2 while 3.5 rounds to 4.
Ceiling - Round toward positive infinity. Note: This is the opposite of FLOOR and never decreases the calculated value.
Down - Round to the next digit; closer to zero.
Floor - Round down toward negative infinity. Note: This is the opposite of CEILING and never increases the calculated value.
Up - Round to the next digit; away from zero.
Unnecessary - Rounding is not necessary.
Minimum # of Items That Can Participate In Group Discount. - The minimum number of items required in order to allow application of a group discount.
Minimum Threshold For You Saved Amount? - The minimum amount of customer savings required for the system to print the customer savings information on the sales receipt.
Precision Decimal Places For Calculating Line Item Discounts. - If
LineDiscountUseConfiguredScale is true, the system uses this scale instead of the local currency scale to round the line item discount amount.
Print You Saved Amount On Receipts? - Determines whether the system prints customer savings information on the sales receipt.
Prompt Confirmation On Item Deletion Participating In Group Discount? -
Determines whether the system prompts for confirmation if the associate wants to remove an item with a group discount. The group discount will be removed from other items as well.
Threshold Amount To Measure Line Item Discounts Against. - If
DiscountThreshold Enabled is true, the system validates the total line item discount amount against the threshold amount specified here.
Threshold Percent To Measure Line Item Discounts Against. - If
DiscountThreshold Enabled is true, the system validates the total line item discount percent against the threshold percent specified here.
Use Special Precision For Calculating Line Item Discount Amounts? - Determines whether the system uses LineDiscountPrecision scale instead of the local currency scale to round the line item discount amount.
Returns
Allow Return Items To Be Discounted On Blind Returns? - Determines whether the system allows applying a discount on a blind return (Customer does not present the original sales receipt.) This configuration applies only to line item and group discounts.
This configuration does not apply to transaction discounts.
Version 7.1 User Guide
Allow Return Items To Be Discounted On Unverified Returns? - Determines whether the system allows applying a discount on an unverified return. (Customer presents the original sales receipt but the system is not able to retrieve the original sales transaction.) This configuration applies only to line item and group discounts. This configuration does not apply to transaction discounts.
Allow Return Items To Be Discounted On Verified Returns? - Determines whether the system allows applying a discount on a verified return. (Customer presents the original sales receipt and the system is able to retrieve the original sales transaction.)
This configuration applies only to line item and group discounts. This configuration does not apply to transaction discounts.
Disable Pro-rated Discounts On Returns? - When this setting is enabled, Xstore will turn off the proration of discounts for returns.
...continued from step 4 on page 55
1. At the Reason Code Search page, select the Reason Code Type from the list, then click
Next.
2. The configuration page for the selected reason code type displays. Add a new reason code or edit an existing reason code.
If adding a new reason code:
1) Click Add New.
2) Complete the fields as required, then click Next. See
Configuration Options” on page 64
for a list of reason code fields.
.
If editing an existing reason code:
You can only edit global records if you are editing records in a global configuration.
If you are editing configurations in a specific location (Profile Group or
Store), the Edit button in the Reason Code Detail window will only be available if you have the proper privileges.
1) Select the reason code in the list.
2) At the Reason Code Detail window, select Edit.
3) Complete the fields as required, then click Next. See
Configuration Options” on page 64
for a list of reason code fields.
4) Continue with step 3 below.
CHAPTER 5: Configurator
3. Review the reason code options you selected:
Version 7.1
Figure 5-9: Reason Code Options Review
To save the new reason code, click save. The reason code is added to the Reason
Codes list.
To edit the reason code:
Click previous to go back one screen.
<OR>
Select a configuration option in the Edit Reason Code section in the left panel of the window.
After making your changes, click save. The new reason code is added to the
Reason Codes list.
To discard the reason code, click cancel. Click Yes to confirm you want to cancel reason code setup.
4. After completing reason code setup, Xadmin returns to the Reason Codes list page.
To deploy your changes, see “Deploying Configuration Changes” on page 120 .
To view a summary list of a profile element's configuration changes to identify how it differs from the global configuration, see
“Viewing Configuration Changes” on page 125
.
[C
ONFIGURATION
O
VERRIDES
& S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To delete the
current profile element configuration changes, see “Delete Profile Configuration
[S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To copy store configurations from another store, see
“Copy Store Configurations” on page 130 .
The set of configuration options will vary with the Reason Code Type. This section defines the basic options available for setting up reason codes.
General Options
Enabled? - Reason Code enabled status check box. This option is enabled by default. Remove the check mark to disable the reason code.
Version 7.1 User Guide
Reason Code - The reason code value associated with the reason type code. This value must be unique, and cannot be changed when editing an existing reason code.
Description - Text description for the reason code.
Locale for translation - If needed, select a translation locale and enter the description for the locale.
Does this reason code have a parent code? - If true, select the parent reason code (hierarchy level) upon which the nested reason code is based.
Does this reason code require that a comment be added? - If true, the POS user will be prompted to add a comment. Specify whether the comment is optional
(Prompt to add comment), or if the comment is required (Comment is required).
Does this reason code need to display a customer message? - If true, enter the customer message to be displayed when the reason code is selected in the POS system. If needed, select a translation locale and enter the customer message for the locale.
Should this reason code be excluded from reason code lists displayed in
Xstore? - Select this option if this reason code will not be available to the Xstore
POS user.
Inventory Adjustment Options
What is the inventory action code for this reason code? - If this reason code has an inventory action code, select the code from the list to specify the inventory action (add or subtract from inventory) to be taken based on the reason code.
Paid In/Paid Out Options
Does the reason code have a General Ledger Account Number? - If this reason code is associated with a General Ledger account, enter the General Ledger account number to be recorded when the reason code is selected in Xstore.
Does the reason code require a minimum amount? - If true, enter the minimum monetary amount allowed for this reason code.
Does the reason code require a maximum amount? - If true, enter the maximum monetary amount allowed for this reason code.
Return Reason Code Options
What inventory location ID is affected by this reason code? - Select the inventory location ID to which the item will be returned.
What inventory bucket ID is affected by this reason code? - Select the inventory bucket ID within the location to which the item will be returned.
CHAPTER 5: Configurator
Version 7.1
Use of the Menu Configuration and Tab Configuration tools assumes some knowledge of the Xstore menus and tabs and how they are used in the Xstore application.
...continued from step 4 on page 55
Select a menu option:
Figure 5-10: Menu Options
Select Menu Configuration to add, remove, and edit options on Xstore menus.
Continue with Xstore Menu Configuration below.
Select Tab Library Configuration to add or remove message area tabs used in
Xstore. Skip to “Xstore Tab Configuration” on page 76 .
Select Menu System Configuration to configure the system configuration settings that are specific to menus. Skip to
“Menu System Configuration” on page 80
.
The Xstore menus have been organized by categories. For example, all menus with a category of Back Office will be grouped together under the Back Office category name and all menus with the category Tender will be grouped together under the Tender category name.
Version 7.1 User Guide
This is a Menu Category folder. All menus belonging to this category are located in this folder.
A blue Menu Category folder indicates a menu within the folder has been modified.
This icon indicates there are additional menus nested below this list menu type.
This icon indicates there are additional menus nested below this button menu type.
This icon indicates this is the lowest level for this list menu type. There are no menus nested below this menu.
This icon indicates this is the lowest level for this button menu type. There are no menus nested below this menu.
This icon indicates this list menu type has been modified.
This icon indicates this button menu type has been modified.
This icon indicates that this menu also appears in other Categories. Any changes made to this menu in one category will also be applied to the menu in all the categories where it appears.
To find menus containing specific text, enter the search text in the input box, then press
[Enter]. The results are shown in the left panel (folder tree). Only those menus containing the specified text are displayed. If needed, click Clear to remove the search criteria and return to the default Menu Configuration page.
Click the Only Show Overrides check box to view only the Menu Categories and menus that have been changed.
CHAPTER 5: Configurator Version 7.1
Perform the following steps to configure Xstore menus.
1. After selecting Menu Configuration at the Menu Options page (Figure 5-10), click the
menu category from the Menus tree that you want to configure.
Figure 5-11: Menu Configuration Page - Menu Categories
2. With the category expanded, click the menu you want to configure.
3. You have the following configuration options:
Edit existing menu options:
To change the menu text, see “Changing the menu text” on page 70
.
To remove a menu option, see “Removing a menu option” on page 71 .
To change a menu option location, see “Changing a menu option location” on page 72
.
Add a new menu option. See
“Adding a New Menu Option” on page 73 .
4. After completing menu setup, you can perform the following options:
To deploy your changes, see “Deploying Configuration Changes” on page 120 .
To view a summary list of a profile element's configuration changes to identify how it differs from the global configuration, see
“Viewing Configuration Changes” on page 125
.
[C
ONFIGURATION
O
VERRIDES
& S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To delete the
current profile element configuration changes, see “Delete Profile Configuration
[S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To copy store configurations from another store, see
“Copy Store Configurations” on page 130 .
Version 7.1
With the menu displayed, edit the menu as needed.
Menu List Example
User Guide
Menu Button Example
Refer to the following sections for procedural information.
CHAPTER 5: Configurator Version 7.1
Changing the menu text
1. Select the menu option to be changed and type the new menu name in the text field below the menu. The old text is replaced by the new text you typed.
Figure 5-12: Menu List Example - New Text
Figure 5-13: Menu Button Example - New Text
2. [
O
PTIONAL
] Select a locale to view the menu as it will be displayed in a different locale.
This option will only show the locales set up for you organization.
3. Click Save.
Figure 5-14: Available Locales List
Version 7.1 User Guide
Notes: About this page:
• The red icon in the tab indicates this configuration change has not been saved.
• To close the tab, click the close icon . You will be prompted if there are unsaved changes.
• Click Cancel to discard your changes.
Removing a menu option
1. Select the menu option to be removed and click the Delete button. The menu option will be removed from the menu. The other menus will be shifted accordingly.
Figure 5-15: Menu List Example - Delete Selected Menu
Figure 5-16: Menu Button Example - Delete Selected Menu
If needed, click Cancel if you want to discard your changes before saving.
2. Click Save.
CHAPTER 5: Configurator Version 7.1
Changing a menu option location
For Menu Buttons:
1. Select the menu button to be moved and click the Left and Right arrows to change the menu button location within the menu. The other menu buttons will be shifted accordingly
The icon associated with a menu button indicates this button is
“locked” in this location and cannot be moved. The Left and Right arrows will be disabled since the menu button cannot be moved.
Click Cancel if you want to discard your changes before saving.
2. Click Save.
For Menu Lists:
1. Select the menu option to be moved and click the Up and Down arrows to change the menu option location within the menu. The other menus will be shifted accordingly.
Click Cancel if you want to discard your changes before saving.
2. Click Save.
Version 7.1
User Guide
Adding new options to menus assumes you have a working knowledge of how and where the menus are used in the Xstore application.
1. With the menu displayed, click Add.
Figure 5-17: Menu List Example
Figure 5-18: Menu Button Example
CHAPTER 5: Configurator Version 7.1
2. At the Add Action window, select a menu option to be added to the selected menu and click Accept.
Figure 5-19: Add Action Window
To find a menu option quickly, type the name in the search field.
Clicking Cancel will return to the menu without making any changes.
3. When prompted, click the location for the new menu option. The other menu options will be adjusted accordingly if needed.
Menu List Example
Figure 5-20: New Menu Option Location
Figure 5-21: New Menu Option Added
Version 7.1
Menu Button Example
Figure 5-22: Menu Buttons - New Menu Option Location
User Guide
Figure 5-23: Menu Buttons - New Menu Option Added
Note: In the menu button example shown above, the More button was added
automatically to accommodate the new menu option.
4. Click Save.
CHAPTER 5: Configurator Version 7.1
The Xstore Tab Library contains a set of ready-to-implement tabs and widgets that can be easily incorporated into Xstore to enhance the user experience. The Tab Library provides multiple options for information tabs and web widgets, beyond the five standard tabs traditionally provided in the Information area with base Xstore. You can select from an array of pre-defined widgets and tabs in the library to be displayed in Xstore.
In addition, these tabs can be configured to work in different contexts. For example, tabs that display in "login mode" may not be the same tabs that are available during "transaction mode".
Additional configuration may be required to set up the information found on the various tabs. The tab configuration feature described here is used to manage which pre-defined tabs are used in Xstore and where they will appear.
Security privileges are required to use this feature:
Security Privilege Description
Configurator
Menu Configuration
This privilege allows the user to access the menu config option from the configurator landing page
This privilege allows the user to access the actual menu config feature.
Tab Configuration
This privilege allows the user to access the tab library config feature.
The base implementation of Xstore displays five information tabs: Info, Tasks, (Sales) Goals,
Messages, and Keypad. The tabs and widgets in the library can be used in place of—or in addition to—the tabs provided with base Xstore.
It is possible to add more or less than the standard five tabs delivered in base Xstore; however, for best results MICROS recommends a limit of five tabs per context.
Perform the following steps to configure which tabs will be in use, and where they will be displayed.
Version 7.1 User Guide
1. After selecting Tab Library Configuration at the Menu Options page ( Figure 5-10 on page 66
), the Tab Library Configuration page displays.
Figure 5-24: Tab Library Configuration Page
This page shows the current tab layout for the selected context
(Default or Transaction). Any text located within the tab area will appear blurred and is simply shown to illustrate the tab's content.
2. At the Tab Library Configuration page, choose the tab context from the drop-down list:
Tabbed Pane Default - The tabs that are available when not in a transaction.
Tabbed Pane Transaction - The tabs that are available during a transaction.
3. [
O
PTIONAL
] Select a locale to view the tab as it will be displayed in a different locale. This option will only show the locales set up for you organization
4. Choose from the following options for the selected tab context:
To add a new tab, see
“Adding a New Tab” on page 78 .
To remove a tab, see
.
To move a tab, see “Moving a Tab Position” on page 79 .
To change the tab name, see “Changing a Tab Name” on page 79
.
5. After saving the tab configuration, you can perform the following options:
To deploy your changes, see “Deploying Configuration Changes” on page 120 .
To view a summary list of a profile element's configuration changes to identify how it differs from the global configuration, see
“Viewing Configuration Changes” on page 125
.
CHAPTER 5: Configurator Version 7.1
[C
ONFIGURATION
O
VERRIDES
& S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To delete the
current profile element configuration changes, see “Delete Profile Configuration
[S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To copy store configurations from another store, see
“Copy Store Configurations” on page 130 .
1. At the Tab Library Configuration page, click the Click here to add a tab to the viewport link.
2. Select a tab from the list and click the Add button. The tab is added to the information area image.
Figure 5-25: Tab Options
To close the Add Tab window without making any changes, click the button.
Version 7.1
3. If needed, override the default field(s).
User Guide
Figure 5-26: URL Example
For the URL tab, the POS Terminal must have rights to view the URL website through security and fire wall settings maintained by the corporate office.
4. Click Save to save your changes.
1. At the Tab Library Configuration page, click the tab you want to remove.
2. With the tab selected, click the Remove button (see Figure 5-26).
3. When prompted, click Yes to confirm you want to remove the selected tab.
The tab is removed from the information area image.
4. Click Save to save your changes.
1. At the Tab Library Configuration page, click the tab you want to move.
2. With the tab selected, click the navigation buttons
position left or right (see Figure 5-26).
3. Click Save to save your changes.
to move the selected tab’s
1. At the Tab Library Configuration page, click the tab you want to rename.
2. With the tab selected, type a new name for the tab.
3. Click Save to save your changes.
Although the tab name is not a required field in Xadmin, Xstore expects a name and will display a translation error if the name is not specified here.
CHAPTER 5: Configurator Version 7.1
The system configuration options for menus in this feature are simply a subset of the system configuration options available from Xstore
System Config Options. See
“Configuring Xstore System Config
Options” on page 92 for more information.
The following configurations apply specifically to menus. The categories have been set up as follows:
Help
Name Of Help Menu - The menu to be displayed when the Help button is selected. The set of actions to be run for the menu are defined in MenuConfig.xml.
Register Configuration
The Number Of Buttons On A Menu - This determines the number of buttons on a menu. Users are required to make a corresponding change to UIConfig.xml. These settings will not impact the Xmobile menu layout which will remain fixed at a 3 x 2 grid.
Store Specific
Hide Menu Options From Users That Lack Access? - This is used to hide menu options the user does not have security privileges to use. Answer yes to hide the menu option completely. Answer no to display the option as disabled.
Version 7.1
User Guide
Receipt configuration is limited to certain receipts, and to specific areas within those receipts.
...continued from step 4 on page 55
1. Select a receipt option:
Find Receipt By Transaction - Select this option if you want to make your edits
based on a specific receipt from a known transaction. See “Finding the Receipt by
.
Find Receipt By Type - Select this option if you want to make your edits based on
a specific type of receipt. See “Finding the Receipt by Type” on page 82
.
Change Receipt Logo - Select this option to change the logo that displays on your
sales receipts. See “Changing the Receipt Logo” on page 87 .
Receipt System Configuration - Select this option to configure system
configuration settings specific to receipts. See “Receipt Configuration: System
Configuration Options” on page 88 .
2. After completing receipt setup, you can perform the following options:
To deploy your changes, see “Deploying Configuration Changes” on page 120 .
To view a summary list of a profile element's configuration changes to identify how it differs from the global configuration, see
“Viewing Configuration Changes” on page 125
.
[C
ONFIGURATION
O
VERRIDES
& S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To delete the
current profile element configuration changes, see “Delete Profile Configuration
[S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To copy store configurations from another store, see
“Copy Store Configurations” on page 130 .
CHAPTER 5: Configurator
Version 7.1
For a receipt type to be available here, an actual transaction must exist that uses the receipt type.
1. Select a receipt type (and a locale if applicable) from the list and click Search.
Figure 5-27: Receipt Types
The Locale drop-down field defaults to the locale of the current user. Locale is used to find the selected receipt types that match to the selected locale. For example, if Espanol is selected from the
Locale list, only those receipts that are assigned to the Espanol locale will be displayed.
If the search yields no results, a message is
shown below the receipt list.
2. At the Receipt Configuration page, select a receipt from the Receipt Options drop-down list. The Receipt Options drop-down list contains the various receipts available for the selected receipt type.
3. The Edit Receipts page displays.
The initial view of the Edit Receipts page automatically displays the first receipt type in the drop-down list.
Version 7.1 User Guide
Figure 5-28: Edit Receipts Page - Bounce Back Coupon Receipt Example
Notes: About the Edit Receipts Page
The calendar date and receipt view default to the current day. If applicable, use the calendar to select another date to view the receipt with the text entries for that specific date. Click the Refresh button to update the receipt for the new date.
If the receipt you selected cannot be edited, you will see this message and the receipt will appear as a gray image.
You can select another receipt from the list, or use the navigation breadcrumbs to return to the previous screen.
Only receipt sections highlighted in red can be edited.
CHAPTER 5: Configurator
If a receipt section is not enabled for the current receipt, the section is shown as a watermark with a white background and gray text, but can be edited.
Version 7.1
4. Click on an area of a receipt that is highlighted in red to change it. The selected section will be highlighted in green to indicate it is the active section. The text area on the Edit
Receipts page shows all existing entries for the selected section and the effective dates if applicable.
5. At the Edit Receipts page (Figure 5-28), add new text or edit existing text:
To edit an existing line of text, click the text line to open the Edit Receipt Text window and make your receipt changes as needed.
To add new text, click the Add New button to open the Edit Receipt Text window and add new text as needed.
Figure 5-29: Edit Receipt Text Window
a. Receipt Text - Type the text as it should appear on the selected section of the receipt.
b. Dates - [
O
PTIONAL
] Date fields are not required. If there are no dates for a row, the text will always be displayed for the selected section. To create date-defined text for the selected section of the receipt, enter a Start Date and End Date for the length of time the text will be printed on the receipt. This provides the ability to set up future text for each section in a receipt without affecting the current receipt. Leave the End Date field blank if there is no ending date. Leave both date fields blank if there are no date restrictions. To view the receipt changes for a specific date, select the date and click Refresh.
c.
Locale - [
O
PTIONAL
] To add or edit receipt text for a different locale, select a locale from the locale drop-down list and enter translated text. This option is only available if multiple locales have been set up for your organization.
Version 7.1 User Guide
d. Text Format - [
O
PTIONAL
] Use the following icons to format the text on the receipt.
When an icon is selected, the format will be applied to all of the text in the box, even if only part of the text was selected at the time. When a format option is selected, the icon changes to a blue background. If you need to remove a format from the text, click the blue icon to remove the formatting. The icon will now be white, indicating the format is not applied.
Icon Format Result
Click this icon to make the text bold.
Click this icon to italicize the text.
Click this icon to underline the text.
When choosing to underline text, most receipt printers will underline the entire row whether there is text there or not.
For example:
Thanks for shopping!
Xadmin displays the full underline on the Receipt view; however, it is not shown in the text area of the page.
Click this icon to make the text double wide.
Xadmin displays the double-wide text spacing on the Receipt view; however, it is not shown in the text area of the page.
Click this icon to make the text double high.
Xadmin cannot display the double-high text on the Receipt view or in the text area of the page.
e. Disabled/Enabled - The receipt text is enabled by default. To disable the receipt text, click the Is this text enabled? check box to remove the check mark. Disabled text is not shown in the receipt view.
6. Click Save.
CHAPTER 5: Configurator Version 7.1
7. The receipt view displays and shows your changes using the updated Start date.
Figure 5-30: Edit Receipts Page - Modified Receipt Text Example
If there are multiple entries with the same or overlapping dates, the entries will all display on the receipt. Order will be determined by when the row was added. The order on the receipt will match the order in the text area of the Edit Receipts page.
1. Complete all the fields to locate the receipts from a specific transaction: Store number,
Date the transaction was completed, Register identifier where the transaction was rung, and the Transaction number.
Figure 5-31: Input Fields
2. Click Search to return a list of the receipts for the transaction.
3. Continue with
step 3 on page 82 . The process for modifying receipts either by
transaction receipt or by receipt type is the same from this point forward.
Version 7.1
Notes: About the logo file format
• Only black and white images may be used.
• Only bitmap (.bmp) format is supported.
• File size cannot exceed 100KB.
• Image width cannot exceed 400 pixels.
1. With your current logo displayed, click the Change button.
User Guide
Figure 5-32: Change Receipt Logo Option
2. Click Browse to browse for the new logo file for the receipt.
Figure 5-33: Receipt Configuration - Choose and Upload File
CHAPTER 5: Configurator Version 7.1
3. After locating the correct file, click Upload to import the file.
If this is not the logo you want to use, click Browse to find a different logo.
If the file format for the new logo you selected is not supported, you will see this message. Click Browse to find a different logo.
(Refer to
“About the logo file format” on page 87
for the supported image formats).
4. With the new logo displayed, click Save.
Figure 5-34: New Logo Uploaded
5. The new logo is now shown in the Current Logo section of the page.
The following configurations apply specifically to receipts. The categories have been set up as follows:
“Commission Options” on page 89
“Inventory Location Based” on page 90
“Till Accountability” on page 91
“Transaction Behavior” on page 91
Version 7.1 User Guide
The system configuration options for receipts in this feature are simply a subset of the system configuration options available from Xstore
System Config Options. See
“Configuring Xstore System Config
Options” on page 92 for more information.
Charity
Enable Printing Charitable Contribution Line Item On The Receipts? - Enable/
Disable the donation line item being printed on the receipts.
Enable Printing Charity Footer Message On The Receipts? - Enable/Disable the charity footer message being printed on the receipts.
Commission Options
Print Sales Associate First Name On Receipts? - Determines whether the system prints the first name of the current transaction's commissioned associates on the sales receipts.
Print Sales Associate Last Name On Receipts? - Determines whether the system prints the last name of the current transaction's commissioned associates on the sales receipts.
Print Sales Associates Using Multiple Lines On Receipt? - Determines whether the system prints each commissioned associate on a new line (Yes) or all commissioned associates on one line (No) on the sales receipts.
Discount Options
Minimum Threshold For You Saved Amount. - Enter the minimum amount of customer savings required for the system to print the customer savings information on the sales receipt.
Print You Saved Amount On Receipts? - Determines whether the system prints customer savings information on the sales receipt.
Email Settings
Default Email Host? - Specify the default email host name used for emailing customer receipts.
Default Receipt Email Subject. - Specify the default subject for an emailed receipt.
The value is specified in translations_en.properties.
Font Settings For The Email Text Used When Sending Receipts. - Specify the font family and size for email receipt text.
Prompt To Email Receipts? - Determines whether users are always prompted with the option to email receipts to customers.
Select Yes to always prompt to ask the customer if they want receipts emailed.
Select No and the system will check the email permissions for the customer and will only email if the permission is set to yes.
Save Updated Email Address To Customer Record? - Determines whether customer email addresses are updated and saved to the customer record during the process of emailing a transaction receipt.
CHAPTER 5: Configurator Version 7.1
Send Receipts Via Email? - This is the global on/off switch for sending email receipts.
Select Yes to enable the functionality. Receipts are emailed to customers if the receipt is configured as an email receipt.
Translation Key For The Sender Name Of Emailed Receipts. - Specify the translation key for the sender name of receipt emails. The value is specified in translations_en.properties.
Gift Receipts
Allow User To Choose Gift Receipt Print Method? - Determines whether the system allows the user to choose to print a gift receipt for each item or one gift receipt for all items.
Select Yes to allow the user to choose whether to print a gift receipt for each item or one gift receipt for all items.
Select No to not allow the user to choose a gift receipt type option.
Maximum Gift Receipts That Can Be Printed. - Enter the maximum number of gift receipts allowed to be printed by the system before a manager override is required.
Print One Receipt Per Gift Item? - Used when the quantity of a line item is greater than one. Determines whether the system prints a separate gift receipt for each item
(Yes), or prints one gift receipt for the total quantity (No).
Prompt User To Group Gift Receipts? - Determines if the associate is prompted to group items onto one or many gift receipts at the customer's discretion.
Gift Registry
Automatically print gift receipts for items purchased from a gift registry? -
Determines whether the system automatically adds a gift receipt to an item purchased from a gift registry. Select Yes to have the gift receipt automatically added to an item purchased from a gift registry.
Inventory Location Based
Print Inventory Location Sold From On Receipt? - Determines whether the system prints the inventory location from which an item was sold on the receipt.
Item Options
A List Of Non-Merchandise Item Types That Are Included In Item Count. - Select the non-merchandise item types that will be included in the total item sold count on the sales receipt. Valid Values: Voucher, Loyalty Card.
Kit Options
Link The Component Quantity Of A Kit To The Kit Quantity For Receipts? -
Determines whether the quantity of the kit component rows on the virtual and real receipts are linked to the quantity of the kit item.
If Yes, the component item quantity displayed will be multiplied by the quantity of the parent kit line item.
If No, the component item quantity will not change, regardless of the parent kit line item's quantity.
Version 7.1 User Guide
Maximum Number Of Kit Components To Display On A Receipt. - Enter the maximum number of kit components to display on the virtual receipt for a kit item. If there are more kit components than rows available for display, the last row will be used to display a continuation string, such as an ellipsis (...).
Layaway
Print Layaway Merchandise Ticket Per Item? - Determines whether the system prints a separate merchandise ticket for each layaway item at setup.
Print Layaway Merchandise Ticket With All Items? - Determines whether the system prints a merchandise ticket for a layaway account.
Print Layaway Specific Receipt? - Determines whether the system prints a layaway receipt that contains only layaway account and item information. Line items belonging to other sale types (i.e. sales or returns) will not be included on this receipt.
Loyalty Options
Show Loyalty Card Expiration Date? - Determines whether to show the loyalty card expiration date in the display and on the receipt.
Send Sale
Print Merchandise Ticket For Send Sale Items? - Determines whether the system prints a merchandise ticket for each send sale item sold.
Till Accountability
Print Total Cash Pickup Amounts On Closing Till Receipts? - Determines whether the system prints the total cash pickup amount on closing till count receipts.
Training Mode
Restrict Printing Of Receipt Confirming Training Mode Enter And Exit? -
Determines whether the system prints receipts for entering and exiting training mode.
(Training mode must be enabled on the register for this option to be valid.)
Restrict Receipt Printing In Training Mode? - Determines whether the system prints receipts in training mode. (Training mode must be enabled on the register for this option to be valid.)
Transaction Behavior
Print Store Copy Of Receipt When Sigcap Used? - Determines whether the system prints a store copy sales receipt if the customer signature is captured by a signature capture device.
Print Suspended Transaction Receipt? - Determines whether the system prints a receipt when suspending a retail transaction.
CHAPTER 5: Configurator Version 7.1
This option replaces the standard process of manually managing the
SystemConfig.xml file. If you use this Xadmin configuration tool,
SystemConfig.xml files should not be created manually and installed in any store/register (via config path).
If any SystemConfig.xml files are manually created and installed in any store/register (via config path), the changes they contain will work in Xstore as they always have; however, these configurations will be totally unknown to this System Config option and may possibly impair its ability to work properly.
...continued from step 4 on page 55
1. At the System Configuration page Search box, do one of the following:
Figure 5-35: System Configuration Page - System Config Search Box
To find system configurations containing specific text, enter the search text in the input box, then press [Enter]. The text typed here can be found anywhere within the configuration: the label, the description, the module, or the config path itself. The results are shown in the left panel (folder tree). Only those configurations containing the specified text within the label, description, module, or config path are displayed.
If needed, click Clear to remove the search criteria and return to the default System
Configuration page.
To view only system configuration categories and configuration options with overrides, select the Only Show Overrides check box.
About Configuration Overrides
A configuration marked as an override differs between scopes:
Within the Global scope, an override means that the state of the configuration varies from Xstore base configuration.
Within a Profile Group/Profile Element combination, an override means that the configuration varies from the Global configuration.
To return to the default System Configuration page, deselect the check box.
Version 7.1
To display additional filtering options, click Show more filters.
Additional filter options display:
User Guide
Figure 5-36: Additional Filter Options
This option provides an extra level of organization for the various configuration options, and also provides the ability to filter on just one or many tags. By default, all tags are selected. Select one or more tags to view only the related category folders. To select all tags at once, click Include all. To clear all selected tags, click
Exclude all. When finished with the filter options, click Hide filters.
2. Continue with
Viewing/Editing System Configurations
.
1. On the left side of the System Configuration page, click the arrow associated with a system configuration category to open the folder and show the configuration options within the selected category.
Figure 5-37: System Configuration Page - Expanded Category Folder
CHAPTER 5: Configurator Version 7.1
If a category contains at least one configuration option that has been overridden, the color of the folder is blue (
1
).
The overridden configuration option within the category is indicated by an override icon
(
2
).
See
Overrides” on page 92 for more information about configuration overrides.
2. Select a configuration option within the selected category to view the configuration details in the right side of the System Configuration page.
Figure 5-38: System Configuration Page - Configuration Option Detail
The following detailed information displays:
The configuration name (label).
The configuration description.
The tag or tags associated with the selected configuration. This information can be used to filter or search for configurations.
Valid values when applicable.
Base Value or Global Value if the Configuration has been overridden. See Figure 5-
The current value setting of the configuration.
Note: If this setting is different than its original value (Base for Global scope as shown here, and Global for configuration overrides) the original value is also shown
Version 7.1
in this section. See
“About Configuration Overrides” on page 92 .
User Guide
Figure 5-39: Global Scope - Base Value Override
The path in SystemConfig.xml (at the bottom of the page).
3. Click Edit to make any changes.
4. At the editing window you have the following options:
Figure 5-40: System Configuration - Edit Window
Edit Config - Select an option or enter information as needed for the configuration.
Force to appear as override check box - Select this option to label the configuration as an override.
Overrides differ between scopes. Within the Global scope, an override means that the state of the configuration varies from Xstore base configuration. Within the
Profile Group/Profile Element combination scope, an override means that the configuration varies from the Global configuration.
This setting is more than an arbitrary flag. For example, if a Profile Group/Profile
Element is using the same config values as the global configuration, that means that when you change the config values for the global configuration, you are also
CHAPTER 5: Configurator Version 7.1
effectively changing the config values for the profile group/profile element. Using this check box, config values marked as overrides for a Profile Group/Profile Element will not change.
Revert to base value
1
or Revert to global value link - Click this link to revert the configuration back to the base value (or global value for Profile Group/Profile
Element combination scope).
Edit Form Navigation Options:
To close the form without saving your changes, click .
To view the previous/next configurations in the category, click .
5. Click Save to save your changes and return to the System Configuration Page.
6. After completing System Configuration setup, you can perform the following options:
To deploy your changes, see “Deploying Configuration Changes” on page 120 .
To view a summary list of a profile element's configuration changes to identify how it differs from the global configuration, see
“Viewing Configuration Changes” on page 125
.
[C
ONFIGURATION
O
VERRIDES
& S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To delete the
current profile element configuration changes, see “Delete Profile Configuration
[S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To copy store configurations from another store, see
“Copy Store Configurations” on page 130
...continued from step 4 on page 55
This option is only available for the Global scope.
1. Select an option from the Security Configuration page:
Figure 5-41: Security Configuration Page Options
Version 7.1 User Guide
Select Security Privileges to set up Xstore security privileges. Continue with step 2
below.
Select Security Groups to add or edit existing Xstore security groups. Skip to
“Security Groups Setup” on page 98 .
Select Security System Configuration to configure system configuration settings
specific to security. Skip to “Security System Configuration” on page 100
.
2. At the Security Privileges page, select a privilege to edit.
To find a security privilege in the list, type any text that may be part of the privilege in the “Find a Privilege” text box at the top of the page.
3. Edit the Security Privilege as needed:
Figure 5-42: Edit Security Privilege Window
Edit Form Navigation Options:
To close the form without saving your changes, click .
To view the previous/next configurations in the category, click .
Is authentication required? - Determines if the POS system should either always prompt for authentication, or authenticate against the current POS user. If selected, indicates that authentication is required for this privilege type.
Can this privilege be overridden? - If selected, the privilege can be overridden.
Security Groups - Select all groups that apply. For example:
CHAPTER 5: Configurator Version 7.1
Everyone
Trainee
Cashier
Keyholder
Manager
Is a second set of credentials required? - Determines whether a second authorization is required.
If selected, complete additional information as needed:
Do they have to be different than the first set? - If selected, then the same
Employee ID cannot be used in both prompts.
Second Security Groups - Select all groups that apply.
4. Click Save to return to the Security Configuration page.
5. After completing Security Privilege setup, you can perform the following options:
To deploy your changes, see “Deploying Configuration Changes” on page 120 .
To view a summary list of a profile element's configuration changes to identify how it differs from the global configuration, see
“Viewing Configuration Changes” on page 125
.
1. Select Security Groups from the Security Configuration page.
Figure 5-43: Security Configuration Page Options
Version 7.1
2. You have the following options at the Security Groups Page:
User Guide
Figure 5-44: Security Groups Page
To add a new Security Group, click the add a new security group link.
a. Enter the information in the Add Security Group window. All fields are required.
Figure 5-45: Add Security Group Window
b. Click Save. The new group is added to the Security Groups list.
To edit an existing Security Group, select it in the Security Groups list, then click Edit.
a. Enter the information in the Edit Security Group window. Only the rank can be changed.
b. Click Save.
Figure 5-46: Edit Security Group Window
CHAPTER 5: Configurator Version 7.1
3. After completing Security Groups setup, you can perform the following options:
To deploy your changes, see “Deploying Configuration Changes” on page 120 .
To view a summary list of a profile element's configuration changes to identify how it differs from the global configuration, see
“Viewing Configuration Changes” on page 125
.
The system configuration options for security in this feature are simply a subset of the system configuration options available from Xstore
System Config Options. See
“Configuring Xstore System Config
Options” on page 92 for more information.
The following configurations apply specifically to security. The categories have been set up as follows:
“Till Accountability” on page 103
House Accounts
Manager Override When Tender Amount Exceeds House Account Balance? -
Determines whether the system prompts for manager override if the tender amount exceeds the remaining balance of the house account. If Yes, and a manager-level user is logged in, the system displays the credit limit and prompts the user to proceed. If a user lower than the manager privilege is logged in, and the user chooses to proceed with exceeding the credit limit, the manager security login displays for approval.
Sales
Allow User To Ring His/Her Own Sale? - Determines whether the system allows employees to ring retail transactions for themselves.
Security
Account Lockout Allowable Retry Attempts. - If Account Lockout functionality is enabled, the system locks out the associate's account after this number of failed login retries. Default: Enabled, set to 3 attempts.
Allowable Retry Attempts Per Challenge Question. - If Account Lockout functionality is enabled, the system locks out the associate's account after this number of failed challenge question retries.
Check For An SSL Certificate? - This setting determines if the system will check the
SSL certificate.
Confirm The Quantity Of A Store Replenishment Order? - The quantity above which the user will be prompted to confirm the value entered on the store replenishment order.
Version 7.1 User Guide
Enable Lockout Feature For Failed Login Attempts? - Turns on/off the Account
Lockout functionality where the system locks out the associate's account after a configured number of failed login retries. Default: Enabled
Enable Password Expiration? - Turns on/off Password Expiration functionality to expire an employee login password after a specified number of days. Default: Enabled
Password Expiration Days. - If Password Expiration functionality is enabled, the system expires an employee login password after this number of days. Default: 90 days
Password Re-Use Restriction Count. - Associates are not allowed to reuse the same password within this number of password resets.
Provide A Warning Before A Certificate Expires? - This setting determines the maximum number of days remaining before an SSL certificate expires where the system will warn the user of the expiration.
Setting this value to 0 will set it to the default value (14).
Relate Default User ID. - The default user Id that has access to Relate. This user Id must be set up in both Xstore and Relate for WSDL version 2.
Relate Security Type. - Determines how user data security should be pulled from
Relate. This will tell whether the security is based on the individual user, the user's role, or a default user.
No Security - Send the configured default user for every call. This will give the same security setting for everyone.
User ID - Send the actual user Id. For this option, every Xstore user must be set up in Relate.
User Role - Send the Primary Group Id of the user.
The number of password challenge questions required for employee
identification. - This setting provides the ability to dictate how many challenge questions employees must answer before being allowed to reset their password.
There are ten challenge questions stored within the database, therefore no more than ten questions can be asked.
Treat Security Groups As 'Greater-Than' Or 'Greater-Than Or Equal-To'. - When creating/editing employees, this determines whether higher-ranked in sec_groups.group_rank means "greater than" or "greater than or equal".
Answer Yes to allow a logged in user to edit associates with a rank that is equal to or lower than the logged in associate.
Answer No if the logged in user can only edit associates with a lower rank than themselves. If set to No, the highest ranking employee in the store will be unable to create or edit an employee of equal rank. In this scenario, the information must be downloaded from the home office rather than created in the store. (For example, if
CHAPTER 5: Configurator Version 7.1
Manager is the highest rank in the store, new managers must be downloaded from the home office rather than created in the store).
Use challenge questions for employee password reset? - Turning this setting on will enable the use of challenge questions to identify an employee for the purpose of resetting the employee's password.
Once this is turned on, any employee that has yet to select and answer challenge questions will be forced to do so upon successfully logging into back office or register mode.
Which Id To Use For Employee Logon? - Determines the type of identification the associates will use to log into the system; Employee ID or Login ID.
Store Specific
Default Id Type For Tenders Requiring Customer Identification. - The default identification type used for certain tenders that require customer identification information. Valid Values: Drivers License, Social Security, Military Id, Credit Card,
Employee Id, Customer Card, Any identification type
Hide Menu Options From Users That Lack Access? - This is used to hide menu options the user does not have security privileges to use. Answer yes to hide the menu option completely. Answer no to display the option as disabled.
Tender Options
Authorization Method Code For BinSmart Lookups. - This is the authorization method code used to perform the lookup. Valid only for Merchant Warehouse.
Display Cash Total? - Only applicable for currency rounding, this indicates whether the rounded cash total is displayed below the transaction total in the viewport.
Enable Merchant Warehouse's BinSmart Lookups? - This determines whether
Merchant Warehouse's BinSmart lookups are used for Credit/Debit authorizations.
Inform Users With A Message That No Signature Is Required? - This option controls turning off/on the information message displayed when processing a transaction below a configured value.
Preferred Payment Recommendation When Errors Occur. - This is the preferred payment recommendation when an error occurs or a failed response is returned; credit or debit.
Require Pin Pad Entry For Debit Tender? - Determines whether a pin pad device is required for tendering with a debit card.
Rounding Method To Use For Local Currency. - The local currency amount rounding method.
Half Up - Round to the nearest neighbor unless equidistant, then round up.
Half Down - Round to the nearest neighbor unless equidistant, then round down.
Half Even - Round to the nearest neighbor unless equidistant, then round to even neighbor. Example: 2.5 rounds to 2 while 3.5 rounds to 4.
Ceiling - Round toward positive infinity. This is the opposite of FLOOR and never decreases the calculated value.
Version 7.1 User Guide
Down - Round to the next digit; closer to zero.
Floor - Round down toward negative infinity. This is the opposite of CEILING and never increases the calculated value.
Up - Round to the next digit; away from zero.
Unnecessary - Rounding is not necessary.
Till Accountability
Adjust Store Bank Balance By Deposit Discrepancies? - Determines whether the system automatically adjusts the store bank balance based on the bank deposit discrepancy.
Display Count Balance Info On Till Close Count? - Determines whether the system displays the till count balance and discrepancy information after the associate completes the till close count.
Display Options For Cash Pickup Summary. - The cash pickup count summary screen display type.
Minimum - Declared amount
Simple - Declared amount, system amount
Detailed - Declared amount, system amount, over/under amount
Full - Currently, same as Detailed
Display Options For End Till Count Summary. - The till end count summary screen display type.
Minimum - Declared amount
Simple - Declared amount, system amount
Detailed - Declared amount, system amount, over/under amount
Full - Currently, same as Detailed
Display Options For Mid-Day Deposit Till Count Summary. - The mid-day deposit till count summary screen display type.
Minimum - Declared amount
Simple - Declared amount, system amount
Detailed - Declared amount, system amount, over/under amount
Full - Currently, same as Detailed
Display Options For Till Reconciliation Summary. - The till reconcile count summary screen display type.
Minimum - Declared amount
Simple - Declared amount, system amount
Detailed - Declared amount, system amount, over/under amount
Full - Currently, same as Detailed
Display Options For Till Start Count. - The cash count entry method used for the start count.
CHAPTER 5: Configurator Version 7.1
Minimum - Declared amount
Simple - Declared amount, system amount
Detailed - Declared amount, system amount, over/under amount
Full - Currently, same as Detailed
Force Re-Count Of Till With Discrepancies Over Threshold? - Determines whether the system forces a till recount if the till close count discrepancy exceeds the threshold.
Method Of Counting Cash Deposit. - The cash count entry method for a store bank deposit.
Total Short - User enters total cash amount only.
Denomination - User enters denominated cash amounts.
Method Of Counting For Start Till. - The cash count entry method for a till opening count.
Total Short - User enters total cash amount only.
Denomination - User enters denominated cash amounts.
Method Of Counting For Store Bank Opening. - The cash count entry method used for counting the store bank.
Total Short - User enters total cash amount only.
Denomination - User enters denominated cash amounts.
Method Of Counting For Till Cash Transfer. - The cash count entry method for a cash transfer.
Total Short - User enters total cash amount only.
Denomination - User enters denominated cash amounts.
Method Of Counting For Till Pickup. - The cash count entry method for a cash pickup.
Total Short - User enters total cash amount only.
Denomination - User enters denominated cash amounts.
Method To Count Store Bank Deposit. - The store bank deposit till count method.
This configuration is only valid if the store requires an end count of the store bank at store close.
Storebank Complete - Brings up the entire store bank end count screen for all tenders.
Remaining Cash - Prompt the user to enter the total cash NOT to be deposited to the bank institution.
Complete Deposit - Deposit all tenders from the store bank to the bank institution.
Notify When Cash Amount Drops Below This Threshold Amount In Till. - When the cash amount in the drawer drops below this amount after a retail transaction is completed, an acknowledge-only prompt will appear and notify the user.
Print Total Cash Pickup Amounts On Closing Till Receipts? - Determines whether the system prints the total cash pickup amount on closing till count receipts.
Version 7.1 User Guide
Prompt User To Open Store Bank During Store Open? - Determines whether the system automatically prompts the user asking if they wish to open the store bank when the store is opened.
Require Store To Count Store Bank Deposit At Close? - Determines whether the system requires a store bank deposit count at store close.
Skip Initial Count Summary? - When initiating a count, determines whether the system displays the tender summary list or the first tender to be counted.
Suggested Pickup Amount Based On This Threshold Amount. - When the cash amount exceeds this configured maximum amount, the system will prompt the associate to perform a cash pickup with the amount that is the current cash total minus this amount. This is a positive floating point number indicating the minimum amount of cash that should be left in the till following a pickup.
Validate Cash Refund Amounts Against The Current Till Count? - Determines whether the system validates refund cash amounts to ensure the current till cash amount is greater than the refund cash amount.
Validate Store Bank Deposit Amount Against System? - Determines whether the system validates the store bank deposit amount and prompts the associate to accept or recount if there is any discrepancy.
Warranty
Allow Warranties Not on File? - Per each context (return or work order), when enabled, the system will allow the user to apply existing warranties that cannot be verified (given appropriate security clearance). When disabled, the application of unverifiable warranties will always be prohibited. Valid Values: Return, Work Order
Only tenders of type Miscellaneous, Currency, and Credit Card can be created through Xadmin. Tender type codes (tnd_tndr_typcode) must be pre-defined in the Xcenter database to create tenders.
Base Xstore only supports USD (US Dollar), CAD (Canadian Dollar),
EUR (Euro), GBP (British Pound), and JPY (Japanese Yen) without additional Xstore changes. If support for other currencies is required, contact your MICROS representative for more information.
...continued from step 4 on page 55
CHAPTER 5: Configurator
1. Select an option from the Tender Configuration page:
Version 7.1
Figure 5-47: Tender Configuration Page Options
Select Tender Maintenance to view and edit data for tenders that are used in
Xstore. Continue with step 2 below.
The Tender Maintenance option is only available at the global level.
Select Tender Options Maintenance to view and edit data for tender options that
are used in Xstore. Skip to “Tender Options Maintenance” on page 109 .
Select Tender Security Settings to configure tender limitations in Xstore. Skip to
“Tender Security Settings” on page 112 .
Select Tender System Configurations to configure the system configuration settings that apply specifically to tenders. Skip to
Configuration Options” on page 115
.
2. Select a Tender Type from the list, then click Next.
3. At the Tender Maintenance page, add a new tender or edit an existing tender:
Figure 5-48: Tender Maintenance Page - Credit Card Tender Example
Version 7.1
If adding a new tender:
1) Click Add New.
User Guide
Only tenders of type Miscellaneous, Currency, and Credit Card can be created through Xadmin.
2) Complete the fields as required, then click Next. See
“Tender Configurations” on page 108 for a list of tender configuration options.
3) Skip to step 4 on page 107 to review your selections.
If editing an existing tender:
1) Select the tender in the list.
2) At the Tender Detail window, click Edit.
3) Complete the fields as required, then click Next. See
“Tender Configurations” on page 108 for a list of tender configuration options.
4) Continue with step 4 below to review your selections.
4. Review the tender information you selected:
Figure 5-49: Tender Information Review
To save the tender, click save. The tender is added to the Tender list.
To edit the tender:
Click previous to go back one page , or select a configuration option in the Edit Tender section in the left panel of the window.
After making your changes, click save. The new tender is added to the Tender list.
To discard the tender changes, click cancel. When prompted, click Yes to confirm you want to cancel tender setup.
5. After completing tender setup, Xadmin returns to the Tender Maintenance page.
CHAPTER 5: Configurator Version 7.1
To deploy your changes, see “Deploying Configuration Changes” on page 120 .
To view a summary list of a profile element's configuration changes to identify how it differs from the global configuration, see
“Viewing Configuration Changes” on page 125
.
[C
ONFIGURATION
O
VERRIDES
& S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To delete the
current profile element configuration changes, see “Delete Profile Configuration
[S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To copy store configurations from another store, see
“Copy Store Configurations” on page 130 .
1. Basic Information
Define the basic information for the tender, then click Next.
Tender ID - Enter the tender identifier. This value can only be edited in Add mode.
Description - Enter a text description of the tender.
Locale - If needed, select a translation locale and enter the description for the locale.
Currency - Set up the Currency ID:
This option allows you to set the Currency ID on any tender to a keyword "*" that represents the local currency. For any tenders that have this keyword "*" set as the currency ID, Xstore will retrieve the local currency ID from SystemConfig.xml.
This makes it easier to set up tender types to always use the local currency of the store rather than needing to explicitly define each tender with a specific currency ID.
For example, rather than setting up Visa/USD, Visa/CAD, Visa/AUD, etc., it is possible to simply use the "*" keyword for the Visa tender to instruct Xstore to retrieve the store's local currency ID automatically for Visa.
To set the Currency ID to Xstore's local currency, disable the "Does this
tender use a specific Currency?" check box. This automatically sets the currency
ID to "*". In Xstore, this "*" value is recognized as a directive to use the local currency for the tender
To set the Currency ID to a specific value, enable the "Does this tender use a
specific Currency?" check box. When prompted, select a Currency ID from the list of available currencies. Xstore will use the selected Currency ID for the tender.
Include in Flash Sales Report? - If selected, the tender will be included on the
Flash Sales Report. When prompted enter the order in which it should appear on the report in the Flash Sales Report Display Order field.
Display Order - Determines the order in which tenders display on the count page during closing.
Version 7.1 User Guide
Enabled check box - When selected, the tender is available for use.
2. Denominations Information [DENOMINATION tender types only]
Configure denominations for the tender.
To add a new denomination, enter the following denomination detail, then click the
Add Denomination link:
Denomination ID - The denomination identifier.
Description - The denomination description
Value - The denomination value
Note: A Delete option is available after adding a denomination.
3. Availability Information
Select the transaction types this tender is available for. To quickly choose all transaction types at once, click the Select All link.
1. Select Tender Options Maintenance from the Tender Configuration page
2. Select a Tender Type from the list, then click Next.
3. At the Tender Options Maintenance page, select a tender from the list.
Figure 5-50: Tender Options Maintenance Page
CHAPTER 5: Configurator
4. At the Tender Options Detail window, click Edit.
Version 7.1
Figure 5-51: Tender Options Detail Window
6. Review your selections and skip to step 4 on page 107
to complete tender options setup.
1. Usage Information
Define how the tender will be used.
Effective Date - [
O
PTIONAL
] Enter the effective date. Allows entry using the calendar component.
Expiration Date - [
O
PTIONAL
] Enter the expiration date. Allows entry using the calendar component.
Does this tender default the tender amount to the amount due? - If selected, the amount due from the customer is shown as a default value in the focus bar at tendering.
Is a failed over tendering attempt allowed to be overridden for this tender?
- If selected, the over tender limit can be overridden.
Is there a limit to the amount of cash change? - If selected, enter the maximum amount of cash that can be given as change when this tender is used as payment.
Is there a required tender to give as change when the cash change limit
has been exceeded? - If selected, choose the tender to be used as change after the cash change limit has been reached.
Are split tenders allowed? - When selected (default), this tender can be used if there are tenders in the current transaction. If this option is not selected, the tender amount entered cannot be less than what is due on the transaction.
Is a serial number required? - If selected, the serial number of the tender type must be captured as part of the tender process.
Version 7.1 User Guide
Open cash drawer? - If selected, the cash drawer opens when the tender type is offered by the customer.
Open cash drawer on Post Void? - If selected, open the cash drawer each time a post void is performed using this tender.
Is endorsement/franking required? - If selected, an endorsement or franking is required before this tender can be accepted.
Is this tender able to be voided? - If selected, this tender can be voided.
Is there a minimum denomination amount used for currency rounding for
this tender? - If selected, enter the minimum denomination value when prompted.
When used as foreign currency, is change allowed back on this tender? - If selected, giving change in foreign cash currency is allowed. If not selected, any change due is given in the local currency.
2. Customer Information
Define how the customer will use the tender.
Is customer identification required? - If selected, choose the type of customer identification required.
Is customer association required? - If selected, a customer must be associated with this tender.
Is customer signature required? - If selected, a customer signature is required before this tender can be accepted.
Are there a minimum and maximum days for a return with this tender? - If selected, enter the minimum number of days and maximum number of days allowed for return of an item to use this tender for refund.
3. Authorization Information [AUTH tender types only]
Configure authorization rules for the tender.
Is a swipe on a magnetic stripe reader (MSR) required? - If selected, the tender must be inserted into the magnetic card reader.
Is authorization required? - If selected, authorization is required before the tender can be accepted.
Enter/select authorization information when prompted:
Authorization Method - Select the authorization method from the list.
Is postal code entry required? - If selected, a postal code must be associated with this tender.
Is expiration date entry required? - If selected, this type of tender requires an authorization expiration date and it must be recorded at the time of settlement. (Used to enable expiration date prompting for a major credit tender.)
Is CID entry required when swiped? - If selected, the card ID is required when this card is swiped.
Is CID entry required when keyed? - If selected, the card ID is required when this card is keyed into the system manually.
CHAPTER 5: Configurator Version 7.1
Is PIN entry required? - If selected, the customer must enter a personal identification number (PIN) to validate the method of payment.
4. Count Information [COUNT tender types only]
Specify the options used to configure counting and reporting rules for the tender.
Is this tender counted independently from tender type? - If selected, the tender will be counted separately. When prompted, choose the Till Count Method to be used from the list. If not selected, the tender will be counted as part of its tender category grouping.
Note: This option is automatically selected for cash currency and cannot be deselected.
Is a recount required if tender does not balance? - If selected, enter the Close
Count Discrepancy Threshold value when prompted.
Reporting Group - Select the reporting group for the tender:
Tender Summary group
Foreign Currency group
Is a suggested deposit amount required? - If selected, enter the Suggested
Deposit Threshold value when prompted.
Are the counts and amounts pre-populated? - If selected, the system counts the tender automatically to populate the system tender.
The combination of Tender ID, Security Group, Usage Code, and Entry
Method must be unique.
1. Select Tender Security Settings from the Tender Configuration page (Figure 5-47).
Version 7.1 User Guide
2. At the Tender Security Settings page, you can add a new security setting or edit an existing one.
Figure 5-52: Tender Security Settings Page
Use the Tender ID and Security Group filters to locate a tender/security group in the list.
If adding a new tender security setting:
1) Click Add New.
2) At the Security Setting Detail window, complete the fields as required, then click
Save. See
“Tender Security Settings Configuration Options” on page 114 for a
list of configuration options.
If editing an existing tender security setting:
1) Select the tender security setting in the list.
2) At the Security Setting Detail window, complete the fields as required, then click
Save. See
“Tender Security Settings Configuration Options” on page 114 for a
list of tender configuration options.
3. After completing tender security setting setup, Xadmin returns to the Tender Security
Settings list page.
To deploy your changes, see “Deploying Configuration Changes” on page 120 .
To view a summary list of a profile element's configuration changes to identify how it differs from the global configuration, see
“Viewing Configuration Changes” on page 125
.
[C
ONFIGURATION
O
VERRIDES
& S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To delete the
current profile element configuration changes, see “Delete Profile Configuration
[S
TORE
S
PECIFIC
O
VERRIDES
O
NLY
]
- To copy store configurations from another store, see
“Copy Store Configurations” on page 130 .
CHAPTER 5: Configurator Version 7.1
The available configuration options depend upon the selected Tender and Usage Code.
General Information
(Note: The following fields cannot be changed in edit mode.)
Tender ID - Select the tender identifier from the list.
Security Group - Select the security group from the list.
Usage Code - Select the usage code from the list.
Entry Method Code - Select the entry method code from the list.
Limits
Maximum amount allowed to over tender - Enter the maximum amount allowed to over tender.
Minimum amount Accepted - Enter the minimum amount that can be accepted.
Maximum amount Accepted - Enter the maximum amount that can be accepted.
Online Authorization Rules [only shown for tenders that require authorization]
Authorization needed when amount is above - Enter the maximum value that can be accepted without authorization.
Maximum amount allowed to authorize - Enter the maximum value of an individual tender type that can be authorized either in-house or by a third party. This especially applies to checks where the check authorization company sets a ceiling by retailer.
Offline Authorization Rules [only shown for tenders that require authorization]
Authorization needed when amount is above - Enter the maximum value that can be accepted without authorization when in offline mode.
Maximum amount allowed to authorize - Enter the maximum value of an individual tender that the system accepts without authorization when in offline mode.
Refund
Maximum refund allowed with a receipt - Enter the maximum refund allowed with a receipt.
Maximum refund allowed without a receipt - Enter the maximum refund allowed without a receipt.
Version 7.1 User Guide
The system configuration options for tenders in this feature are simply a subset of the system configuration options available from Xstore
System Config Options. See
“Configuring Xstore System Config
Options” on page 92 for more information.
The following configurations apply specifically to tenders. The categories have been set up as follows:
below
“Till Accountability” on page 118
Charity
Enable Prompting User When Voiding Charity Line Item? - Determines whether the system displays the notification message when a charity item is voided if tendering is canceled.
Closing Options
Perform Till Count During Close? - Determines whether the system prompts the associates to perform a till closing count at register close.
Discount Options
How Should Price Be Rounded After Discount Applied? - Select the local currency amount rounding method used for determining the price after a discount is applied. Valid
Values:
Half Up - Round to the nearest neighbor unless equidistant, then round up.
Half Down - Round to the nearest neighbor unless equidistant, then round down.
Half Even - Round to the nearest neighbor unless equidistant, then round to even neighbor. Example: 2.5 rounds to 2 while 3.5 rounds to 4.
Ceiling - Round toward positive infinity. Note: This is the opposite of FLOOR and never decreases the calculated value.
Down - Round to the next digit; closer to zero.
Floor - Round down toward negative infinity. Note: This is the opposite of CEILING and never increases the calculated value.
Up - Round to the next digit; away from zero.
Unnecessary - Rounding is not necessary.
CHAPTER 5: Configurator Version 7.1
House Accounts
AR Manual Auth Phone Number. - Enter the phone number for the associates to call for authorization when the accounts receivable tender amount exceeds the account credit limit and the exceeded amount is below the threshold amount.
AR Over Tender Amount Allowed Over Credit Limit. - Enter the threshold amount the system allows when the accounts receivable tender amount exceeds the account credit limit.
Manager Override When Tender Amount Exceeds House Account Balance? -
Determines whether the system prompts for manager override if the tender amount exceeds the remaining balance of the house account.
If set to Yes, and a manager-level user is logged in, the system displays the credit limit and prompts the user to proceed.
If set to Yes, and a user lower than the manager privilege is logged in, and the user chooses to proceed with exceeding the credit limit, the manager security login displays for approval.
If set to No, the system does not prompt for manager override.
Prompt For User Information On AR Transaction? - Determines whether the system prompts for the AR account user information when performing tender/refund/payment on an accounts receivable account.
Require Customer To Be AR Account Owner To Use AR Functions? - Determines whether the system requires the associated customer of the retail transaction to be the
AR account owner in order to access the accounts receivable retail functionality (tender, payment).
Opening Options
Skip Till Count Since Workstation Doesn't Have Cash Drawer? - This applies to
Register Accountability Only. Used for registers that do not have a cash drawer or do not handle cash. Select Yes to prevent the system from prompting for begin or end count during the register open or close. The system automatically moves all tender amounts from the register/handheld to the store bank.
PayPal
Enable PayPal Mobile Payments Polling Service? - Used to enable/disable PayPal
Mobile Payments polling service. When enabled, Xstore will automatically update the list of currently checked-in customers based on a configurable interval.
PayPal Point Of Sale Service API Version. - Enter the current version of the PayPal
POS service API.
PayPal Polling Interval (in Seconds). - Enter the interval for the PayPal Mobile
Payments polling service in seconds.
PayPal Preferred Image Size. - Select the size of the photo image that Xstore will use on the confirmation page for the PayPal Mobile Payments.
PayPal Tab Height. - Enter the number of rows for the PayPal tab.
PayPal Tab Width. - Enter the number of columns for the PayPal tab.
Version 7.1 User Guide
Returns
Prompt For Tender On Credit Card Returns? - Determines whether the system prompts for refund tender amount to be credited back to the original sale credit card.
If Yes, the system prompts for the amount to credit back to the original card.
If No, the entire refund amount will be credited back to the selected original credit card.
Store Specific
Default Id Type For Tenders Requiring Customer Identification. - Select the default identification type used for certain tenders that require customer identification information. Valid Values: Drivers License, Social Security, Military Id, Credit Card,
Employee Id, Customer Card, Any identification type.
Tender
Allow Multiple Incoming Tenders In One Transaction? - Determines whether the system allows multiple incoming (exchange from) tenders in a tender exchange transaction.
Allow Multiple Outgoing Tenders In One Transaction? - Determines whether the system allows multiple outgoing (exchange to) tenders in a tender exchange transaction.
Default Tender Id To Use For Change If Not Specifically Configured. - Select the change tender id the system will use by default if the system cannot find the valid change tender based on the sale tenders. Valid Values: Issue Store Credit, Issue Gift
Card.
Prompt User To Imprint Credit Card For Manual Cards? - Determines whether the system prompts the associate to imprint the credit card when there is a manually entered credit card tender in the completed sale transaction.
Quick Cash Button Increment Display. - The Quick Cash Buttons will display in increments based on this entry for the minimum denomination factor.
Use Quick Cash Buttons? - Determines whether the Quick Cash Button functionality is enabled.
Tender Options
Authorization Method Code For BinSmart Lookups. - Enter the authorization method code used to perform the lookup. Valid only for Merchant Warehouse.
Cash Payment Threshold To Invoke Additional Info Collection For IRS. - If the amount of cash paid by a customer exceeds this threshold amount, the system will display the IRS form to gather additional customer information.
Display Cash Total? - Only applicable for currency rounding; indicates whether the rounded cash total is displayed below the transaction total in the viewport.
Enable Merchant Warehouse's BinSmart Lookups? - Determines whether Merchant
Warehouse's BinSmart lookups are used for Credit/Debit authorizations.
Inform Users With A Message That No Signature Is Required? - This option controls turning off/on the information message displayed when processing a transaction below a configured value.
Local Currency Id. - Select the currency for the current locale.
CHAPTER 5: Configurator Version 7.1
Method To Mask Vouchers/Gift Cards. - Enter the voucher number masking method.
CREDITCARD - Mask all but the last 4-digits of the Account Number.
MASK_LAST_4 - Mask (****) the last 4-digits of the Account Number.
Minimum Check Number. - Enter the lowest check number the system will accept when the customer pays with a check.
Preferred Payment Recommendation When Errors Occur. - Select the preferred payment recommendation when an error occurs or a failed response is returned. Valid
Values: Credit, Debit.
Prompt For Birth Date On Check Tender? - Determines whether the system prompts for the customer's birthdate when the customer pays with a check.
Require Pin Pad Entry For Debit Tender? - Determines whether a pin pad device is required for tendering with a debit card.
Rounding Method To Use For Local Currency. - Select the local currency amount rounding method.
Half Up - Round to the nearest neighbor unless equidistant, then round up.
Half Down - Round to the nearest neighbor unless equidistant, then round down.
Half Even - Round to the nearest neighbor unless equidistant, then round to even neighbor. Example: 2.5 rounds to 2 while 3.5 rounds to 4.
Ceiling - Round toward positive infinity. Note: This is the opposite of FLOOR and never decreases the calculated value.
Down - Round to the next digit; closer to zero.
Floor - Round down toward negative infinity. Note: This is the opposite of CEILING and never increases the calculated value.
Up - Round to the next digit; away from zero.
Unnecessary - Rounding is not necessary.
Till Accountability
Method To Count Store Bank Deposit. - The store bank deposit till count method.
This configuration is only valid if the store requires an end count of the store bank at store close. Valid Values:
Storebank Complete - Brings up the entire store bank end count screen for all tenders.
Remaining Cash - Prompt the user to enter the total cash NOT to be deposited to the bank institution.
Complete Deposit - Deposit all tenders from the store bank to the bank institution.
Skip Initial Count Summary? - When initiating a count, determines whether the system displays the tender summary list or the first tender to be counted.
Validate Cash Refund Amounts Against The Current Till Count? - Determines whether the system validates refund cash amounts to ensure the current till cash amount is greater than the refund cash amount.
Version 7.1
...continued from step 4 on page 55
User Guide
Pole Display is the only Customer Display type supported at this time.
1. At the Customer Display page, click Pole Display.
Figure 5-53: Customer Display Page
2. The current pole display message is shown in the Pole Message field. Edit the pole display message as needed:
Figure 5-54: Edit Pole Display Page
Pole Message - To edit the message text, type the new message. The maximum length is 40 characters.
Locale - If needed, select a translation locale and enter the message text for the locale.
A pole message is required for the default locale. A pole message is not required for other locales you may have set up.
3. Click Save.
CHAPTER 5: Configurator
See
Appendix A: “About Deployments” on page 265
for more information about deployments.
Version 7.1
1. To begin the deployment process, from the Xadmin menu, select Config Manager -->
Configurator, or click the Configurator link in the Configuration Manager panel.
2. Select the configuration scope for the deployment:
Figure 5-55: Configuration Scope Options Page
Select Global Configurations to deploy the global configuration layer which affects all locations. Continue with step 3 below.
<OR>
Select Configuration Overrides to deploy configurations that will override the global layer for specific locations.
a. Select a Profile Group from the list.
b. Select an Element from the list.
c.
Click Next.
d. Continue with step 3 below.
<OR>
Select Store Specific Overrides to change configurations that will override the global layer for a specific store based on the user's scope.
a. Type the store number or begin typing a store number or name in the Store # field.
b. Select the store from the store list.
c.
Click Next.
d. Continue with step 3 below.
3. At the Configuration Action page, select the Deploy option.
Version 7.1 User Guide
If you try to schedule a deployment for a profile element that has no changes, you will see the following message:
If you see this message, return to the Configure screen and make your changes before scheduling a deployment.
4. At the Schedule Deployment page, select a deployment type:
Figure 5-56: Schedule Deployment Page - Global Scope Example
Select Schedule a Planned Deployment to roll out the updates in pre-defined
waves. Continue with “Scheduling a Planned Deployment” on page 122
.
<OR>
Select Schedule a Single Deployment to set up a one-time rollout. Continue with
“Scheduling a Single Deployment” on page 123 .
To view deployment history for this profile element and organization
To view the deployed configuration versions for this profile element by
store, select Deployed Versions. See “Deployed Versions” on page 133 .
CHAPTER 5: Configurator Version 7.1
You must create deployment plans before using this option. Refer to
“Creating a Deployment Plan” on page 209
for more information about setting up deployment plans.
1. Complete the following fields to roll out the updates in pre-defined waves:
Deployment Name - Accept the default name or enter a name for this deployment.
Deployment Plan - Select a deployment plan from the list.
Target Date - Select the date the changes will be sent to the store.
2. Click Next.
3. Review the deployment schedule.
Figure 5-57: Review Deployment Schedule Page
4. Verify the Email Notification List is correct. If needed, click the View List link to see more detail about the email recipients.
5. Review the deployment information:
The “v.x” value in the Deployment Name is the configuration version for this deployment.
Version 7.1 User Guide
If the deployment information is correct, click Deploy.
If a deployment has already been scheduled with an earlier version of configurations, you will be prompted to change the deployment date.
Use the breadcrumbs to return to the Schedule Deployment page and change the date for deployment.
If the deployment information is not correct, use the breadcrumbs to navigate back to the previous page where you can make changes, and go to
.
6. When prompted, click Yes to confirm you want to schedule deployment.
7. Click OK to close the Deployment was scheduled successfully window. The configuration version is now “locked” for this set of configurations.
Figure 5-58: Deployment Scheduled Successfully Window - For Version 23 Example
1. Complete the following fields for a one-time rollout:
Deployment Name - Accept the default name or enter a name for this deployment.
Organization Node - Select the organization target for the configuration changes.
Target Date - Select the date the changes will be sent to the store.
Download Priority - Select the download priority:
Immediate - Download the configuration changes now.
Store Close - Download the configuration changes at end-of-day.
2. Click Next.
CHAPTER 5: Configurator
3. Review the deployment schedule.
Version 7.1
Figure 5-59: Review Deployment Schedule Page
4. Review the deployment information:
The “v.x” value in the Deployment Name is the configuration version for this deployment.
If the deployment information is correct, click Deploy.
If a deployment has already been scheduled with an earlier version of configurations, you will be prompted to change the deployment date.
Use the breadcrumbs to return to the Schedule Deployment page and change the date for deployment.
If the deployment information is not correct, use the breadcrumbs to navigate back to the previous page where you can make changes, and go to
.
5. When prompted, click Yes to confirm you want to schedule the deployment.
6. Click OK to close the Deployment was scheduled successfully window. The configuration version is now “locked” for this set of configurations.
Version 7.1 User Guide
A Configuration Change is recorded when a configurable object has been altered. Multiple alterations of a configurable object does not equate to multiple changes being recorded.
For example, if you change the same reason code three separate times, it counts as one change for the time period that it differs from the global configuration. If you change three different reason codes, that would count as three changes.
This feature provides a summary list of configuration changes, who made them, and when they were made. This list is only a “snapshot” of time in which it is called up. When viewing configuration changes, you can delete configuration changes that have not been deployed.
See “Delete Configuration Changes” on page 127
for more information.
1. From the Xadmin menu, select Config Manager --> Configurator, or click the
Configurator link in the Configuration Manager panel.
2. Select the configuration scope for the deployment. The process varies with the scope
selected on the Configuration Scope Options page ( Figure 5-41 on page 96
):
If
Global Configurations
Configuration Overrides
Then
a. Select a Profile Group from the list.
b. Select an Element from the list.
c.
Click Next.
d. Continue with step 3 below.
Store Specific Overrides
a. Type the store number or begin typing a store number or name in the Store # field.
b. Select the store from the store list.
c.
Click Next.
d. Continue with step 3 below.
CHAPTER 5: Configurator Version 7.1
3. At the Configuration Scope Actions page, select View Configuration Changes.
Figure 5-60: Configuration Scope Actions Page - Global Example
4. View the configuration changes by Category or by Version:
Figure 5-61: Configuration Changes Page: by Category or Version
Click the sort component to sort the columns as needed.
Group By Category:
Category - The configuration category. Select the Category row to view more information: Version Number, Change Description, Date of Last Change, and User.
# of Changes - The number of changes per category.
Date of Last Change - The date the last configuration change was made for this category.
Group By Version:
Version # - The configuration version number. Select the Version # row to view the configuration changes made to that version: Category, Change Description, Date of
Last Change, and User.
# of Changes - The number of changes in this version.
Date Created - The date the version was created.
Version 7.1 User Guide
When viewing configuration changes, you can remove a configuration change (or several changes if applicable) from a configuration update as long as that configuration update has not been deployed.
1. From the Xadmin menu, select Config Manager --> Configurator, or click the
Configurator link in the Configuration Manager panel.
2. Select the configuration scope for the deployment.
3. At the Configuration Scope Actions page, select View Configuration Changes.
4. View the configuration changes by Category or by Version.
5. Click the Delete icon associated with the configuration change you want to remove.
Figure 5-62: Configuration Changes Page - Delete Option
6. When prompted to confirm you want to delete this change, click Yes to remove the configuration change from the configuration update.
Use this option to delete group/element level configuration overrides for a specified group/ element configurations.
To use this feature, “Enable the Option to Delete Configurations?” must be set to true in Xadmin Settings.
When you delete store level or profile group/element level configurations, a deployment is scheduled for those locations to be sent immediately.
If there are any pending configuration deployments for the same location at a future date, the location will receive this delete deployment immediately, and then at a later time the scheduled configurations will be deployed. If this scenario occurs, Xstore and
Xadmin will have different configurations for that location.
CHAPTER 5: Configurator Version 7.1
1. At the Configuration Scope Options page, select Configuration Overrides.
Figure 5-63: Configuration Scope Options Page
2. Select the profile group and element, then click Next.
3. At the Configuration Action page, click Delete Profile Configuration Changes.
Figure 5-64: Configuration Action Page - Configuration Overrides Scope Example
4. When prompted, click Yes to confirm the deletion.
Figure 5-65: Delete Profile Configuration Changes Confirmation Prompt
5. After the deployment has been scheduled successfully, click OK to close the Schedule
Delete Configurations Deployment prompt.
Figure 5-66: Schedule Delete Configurations Deployment Prompt
6. When prompted, click OK to acknowledge all the changes have been removed.
Version 7.1 User Guide
Use this option to delete store-specific configuration overrides. Xadmin deletes configurations that have not been deployed and marks the deployed profile configuration changes as inactive in the Xadmin database. This action retains the history of completed deployments for auditing purposes.
To use this feature, “Enable the Option to Delete Configurations?” must be set to true in Xadmin Settings.
When you delete store level or profile group/element level configurations, a deployment is scheduled for those locations to be sent immediately.
If a scheduled deployment for configuration changes is found, you will not be able to delete a profile configuration change.
1. At the Configuration Scope Options page ( Figure 5-63 on page 128
), select Store
Specific Overrides.
2. Select the store number, then click Next.
3. At the Configuration Action page, click Delete Profile Configuration Changes.
Figure 5-67: Configuration Action Page - Store Specific Overrides Scope Example
4. When prompted, click Yes to confirm the deletion.
5. After the deployment has been scheduled successfully, click OK to close the Schedule
Delete Configurations Deployment prompt.
6. When prompted, click OK to acknowledge all the changes have been removed.
CHAPTER 5: Configurator
To use this feature, “Enable the Option to Create Store-Specific
Configurations?” must be set to true in Xadmin Settings.
Version 7.1
Use this option to copy configuration information from one store to another. You must have access privileges to both the copy-from store and the copy-to (destination) store in order to use this process. Only stores are valid for the copy-from and destination locations, no other hierarchy or store collections are supported. The target store’s previous configurations are retained (but tagged as inactive) for auditing purposes.
This option is not allowed when a scheduled deployment is pending.
1. At the Configuration Scope Options page ( Figure 5-63 on page 128
), select Store
Specific Overrides.
2. Enter the target store number in the Store # field and click Next.
3. At the Configuration Action page, click Copy Store Configurations (
From Store # field.
4. Click Next. This action tags any previously implemented changes as inactive in the database.
5. When prompted, click Yes to confirm the copy instructions.
Figure 5-68: Configuration Copy Confirmation Prompt
The configurations are copied to the destination store:
If the destination store is new, then all the configurations from the copy-from store are now available.
If the destination store previously existed, then the system will overwrite the previous data with the new data from the copy-from store.
6. When prompted, click OK to view the configuration changes.
Figure 5-69: Configuration Copy View Changes
Version 7.1
7. Review configuration changes by Category or by Version.
User Guide
Figure 5-70: View Configuration Changes Page
8. Continue with
“Deploying Configuration Changes” on page 120 to deploy the changes.
Use Deployment History to view a summary of current configuration deployments for the profile element and organization node.
1. From the Xadmin menu, select Config Manager --> Configurator, or click the
Configurator link in the Configuration Manager panel.
2. Select the configuration scope for the deployment. The process varies with the scope
selected on the Configuration Scope Options page ( Figure 5-41 on page 96
):
If
Global Configurations
Configuration Overrides
Store Specific Overrides
Then
a. Select a Profile Group from the list.
b. Select an Element from the list.
c.
Click Next.
d. Continue with step 3 below.
a. Type the store number or begin typing a store number or name in the Store # field.
b. Select the store from the store list.
c.
Click Next.
d. Continue with step 3 below.
CHAPTER 5: Configurator
3. At the Configuration Scope Actions page, select Deploy.
Version 7.1
Figure 5-71: Configuration Scope Actions Page - Global Example
4. At the Schedule Deployment Page, select Deployment History:
Figure 5-72: Schedule Deployment Page - Global Scope Example
5. The Deployment History search results list shows the other configurator deployments of the same Org Node/Element, along with the status for each.
Figure 5-73: Deployment History Search Results List
Version 7.1 User Guide
6. Select a deployment to view additional detail. If needed, a deployment can be edited.
See “Viewing Deployments” on page 216 for more information about Deployment History
and editing deployments.
Use Deployed Versions to view the number of stores, and the version numbers deployed to those stores, in a pie chart format. This version information is reported to Xadmin by the primary register at the store.
1. From the Xadmin menu, select Config Manager --> Configurator, or click the
Configurator link in the Configuration Manager panel.
2. Select the configuration scope for the deployment. The process varies with the scope
selected on the Configuration Scope Options page ( Figure 5-41 on page 96
):
If Then
Global Configurations
Configuration Overrides
Store Specific Overrides
a. Select a Profile Group from the list.
b. Select an Element from the list.
c.
Click Next.
d. Continue with step 3 below.
a. Type the store number or begin typing a store number or name in the Store # field.
b. Select the store from the store list.
c.
Click Next.
d. Continue with step 3 below.
3. At the Configuration Scope Actions page, select Deploy.
Figure 5-74: Configuration Scope Actions Page - Global Example
CHAPTER 5: Configurator
4. At the Schedule Deployment Page, select Deployed Versions:
Version 7.1
Figure 5-75: Schedule Deployment Page - Global Scope Example
5. With the pie chart displayed, click on a section to display a list of the stores to which the version number was deployed.
Figure 5-76: Deployed Config Versions By Store
The pie chart represents the number of stores, and the version numbers deployed to those stores, based on the version reported from the primary register in the store.
Version 7.1
The list includes the Store Name, Store ID, Phone Number, and Address.
User Guide
Figure 5-77: Deployed Config Versions By Store Detail
CHAPTER 5: Configurator Version 7.1
C H A P T E R
Data Management is used to create, maintain, and deploy Xadmin data selectively, or globally across the entire organization. Data Management is also used to set up and maintain your organization hierarchy and store collections, and to initiate the end-of-year process to post the required roll-up data for stock valuation for all items and stores.
The logged-in user is assumed to represent some tier of the organization. For this reason, the user’s assigned org node hierarchy will determine the data he/she has access to. See
Chapter 2, “Roles, Users, and Security Access” on page 9
for more information about users and security access.
The following data can be configured in Data Management:
In Data Manager
Merchandise & Non Merchandise Items
Vendors
Employee Records
Exchange Rates
Store Information
Taxes
Store Messages
Employee Tasks
In Organization Hierarchy
Organization Hierarchy Maintenance
Organization Hierarchy Levels
Store Collections
In Roll-up Stock Valuation
Stock Valuation Year End Roll-up
CHAPTER 6: Data Management Version 7.1
Data Management allows you to:
Change or create data for your organization. See “Managing Data” on page 139 .
Redeploy data from one org node to another. See “Data Publisher - Redeploying Data” on page 188 .
.
Initiate the end-of-year process to post the required roll-up data for stock valuation for all items and stores. See
“Stock Valuation Year End Roll-up” on page 199 .
Xstore Database Dictionary - The Xstore Database Dictionary provides Xstore database detail and schema information. This dictionary provides a description of each table as well as a listing of all of the columns in each table.
Xadmin Database Dictionary - The Xadmin Database Dictionary provides Xcenter database detail and schema information. This dictionary provides a description of each table as well as a listing of all of the columns in each table.
Xstore Host Interface Guide - The Xstore Host Interface guide provides information about the files accepted for processing updates to Xstore operating tables. In addition, this guide also provides information about the DataLoader application that is responsible for translating flat data files into database data that can be used by Xstore.
Data Manager changes are collected into “data bundles” containing all of the changes made within a particular org level during a given day. The changes collected in the data bundle will be deployed to their targeted stores automatically at the end of the day, or can be deployed immediately if needed. When you make changes in Data Manager and deploy them, they automatically update the Xcenter database; there is no DataLoader file created and no
DataLoader processing necessary. If anything fails, it can be found in the Xcenter or Xadmin log file.
Use the Pending Modifications feature of Data Manager to delete or view the details of the data bundles before they are deployed.
Use the Data Publisher feature to deploy data from Xcenter to an org node. Deployed data will include all the data available to the targeted org node (within the categories selected by the user) and comes from Xcenter.
Version 7.1 User Guide
1. From the Xadmin menu, select Data Management --> Data Manager, or click the Data
Manager link in the Data Management panel.
2. At the Data Manager page, you have the following options:
Figure 6-1: Data Manager Page
To change or create data for your organization, click Data Management. Continue
To view or deploy pending data changes for your organization, click Pending
Modifications and skip to “Viewing & Deploying the Data Changes” on page 185
.
To transfer data from one org node to another, click Data Publisher and skip to
“Data Publisher - Redeploying Data” on page 188 , step 3.
3. Select the Organization Node for the Data change, then click Next.
Only the Organization Nodes the logged-in user has privileges to use will be listed here.
4. Select a Data option.
Figure 6-2: Data Options Page
CHAPTER 6: Data Management Version 7.1
5. At the page for the selected Data option you can add a new record or modify an existing record:
To add a new record for the Data option using the wizard format, click Add New
†
When adding a new record to a Data option, all fields will be blank.
.
To edit an existing record for the Data option, click the record to open the editing window. When editing a Data option record, some fields cannot be changed.
†
For Data options that do not use a wizard format, information is added and edited in a Data window. After completing the required fields, click Save.
6. Follow the prompts to manage the data for the selected option:
After completing a page, click next when applicable to navigate to the next page until setup is complete.
You can click previous to return to the previous page when applicable.
The breadcrumbs displayed at the top of each page can be used to navigate through the various pages of the activity.
In addition to the breadcrumbs at the top of each page, the side panel on each page shows where you are in the process and can also be used to navigate the various steps of the process as needed.
To exit without saving any changes, click cancel. When prompted, click Yes to confirm you do not want to save any changes.
7. When setup is complete, and you have reviewed your changes, click save.
Version 7.1 User Guide
- Use this feature to manage different types of items, nonmerchandise items, and item matrix features for your organization and to manage the merchandise hierarchy.
- Use this feature to create and modify vendors for your organization.
“Employees” on page 165 - Use this feature to create and modify employee records for
your organization.
“Taxes” on page 168 - Use this feature to manage tax configurations for your
organization.
“Communications” on page 176 - Use this feature to create and modify store messages
and employee tasks.
- Use this feature to create and modify currency exchange rates for your organization.
- Use this feature to search for and modify store information.
This Data Manager Stores option allows you to search for and modify store information for an existing store only. To set up a new store, see
“Managing the Organization Hierarchy” on page 191
.
Refer to each section for more information about the fields for each Data option.
CHAPTER 6: Data Management Version 7.1
Use this feature to manage different types of items and item features for your organization.
Figure 6-3: Data Manager - Items Page
To create and manage merchandise items (including prices and attached items), click
Merchandise Items. See
.
To manage the merchandise hierarchy, click Merchandise Hierarchy. See
To manage the item matrix settings, click Item Matrix Manager. See “Item Matrix
To create and manage non-merchandise items (including prices), click Non-
Merchandise Items. See
“Non-Merchandise Items” on page 157
.
Version 7.1
User Guide
Figure 6-4: Item Maintenance Page
At the Item Maintenance page, click Add New to create a new item.
At the Item Maintenance page, enter search criteria and click Search to find/edit an existing item in your organization. If you do not enter any criteria before selecting Search, all items in your organization will be returned in the search. To edit information for an existing item, select the row from the search results list and click Edit at the Item Information window
(
To view and/or edit item prices, refer to
for procedural information.
See step 6 on page 140 for additional procedural information.
The following Item Maintenance fields are available:
Field Description
Item ID
[R
EQUIRED
]
Enter the item identifier. This field cannot be edited for existing items.
Enter the item description.
Description
[R
EQUIRED
]
Prompt for Description
check box
Select this check box if the item description must be manually entered when this item is sold.
CHAPTER 6: Data Management Version 7.1
Field
Tax Group
[R
EQUIRED
]
Description
Availability
Select the item’s tax group from the drop-down list.
Possible values are from the Tax Group table
(tax_tax_group).
Select the product availability to determine whether or not an item is available for sale: Available, Not Sellable at POS, or Recalled.
Stock Status check box If applicable, select this option and type the item’s status based on its stock availability when prompted for a value.
For example, RESTRICTED_QTY, DISCONTINUED,
CLEARANCE, etc.
Commission check box
Image check box
If applicable, select this option if the item qualifies for commission.
If applicable, select this option and type the file path/URL when prompted.
Attached Items check box Select this option if the item has attached items. (See
“Attached Items” on page 150 for more information about
setting up attached items.)
Serial Number check box Select this option if a serial number is required.
Field
Department
Subdepartment
Class
Subclass
Style check box
Description
Select the item’s department from the drop-down list.
Possible values are from the itm_merch_hierarchy table where level code is DEPARTMENT.
Select the item’s subdepartment from the drop-down list.
Possible values are from the itm_merch_hierarchy table where level code is SUBDEPARTMENT.
Select the item’s class from the drop-down list. Possible values are from the itm_merch_hierarchy table where level code is CLASS.
Select the item’s subclass from the drop-down list. Possible values are from the itm_merch_hierarchy table where level code is SUBCLASS.
Select this option if the item is associated with a style, then enter the style ID when prompted.
Version 7.1 User Guide
Field
Season check box
Description
Select this option if the item is associated with a season, then enter the season code when prompted.
Vendor check box
Item UPCs
Select this option if the item is associated with a vendor, then select the vendor from the drop-down list when prompted.
Enter the UPC for the item and click Add. You can enter as many UPCs as needed. After adding at least one UPC, a
Delete option will be available to remove a UPC if needed.
Field Description
Sale Quantity check box Select this option if the item quantity cannot be changed from 1.
Note: This option will disable all other item quantity options listed here.
Quantity Prompt check box
Weight Prompt check box
Initial Sale Quantity check box
Minimum Sale Quantity check box
Maximum Sale Quantity check box
Select this option if the item quantity must be manually entered when this item is sold.
Select this option if the item weight must be manually entered when this item is sold.
Select this option if the item is sold in a quantity other than one. If selected, enter the initial quantity at which this item must be sold.
Select this option if the item has a minimum sale quantity. If selected, enter the minimum quantity of this item that may be sold in a single transaction.
Select this option if the item has a maximum sale quantity. If selected, enter the maximum quantity of this item that may be sold in a single transaction.
Note: If a value is not specified, the system configuration for maximum quantity per sale item is used. If a value is specified here and it is greater than the system configuration value, the maximum sale quantity is used.
CHAPTER 6: Data Management Version 7.1
Field Description
Customer Information
Required check box
Purchaser Minimum Age
Required check box
Select this option if the system prompts for customer information when the item is sold. If selected, a prompt for information will be displayed. Select whether the information is required or optional:
Prompt, entry is required
Prompt, entry is optional
Select this option if a minimum age is required to purchase the item. If selected, enter the minimum age (in years) required to purchase the item.
Field Description
Inventoried check box Select this option if inventory levels are tracked for this item.
Item Type Restrictions
Disallow Layaway check box
Select this option if this item cannot be added to a layaway transaction type.
Disallow Order check box Select this option if this item cannot be ordered via Locate
Order functionality.
Disallow Rain Check check box
Disallow Returns check box
Select this option if this item is not eligible for rain check functionality.
Select this option if this item cannot be added to a return transaction type.
Disallow Send Sale check box
Disallow Special Order check box
Disallow Work Order check box
Disallow Deal check box
Select this option if this item cannot be added to a send sale transaction type.
Select this option if this item cannot be added to a special order transaction type.
Select this option if this item cannot be added to a work order transaction type.
Price Change Restrictions
Select this option if this item does not qualify for deals.
Version 7.1 User Guide
Field Description
Select this option if this item cannot be discounted.
Disallow Discount check box
Disallow Price Change check box
Select this option if this item price cannot be changed.
Field
Unit Cost
Initial List Price
Prompt for Price check box
Description
Enter the cost for each retail sale unit of this item.
Enter the retail price per sale unit of the item.
Select this option if the retail price must be manually entered when this item is sold.
When viewing item information, and if the selected item record is within your targeted org node, there is an option available to view and edit item pricing information. You can edit prices for your org node level only. However, you can view prices set above your org node level.
1. At the Item Maintenance page ( Figure 6-4 on page 143 ), enter search criteria and select
Search to find/edit an existing item in your organization.
2. At the Item search results list, select the item row from the list.
3. Click Prices at the Item Information window.
Figure 6-5: Item Information Window
CHAPTER 6: Data Management Version 7.1
4. At the Item Prices page you can calculate the price of an item based on specified parameters, add a new price, or edit an existing price as needed.
Figure 6-6: Item Prices Page
To quickly find an item price in the list at the Item Prices page, select the type of price from the Price Type filter list.
Use this procedure to identify the exact price that exists for an item based on the type of price (regular price or a customer group), the pricing quantity, and date.
1. At the Item Prices page, enter the required information:
Price Type [R
EQUIRED
]
- What type of price should be used?
Regular Price
Customer Group Price - Select from the list of available price types for the organization. For example, Employee Family, Employee, Elite Program Member,
Normal Level
Pricing Quantity [R
EQUIRED
]
- Enter the quantity of the item you are pricing.
Start Date [R
EQUIRED
]
when the price is in effect - Use the calendar to select the date for the item you are pricing.
2. Click Calculate.
Version 7.1
3. The system retrieves the pricing information:
If pricing information is found, the price for the item—based on the criteria you entered—is displayed.
User Guide
If no pricing information is found, the “No Price Found” message displays. If you want to add pricing information, click the “No Price Found” link to open the Add Item Price window.
At the Add Item Price window, the parameters you entered in the pricing search (Price Type, Pricing Qty, and Start Date) are populated automatically. See
below for more information about adding/ editing prices.
1. At the Item Prices page, do one of the following:
To add a new price, click Add New and complete the fields as required.
To edit an existing price, click a row in list and edit the fields as needed.
Figure 6-7: Item Price Window - Add New Price Example
Field
Org Node
Price Type
[R
EQUIRED
]
Pricing Qty
[R
EQUIRED
]
Start Date
[R
EQUIRED
]
End Date
Price [R
EQUIRED
]
Description
This value cannot be changed.
Select a price type from the drop-down list of available price types.
This value cannot be changed in Edit mode.
Enter the pricing quantity for this item. This value cannot be changed in Edit mode.
Enter/select the starting date for this price to be in effect. This value cannot be changed in Edit mode.
Enter/select the ending date when this price is no longer in effect.
Enter the item price.
CHAPTER 6: Data Management Version 7.1
2. Click Save.
When viewing item information, if the selected item record is within your targeted org node and enabled for attached items, there is an option available to view and edit attached item information. You can edit attached items for your org node level only. See
“Basic merchandise information” on page 143
for attached item setup information.
1. At the Item Maintenance page ( Figure 6-4 on page 143 ), enter search criteria and select
Search to find/edit an existing item in your organization.
2. At the Item search results list, select the item row from the list.
Items that have “attached items” are shown with a green check mark on the
Merchandise Items list page.
Figure 6-8: Merchandise Items List Page - With Attached Items
3. Click Attached Items at the Item Information window to open the Attached Items page.
Figure 6-9: Item Information Window - Attached Items Button
Version 7.1 User Guide
4. The Attached Items page lists the existing attached items for the selected merchandise item.
Figure 6-10: Attached Items Page
To add an attached item to the sold item:
If you know the attached item Id, enter the Item Id in the “Enter an item ID”
field and click Add. Continue with step 2 on page 152
.
If you do not know the item Id, enter search criteria and then click Search to find an item to attach to the merchandise item. Continue with
.
To edit an attached item, select the row you want to edit. Continue with
To delete the relationship between the attached item and the sold item, click the delete icon associated with the attached item and click Yes when prompted to confirm the deletion.
CHAPTER 6: Data Management
1. At the Add Attached Item window, select the item and click Add.
Version 7.1
Figure 6-11: Add Attached Item Window
2. Enter the attached item information.
Sold Item - The merchandise item. [
C
ANNOT BE CHANGED
]
Attached Item - The item attached to the merchandise item. [
C
ANNOT BE CHANGED
]
Org Node - The org node that was targeted when the attached item relationship was originally made. [
C
ANNOT BE CHANGED
]
Quantity to Add -
[R
EQUIRED
]
The quantity of the item that is to be attached.
Start Date -
[R
EQUIRED
]
The starting date for this attached item.
End Date - The ending date for this attached item.
Do you want to prompt users before adding this item check box - Select to enable prompting.
Do you want to prompt users when returning this item check box - Select to enable prompting.
3. Click Save. The system returns to the Attached Items page.
Version 7.1 User Guide
1. After selecting the row you want to change, edit the attached item information.
Sold Item - The merchandise item. [
C
ANNOT BE CHANGED
]
Attached Item - The item attached to the merchandise item. [
C
ANNOT BE CHANGED
]
Org Node - The org node that was targeted when the attached item relationship was originally made. [
C
ANNOT BE CHANGED
]
Quantity to Add -
[R
EQUIRED
]
The quantity of the item that is to be attached.
Start Date -
[R
EQUIRED
]
The starting date for this attached item.
End Date - The ending date for this attached item.
Do you want to prompt users before adding this item check box - Select to enable prompting.
Do you want to prompt users when returning this item check box - Select to enable prompting.
2. Click Save. The system returns to the Attached Items page.
...continued from “Items” on page 142 .
Select the Merchandise Hierarchy option (Figure 6-3 on page 142) to view and configure
the merchandise hierarchy for your organization.
Figure 6-12: Merchandise Hierarchy Maintenance Page - Dept 300 Selected
The following information is shown on this page:
Merchandise Level Information - This area shows information about the selected level of the merchandise hierarchy, including the Parent Level and Value and the Item Level and
Value.
CHAPTER 6: Data Management Version 7.1
If a level is inactive, it will be indicated as “Hidden”.
Use the merchandise hierarchy tree to navigate and understand the hierarchy itself. (By default, the tree displays the Department level). When you select a merchandise hierarchy level in the tree view, the details of the level are displayed in the Merchandise Level
Information panel.
Click Edit to update the merchandise level information displayed in the panel. See Editing a
below.
Action Panel - This area contains the link to add to an organization's organization hierarchy.
The color legend shown here corresponds to the colors in the tree view for the merchandise hierarchy levels. To add new areas of a merchandise hierarchy, see
Hierarchy Level” on page 155 .
You cannot add a new merchandise hierarchy level. Levels are restricted to what currently exists in your organization: Department,
Subdepartment, Class, etc.
1. In the tree view, select the parent hierarchy level for the planned edit to the merchandise hierarchy.
Use the “Find a Node” search box to quickly locate a node in the merchandise hierarchy tree.
2. With the node selected, click Edit.
3. Edit the information as needed:
Figure 6-13: Edit Merchandise Level
Parent Level - The parent merchandise hierarchy level. [
C
ANNOT BE CHANGED
]
Version 7.1 User Guide
Parent Value - The parent merchandise hierarchy value. [
C
ANNOT BE CHANGED
]
Level - The level type. (For example, if the parent level is a Department, then this
level is Subdepartment based on the Merchandise Hierarchy setup shown here).
[
C
ANNOT BE CHANGED
]
Hierarchy ID - The identifier for the merchandise hierarchy level. [
C
ANNOT BE
CHANGED
]
Description - The description for the merchandise hierarchy level.
Display Order - The display order for the merchandise hierarchy level.
Is this merchandise level visible? check box - When selected, the merchandise level is active and visible. To deactivate the merchandise hierarchy level, remove the check mark from the check box. The deactivated level and all sublevels are grayed out on the page and a message displays in the Merchandise Level Information panel indicating that the level is hidden.
If needed, click to close the window without saving your changes. If prompted, click Yes to confirm you do not want to save any changes.
4. Click Save to close the window. The merchandise hierarchy level is updated as specified.
1. In the tree view, select the parent hierarchy level for the planned addition to the merchandise hierarchy.
Use the “Find a Node” search box to quickly locate a node in the merchandise hierarchy tree.
2. With the node selected, click the link add a level to the currently selected node.
Figure 6-14: Add a Level Link
CHAPTER 6: Data Management
3. Enter the information for the new level:
Version 7.1
Figure 6-15: Add Merchandise Level
Parent Level - The parent merchandise hierarchy level. [
C
ANNOT BE CHANGED
]
Parent Value - The parent merchandise hierarchy value. [
C
ANNOT BE CHANGED
]
Level - The level type to be created. (For example, if the parent level is a
Department, then this level is Subdepartment based on the Merchandise Hierarchy
setup shown here). [
C
ANNOT BE CHANGED
]
Hierarchy ID - The identifier for the new merchandise hierarchy level.
[R
EQUIRED
]
Description - The description for the new merchandise hierarchy level.
[R
EQUIRED
]
Display Order - The display order for the new merchandise hierarchy level.
Is this merchandise level visible? check box - When selected, the merchandise level is active and visible. To deactivate the merchandise hierarchy level, remove the check mark from the check box. The deactivated level and all sublevels are grayed out on the page and a message displays in the Merchandise Level Information panel indicating that the level is hidden.
If needed, click to close the window without saving your changes.
When prompted, click Yes to confirm you do not want to save any changes.
4. Click Save to close the window. The new merchandise hierarchy level is added to the tree.
Version 7.1 User Guide
...continued from “Items” on page 142 .
Select the Non-Merchandise Items option (Figure 6-3 on page 142) to view and configure
the merchandise hierarchy for your organization. The Non-Merchandise Items Maintenance page displays all non-merchandise items available to the targeted org node.
Figure 6-16: Non-Merchandise Items Maintenance Page
Use the Subtype Code filter to find non-merchandise items within the list of non-merchandise items.
At the Non-Merchandise Items Maintenance page, click Add New to create a new item.
At the Non-Merchandise Items Maintenance page, select the row from the non-merchandise items list and click Edit at the item information window.
To view and/or edit item prices, refer to
“Item Prices” on page 147 , step 2, for procedural information.
See step 6 on page 140 for additional procedural information.
CHAPTER 6: Data Management Version 7.1
The following Non-Merchandise Item Maintenance fields are available:
Field
Item ID
[R
EQUIRED
]
Description
Enter the item identifier. This field cannot be edited for existing items.
Enter the item description.
Description
[R
EQUIRED
]
Prompt for Description
check box
Tax Group
[R
EQUIRED
]
Availability
Select this check box if the item description must be manually entered when this item is sold.
Select the item’s tax group from the drop-down list.
Possible values are from the Tax Group table
(tax_tax_group).
Select the product availability to determine whether or not an item is available for sale: Available, Not Sellable at POS, or Recalled.
Commission check box
Image check box
Serial Number check box
If applicable, select this option if the item qualifies for commission.
If applicable, select this option and type the file path/URL when prompted.
Select this option if a serial number is required.
Field Description
Sale Quantity check box Select this option if the item quantity cannot be changed from 1.
Note: This option will disable all other item quantity options listed here.
Quantity Prompt check box
Initial Sale Quantity check box
Minimum Sale Quantity check box
Select this option if the item quantity must be manually entered when this item is sold.
Select this option if the item is sold in a quantity other than one. If selected, enter the initial quantity at which this item must be sold.
Select this option if the item has a minimum sale quantity. If selected, enter the minimum quantity of this item that may be sold in a single transaction.
Version 7.1 User Guide
Field Description
Maximum Sale Quantity check box
Select this option if the item has a maximum sale quantity. If selected, enter the maximum quantity of this item that may be sold in a single transaction.
Field Description
Customer Information
Required check box
Purchaser Minimum Age
Required check box
Select this option if the system prompts for customer information when the item is sold. If selected, a prompt for information will be displayed. Select whether the information is required or optional:
Prompt, entry is required
Prompt, entry is optional
Select this option if a minimum age is required to purchase the item. If selected, enter the minimum age (in years) required to purchase the item.
Field Description
Inventoried check box Select this option if inventory levels are tracked for this item.
Item Type Restrictions
Disallow Layaway check box
Select this option if this item cannot be added to a layaway transaction type.
Disallow Order check box Select this option if item cannot be ordered via Locate Order functionality.
Disallow Returns check box
Disallow Send Sale check box
Select this option if this item cannot be added to a return transaction type.
Select this option if this item cannot be added to a send sale transaction type.
Disallow Special Order check box
Disallow Work Order check box
Select this option if this item cannot be added to a special order transaction type.
Select this option if this item cannot be added to a work order transaction type.
CHAPTER 6: Data Management Version 7.1
Field Description
Disallow Deal check box
Disallow Discount check box
Disallow Price Change check box
Price Change Restrictions
Select this option if this item does not qualify for deals.
Select this option if this item cannot be discounted.
Select this option if this item price cannot be changed.
Field Description
Type Code
[R
EQUIRED
]
Select the type code for the non-merchandise item. If needed, select Other to create a new type code and enter new type code in the Type Code field.
Note: A new type code created here will only be for this non-merchandise item and will not be available for any other items.
Subtype Code
[R
EQUIRED
]
Select the subtype code for the non-merchandise item.
Exclude From Net Sales check box
Select this option if the non-merchandise item will not be attributed as revenue.
Prompt for Price check box
Select this option if the retail price must be manually entered when this item is sold.
...continued from “Items” on page 142 .
Select the Item Matrix Manager option (Figure 6-3 on page 142) to manage the item
matrix information for your organization.
At the Item Matrix Manager page, manage the look and feel of the item matrix in Xstore. Use this feature to assign matrix colors to merchandise hierarchy and/or item records, mark merchandise hierarchy and/or item records as hidden (items labeled as hidden will not show
Version 7.1 User Guide
in the item matrix in Xstore), and change the sort order of merchandise hierarchy and/or item records to specify how they will display within the item matrix in Xstore.
Figure 6-17: Item Matrix Manager Page
Fields on the Item Matrix screen
Field
Color Area
ID
Description
Color
Hidden
Description
Shows the color currently associated with the merchandise hierarchy or item and is used to drag and drop the selection to another location in the list.
The merchandise hierarchy or item identifier.
The merchandise hierarchy or item description.
The color associated with the merchandise hierarchy or item for display in the item matrix in Xstore.
If the check box is selected, the merchandise hierarchy or item will not show in the item matrix in Xstore.
Links on the Item Matrix screen
Link
Color Legend
Next Level
Description
Opens a window showing the available color palette.
Opens a new page showing the items in next merchandise hierarchy level.
1. Select a color from the Color drop-down list for the merchandise hierarchy or item record you want to change.
The color in the shaded area associated with the item is changed to the selected color.
CHAPTER 6: Data Management
To view the available colors, click the Color Legend link.
The color Gray shown in the legend is not available from the drop-down list of available colors. Gray is used to denote
“Hidden” buttons only.
2. Click Save to save your changes.
1. Hover over the shaded area of the row you want to move.
2. With the move icon showing for the selected item row, drag and drop the item to a new location in the list to change the sort order.
Version 7.1
3. Click Save to save your changes.
1. Click the Hidden check box for the merchandise hierarchy or item record.
Figure 6-18: Hidden Check Box Selected
When the Hidden check box is selected, the color drop-down list and the Next Level link are no longer available for selection. In addition, the color in the shaded area associated with the item is changed to gray.
2. Click Save to save your changes.
Version 7.1
Use this feature to create and modify vendors for your organization.
User Guide
Figure 6-19: Vendor Maintenance Page
At the Vendor Maintenance page, click Add New to create a new vendor.
Enter search criteria and click Search to find/edit a vendor in your organization. If you do not enter any criteria before selecting Search, all vendors in your organization will be returned in the search. To edit information for an existing vendor, select the row from the search results list and click Edit at the vendor information screen.
To delete an existing vendor, click the Delete icon associated with the record at the search results list.
See step 6 on page 140 for additional procedural information.
Complete the following Vendor Maintenance fields, then click Save.
Field
Vendor ID
[R
EQUIRED
]
Vendor Name
[R
EQUIRED
]
Description
Enter a unique identifier assigned to a vendor. This value cannot be changed in Edit mode.
Enter the name of the vendor.
Contact Name
Contact Telephone
Enter the primary contact person for the vendor.
Enter the primary telephone number of the primary contact.
CHAPTER 6: Data Management Version 7.1
Field
Buyer Name
Description
Enter the name of the buyer associated with the vendor.
Field Description
Address 1
Address 2
Enter the first line of the mailing address.
Enter the second line of the mailing address.
City
State
Postal Code
Enter the city component of the mailing address.
Enter the State/Province component of the mailing address.
Enter the Postal or ZIP code component of the mailing address.
Country
Vendor Telephone
Enter the country component of the address.
Enter the primary telephone number.
Version 7.1
Use this feature to create and modify employee records for your organization.
User Guide
Figure 6-20: Employee Maintenance Page
At the Employee Maintenance page, click Add New to create a new employee record.
Enter search criteria and click Search to find/edit an existing employee record in your organization. If you do not enter any criteria before selecting Search, all employee records in your organization will be returned in the search. To edit information for an existing employee record, select the row from the search results list and click Edit at the employee information screen.
To delete an existing employee record, click the Delete icon associated with the record at the search results list.
See step 6 on page 140 for additional procedural information.
The following Employee Record Maintenance fields are available:
Field Description
Employee ID
[R
EQUIRED
]
Enter the unique number used to identify a store employee.
This field cannot be changed in edit mode.
Login ID
If used, enter the employee’s user ID for logging in to the system. (Only displayed if Xstore is configured to use a Login
ID.)
First Name
[R
EQUIRED
]
Middle Name
Enter the employee’s first name.
Enter the employee’s middle name.
CHAPTER 6: Data Management Version 7.1
Field
Last Name
[R
EQUIRED
]
Description
Enter the employee’s last name.
Note: Select a suffix from the drop-down list if applicable.
Language
Gender
Employment Status
Select the employee's preferred language.
Select the employee's gender, Male or Female.
Activation Date
Select the employee’s status: Active, Inactive, Terminated.
Note: If Terminated status is selected, the termination date is required. Enter the termination date in the Termination
Date field.
Enter the date on which the employee became active.
Field Description
Job Title
Birth Date
Enter the employee’s job title.
Enter the employee’s date of birth.
Base Pay
Pay Status
Hire Date
Last Review
Next Review
Extra Withholding check box
Overtime Eligible check box
Clock In Required check box
Enter the employee’s base pay.
Select the employee’s pay status; hourly or salaried.
Enter the date the employee was hired.
Enter the date of the employee’s last review.
Enter the date of the employee’s next review.
Select this option if the employee wants to have extra money withheld from his/her pay. Type the dollar amount to be withheld in the Amount field.
Select this option if the employee is eligible for overtime.
Select this option if the employee is required to clock in and out.
Version 7.1 User Guide
Field Description
Address 1
Address 2
Enter the first line of the mailing address.
Enter the second line of the mailing address.
City
State
Postal Code
Enter the city component of the mailing address.
Enter the State/Province component of the mailing address.
Enter the Postal or ZIP code component of the mailing address.
Country
Primary Phone
Other Phone
Emergency Contact
Emergency Phone
Enter the country component of the address.
Enter the employee’s primary phone number.
Enter the employee’s alternate phone number.
Enter the employee’s email address.
Enter the name of an emergency contact for the employee.
Enter the phone number of the emergency contact for the employee.
Field Description
Primary Security Group
[R
EQUIRED
]
Security Groups check box
Customer Groups check box
Select the fundamental security group to which this employee belongs.
Select any other security groups to which this employee belongs: Trainee, Cashier, Keyholder, Manager. Select all that apply. By default, the “Everyone” security group is required for all employees. This value cannot be changed.
Select the customer groups to which this employee belongs.
Select all that apply.
CHAPTER 6: Data Management Version 7.1
Field Description
Store #
Start Date
Temporary Assignment check box
Enter the specific retail store within the organization the employee is assigned to.
Enter the date the employee assignment begins at the store.
Click Add Store to assign the employee to this store on the start date. Add as many stores/start dates as needed.
Note: Click Add All Stores to assign the employee to all stores in the organization.
The store information is added to the screen. Repeat until all stores where the employee works are listed. If needed, click Delete to remove an assigned store.
Select this option if the assignment is temporary. Enter the ending date for this temporary assignment.
Use this feature to manage tax configurations for your organization.
Figure 6-21: Data Manager - Taxes Page
To set up and manage Tax Authorities, Tax Locations, Tax Brackets, and Tax Groups used to create the tax rates, click Tax Elements. See
below.
To set up and manage Tax Rates, click Tax Rates. See
Note: The Tax Elements must be set up before you can set up the Tax Rates.
Version 7.1
Set up the basic tax elements here before setting up the tax rate rules.
User Guide
Figure 6-22: Tax Elements Page
Tax Authorities - Identifies the name of the authority that imposes the tax, and also
supplies the rounding rules that are used in the calculation. See “Tax Authorities” on page 169 .
Tax Locations - Defines the tax locations that can be assigned to individual stores. See
.
Tax Groups - Defines tax groups for items that are taxed according to the same rules.
For example, certain food products may belong to the same tax group. After defining the tax groups, they may be assigned to individual items. See
.
Tax Brackets - Defines the tax brackets used to calculate the sales tax for an item or
transaction. See “Tax Brackets” on page 172
.
1. At the Tax Authorities Maintenance page, click Add New to create a new tax authority.
2. Complete the fields as required, then click Save.
1. At the Tax Authorities Maintenance page, select a tax authority from the list of tax authorities that are currently available for the targeted org node.
CHAPTER 6: Data Management Version 7.1
2. Edit the fields as required, then click Save.
The following Tax Authority fields are available:
Field
ID
[R
EQUIRED
]
Name
[R
EQUIRED
Rounding Code
]
Description
Enter a unique identifier of a tax authority. The ID cannot be changed in edit mode.
Enter the name of the tax authority.
Rounding Digits
Select from the drop-down list of rounding codes. Codes indicate how tax is to be rounded when calculated. The list is populated using TaxAuthorityUiContainer.
Values:
Always round down
Always round up
Round ceiling
Round floor
Round half down
Round half even
Round half up
Enter the number of digits to which rounding is to be calculated.
Version 7.1 User Guide
1. At the Tax Locations Maintenance page, click Add New to create a new tax location.
2. Complete the fields as required, then click Save.
1. At the Tax Locations Maintenance page, select a tax location from the list.
2. Edit the fields as required, then click Save.
To search for a specific tax location, begin typing the tax location description in the
The following Tax Location fields are available:
Field Description
ID
[R
EQUIRED
]
Enter a unique identifier of a tax location. The ID cannot be changed in edit mode.
Name
[R
EQUIRED
]
Description
Enter the name of the tax location.
Enter a text description of the tax location.
Any Tax Locations created here will be “pending deployment”; however, these locations will be available for use within the other areas of the Taxes feature.
1. At the Tax Groups Maintenance page, click Add New to create a new tax group.
2. Complete the fields as required, then click Save.
1. At the Tax Groups Maintenance page, select a tax group from the list.
2. Edit the fields as required, then click Save.
CHAPTER 6: Data Management Version 7.1
The following Tax Group fields are available:
Field Description
ID
[R
EQUIRED
]
Enter a unique identifier of a tax group. The ID cannot be changed in edit mode.
Name
[R
EQUIRED
]
Description
Enter the name of the tax group.
Enter a text description of the tax group.
Any Tax Groups created here will be “pending deployment”; however, these groups will be available for use within the other areas of the
Taxes feature.
1. At the Tax Brackets Maintenance page, click Add to create a new tax bracket.
2. Complete the fields as required in step 3 below.
1. At the Tax Brackets Maintenance page, select a tax bracket from the list.
2. Edit the fields as required in step 3 below.
3. Complete the following Tax Bracket fields:
Field
Bracket ID
[R
EQUIRED
]
Tax Breakpoint
[R
EQUIRED
]
Tax Amount
[R
EQUIRED
]
Description
Enter a unique identifier of a tax bracket. The ID cannot be changed in edit mode.
Enter the tax breakpoint, up to 6 decimal places.
Enter the tax amount, up to 6 decimal places.
4. Click Add to add the tax breakpoint and tax amount to the Tax Bracket.
Continue adding all tax breakpoints and tax amounts for the Tax Bracket, and click Add after each addition to add the values to the Tax Bracket. The entered values are sorted in ascending order based on the breakpoint as they are added.
5. Click Save to save the Tax Bracket.
Version 7.1 User Guide
Any Tax Brackets created here will be “pending deployment”; however, these brackets will be available for use within the other areas of the
Taxes feature.
Click the Delete link associated with the tax breakpoint and tax amount.
Figure 6-23: Delete Link - Tax Breakpoint And Tax Amount
1. With the Tax Bracket displayed, click Delete.
Figure 6-24: Delete Tax Bracket
2. When prompted, click Yes to confirm the deletion.
CHAPTER 6: Data Management Version 7.1
After setting up the basic tax elements (see
“Tax Elements” on page 169 ), perform the
following steps to set up and manage tax rate rules and group rules.
1. Select Tax Rates at the Taxes page ( Figure 6-21 on page 168
), then enter/select a Tax
Location and click Next.
2. Add a new tax rate, or edit an existing tax rate for the selected tax location:
1. At the Tax Location Group Rules page, click Add New to create a new Tax Group Rule for the selected tax location.
2. Complete the fields as required, then click Save.
1. At the Tax Location Group Rules page, select a Tax Location Group Rule from the list.
2. Edit the fields as required, then click Save.
The following Tax Group Rule fields are available:
Field Description
Tax Group
[R
EQUIRED
]
Select the ID assigned to the tax group. The ID cannot be changed in edit mode.
Enter the name assigned to the tax group.
Select the Tax Authority.
Name
[R
EQUIRED
]
Tax Authority
[R
EQUIRED
]
Tax Type
[R
EQUIRED
]
Transaction Level check box
Compound Tax check box
Select the Tax Type.
Select this check box to use this group rule at the transaction level.
Select this check box to compound this group rule.
A compound tax is a special kind of tax that is calculated by applying it to a previously taxed item. The value of the compound tax is based on the sum of an item’s price plus the tax that was previously applied to it.
1. At the Tax Location Group Rules page, click Edit Rates.
2. Do one of the following:
To create a new Tax Rate Rule, click Add New.
To edit an existing Tax Rate Rule, select it in the list.
Version 7.1 User Guide
3. Complete the following Tax Rate Rules fields:
Field Description
Minimum Taxable
Amt
Maximum Taxable
Amt
Specify the starting value amount at which the tax rate rule is first applied if the tax rate rule is applied at different thresholds.
Specify the highest value amount at which the tax rate rule is applied if the tax rate rule is applied at different thresholds.
Tax Rate
[R
EQUIRED
]
Effective Date
Expiration Date
Breakpoint
Select the tax rate and enter the amount, percent, or select a tax bracket.
Enter the date on which the tax rate rule becomes operative.
Enter the date on which the tax rate rule is no longer operative.
Select the breakpoint from the list.
This value determines if the tax rate rule is applied to the entire value of the transaction or only to a portion of it, if the rule has threshold values defined.
4. Click Save.
The Seq. Number determines the order in which a tax is applied in a transaction. The rule with sequence number “1” is first, “2” is second, and so on.
1. Click the delete icon associated with the Tax Rate Rule.
2. When prompted, click Yes to confirm the deletion.
See “If adding or editing a Tax Rate Rule:” on page 174 . The process for Tax Rate Rule
Overrides is the same as the process for Tax Rate Rules.
CHAPTER 6: Data Management
Use this feature to create and modify store messages and employee tasks.
Version 7.1
Figure 6-25: Communications Options Page
To create or edit a store message and target it to a location, or a location and
register combination, click Store Messages. See Store Messages below.
To create or modify tasks for a store or for specific employees within a store, click
Employee Tasks. See
“Employee Tasks” on page 178 .
Use this feature to create or edit a store message and target it to a location, or a location and register combination.
Figure 6-26: Store Messages Page
1. At the Store Messages page, click Add New to create a new message.
2. Complete the fields as required, then click Save.
Version 7.1 User Guide
1. Enter search criteria and click Search to find/edit a store message in your organization.
If you do not enter any criteria before selecting Search, all messages in your organization will be returned in the search.
2. To edit information for an existing message, select the row from the search results list and edit the information as needed. You also have the option here to create a new message by clicking Add New at the search results page.
3. Complete the fields as required, then click Save.
To delete an existing message, click the Delete icon associated with the record at the search results list. When prompted, click Yes to confirm the deletion.
See step 6 on page 140 for additional procedural information.
The following Store Messages fields are available.
Field Description
Message Scope
Register Specific check box
URL check box
Identifies the scope and number of stores that will be receiving this message. The message scope is the node selected for the Data Manager session and cannot be changed here.
Select this option if the message is targeted to a specific register and enter the register number in the Register # field when prompted.
Note: If you select this option, the message displays on only the specified workstation. If you do not select this option, the message displays on all workstations.
Select this option if there is a URL associated with this message and enter the URL when prompted.
The hyperlink will display with the message in Xstore.
Priority [R
EQUIRED
]
Start Date [R
EQUIRED
]
End Date [R
EQUIRED
]
Message [R
EQUIRED
]
Select the message priority: High, Medium, Low.
Enter the date the message is to be displayed.
Enter the date the message is no longer displayed.
Enter the message text.
CHAPTER 6: Data Management Version 7.1
Use this feature to create or modify tasks for a store, or for specific employees within a store.
Figure 6-27: Employee Tasks Page
1. At the Employee Tasks page, click Add New to create a new employee task.
2. Complete the fields as required, then click Save.
1. Enter search criteria and click Search to find/edit an existing employee task in your organization. If you do not enter any criteria before selecting Search, all employee tasks in your organization will be returned in the search.
2. To edit information for an existing employee task, select the row from the search results list and edit the information as needed. You also have the option here to create a new task by clicking Add New at the search results page.
3. Complete the fields as required, then click Save.
To delete an existing employee task, click the Delete icon associated with the record at the search results list. When prompted, click Yes to confirm the deletion.
See step 6 on page 140 for additional procedural information.
The following Employee Tasks fields are available.
Field Description
Status
This field cannot be changed. Indicates the status of the task
(Open, In Process, Cancelled, and Closed).
Version 7.1 User Guide
Field
Store # [R
EQUIRED
]
Description
Enter the store number. This value can only be edited in Add mode.
Task Title [R
EQUIRED
]
Priority [R
EQUIRED
]
Type [R
EQUIRED
]
Enter a short summary description of the task.
Select the task priority: High, Medium, Low.
Select the type that best fits the task (General, Mailing,
Display, Housekeeping, Receiving, Shipping, or Count).
Start Date [R
EQUIRED
]
End Date [R
EQUIRED
]
Start Time [R
EQUIRED
]
End Time [R
EQUIRED
]
Visibility [R
EQUIRED
]
Assignee
Description [R
EQUIRED
]
Enter the date the task should be started.
Enter the date the task should be completed.
Enter the time the task should begin.
Enter the time the task should end.
Select who can view this task: Store, Employee Group, or
Employee.
If the visibility selection is Employee Group or Employee, select the target assignee from the drop-down list.
[R
EQUIRED
]
Note: The visibility field determines the drop-down list for the Assignee field. If you select Store for visibility this field will not be available.
Enter a detailed description of the task.
CHAPTER 6: Data Management Version 7.1
Use this feature to create and modify currency exchange rates for your organization.
Figure 6-28: Exchange Rates Maintenance Page
1. At the Exchange Rates maintenance page, click Add New.
2. Enter information required to create a new currency exchange rate record.
3. Click Save.
1. Select the record from the list to open the Edit window.
2. Make your changes, then click Save.
Figure 6-29: Exchange Rate Maintenance Edit Window
To delete a currency exchange rate record, click the Delete icon associated with the record. When prompted, click Yes to confirm the deletion.
The following Currency Exchange Rates fields are available:
Field
Base Currency
Description
Select the local/home currency. This value can only be edited in Add mode.
Exchange Currency
Exchange Rate
Select the non-local currency used in the exchange of tenders. This value can only be edited in Add mode.
Enter the quantitative conversion factor between the base currency and the exchange currency.
Version 7.1
User Guide
This Data Manager Stores option allows you to search for and modify store information for an existing store only. To set up a new store, see
“Managing the Organization Hierarchy” on page 191
.
Use this feature to search for and modify store information.
Figure 6-30: Stores Maintenance Page
1. Find the store to be edited:
If you know the store ID, enter the store ID in the Edit a Store Location field at the
Stores Maintenance page.
To search for a store, enter search criteria and click Search to find/edit an existing store in your organization. If you do not enter any criteria before selecting Search, all stores in your organization will be returned in the search. To edit information for an existing store, select the row from the search results list.
2. Click Edit at the Store Information screen.
3. Complete the fields as required, then click Save.
See step 6 on page 140 for additional procedural information.
CHAPTER 6: Data Management Version 7.1
The following Stores fields are available:
Field
Store #
Description
The store identifier. This value cannot be changed.
Store Name [R
EQUIRED
]
Alternate Store #
Edit the store name.
Enter the Shop ID (alternate store number) assigned to a store number as a reference to an outside/downstream integration.
Airport Zone
Store Description check box
Address 1
Address 2
City
State
Postal Code
Country
Geographic Parameters check box
Select the Zone ID assigned to a store number as a reference to calculate the TAX_FREE, TAX_NORMAL, and
PRICE_SPECIAL amounts for transactions in an Airside location. Valid values are derived from data from the com_airport_zone table in the Xcenter database.
Select this option to enter a text description for the store.
Type the description in the description field when prompted.
Enter the first line of the mailing address.
Enter the second line of the mailing address.
Enter the city component of the mailing address.
Enter the State/Province component of the mailing address.
Enter the Postal or ZIP code component of the mailing address.
Enter/select the country component of the address.
Select this option to enter the latitude and longitude values for this location.
Version 7.1
Field
Tax Location
Currency
Locale
Organization Hierarchy
Position
Description
Select the identifier of the tax location.
Select the base currency used in the store.
Select the base locale for the store.
View only. This shows the store’s position in the organizational hierarchy.
User Guide
Field Description
Deposit Bank Name
Deposit Bank Account
Number
Enter the deposit bank name to be printed when franking.
The default value here is from Xadmin System Settings.
Enter the deposit bank account number to be printed when franking. The default value here is from Xadmin System
Settings.
Enter the number of registers in the store.
Number of Registers in the Store
Use Till Accountability
check box
I
MPORTANT
!
If this setting is changed, you must deploy the changes at the end of the day, during the store close.
Downloading this change during the day, while the store is open, will cause problems in Xstore.
This setting determines whether the store uses Till
Accountability mode or Register mode. Select the check box to use Till Accountability mode. The default value here is from
Xadmin System Settings.
CHAPTER 6: Data Management Version 7.1
Field Description
Default Float Amount check box
In Register Mode:
If the default float amount is the same for every register/ till ( selected), enter the default float amount that applies to all registers/tills.
If the default float amount is not the same for every register/till ( not selected), enter an amount for the till and click Add. Repeat this step for all registers/tills in the store. A Delete option is available if you need to make a change.
greater than the number of registers.
In Till Accountability Mode:
If the default float amount is the same for every till ( selected), enter the default float amount that applies to all tills, then enter the number of tills used in the store.
If the default float amount is not the same for every till ( not selected), enter an amount for the till and click Add. Repeat this step for all registers/tills in the store. A Delete option is available if you need to make a change.
sum of all till float amounts.
Field
Store Manager
Telephone 1 through 4
Store Email
Description
Enter the store manager’s name.
Enter the telephone numbers for the store. Telephone 1 is the primary telephone number for the store.
Enter the store’s email address.
Version 7.1 User Guide
Data Manager changes are collected into “data bundles” containing all of the changes made within a particular org level during a given day. The changes collected in the data bundle will be deployed to their targeted stores automatically at the end of the day (as configured), or can be deployed immediately using the Pending Modifications option described here if needed.
Any changes made after the configured time of day will collect and deploy during the next day (and the next configured time) unless the change(s) are deployed manually.
Click Pending Modifications at the Data Manager page to view and/or deploy data changes.
Figure 6-31: Data Manager Page
The Pending Modifications page shows the data bundles within the logged on user's org hierarchy level that have not been deployed. There is one row per target.
Figure 6-32: Pending Modifications Page
Options at the Pending Modifications page include the ability to view, deploy, or delete the changes as a whole (data bundle) including all the individual data changes that they contain.
To delete only an individual data change or changes within a data bundle, see
“Viewing the Individual Changes in the Data Bundle” on page 187
CHAPTER 6: Data Management Version 7.1
If you choose to deploy the changes here, the deployment will happen immediately. Once deployed, it is no longer possible to view or edit the data changes, (i.e. the group of changes will not be available to be deployed again). If an error was deployed, you must create a new data change and deploy it to fix the error.
Any deployments manually initiated from the Pending Modifications
page will be shown on the Deployments page. See Chapter 7,
“Deployment Manager” on page 201 for more information.
The following information is shown on the Pending Modifications page:
Field Description
Target
Last Edited
The org node targeted for the data bundle
The date the data bundle was most-recently edited.
Last Edited User
# of Changes
Deploy Icon
Delete Icon
The user who last edited the data bundle.
The number of individual changes in this data bundle for the targeted org node.
To deploy the Data changes as a whole (data bundle), click the
Deploy icon associated with the row in the search results list.
When prompted, click Yes to confirm you want to deploy the selected Data change. Click OK at the deployment scheduled successfully prompt and the row is removed from the pending modification list.
To delete the Data changes as a whole (data bundle), click the
Delete icon associated with the row in the search results list.
When prompted, click Yes to confirm you want to delete the selected Data change and the row is removed from the pending modification list.
Version 7.1 User Guide
To view the individual changes in the data bundle, click the row in the search results list at
the Pending Modifications page (Figure 6-32). The Pending Modifications Detail page lists the
individual data changes that have been made within the selected group of undeployed data changes. Options here include the ability to view or delete the individual changes.
Figure 6-33: Pending Modifications Detail Page
To filter the list based on an Area within the group of undeployed data changes, select the Area from the dropdown list.
Field
Action
Area
Data Element
Last Edited
Last Edited User
Delete Icon
Description
The action that will be taken when sent to Xstore; Add, Update, or
Delete.
The type of data manager change.
A description of the data manager change.
The date the modification was most-recently edited.
The user who last edited the modification.
To delete the individual Data change within the data bundle, click the Delete icon associated with the row. When prompted, click
Yes to confirm you want to delete the selected Data change and the row is removed from the data bundle.
CHAPTER 6: Data Management Version 7.1
This feature provides the ability to deploy data from Xcenter to an org node so that all data within the selected org node's scope is transferred to the selected org node.
For example, when opening a new store, use this feature to send Xcenter data to the new store.
The intended use of this feature is for franchise retailers that have a need to republish small amounts of data to the store. Retailers with thousands of items will likely use a merchandising system to republish items. Using this feature for a large number of items could perform slowly and could encounter out-of-memory errors.
Valid data for redeployment includes: Items, Exchange Rates, Store Messages, Taxes,
Employees, and Vendors.
Tasks and Stores data cannot be redeployed.
Data intended for the selected node will be deployed as follows:
A transfer to a single store may require data from a store-level, district-level, and corporate-level. In this example, all of this data will be included in the deployment.
A transfer to a region or district may result in multiple deployments to accommodate the multiple stores within the node. For example, if transferring to a district, the district may contain a total of 10 stores, and the stores may all receive different data which will result in 10 deployments.
1. From the Xadmin menu, select Data Management --> Data Manager, or click the Data
Manager link in the Data Management panel.
2. Click Data Publisher.
3. Select the Target Organization Node, then click Next.
Only the Organization Nodes the logged-in user has privileges to use will be listed here.
Version 7.1 User Guide
4. At the Publish Data page, select the types of data to be transferred from Xcenter to the targeted org node:
Figure 6-34: Publish Data Page
To transfer all data listed here to the targeted org node, click the Select All button.
When all categories are selected, the button toggles to “Select None”.
If selected, all check marks will be removed.
To transfer all data in a category, select the check box next to the category name.
To transfer specific data within a category, select the check box next to the data item.
5. Click Next.
CHAPTER 6: Data Management Version 7.1
6. At the Target Node Information window, review your changes and select a download priority option — Immediate or Store Close — from the drop-down list.
Figure 6-35: Target Node Information Window
7. Click Deploy.
8. When prompted that the deployment was scheduled successfully, click OK to close the window.
About Deployment
If the deployment of data should fail for one (or more) nodes within the target, the entire deployment will not fail. In this case, the progress bar turns red, indicating an error. At the end of the transfer, a failure count is shown above the progress bar (i.e., 5/250), and you can click a provided link to see more information at the “View Deployments” page.
Version 7.1 User Guide
Organization Hierarchy management includes both defining the hierarchy levels in your organization, as well as organizing and maintaining the nodes in the hierarchy.
1. From the Xadmin menu, select Data Management --> Organization Hierarchy, or click the Organization Hierarchy link in the Data Management panel.
2. At the Organization Hierarchy page, you have the following options:.
Figure 6-36: Organization Hierarchy Page
To define organization hierarchy levels, click Organization Hierarchy Levels.
Refer to Defining Organization Hierarchy Levels
below for procedural information.
To maintain and organize the nodes in the hierarchy, click Organization Hierarchy
Maintenance. Refer to
“Maintaining the Organization Hierarchy” on page 193
for procedural information.
To create and maintain store collections, click Store Collections. Refer to
“Creating and Maintaining Store Collections” on page 198
Use this feature to define the Organization Hierarchy levels in your organization. Once set up, these levels will be available for use in Organization Hierarchy Maintenance.
The Parent (root) Level field cannot be edited, and only one root level (*) is allowed.
STORE is the lowest hierarchy level. You cannot add a level order lower than STORE level.
STORE is a reserved word within organization hierarchy maintenance and cannot be added as an organization level.
CHAPTER 6: Data Management Version 7.1
Figure 6-37: Organization Hierarchy Levels Page
1. Select an org node within the org hierarchy tree.
2. With the node selected, click Add Level to add an org level to the selected node.
3. Complete the fields as required and click Save.
Field
Parent Level
Org Level [R
EQUIRED
]
Description
Description
Defaults to the currently selected node and cannot be changed.
Enter the name of the new org level.
Enter a description for the new org level.
1. Select an org node within the org hierarchy tree.
2. With the node selected, enter the description in the Description field.
Figure 6-38: Organization Hierarchy Levels Page - Edit Description
3. Click Save. The tree view description is updated with the new description.
Version 7.1 User Guide
1. Select an org node within the org hierarchy tree.
2. With the node selected, click Delete.
Levels that are currently being used, i.e., levels with children, cannot be deleted.
3. When prompted, click Yes to confirm you want to delete the selected hierarchy level.
The Organization Hierarchy Maintenance feature provides the ability to add an organization hierarchy level to a node, create a new store and add it to an org node, add an existing, unassigned store to an org node, temporarily deactivate an org node, and deploy the changes.
Figure 6-39: Organization Hierarchy Maintenance Page
To search for a specific node, begin typing the node description in the Find a Node field.
CHAPTER 6: Data Management Version 7.1
Organization Hierarchy levels must be defined before they can be used in Organization Hierarchy Maintenance. See
for more information about setting up
Organization Hierarchy levels for your organization.
Perform the following steps to add an organization hierarchy level to a node.
1. From the Organization Hierarchy Maintenance page, select an org node within the org hierarchy tree.
2. With the node selected, click the add a level to the currently selected node link.
3. Complete the fields as required:
Field
Parent Node
Level
Value
[R
[R
Manager
EQUIRED
EQUIRED
]
]
Figure 6-40: Add Hierarchy Level Node Window
Active Node check box
Description
Defaults to the currently selected node.
Select the new level from the drop-down list.
Organization Hierarchy levels must be defined before they can be used in Organization Hierarchy Maintenance. See
“Defining Organization Hierarchy Levels” on page 191 for
more information about setting up Organization Hierarchy levels for your organization.
Enter a value for the new level.
Enter the manager for the new level. This is a "level manager" or an org node manager (e.g. district manager).
The value is stored in the org hierarchy table along with the node info.
Selected by default, indicating the organization hierarchy level is active and available. To deactivate the org node, deselect the Is this node active? check box. Refer to
Deactivate an Org Node” on page 196
for more information.
4. Click Save.
Version 7.1 User Guide
Perform the following steps to edit an organization hierarchy level value and/or manager.
1. Select an org node within the org hierarchy tree.
2. With the node selected, click Edit.
3. Make changes to the level Value and/or Manager as needed.
4. Click Save.
To deactivate the org node, deselect the Is this node active? check box. Refer to “
“To Deactivate an Org Node” on page 196
for more information.
Perform the following steps to add any unassigned stores to the organization hierarchy. This process does not create new stores, it is used to add existing stores to the Organization
Hierarchy tree.
1. Select an org node within the org hierarchy tree.
2. With the node selected, click the add the stores to the currently selected node link to display a list of all unassigned stores.
3. Select the check box for one (or more) stores from the list, then click Add to add the selected stores to the selected org node.
4. The stores are added to the selected org node and the system returns to the
Organization Hierarchy Maintenance page.
Perform the following steps to create a new store and place it within the organization hierarchy. This process is not used to add existing stores to an org hierarchy node.
1. Select the node where the new store will be placed.
2. With the node selected, click the create a new store record link.
3. Complete the required fields in the Store wizard, then click Save.
4. When prompted, click OK to close the “Store created successfully” prompt. A deployment of this record to all stores will now be scheduled.
5. When prompted, click OK to close the “Deployment was scheduled successfully” prompt.
6. The system returns to the Organization Hierarchy Maintenance page. The new store is added to the selected org node.
CHAPTER 6: Data Management Version 7.1
Perform the following steps to deactivate an org node. Deactivated org nodes will not appear in drop-down pick lists throughout Xadmin. Making an org node inactive does not stop the stores within that node from functioning. This inactive setting simply prevents users from making data changes and deployments to the node. For example, this feature may be used when creating new districts or reorganizing the hierarchy. Deactivating an org node ensures that other users cannot make data changes or deployments to the stores that fall within that node.
Perform the following steps to deactivate an org node.
1. Select an org node within the org hierarchy tree.
2. With the node selected, click Edit.
3. Deselect the Is this node active? check box.
4. Click Save.
5. The org node information shows the node is Inactive and the org node is grayed-out in the tree view.
Figure 6-41: Inactive Org Node Example
To activate an inactive org node, select the Is this node active? check box.
Version 7.1 User Guide
Perform the following steps to move org nodes throughout the org hierarchy. For example, this feature can be used if redistricting actions are needed within the organization. This type of movement may be as simple as: Move STORE:101 from DISTRICT:2 to DISTRICT:3, or it may be more complicated and involve multiple moves. In either case, the process is the same.
1. Select an org node (other than the root node) within the org hierarchy tree.
2. With the node selected, click Edit.
3. To change the selected node's parent level, begin typing the node identifier in the Parent
Node field. The suggested parent nodes are displayed in a list.
Figure 6-42: Parent Node Suggestion List
4. Select the new parent level, then click Save.
The previously selected node is now shown under its new parent level.
Perform the following steps to deploy the organization hierarchy data to the stores.
1. Click the deploy the data link.
2. When prompted, click Yes to deploy the organization hierarchy to all stores.
3. Click OK to close the deployment successful window.
CHAPTER 6: Data Management Version 7.1
Use Store Collections to create and maintain groups of organization nodes that represent collections of stores from different places in the organization hierarchy.
Store Collections are user-defined store groups. Once defined and set up, these Store
Collections are made available to be used as target areas for configuration and data changes.
The Store Collections page shows your current Store Collections and the number of stores in each collection. In the example below, two store collections have been defined. If no collections have been defined this page will be blank. Click a column header to sort the column as needed.
Figure 6-43: Store Collections Page
1. At the Store Collections page, click Add New to create a new store collection.
2. Complete the fields as required:
ID - Enter the collection identifier. This field can only be edited when adding a new
Store Collection. A store collection ID must be letters or numbers only and cannot include a colon (:), underscore (_), or comma (,) in the name.
Description - Enter the collection description. This field can be changed when adding a new Store Collection, and when editing an existing Store Collection.
Organization Nodes - Specify the node belonging to this store collection, then click
Add. Repeat this step for each node that is part of this collection.
3. Click Save.
4. Xadmin returns to the Store Collections page.
Version 7.1 User Guide
1. At the Store Collections page, select a Store Collection from the list.
To delete a store collection, at the Store Collections page (Figure 6-
43), select the Delete icon associated with the Store collection.
When prompted, click Yes to confirm the deletion.
2. Complete the fields as required:
ID - This field cannot be changed.
Description - Edit the collection description.
Organization Nodes
To add a node, specify the node belonging to this store collection, then click
Add. Repeat this step for each node to be added to this collection.
To remove a node from the collection, click the Delete link associated with the node.
3. Click Save.
4. Xadmin returns to the Store Collections page.
The end-of-year process is used to post the required rollup data for stock valuation for all items and stores. This closes the item's quantity and value for the specified fiscal year. The consolidated inventory totals are used for the stock valuation (PWAC) reports.
The inv_cst_item_yearend table must be populated with data for the previous year. For new retailers with no previous years’ data, a record must be added for the previous year with quantity zero (0).
Stock Valuation is a process that allows you to track the item stock value for receivables at the store for both corporate-created receiving documents and store-created receiving documents. This inventory valuation allows you to determine a monetary value for items that make up your inventory, and is dependent on a "year-end" process for the company. Stock valuation is based on the fiscal calendar.
All receiving documents must contain the items’ cost to be used to calculate the stock valuation. The cost is the amount charged to the franchisee/store. When merchandise is received from the warehouse, the cost on the ASN/receiving document must be accepted or adjusted by the store in order to receive merchandise into inventory.
CHAPTER 6: Data Management Version 7.1
To access Stock Valuation Year End Roll-up, select Roll-up Stock Valuation from the Data
Management menu.
Perform the following steps to post the required rollup data for stock valuation for all items and stores.
1. Enter the Fiscal year that is being closed.
2. Click Roll-up Data.
The system will perform the following validation checks on the Fiscal Year entered:
Must be less than the current fiscal year.
Cannot be greater than the last consolidated year + 1. (The sequence must be respected; if 2011 has been consolidated, you can only consolidate 2012.)
Cannot be less than the last consolidated year. (If 2012 has been consolidated you cannot select 2010, but you can select 2012.)
If there are no previous consolidations, the system can accept any value less than the current year. (In this case, if there are any documents in the database for the year before the selected year, all documents will be consolidated in the selected year.)
Current year=2014
Documents exist in the database for 2009, 2010, 2011, 2012, and 2013
No consolidations have been done to date
If 2012 is selected as the closing year, the system will prompt to close previous years
(2009, 2010, 2011) first before continuing.
C H A P T E R
Deployment Manager is used to upload files for deployment, create deployment plans for scheduling updates, and track the status of configuration and file deployments.
For additional technical information about Deployments, see Appendix A: “About
.
1. Xenvironment contacts Xcenter at a pre-defined interval, asking for any updates.
2. If updates are available, Xenvironment downloads the files specified by the manifest either immediately or at store close.
3. Xenvironment then applies the files per the instructions in the manifest either immediately or at store close.
CHAPTER 7: Deployment Manager Version 7.1
The File Upload feature provides the ability to upload files from your local PC into Xadmin so the files can be deployed to stores. A deployment is automatically scheduled based on the targeting information in the file header. Xstore software updates, standard DataLoader files
(.dat, .mnt, .reo, .rep), Xstore .cip files, .zip files for JRE/JCE, .tar.gz files, and Xstore debit.txt files are supported for upload. See
below.
The View Deployments feature provides both the ability to view detailed information about a deployment and the ability to cancel a deployment before it has been deployed if it meets the eligibility criteria. The current status of all deployments made from Xadmin can be tracked down to the store level. You can view summary level data for each deployment, down
to the status of delivering and loading each update at each target store. See “Viewing
.
The Deployment Plans feature provides the ability to define phased Deployment Plans (i.e. templates) that can be used to schedule Configurator updates or File Uploads to save time when scheduling roll-outs. See
“Deployment: Using a Deployment Plan” on page 207 .
The Automatic External File Delivery feature provides the ability to have any standard
DataLoader files (.dat, .mnt, .reo, .rep) left by any external system in a file drop directory so the files can be deployed to stores. See
“Automatic External File Delivery” on page 227 .
Only the uploaded files that fall within the current user's org node are shown on the File Upload page. Files must have been uploaded by a user with the same, or lower, org node as the current user.
1. From the Xadmin menu, select Deployment --> File Upload, or click the File Upload link in the Deployment Manager panel.
2. At the File Upload page, click Add File to browse for the file you want to upload.
Figure 7-1: File Upload Page
Only files with the following valid extensions can be uploaded: .cip,
.jar, .mnt, .rep, .reo, .dat, debit.txt (bin file), .tar.gz, and .zip.
Version 7.1
3. When prompted, click Browse to search for the file.
User Guide
4.
[O
PTIONAL
]
Type a description for the file.
5. Click Upload. Uploaded file records are stored in the cfg_upload_record table.
If you try to upload a file that has been previously uploaded, you are prompted that this new upload will overwrite the previous one. Click
Overwrite to overwrite the previous file or Cancel to return to the File
Upload page without uploading the file.
6. At the Upload Successful progress bar, choose whether to deploy the file now or deploy the file later:
Figure 7-2: Upload Successful Progress Bar
Click No to return to the File Upload page without deploying the file.
7. Perform actions as needed:
To upload additional files, repeat steps 2 through 6.
To deploy an uploaded file, see “File Upload: Deploying a File or Files” on page 204
.
To remove a file from the Upload File list, see
“File Upload: Removing an Uploaded
File From the List” on page 204
.
CHAPTER 7: Deployment Manager Version 7.1
Follow the instructions in this section if you need to remove an uploaded file from the list.
1. At the File Upload page ( Figure 7-1 on page 202
), click the delete icon to remove the selected file from the list.
2. At the confirmation prompt, click Yes to remove the selected file.
Follow the instructions in this section to deploy a file or multiple files.
1. At the File Upload page, select the file, or files, you want to deploy.
Figure 7-3: File Upload Page - File Selected
2. Click Deploy.
3. At the Schedule Deployment page, select a deployment option:
Figure 7-4: Schedule Deployment Page
Schedule a Planned Deployment - Select this option to use a pre-defined Deployment
Plan to roll out the updates in waves. Skip to “Deployment: Using a Deployment Plan” on page 207 .
This option assumes at least one Deployment Plan has been defined.
See
“Creating a Deployment Plan” on page 209
for more information about setting up a Deployment Plan.
Schedule a Single Deployment - Select this option for a one-time rollout to a single
organization node and date. Continue with Deployment: Using a Single Deployment
.
Version 7.1 User Guide
If you selected Schedule a Single Deployment in
, the Single
Deployment section of the screen expands to show the required fields.
Figure 7-5: Single Deployment Fields
4. Complete the following fields, then click Next. All fields are required.
Field Description
Deployment Name
This field defaults to the file name and date it was uploaded.
Accept this default or enter a name to identify this deployment.
Organization Node
Target Date
Download Priority
Select the organization target for the configuration changes.
Select the date the changes will be sent to the store.
Select the download priority to be specified in the manifest:
Immediate - Download the files now.
Store Close - Download the files at end-of-day.
CHAPTER 7: Deployment Manager
5. Review the deployment information:
Version 7.1
Figure 7-6: Single Wave: Review Deployment Schedule
For Single Deployments, the Wave Name defaults to Default Wave and the Launch Type defaults to Automatic. These values cannot be changed.
The following Wave information is shown on the Review Deployment Schedule page:
Field Description
Wave #
Name
The wave identifier.
For Single Deployments, the Wave Name defaults to Default
Date
Launch Type
Organization Nodes
# of Stores
The date the changes will be sent to the store.
The launch type, defaults to Automatic.
The targeted org node or nodes.
The number of stores affected by this single deployment.
If all information is correct, go to step 6 below.
If you need to change the launch date, select the wave and enter the new date at the Edit Wave window, then click OK.
If you need to make any other changes, click the Schedule Deployment breadcrumb to return to the previous page where you can edit the information. Go
6. Click Deploy.
7. When prompted, click Yes to confirm you want to schedule the deployment.
8. Click OK to close the Deployment Scheduler status bar window.
The deployment file is placed in the root directory of Apache Server with a file name of
{org}_{deployment id}_!!_{filename} and a record is written to the dpl_deployment table.
See “Viewing Deployments” on page 216
for more information about the deployed file.
Version 7.1 User Guide
Templates, known as "Deployment Plans", can be set up in advance and then reused whenever needed. These Deployment Plans are used to distribute changes to stores for configuration and file uploads. See
“Creating a Deployment Plan” on page 209
.
If you selected Schedule a Planned Deployment in
“File Upload: Deploying a File or Files” on page 204
, the Deployment Plan section of the screen expands to show the required fields.
Figure 7-7: Planned Deployment Fields
1. Complete the following fields.
Field Description
Deployment Name
This field defaults to the file name and date it was uploaded.
Accept this default or enter a name to identify this deployment.
Deployment Plan
Target Date
Select the deployment plan from the list.
Select the date the changes will be sent to the store.
2. Click Next.
All deployments using a Plan will start at Store Close.
CHAPTER 7: Deployment Manager Version 7.1
3. Review the deployment schedule and Email Notification list, then click Deploy.
Figure 7-8: Review Deployment Schedule Page
If you are not ready to deploy, use the breadcrumbs at the top of the page to navigate to a previous page.
4. When prompted, click Yes to confirm you want to schedule the deployment.
5. Click OK to close the Deployment Scheduler status bar window.
Figure 7-9: Deployment Scheduler Status Bar Window
“Viewing Deployments” on page 216 for more information about tracking the
current status of all deployments.
Version 7.1 User Guide
Use a Deployment Plan to roll out updates on a pre-defined schedule when setting up a
Configurator or File Upload deployment. Scheduled roll-outs are created by defining phased plans (i.e. templates) containing Waves. The plans created here will be available when you
schedule a deployment. See “Deployment: Using a Deployment Plan” on page 207
.
1. From the Xadmin menu, select Deployment --> Deployment Plans, or click the
Deployment Plans link in the Deployment Manager panel.
2. At the Deployment Plans page, click Add New to create a new Deployment Plan.
Figure 7-10: Deployment Plans Page
3. At the Create Deployment Plan page, complete the fields as required to identify this plan and to define the scope:
Field
Plan Name
Description
Security Scope
Figure 7-11: Create Deployment Plan Page
Description
Enter a name for the plan, up to 60 characters.
Enter a description for the plan, up to 255 characters. This name can be changed after the plan has been created and saved.
Select the target level (store or org node) for this plan. This value defaults to the highest level of the logged-on user. If a user has more than one hierarchy node assigned, there is no default.
CHAPTER 7: Deployment Manager Version 7.1
Field
Email Notifications
Description
Review/edit the email addresses for emails to be sent for
Wave Approval reminders and Wave Approval waiting
notifications. See “Email Notifications” on page 214
for more information about this feature.
4. Click Add New (
) to define the Waves for this plan at the Create
Wave page:
Figure 7-12: Create Wave Page
To be valid, a Deployment Plan must have a minimum of one Wave.
You can add any number of Waves to the Deployment Plan.
For global scope only, you can select the All Remaining Stores check box to quickly add all stores in the node that have not been included in any previous waves. This can be used to make sure there are no missing stores in the Deployment Plan.
Field
Wave Name
Launch
(day(s) after previous wave)
Description
Enter the Wave name or accept the default name.
By default, each Wave is numbered automatically to track the number of waves in the plan. You can append additional text to the wave number (for example, Wave 1: Reg1) or change the text (for example, First Wave - Reg1), up to 60 characters.
For Wave 1, this will default to NA since the first wave is the baseline date used to calculate all subsequent days.
For Waves 2 and above, enter the interval between waves, up to 4 digits maximum.
Note: Zero (0) is a valid entry for the number of days after the previous wave. This allows multiple waves to start on the same day, possibly with different launch types.
Version 7.1 User Guide
Field
Launch Type
Description
Approval Required
[D
EFAULT
]
- User approval is needed before the Wave launches.
Automatic - The Wave launches automatically on the set number of days after the previous wave completes.
5. To specify which stores/nodes this Wave should deploy to:
a. Click Add Organization Nodes.
b. Expand the org hierarchy node tree as needed to select the stores/nodes for this
Wave.
Figure 7-13: Org Hierarchy Node Tree
The nodes returned in this list are filtered based on the Scope you selected for the Plan. Store collections are not included in this list.
c.
Click OK.
The selected store/node is listed on the Create Wave page along with a Delete link.
If needed, you can click Delete to remove the store/node from the Wave.
Figure 7-14: Wave 1 - First Store/Node Added Example
6.
[O
PTIONAL
]
Repeat step 5 to add additional stores/nodes to this Wave.
7. After adding all stores/nodes to this Wave, click Save Wave. The Wave is added to the
Deployment Plan and you are returned to the Create Deployment Plan page.
CHAPTER 7: Deployment Manager Version 7.1
Notes: About Wave Validation
• The same node cannot be selected in multiple Waves (for example,
District 1 in Wave 1 and District 1 in
Wave 2). If you try to add an org node in multiple Waves, this message displays. Click OK to close the message box and then click Delete to remove the duplicate Organization Node from the
Wave.
• Overlap within a Wave or between
Waves is not allowed. If you try to add overlapping stores/nodes between two waves, this message displays. Click Yes to continue. Click No to return to the Create Wave page and then click Delete to remove the duplicate store from the Wave.
8.
[O
PTIONAL
]
To create additional Waves for the Deployment Plan, return to
step 4 on page 210 . Repeat as often as needed.
The next wave defaults to the next higher number, for example, Wave 2 follows
Wave 1.
Enter the number of days this wave should be launched after the previous wave. For example, schedule Wave 2 to launch 7 days after Wave 1 is launched, and schedule
Wave 3 to launch 5 days after Wave 2 is launched, and so on.
Select the launch type, Approval Required or Automatic.
9. When all Waves have been added to the Deployment Plan, click Save Plan to save all plan changes and return to the Deployment Plans page.
Notes: About Deployment Plan Validation
• If the Deployment Plan does not cover all stores within the selected scope, this message displays. Click
Yes to save the plan even though not all stores in the selected scope are included. Click No to return to the Create
Deployment Plan where you can make changes as needed.
Version 7.1
10. The Deployment Plans page displays information about each plan.
User Guide
Header
Plan ID
Plan Name
Security Scope
# of Waves
Created On
Description
Delete Icon
Figure 7-15: Deployment Plans Page
Description
The auto-generated plan Identifier.
The name of the plan.
The target level (store or org node) for this plan.
The number of waves in the Deployment Plan.
The date the plan was created.
The plan description.
See Deleting a Deployment Plan and Waves below.
1. From the Xadmin menu, select Deployment --> Deployment Plans, or click the
Deployment Plans link in the Deployment Manager panel.
2. At the Deployment Plans page (Figure 7-15), click the Delete icon to delete a Plan.
3. When prompted, click Yes to delete the selected plan and all of its waves.
1. From the Xadmin menu, select Deployment --> Deployment Plans, or click the
Deployment Plans link in the Deployment Manager panel.
2. At the Deployment Plans page (Figure 7-15), select a Deployment Plan from the list of
plans.
3. With the Waves page displayed, click the Delete icon to delete a selected Wave.
4. When prompted, click Yes to delete the selected wave.
CHAPTER 7: Deployment Manager Version 7.1
Editing a Deployment Wave and Plan is similar to the process used to create a new
Deployment Wave and Plan.
See “Creating a Deployment Plan” on page 209 for more information about the fields on the
Create Deployment Plan and Create Wave page.
1. From the Xadmin menu, select Deployment --> Deployment Plans, or click the
Deployment Plans link in the Deployment Manager panel.
2. At the Deployment Plans page, select a plan from the list.
3. Edit the Wave information as needed:
a. Select a Wave from the list and edit the fields as needed.
b. To add a Wave, select Add New to add a new Wave to the Plan.
If all stores are covered in this plan, the Add New option will not be available.
c.
Click Save Wave to save your changes.
4. If needed, edit the Plan information.
5. Click Save Plan to save all plan changes and return to the Deployment Plans page.
Set up an email notification list for emails to be sent for Wave Approval reminders and Wave
Approval waiting notifications. The Approval Needed email notification will be sent out a configurable number of days before the projected launch date of a wave that is launch type
"Approval Required".
The number of days is set up in Xadmin Configuration (Number of Days Before Deployment
Wave to Send Notification). See
“Xadmin Configuration Options” on page 28
.
A Wave On Hold email notification will be sent out when the projected launch date has passed and a wave is still waiting to be approved.
The email includes a link that will direct the recipient to the Deployment Summary page for the deployment that needs approval. See
“Approval Needed Email Notification Example” on page 215
for a sample email message.
Perform the following steps to add and remove users from the Email Notification list of a
Deployment Plan.
1. From the Xadmin menu, select Deployment --> Deployment Plans, or click the
Deployment Plans link in the Deployment Manager panel.
2. At the Deployment Plans page, click Add New to create a new Deployment Plan or select a Deployment Plan from the list.
3. At the Create Deployment Plan page ( Figure 7-11 on page 209
), click the Email
Notifications Edit link.
Version 7.1 User Guide
4. At the Email Notifications page, add or remove email information as needed:
Figure 7-16: Email Notifications Page
Email addresses listed in the search results are set up in
System-->Xadmin Users-->Users and Security Access. See “Admin
Users - Using Roles to Grant Access to Xadmin” on page 17
for more information.
To add a new user email to the Deployment Plan:
1) Enter search information (ID, Name or Email) in the Search field to find the user’s email.
2) Select the email from the list, then click Add.
To remove a user email from the Deployment Plan, click the Delete icon ( ) associated with the email you want to remove.
5. Click Save.
6. Click Save Plan to save changes to the plan.
Approval Needed Email Notification Example
CHAPTER 7: Deployment Manager Version 7.1
The current status of all deployments made from Xadmin can be tracked down to the store level. A drill-down style interface is provided to view summary level data for each deployment, down to the status of delivering and loading each update at each target store.
1. From the Xadmin menu, select Deployment --> View Deployments, or click the View
Deployments link in the Deployment Manager panel.
2. At the Deployments page, enter criteria for the Deployment you are searching for and then click Search.
To return a list of all deployments, leave the fields blank and click
Search.
To view additional deployments, select a date range from the View More
Deployments drop-down list.
The Deployments page shows the summary list of deployments. By default, this list is sorted with the latest deployment shown at the top. Click on a field heading ( ) to re-sort the list as needed.
Figure 7-17: Deployments Page - Search Results
Deployment information is stored in the dpl_deployment database table.
The “v.x” designation in the deployment name indicates the config version for this set of configurations.
Deployment ID - The auto-assigned deployment identifier.
Name - The deployment name.
Type - The deployment type; Configurator, Data Manager, File Upload, or Auto
Deploy.
Version 7.1 User Guide
Plan - The deployment plan name.
Launch Date - The deployment launch date.
Waves Complete - The number of waves completed compared to the total number scheduled.
Status - The deployment status; Approval Required, Complete, In Process,
Cancelled, Scheduled, Error
3. Select a row in the Deployments page summary list (Figure 7-17) to view additional
information about the selected deployment.
4. The Deployment Summary page displays and shows the current status of the selected deployment as reported by all of the stores via Xenvironment.
Figure 7-18: Deployment Summary Page - Approval Required Example
The information shown here is a collection of aggregate counts for all of the possible deployment statuses; such as the number of stores that have downloaded the manifest, the number of stores that have downloaded the deployment's files (successfully or in error), and the number of stores that have applied the deployment's files (successfully or in error). If needed, click Refresh at any time to update the page and see current changes.
Perform the following functions as needed:
Approve Waves - If approval is required before a Wave can begin, an authorized user must review and approve the Wave. See
“To Approve a Wave” on page 223
.
View store details - This page also provides a link to a per-store list of status data
(View Details By Store). See
“To View Detail By Store” on page 220 for more
information.
CHAPTER 7: Deployment Manager Version 7.1
Stop or cancel a deployment
A Stop Deployment button on this page is available once the deployment is under way or as soon as the first wave's date is today. Stop Deployment will cancel the deployment before the next wave begins. See
“To Stop a Deployment” on page 225
.
A Cancel Deployment button on this page is only available if you are viewing a deployment before the deployment has started. Once the deployment is under way it cannot be cancelled. See
“To Cancel a Deployment” on page 226
for more information about cancelling a deployment.
Purge Files - If applicable, a Purge Files link is available to delete the files. See
Field
Deployment Plan
Status
Stores Targeted
Manifests Downloaded
Security Scope
Create Date
Create User Id
Cancel Date
Cancel User Id
View Details By Store link
Comments
The name of the plan that used in this deployment, It will contain "Single Wave" if the Single Wave option was selected.
The deployment status: Error, Complete, In process,
Approval Required, Scheduled, Cancelled
The total number of stores targeted in all waves.
The number of stores that have downloaded the manifest.
There will be one manifest per store.
The hierarchy node level of the deployment.
The date the deployment was created.
The user who created this deployment.
The date the deployment was cancelled. This field is only displayed if the deployment was stopped or cancelled. See
“To Cancel a Deployment” on page 226
and
.
The user who cancelled the deployment. This field is only displayed if the deployment was stopped or cancelled. See
“To Cancel a Deployment” on page 226
and
.
Opens a window showing a per-store list of status data.
See
“To View Detail By Store” on page 220
.
Version 7.1 User Guide
Files Downloaded
File Status Code
Not Reported
Incomplete
Comments
No status available yet.
Only occurs if multiple files are downloaded and the files currently have different statuses during the download process.
File download errors.
File download successful.
Error
Success
Files Applied
File Status Code
Not Reported
Incomplete
Error
Success
Comments
No status available yet.
Only occurs if multiple files are downloaded and the files currently have different statuses during the application process.
File application process has errors.
Files applied successfully.
File Category
Config
File Type
configurator.zip
Comments
The zip file contains the manifest and configuration information.
Compressed data datamanager.zip
Data
The zip file contains the manifest and data manager information.
.mnt, .reo, .dat, .rep
The standard Dataloader files.
App update
updater.jar
debit.txt
CIP
JRE/JCE
debit.txt
.cip
The executable jar file contains software update information.
The debit bin file containing BIN range values for authorized card tenders.
Contains cipher keys information.
Purge Files link
XST-jre-windows.zip
XST-jce-windows.zip
Contains the JRE/JCE file types
See
.
CHAPTER 7: Deployment Manager Version 7.1
Field
Wave #
Name
Date
Launch Type
Approved?
# Stores Complete
Show Stores link
Comments
The Wave number.
The Wave name.
The launch date.
The launch type; Approval Required or Automatic.
For Automatic launch type, this does not apply. For
Approval Required launch type, indicates whether or not
the wave has been approved. See “To Approve a Wave” on page 223
for more information about approving a wave.
The number of complete stores.
Click the icon to view detailed information about the files downloaded and files applied to the targeted stores for the Wave.
The Detail by Store page is accessed from the Deployment Summary page and displays a per-store list of status data.
1. To view store details, click the View Details By Store link in the Deployment Summary
page ( Figure 7-18 on page 217
).
By default, the initial page filter is set to show any errors.
Use the filter selections to filter the records based on the status code values. If a value of 0 (zero) is associated with a status, the option to enable or disable it is not available since there are no records to filter.
Figure 7-19: Detail by Store Page - Targeted Store Detail - Not Reported and Success Filters
Version 7.1 User Guide
These status codes show each individual store's deployment statuses and are an aggregation of all the statuses across all the files defined in the deployment.
Manifest Downloaded - If the manifest was downloaded, the date and time will be shown in this column. If the manifest has not been downloaded, this column will show Not Reported.
Files Downloaded - If the file(s) were downloaded successfully, Success will be shown in this column. If the file(s) were downloaded with an error, Error will be shown in this column. If the file(s) have not been downloaded, Not Reported will be shown in this column. If multiple files are currently being downloaded and the files have different statuses at this moment, Incomplete will be shown in this column.
Files Applied - If the file(s) were applied successfully, Success will be shown in this column. If the file(s) were applied with an error, Error will be shown in this column. If the file(s) have not been applied, Not Reported will be shown in this column. If multiple files are currently being applied and the files have different statuses at this moment, Incomplete will be shown in this column.
2. Use the filters to view data as needed.
CHAPTER 7: Deployment Manager Version 7.1
3. Select a row in the list to view additional information about a specific store.
Figure 7-20: Store Detail Window
If an error is reported, detailed information about the error is provided in the Details section of the Store Detail window as shown below.
4. If needed, use the arrows to view detail for other stores in the list.
5. Click to close the window and return to the Detail by Store page.
Version 7.1 User Guide
For Approval Required waves, perform the following steps to approve a wave.
1. At the Deployment Summary page ( Figure 7-18 on page 217 ), select the row of the
Wave that needs to be approved.
2. At the Wave Approval window, click the Approve link to change the approval status to approved.
Figure 7-21: Wave Approval Window
3. Click Save. The Wave Approval Window closes and the system returns to the
Deployment Summary page where the Wave now shows it has been approved.
You cannot unapprove a Wave if the wave has started, for example, if the target date is today’s date. Only a wave that has not started yet can be unapproved.
1. At the Deployment Summary page ( Figure 7-18 on page 217 ), select the row of the
Wave that needs to be unapproved.
2. At the Wave Approval window, click the Unapprove link to change the approval status to unapproved.
Figure 7-22: Wave Approval Window
3. Click Save. The Wave Approval Window closes and the system returns to the
Deployment Summary page where the Wave now shows it has not been approved.
Once a wave has been unapproved, the date can be changed and then the wave can be approved again.
CHAPTER 7: Deployment Manager Version 7.1
Use this option to purge old deployment files from the Apache Server. This option is only available for Deployments that have a status of Complete or Cancelled.
1. At the Deployment Summary page, click the Purge Files link.
Figure 7-23: Deployment Summary Page - Purge Files Link
2. When prompted, click Yes to confirm you want to delete the files from Apache Server.
3. Click OK to close the Successful Purge window and the Purge Status is updated to
Success.
At the Deployments page, the status indicates the deployment file has been purged.
Figure 7-24: Deployments Page - Search Results - Purged Status Example
Version 7.1 User Guide
Follow the instructions in this section if you need to stop a deployment that is under way. The
Stop Deployment process will cancel the deployment before the next wave begins.
There is no way to determine where within a wave (e.g. which store it's on) the deployment will be stopped. Once the Stop Deployment button is selected, the wave is stopped immediately and the remaining stores will not be updated.
Once a deployment has been stopped it cannot be restarted. It must be re-created to run again.
1. From the Xadmin menu, select Deployment --> View Deployments or click the View
Deployments link in the Deployment Manager panel.
2. At the Deployments page select the deployment you want to stop from the summary list of deployments.
3. At the Deployment Summary page, click Stop Deployment.
Figure 7-25: Deployment Summary Page
4. When prompted, select Yes to stop the deployment, and click OK when prompted to acknowledge the deployment has been stopped.
If you decide not to stop the deployment by clicking No, you are returned to the
Deployment Summary page without making any changes.
CHAPTER 7: Deployment Manager
Version 7.1
Once a deployment has been cancelled it cannot be restarted. It must be re-created to run again.
Follow the instructions in this section if you need to cancel a deployment. You can only cancel a deployment if no manifests have been downloaded, and all statuses are unreported.
1. From the Xadmin menu, select Deployment --> View Deployments or click the View
Deployments link in the Deployment Manager panel.
2. At the Deployments page select the deployment you want to cancel from the summary list of deployments.
3. At the Deployment Summary page, click Cancel Deployment.
Figure 7-26: Deployment Summary Page - Cancel Deployment Example
The Cancel Deployment button will only be available if no manifests have been downloaded and all statuses are unreported for the deployment. Once the Deployment is under way, a "Stop Deployment" button will be available here. The Stop Deployment option cancels the deployment before the next wave begins.
4. When prompted, select Yes to cancel the deployment, and click OK when prompted to acknowledge the deployment has been cancelled.
Figure 7-27: Cancel Deployment Prompt
Version 7.1 User Guide
If you decide not to cancel the deployment by clicking No, you are returned to the
Deployment Summary page without making any changes.
5. The date the deployment was cancelled and the user who cancelled the deployment are shown on the Deployment Summary page.
Figure 7-28: Deployment Summary Page - Cancelled Deployment
The Automatic External File Delivery feature provides the ability to have any standard
DataLoader files (.dat, .mnt, .reo, .rep) left by any external system in a file drop directory so the files can be deployed to stores.
Xadmin monitors a specific directory for files. This directory is configured in
System-->Xadmin Settings -->Directory for Automatically Deployed Data Files
(AutoFileTransferDirectory).
The interval at which the directory is checked is also configured in System-->Xadmin
Settings-->Detection Interval for Automatically Deployed Data Files
(AutoFileTransferSchedulerInterval). See
“Xadmin Configuration Options” on page 28
.
Any files placed in the auto directory, in the appropriate org directory, (/filetransfer/ auto/org${organizationId}/) will be picked up and a deployment will be created for that file. No user intervention is required to move the files to the stores.
The order in which files are consumed by Xadmin is not guaranteed. If a specific ordering of records across multiple files is required, MICROS recommends that those files be combined in a single file, in the appropriate order, before dropping them off in this directory.
Each file must contain an XML header line that will dictate when and where the file is delivered.
<Header line_count="3" download_id="configurator::7::72::0" application_date="2013-05-26" target_org_node="STORE:102" deployment_name="specified_name" download_time="IMMEDIATE" apply_immediately="true" />
CHAPTER 7: Deployment Manager Version 7.1
Line Count [optional]
The line_count attribute is used to indicate how many lines of data are in the file (not including the header). If it is not present, the DataLoader will not validate total line count when loading the file, but will still load the file.
Download Id
The download_id attribute is used to identify the download.
Application Date
The application_date attribute is used to determine the date on which the file will be deployed. If the application date attribute is not present, the date that the file is picked up will be used which means the file will be deployed on the same day.
Target Org Node
The target_org_node attribute is used to determine to what org node or store collection the file will be deployed. Its format is <org code>:<org value> (e.g. STORE:102) or
<CollectionName> (e.g. My Collection). If the target org node attribute is not present,
*:* will be used which means the file will be delivered to all stores in the organization.
Deployment Name
If the deployment_name field is populated, the value will be used as the name for the deployment, otherwise the auto-suggestion name will be used.
Download Time
The download_time attribute is used to indicate when the file will be downloaded. Possible values are "IMMEDIATE" and "STORE_CLOSE".
If a deployment is scheduled for immediate download, Xenvironment will begin to download the file immediately. If a deployment is scheduled for download during the store close,
Xenvironment will wait until the nightly closing process is initiated to begin downloading the file.
If download_time is not present, the deployment will be scheduled with "STORE_CLOSE".
Apply Immediately
The apply_immediately attribute is used to indicate when the file will be applied. Possible values are true and false. If set to true, the file is loaded immediately. If set to false, the file is scheduled to be applied during the closing process.
If "apply_immediately" is not present, the deployment will be scheduled with "false".
See Appendix A: “About Deployments” on page 265
for more information.
C H A P T E R
The Electronic Journal component is used to view transactional data from the Xcenter database in a receipt format. The Xadmin Electronic Journal is similar to the Xstore POS
Electronic Journal, and provides the ability to search for and review transactional activity within your store hierarchy. This application runs against the Xcenter database and provides visibility for transactions across all stores.
The search capabilities allow you to quickly locate any transaction across the chain. You can view the detail in a receipt format that mirrors the receipt generated at the store, including the customer's signature (if captured). This feature is commonly used for credit dispute
(chargeback) resolution, as well as loss prevention investigation.
This chapter contains instructions on starting the Electronic Journal function and searching for transaction data.
1. From the Xadmin menu, select Journal --> Electronic Journal, or click the Electronic
Journal link in the Reports panel.
The Electronic Journal page displays, showing the search parameters.
2. Enter your search criteria to limit the amount of data returned.
The following search parameters are available:
Org Node - Enter a node ID or click the icon to select a node from the hierarchy tree to restrict the search to a store (or stores) in the organization. [
R
EQUIRED
]
Register # - Enter the identifier for a specific register or leave blank for all registers.
CHAPTER 8: Electronic Journal Version 7.1
Customer Number - Enter a customer’s ID number to view information about a specific customer, or leave blank for all customers.
Customer Last Name - Enter a customer’s last name to search for and view information about a specific customer, or leave blank for all customers.
Credit Card Last 4 # - Enter the last 4 digits of the credit card.
Entry is restricted to only 4 digits.
Tender Type - Select a tender from the list to search for a specific type of tender, or accept the default value <ALL> to view information for all tenders.
Transaction Type - Select the type of transaction from the drop-down list; the default is Retail Sale. The value <ALL> allows you to search for all transaction types.
Business Date - Enter a start date and end date, accept the default, or click the calendar icon to choose the dates. The default is the previous 30 days.
Transaction ID - Enter a transaction identifier for a specific transaction, a range of transactions, or leave these fields blank to view information for all transactions. Enter the same transaction number in both fields to locate a specific transaction number.
Cashier ID - Enter the identifier for the ringing associate’s ID, a range of ringing associate IDs, or leave blank for all associates.
3. Click the Search button to execute the search:
The information returned from the search shows the store ID, register ID, transaction ID, transaction type, transaction status, cashier ID, business date, customer name, and transaction total.
The first 200 results are displayed on the page. If the desired result is not listed, click Electronic Journal in the breadcrumb at the top of the page to return to the search parameters. Refine the search criteria and search again.
A sorting component is available for a column, when applicable.
If a single transaction matches the search criteria, only one row is returned.
4. Click a transaction in the list to view additional information.
Figure 8-1: Electronic Journal Viewer Page - Transaction List
Version 7.1 User Guide
5. If multiple receipt types exist for this transaction, select a receipt from the list:
Figure 8-2: Receipt Type List
The selected receipt image displays.
Figure 8-3: Transaction Receipt Data
CHAPTER 8: Electronic Journal Version 7.1
6. When the receipt image displays you have the following options:
Click the Print button to print a copy of this receipt.
Select a different receipt type from the list (Figure 8-2) to view a different receipt
from this transaction.
Click the breadcrumbs to navigate to a previous page:
To return to the transaction list for this location, click the location breadcrumb (STORE:101 in this example).
To return to the Ejournal search parameters, click the Electronic Journal breadcrumb.
To return to the Home page, click the Home breadcrumb.
C H A P T E R
The Reports component is used to run and view Xstore reports against the Xcenter (central) database.
Xadmin Reports provides a wide variety of reports to help you monitor and analyze a store's operations and sales. The reports are grouped by functionality, similar to their configuration in base Xstore POS reporting.
This chapter contains the following sections:
For information on starting the Reports function, see “Accessing and Running Xadmin
.
For a list of reports, see “Available Reports By Category” on page 236 .
A system configuration allows you to turn off and on any of the valid file format types available to be used when viewing/saving reports. You can also select the default format to be selected from the list of enabled file formats.
For instructions on specifying the report formats to be available to the user, see
,
“Reports Category” on page 31 .
CHAPTER 9: Reports Version 7.1
Only reports the user has privileges to access (based on the user’s role) will be available.
1. From the Xadmin menu select Reports -->Reporting category option (Flash Sales
Summary or All Reports), or from the Reports panel, click the Flash Sales Summary link or the Daily Sales & Cash Report link.
If you selected the All Reports link, use the report tree structure to select the
specific report, then continue with step 2 below.
If you selected the Flash Sales Summary link or the Daily Sales & Cash Report link,
the specific report parameters page displays. Continue with step 2 below.
If you selected the Electronic Journal link in the Reports panel, refer to Chapter 8,
“Electronic Journal” on page 229
for more information.
2. Enter the report parameters to be used to run the report.
The report parameters are the same options that are available when running the identical report within Xstore POS, and are specific to each report.
Refer to the Xstore Reports Guide for detailed information about the standard reports available in Xadmin.
3. In addition to the reporting parameters, specify an output type:
The output types available here are configured in Xadmin Settings. See
,
.
PDF - Portable Document Format
HTML - HyperText Markup Language (The predominant markup language for web
pages.)
CSV - Comma Separated Values (A common import and export format for
spreadsheet layout).
XLS - MS Excel
XLSX - MS Excel 2007 or newer
PPTX - MS PowerPoint
RTF - Rich Text Format
DOCX - MS Word
Version 7.1 User Guide
XLSX, PPTX, and DOCX output types may not open properly in FireFox.
The work-around for this is as follows:
1. Right-click on the "Click To Download Report" link.
2. Select “save as...” and save the report to the local file system.
3. Open the report outside of the browser.
4. Click Run Report to create the report. The report will be displayed in the format you selected, or you may need to click the Download link ( ) when applicable.
Report Example
Figure 9-1: Daily Sales Report Example - PDF Format
5. To close the report, click the on the tab.
6. To return to the report parameters, click the Reports tab.
CHAPTER 9: Reports Version 7.1
The following reports are available in base Xadmin. Refer to the Xstore Reports Guide for detailed information about these reports.
Flash Sales Reports Category
Flash Sales Summary
Flash Sales By Department
Flash Sales By Hour
Flash Sales By Employee
Sales Reports Category
Daily Sales & Cash Report
Sales By Hour Report
Sales By Hour Analysis Report
Sales By Department Report
Sales By Department and Employee Report
Returned Merchandise Report
Daily Sales Report
Best Sellers By Style Report
Best Sellers By Item Report
Worst Sellers By Style Report
Worst Sellers By Item Report
Credit Card Report
Daily Sales Total Report
Stock Valuation Reports
WAC Reports
WAC Stock Valuation Report
WAC Detail Report
PWAC Reports
PWAC Stock Valuation Report
PWAC Detail Report
Airport Reports
Airport Authority Report
Inventory Reports Category
Shipping Exception Report
Receiving Exception Report
Inventory Stock Cost
Receiving Report
Employee Schedule Reports Category
Employee Performance Report
Customer Account Reports Category
Layaway Aging Summary Report
Layaway Aging Detail Report
Layaway Account Activity Summary
Report
Layaway Account Activity Detail
Report
Customer Account Activity Summary
Report
Misc Reports Category
Journal Report
Store Locations Report
Customer List Report
Special Orders Report
Price Change Report
Item List Report
Employee Tasks Report
Version 7.1
Transaction Audit Reports
No Sale Report
Price Override Report
Line Void Report
Post Void Summary Report
Post Void Detail Report
Suspended Transaction Detail Report
Suspended Transaction Summary Report
Transaction Cancel Detail Report
Transaction Cancel Summary Report
Gift Certificate Report
Tax Exemption Report
User Guide
CHAPTER 9: Reports Version 7.1
C H A P T E R
The Support Tools component allows you to view issues taking place at the store level, and to set up email alerts to be sent to the appropriate personnel when any issues occur.
The Alert Console shows logged events for replication errors, connectivity errors, application errors, hardware errors, update errors, and version errors. Using Alert Settings it is also possible to customize the alert severity threshold level values for your organization, providing the ability to set your organization's tolerance levels for the various alert events.
The Deployed Xstore Versions support tool allows you to view the Xstore versions deployed throughout your organization, in a pie chart view. You can quickly see the number of stores running each version of Xstore, and to get additional store-level information.
The Publish PosLog Data support tool provides the ability to compile the PosLog data from within Xcenter and save it as a file to a specified location, or to rebroadcast the PosLog data to specified broadcasters in order to post to a 3 rd
party system (Relate, Serenade, XBR, etc.) through platform independent technologies such as Web services. This allows you to manage this information centrally, without having to connect remotely to stores.
The Replication Status support tool provides the ability to view and act on replication errors. Replication is the process used to copy and distribute data from one database to another, and to synchronize between the databases to maintain consistency.
CHAPTER 10: Support Tools Version 7.1
The Alert Console feature allows corporate users to view an Alerts console showing logged events for replication errors, connectivity errors, application errors, hardware
errors, update errors, and version errors. See “Alert Console” on page 241 .
- describes the logged events for replication errors.
- describes the logged events for connectivity errors.
- describes the logged events for application errors.
“Hardware” on page 247 - describes the logged events for hardware errors.
- describes the logged events for update errors.
“Versioning” on page 249 - describes the logged events for version errors.
The Alert Settings feature provides the ability to set up an email notification list to be used when critical alerts occur, and provides the ability to modify and customize the alert severity threshold values for your organization. For information about the Alert Settings
feature, see “Alert Settings” on page 250
.
The Deployed Xstore Versions feature shows Xstore version information by store in a
pie chart format. For information about the Deployed Xstore Versions, see “Deployed
Xstore Versions” on page 256 .
The Publish PosLog Data feature provides the ability to publish transaction and related files from Xcenter as an alternative to polling existing files from the store. For information about publishing a PosLog, see
“PosLog Publisher” on page 258 .
The Replication Status feature provides the ability to view and act on replication errors reported here. For information about the Replication Status feature, see
.
Version 7.1 User Guide
The Alert Console feature allows corporate users to view an Alert page showing logged events for replication errors, connectivity errors, application errors, hardware errors, update errors, and version errors.
If you set up email alerts (see
“To Set Up Critical Alert Email Recipient Addresses” on page 252
), an email with critical alerts details will be sent to the designated recipients. To define severity-level thresholds, see
“Alert Threshold Settings” on page 253
.
You must have the Alert Console privilege to use this feature.
1. From the Xadmin menu, select Support Tools --> Alert Console, or click the Alert
Console link in the Support Tools panel.
2. The initial Alert Console page provides summary-level information at a glance about any issues at the stores in your organization requiring your attention.
The system defaults to the current date and shows the date and time the Alerts Console was last updated.
Figure 10-1: Alert Console Page - Business Date Field
To review alerts from previous dates,
enter the date in the Date field, select a date from the calendar,
or use the Previous Day and Next Day options .
CHAPTER 10: Support Tools Version 7.1
A background process is responsible for reviewing events published to Xcenter and determining whether to create a new alert, or update an existing alert based on currently configured severity thresholds and rules.
If there are any alerts, the console window will show the following information:
, Low .
The severity of the event: Critical , High
The time the event was logged.
The store where the event occurred.
The type of event.
The number (#) of times the event occurred.
, Medium
Figure 10-2: Alert Console (With Alerts)
Version 7.1 User Guide
Click a logged event in the list to view additional details.
The logged events, “Xstore replication queue errors” and
“Xstore replication backlog” and “Xcenter persistence failure” are sourced from Xcenter's rpl_replication_data table.
Figure 10-3: Replication Logged Events Detail
Replication Logged Events
Xcenter persistence failure: A replication request was delivered to Xcenter but could not be persisted to the Xcenter DB. As a result, a record was written to the rpl_replication_data table. Information returned includes replication payload and meta data. (Xcenter)
Xcenter replication crash: These errors are event Log error codes reported by the replication system. (Repl Crash)
Xstore replication queue errors: An error failure occurred during replication. As a result, records are still in the register's replication queue. Information returned includes replication payload and meta data. (RepQ Process)
Xstore replication backlog: There are more than “X” records in the replication queue that have not been tried, indicating a backlog or potential mis-configuration. Information returned includes replication payload and meta data. (RepQ Block)
Xstore replication queue read errors: An error occurred when pulling data from the local replication queue. (RepQ Read)
CHAPTER 10: Support Tools Version 7.1
Click a logged event in the list to view additional details.
The logged events shown here are sourced from Xcenter's ctl_event_log table.
Figure 10-4: Connectivity Logged Events Detail
Connectivity Logged Events
Data source offline: A ping failure or data access error occurred. As a result the data source will not be used. Information returned includes datasource name, scope (WAN/
LAN), and cause. (DB Offline)
Payment system offline: A payment systems host (Xpay) could not be reached.
Information returned includes the message, stack trace, and destination IP/Host. (Xpay
Offline)
Order broker service offline: The order broker host (Locate) could not be reached.
Information returned includes the message, stack trace, and destination IP/Host.
(Locate Offline)
Order broker service error: An error occurred during the order update process.
Information returned includes message and stack trace. (Locate Error)
Service error: An error occurred while calling a web service. Information returned includes message, stack trace, and destination IP/Host. (Service Offline)
Version 7.1 User Guide
Event log servlet error: An error occurred with the servlet Xenvironment uses to report event log errors to Xcenter/Xadmin. (Evtlog Error)
Xenvironment uses this servlet to communicate any problems directly to Xcenter.
Xstore register offline: A register (Xcenter client) has not sent a status update in “X” minutes. Information returned includes Store # and Reg #. (Register Offline)
About Xcenter register offline alert data
Xcenter register offline alert data is sourced from the ctl_event_log table as noted above, and also has a technical relationship to the ctl_device_registration table.
There is a process that runs in Xadmin which periodically observes the ctl_device_registration table. It notices when registers stop "checkingin" within certain configurable time limits. When the process notices a register has failed to check in, it adds a record to Xcenter's ctl_event_log (which then gets reported as an alert just like all the other alerts).
The process that observes ctl_device_registration can be configured as follows:
Interval for Checking for Missing Registers - controls how frequently the process inspects ctl_device_registration for missing registers. Default is 15 (minutes).
Time Before Register Is Considered Missing - how much time must elapse since a device last "checked in" before it is considered missing. Default is 61 (minutes).
Time Before Missing Register Is Ignored - once a device has been missing for the amount of time specified here, it is no longer reported as a problem. Default is 72 (hours, aka 3 days).
See also:
Chapter 3, “System Settings” on page 28 for more
information about Xadmin Configuration.
CHAPTER 10: Support Tools Version 7.1
Click a logged event in the list to view additional details.
The logged events shown here are sourced from Xcenter's ctl_event_log table.
Figure 10-5: Application Logged Events Detail
Application Logged Events
Config path error: A pre-flight error occurred when Xstore tried to get its configpath information from Xcenter. (Cfg-Path)
Pre-flight error: (Data, ciphers, SSL, etc.) A pre-flight error or errors occurred during application startup. All errors are included in this single message. Information returned includes pre-flight error names and descriptions. (Pre-Flight)
SSL expiration check: An SSL certification used for communication with Xcenter or
Xpay is nearing, or has reached, its expiration date. Information returned includes a message. (SSL Cert)
Out of memory error: The JVM ran out of memory, terminating the application.
Information returned includes stack trace. (Crash)
Helpdesk error: An unexpected error (helpdesk error) occurred. Information returned includes stack trace. (Helpdesk)
miStore crash: An unexpected error occurred which caused the miStore application to stop functioning. Information returned includes stack trace. (miStore Crash)
miStore low memory: The miStore application is running low on available memory.
Information returned includes stack trace. (miStore Memory)
Missed Close: A store close was missed. (Missed Closing)
Restart: A mid-day restart was performed. (Restart)
Version 7.1 User Guide
Xenvironment Task: Error message from Xenvironment related to atoms and chains.
(Xenv Task)
Xenvironment Database: Error message from Xenvironment related to database backups/restores. (Xenv DB)
Xenvironment IPC: Error message from Xenvironment for IPC errors with the IPC server. For example, when the SSL certificate is nearing expiration. (Xenv IPC)
Click a logged event in the list to view additional details.
The logged events shown here are sourced from Xcenter's ctl_event_log table.
Figure 10-6: Hardware Logged Events Details
Hardware Logged Events
Hardware device initialization errors: A configured hardware device or devices could not be initialized. Information returned includes device names. (Initialization)
Register disk space: The register's disk is nearing capacity and has less than 10% free. Information returned includes % free remaining. (Low Disk)
JPOS hardware device error: A configured hardware device had a failure. (JPOS
Error)
CHAPTER 10: Support Tools Version 7.1
Click a logged event in the list to view additional details.
The logged events shown here are sourced from Xcenter's ctl_event_log table.
Figure 10-7: Updates Logged Events Details
Updates Logged Events
Update service offline: Cannot reach update service. Information returned includes stack trace. (Update Service)
DataLoader error: A failure occurred while loading a download file. Information returned includes the message. (DataLoader)
Config updates error: A failure occurred while applying updates. (Apply Update)
Xenvironment update error: An error occurred related to Xenvironment updates.
(Xenv Update)
Version 7.1 User Guide
Click a logged event in the list to view additional details.
The logged events shown here are sourced from Xcenter's ctl_event_log table.
Figure 10-8: Versioning Logged Events Details
Versioning Logged Events
In store version conflict for Xstore: A single retail location has multiple versions of the Xstore application running at the same time. Information returned includes versions by register. (Xstore Conflict)
In store version conflict for Xenvironment: A single retail location has multiple versions of Xenvironment running at the same time. Information returned includes versions by register. (Xenv Conflict)
In store version conflict for Xadmin configs: A single retail location has multiple versions of configs running at the same time. Information returned includes versions by register. (Config Conflict)
CHAPTER 10: Support Tools Version 7.1
The Alert Settings feature provides the ability to set up an email notification list to be used when critical alerts occur. Email recipients will receive an email that lists each active alert in which an event has occurred since the last email, without logging into Xadmin.
This feature also provides the ability to modify and customize the alert severity threshold level values for your organization. This provides the ability to set your organization's tolerance levels for the various alert events.
1. From the Xadmin menu, select Support Tools --> Alert Settings.
2. The Alert Settings page has two options: Critical Alert Email Settings and Threshold
Settings.
Figure 10-9: Alert Settings Page
To set up recipients for critical alert emails, see Critical Alert Email Settings below.
To set up alert threshold settings, see “Alert Threshold Settings” on page 253 .
Use this feature to define a list of email addresses to be notified when critical alerts occur.
When set up, an email will automatically be sent to the specified recipients, without requiring logging in to Xadmin. The critical alert email will include all alerts that have gone critical since the previous polling interval. (The polling interval is once per minute).
A unique alert (alertable event type/store) will be reported no more than one time in a single business day.
Version 7.1 User Guide
The email content includes the alert, alert type, store #, timestamp, and detail for the last critical alert. A critical alert email can contain one or more alerts.
Figure 10-10: Critical Alert Email Example
Email Alert Attributes
1 Subject Email subject line
2 Event Timestamp
3 Event Count
4 Event Details
Timestamp of when the precipitating event occurred
Number of events that have occurred
A description of the event
Alert Name
Rtl Loc Id
Name of the alertable event type
Retail Location Id of the event
CHAPTER 10: Support Tools
Perform the following steps to set up critical email alerts.
1. From the Xadmin menu, select Support Tools --> Alert Settings.
2. At the Alert Settings page, click Critical Alert Email Settings.
3. Click the Add New link to define a new email address.
Version 7.1
Figure 10-11: Critical Alert Email & Threshold Settings
4. When prompted, enter the recipient’s email address and click Save.
The email address is displayed on the screen and persisted to the database.
To delete an email address, click the
Delete link next to the email address you want to remove.
See “Alert Console” on page 241 for more information about critical alerts.
Version 7.1 User Guide
Use the Thresholds Settings feature to manage system-wide alert threshold settings in your organization.
Perform the following steps to define the threshold settings for alerts.
1. From the Xadmin menu, select Support Tools --> Alert Settings.
2. At the Alert Settings page, click Thresholds Settings.
3. The alert preferences screen shows all alert types and their current thresholds. Edit the values as needed and click Save.
Figure 10-12: Alert Preferences Screen
Alert type severity threshold levels include Medium, High, and
Critical options. See “Alert Console” on page 241 for more
information about the alert types.
There is no column for LOW threshold because Low is always considered to be 0. If there is even one alertable event, the severity must at least be considered Low.
When setting the alert severity threshold values, the relative magnitude values between alert levels must be respected, (i.e. Critical level cannot be lower than High level).
CHAPTER 10: Support Tools
To see the alert type description, use the mouse to hover over the alert type label.
Version 7.1
When an alert type value is changed, a web service call sends the alert value to the cfg_alert_severity_threshold table.
Changes to a critical alert threshold are not retroactive.
For example, consider the scenario where there have been 10 “register offline” events, and the critical alert threshold for “register offline” is 20. If the critical alert threshold is changed to 5, a critical alert email will not be sent until the next “register offline” event occurs (#11). So in this scenario, when the 11th “register offline” event occurs, a critical
email will be sent.
A system-wide configuration parameter defines the start of a business day in hours past
GMT 00:00. See “Xadmin Configuration” on page 28 for more information about this
configuration option.
Setting
dtv.xadmin.smtp.host
dtv.xadmin.smtp.port
dtv.xadmin.smtp.auth
dtv.xadmin.smtp.user
Table 10-1: xcenter.properties Information
Valid Values
String
Integer
Boolean
Description
The email host name.
The email port name. dtv.xadmin.smtp.password
String
String
If true, Xstore will make secure SMTP connections (smtps) for email operations.
This usually requires a user name and password (DefaultMailUser &
DefaultMailPassword). If false, Xstore will use unsecured SMTP connections (smtp) for email operations, and username and password will be ignored.
Username to use if making secure SMTP connections.
Password to use if making secure SMTP connections.
dtv.xadmin.smtp.sender
String The email sender.
Version 7.1 User Guide
Setting
Table 10-1: xcenter.properties Information (continued) dtv.xadmin.support.critical
AlertEmails.enabled
Valid Values
Boolean
Description
True or false.
This table contains the Xadmin support dashboard critical alert email recipient address information.
Table 10-2: cfg_critical_alert_email Table
Column Valid Values
cfg_critical_alert_email.organization_id
Integer cfg_critical_alert_email.email_address
cfg_critical_alert_email.create_date
Varchar(60)
Datetime cfg_critical_alert_email.create_user_id
cfg_critical_alert_email.update_date
Varchar(30)
Datetime cfg_critical_alert_email.update_user_id
Varchar(30)
Description
Organization ID
Critical alert email address
Create date
Create User id
Update date
Update user id
Table 10-3: ctl_event_log Table
Column
ctl_event_log.arrival_timestamp
Valid Values
Datetime
Description
The arrival time of the event log database record into Xcenter.
See the Xadmin Database Dictionary for more information.
CHAPTER 10: Support Tools Version 7.1
The Deployed Xstore Versions feature shows Xstore version information by store in a pie chart format. The store’s primary register is responsible for reporting the version of the store to Xadmin (ctl_device_registration. primary_register_flag = True). The size of each section of the chart is proportional to the corresponding number of stores running the Xstore version.
Due to rounding, the totals shown on the Version Information charts may not add up to 100%.
You must have the Deployed Xstore Versions privilege to use this feature.
1. From the Xadmin menu, select Support Tools --> Deployed Xstore Versions, or click the Deployed Xstore Versions link in the Support Tools panel.
2. The Deployed Xstore Versions by Store page displays.
Figure 10-13: Deployed Xstore Versions by Store Page
This chart shows the Xstore versions currently running in the stores in your organization.
Each Xstore version is shown as a color-coded section of the chart.
The key to the right of the chart indicates the Xstore versions included on the chart, and which color represents each version.
The percentage of stores in your organization running each version of Xstore is shown below the version number.
The most-recent Xstore version is shown in the green section of chart, located on the right side of the chart. (Version 7.0.0.296 - 0.0.0 - 0.0 in this example).
Version 7.1
Using the mouse, hover over a section of the chart to display the Xstore version and percentage of stores running the version compared to all stores.
User Guide
To view additional detail, select a section of the chart and click on it. See
below.
The detailed information available by clicking on a section of the chart shows the Store
Name, Retail Location ID, Phone Number, and Address.
Figure 10-14: Xstore Version by Store Detail
Use the Up and Down arrows the currently selected section.
to view detail about the chart section above and below
To close the Detail window, click the Close
If needed, a scroll bar is provided on the right side of the window.
CHAPTER 10: Support Tools Version 7.1
The PosLog Publisher feature provides the ability to compile the PosLog data from within
Xadmin and save it as a file to a specified location. This allows you to manage this information centrally, without having to connect remotely to stores. Xcenter data can be generated for an org node, store, or only specific registers within a store, for a specific date range.
1. From the Xadmin menu, select Support Tools --> Publish PosLog Data, or click the
Publish PosLog Data link in the Support Tools panel.
2. At the PosLog Search page, enter search criteria to find the PosLog data, then click
Search.
Figure 10-15: PosLog Search Page
Org Node - The org node, selected from the drop-down list. [
R
EQUIRED
]
Trans # - The transaction identifier.
Register # - The register identifier.
Business Date range - The transaction date range. [
R
EQUIRED
]
3. The Search Results page displays the summary results of the search. The maximum number of results returned by the search is controlled by configuration.
See also: POSLog Publish Max Search Results and Number of Records in POSLog Publisher
Result Page configuration options in Chapter 3, “System Settings” on page 27
for more information about these configuration settings.
Version 7.1 User Guide
The PosLog Publisher Search Results page layout will vary depending on the Xadmin configuration setup for PosLog Publisher. See
“PosLog Publisher Search Results Page Layout
Examples” on page 261 for additional information about the search results page options.
Figure 10-16: Search Results Page - Summary View
If no transactions match your search criteria,
Trans Count will show No results
Click “PosLog Search” in the navigation breadcrumb to return to the PosLog Search page.
By default, all transactions returned in the search are selected as indicated by the check mark in the right-most column.
You have the following options available to indicate which PosLogs are to be published:
If applicable, select the group from the View More
POSLogs drop-down list to view more PosLogs.
To select a small sub-set of transactions, uncheck the header check box to remove the check marks, then select each transaction on this page to be published.
If you want to publish most of the transactions on the page, selectively un-check the transactions you do not want to publish.
CHAPTER 10: Support Tools Version 7.1
4. Actions on this page include Publish and Publish All:
Click Publish All to publish all transactions returned by the search, up to the maximum search results limit. This option overrides any selective changes you may have made to the check marks in the right-most column.
Click Publish to publish the transaction or transactions you selected on the page.
5. When prompted, select the target from the list of targets available for publishing and rebroadcasting:
Figure 10-17: Publish PosLogs Target Prompt
Publish the PosLog data from within Xadmin and save it as an XML file to the
specified directory configured in Published POSLog Directory. See “Xadmin
for more information about specifying the directory where the published PosLog file will be saved.
<OR>
Publish the PosLog data to the Broadcaster system in Xcenter through Web services.
Click if you do not want to publish the selected PosLog. You will be returned to the Search Results page.
6. Click Publish.
7. At the confirmation prompt, click OK to close the window.
Figure 10-18: Rebroadcasting Example
Figure 10-19: Xml File Example
Version 7.1 User Guide
The PosLog Publisher Search Results Page page layout will vary depending on the Xadmin configuration setup for PosLog Publisher. The following examples show the different page layouts based on the following configuration settings:
Number of Records in POSLog Publisher Result Page = 100
POSLog Publish Max Search Results =1000
Example 1: Trans Count < 100, Search Results <1000
You will see these results since the transaction count of 43 is less than 100. In this example, both the number of records shown per page (up to 100) and the maximum search results limit (up to 1000) have not been reached.
Example 2: Trans Count > 100, Search Results <1000
In this scenario you will have the option to View More Poslogs since the transaction count exceeds the limit of 100 records shown per page, but is less than the maximum search results limit of 1000.
Example 3:Trans Count > 100, Search Results >1000
In this scenario you will have the option to View More Poslogs since the transaction count exceeds the limit of 100 records shown per page. Also, a message displays indicating the maximum search results limit of 1000 has been exceeded. If the desired result is not listed in the View More PosLogs drop-down list, you must refine your search criteria and search again.
CHAPTER 10: Support Tools Version 7.1
The Replication Status page shows ERROR status information related to the rpl_replication_data table.
1. From the Xadmin menu, select Support Tools --> Replication Status, or click the
Replication Status link in the Support Tools panel.
2. At the Replication Status page, the first 500 results are displayed automatically:
If the desired result is not listed, go to step 3 below to refine your search criteria.
If the desired result is listed, skip to step 5 below.
Figure 10-20: Replication Status Page
3. To search for replication failures based store IDs and/or last update date, complete the following fields as needed:
Store # - Enter/select the store number.
If specified, the application only accepts valid store number inputs. A validation error will display if the specified store number is invalid.
Update Date - From the drop-down list, select “Before”, “After”, or “Equal to”, then select or enter a date.
The update date criterion will be ignored if the input is not valid. Future dates are considered invalid.
4. Click Refresh.
The records in the data table are sorted by update date (the last modified date) by default. To reorder the list, click on a column header.
5. With a record displayed you have the following options:
Delete - Select the check box associated with the record (or records) and click the
Delete button to delete the selected replication error. When prompted, click Yes to confirm you want to delete the record. Click OK to close the confirmation box.
Reprocess - Select the check box associated with the record (or records) and click the Reprocess button to reprocess the replication error record(s). When prompted, click Yes to confirm you want to reprocess the record(s). Click OK to close the confirmation box.
Version 7.1 User Guide
To select all records at once, click the check box in the table header.
View - Click a record to view the detail information about the selected record.
Figure 10-21: Record Detail Window
The following information is shown in the Record Detail window:
Reprocess Information - (Populated when applicable) This section shows the
ID of the user who reprocessed the record, the last reprocess date and time, and the total number of reprocess attempts.
Payload - This section shows the entire contents of the replication data sent by an Xstore register.
Error Detail - This section shows the technical details (like a java stack trace) of the error.
See the Xstore Implementation Guide for more information about replication.
CHAPTER 10: Support Tools Version 7.1
A P P E N D I X
This chapter explains how deployments are created and tracked by Xadmin and applied by
Xstore and Xenvironment.
To allow corporate users to easily maintain store systems, Xadmin provides the ability to deploy changes directly to retail locations or sets of retail locations. A deployment consists of a file, or set of files, and information dictating how and when it will be processed.
Deployments may include Dataloader download files, configuration jar files, debit bin files,
encryption cipher files, or update jar files. See Appendix D: “Glossary” on page 291
for additional details about these types of files.
In this appendix, the file, or files, that will be deployed are referred to as deployment files.
In addition to these deployment files, a deployment includes information that allows for precise distribution to the desired target group. This information includes the locations within the hierarchy that will receive the deployment, the date upon which they will be notified of its availability, when they should begin to download it, and when they should apply it.
APPENDIX A: About Deployments Version 7.1
Xadmin provides an interface for creating deployments. The Configuration Manager and
Data Management features are used to create configuration and data changes, and can also be used to upload files of supported types to be included in deployments. Functionality for automatically creating deployments for files that are placed in a location on the file system using header information to determine the target group and target application date is also provided.
Whenever a deployment is created, Xadmin is responsible for saving the deployment details in the form of a manifest and uploading any deployment files to the Apache file server. Once a deployment is created, its status can be monitored in real-time using Xadmin's Deployment
Viewer feature.
Xcenter assumes two critical roles in the deployment process: responsibility for communicating deployments to stores, and responsibility for accepting status-related feedback pertaining to those deployments.
When a store queries for any available deployments, Xcenter assembles a package that includes deployment manifests for deployments that haven't yet been acknowledged as having been received, and connectivity details for the Apache server that is hosting the files related to those deployments.
It also receives and stores status feedback from the store systems when the manifest for a deployment has been received successfully, when a deployment has been downloaded, and when a deployment has been applied.
The downloaded deployments from Xenvironment are applied to Xstore.
Xenvironment is responsible for querying Xcenter for new deployments and then downloading and applying deployments. It is responsible for forwarding the details of the deployment to the Xenvironment lead, retaining the details pertaining to it, downloading any necessary deployment files, and properly applying those files. It also reports the status of each of those steps back to Xcenter so that the status of each deployment can be tracked in real-time from Xadmin.
Apache is an HTTP server that hosts deployed files so they can be retrieved for application on store systems. When a deployment is initiated from Xadmin, files are uploaded to it and stored for later retrieval by Xenvironment.
Version 7.1 User Guide
DataLoader is responsible for applying any Configuration Manager changes that impact the database, and any other DataLoader download files that have been deployed to stores. It translates data changes from delimited text to database table data.
When you make changes in Data Manager and deploy them, they automatically update the Xcenter database. There is no DataLoader file created and no DataLoader processing necessary. The Xcenter database is updated directly. If anything fails, it can be found in the
Xcenter or Xadmin log file.
Xadmin's file management capabilities can be used to transfer files to and from the store and corporate environments. Xcenter file management transfers only files required by the Xstore
Suite.
The file management capabilities in Xcenter leverage the Apache Web Server for file downloading and posting.
File Download to Stores
Multiple incoming channels are used to target file deliveries to stores: file uploads and configuration changes made through the Xadmin UI and files dropped by external systems.
Xenvironment retrieves deployments during closing and on a scheduled interval throughout the day. A back office menu option within Xstore can also be used to check for updates.
Feedback on deployments is published to Xcenter and can be reviewed in Xadmin.
APPENDIX A: About Deployments
File Upload from Stores
Version 7.1
Xenvironment collects logs from in-store systems (pospoll.zip) and uploads to Xcenter.
The files are left in a configurable directory location.
A customer-specific script can be written to retrieve files from Xcenter in order to move files to their next destination. That process is not provided as part of the Xstore Suite.
The deployment manifest is an XML-encoded representation of the deployment file and contains instructions Xenvironment uses for handling the deployment files. The manifest contains no configuration information itself, and is simply a set of instructions to be used by
Xenvironment.
Sample Deployment Manifest
<?xml version="1.0" encoding="UTF-8"?>
<deploymentManifest xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance" xsi:noNamespaceSchemaLocation="DeploymentManifest.xsd">
<deployment-id>12345</deployment-id>
<deployment-manifest-version>1</deployment-manifest-version>
<updates>
<update>
<relative-url>/path-to-file</relative-url>
<type>APPUPD</type>
<download-priority>IMMEDIATE</download-priority>
<apply-priority>STORE_CLOSE</apply-priority>
<file-hash>asdadadasdasd</file-hash>
</update>
<update>
<relative-url>/path2</relative-url>
<type>DEBITBIN</type>
<download-priority>IMMEDIATE</download-priority>
<apply-priority>IMMEDIATE</apply-priority>
<file-hash>hashhashhash</file-hash>
</update>
</updates>
</deploymentManifest> deployment-id - The numeric deployment ID from Xcenter. May be included twice:
Once on the manifest (generated by Xadmin)
And once - [
OPTIONAL
] - on each update deployment-manifest-version - The version of the deployment manifest.
Version 7.1 User Guide
updates
relative-url - The relative path to download the update from. The path is relative to the URL specified in configuration.
type - Enumeration values include: CONFIG, APPUPD, DATA, COMPRESSED_DATA,
CIP, and DEBITBIN.
download-priority - STORE_CLOSE = Download during the close, IMMEDIATE =
Download immediately.
apply-priority - STORE_CLOSE = Wait until the store close to apply,
IMMEDIATE = apply immediately
file-hash - The MD5 hash of the file being downloaded.
Notes:
• If Xenvironment receives configs/manifests on a nonlead, they will be forwarded to the lead.
• If Xenvironment receives a manifest during the close:
Xenvironment will not attempt to process IMMEDIATE deployments while a close is in progress. They will be processed after the close has completed.
The manifest data will be saved to disk.
The IMMEDIATE deployments will be processed sometime after the close has completed.
The STORE_CLOSE deployments will be processed during that close if the manifest is sent before that point in the close, otherwise they will wait until the next close.
• A RSS feed named 'immediate' is used for the immediate deployments.
1. A file of a supported type is uploaded via the Xadmin File Upload feature.
Supported files include Dataloader download files, configuration jar files, debit bin files, encryption cipher files, and update jar files.
The file is stored on the Xadmin server so that it can be deployed.
2. A file is deployed using the deployment functionality in the File Upload feature.
A deployment manifest is created and stored.
The file is uploaded to Apache.
3. The deployment is downloaded and applied at each applicable store. See
Deployment is Downloaded and Applied” on page 271
for more details.
APPENDIX A: About Deployments Version 7.1
1. A data change, or set of data changes, is made within Xadmin's Data Manager feature.
2. The deployment function within the Data Manager feature is used to schedule a deployment of the session.
A deployment manifest is created and stored.
An update zip file containing a Dataloader download file with the changes made in the Data Manager session is created and uploaded to Apache.
3. The deployment is downloaded and applied at each applicable store. See
Deployment is Downloaded and Applied” on page 271
for more details.
1. A configuration change is made in Xadmin's Configuration Manager feature.
Changes can be made at a Master Profile (Global) level, at a more granular Profile
Group/Profile Element level, or at a Store-Specific level.
2. A deployment of the configurations is scheduled via the Configuration Manager.
The configuration change is versioned. See “Version Tracking of Deployments” on page 271
.
A deployment manifest is created and stored.
An update zip file is created and uploaded to Apache.
If XML configuration changes are included, they will be transmitted in the form of a jar file containing all XML configuration changes for all profiles.
If data configuration changes are included, they will be transmitted in the form of a DataLoader download file including data changes for the target profile.
3. The deployment is downloaded and applied at each applicable store. See
Deployment is Downloaded and Applied” on page 271
for more details.
4. The Master Profile (Global) and any assigned Profile Group/Profile Element details are represented on the store system as configuration path entries (for example, Profile
Group: COUNTRY/Profile Element: CANADA would be represented as :COUNTRY/
CANADA), and determine which of the configurations in the configuration jar apply to the location.
1. A Dataloader download file, including header details that describe the deployment target area and deployment date, is placed in an automatic deployment location on the Xadmin server.
2. Xadmin automatically detects the presence of the file and creates a deployment for it, using the provided target details to target the appropriate systems on the appropriate date.
A deployment manifest is created and stored.
The download file is uploaded to Apache.
3. The deployment is downloaded and applied at each applicable store. See
Deployment is Downloaded and Applied” on page 271
for more details.
Version 7.1 User Guide
Xadmin creates and tracks version numbers for each set of configurations that are deployed at the Master Profile (Global) level, at a more granular Profile Group/Profile Element level, or at a Store-Specific level.
1. When a configuration change is saved to a profile (this could be Master/Default, a specific profile element, or a store-specific profile), a version number is assigned to the change.
a. Version numbers start at 1 and increment by 1. 1 is the first version for a profile element, 2 is the second version, etc.
b. Additional changes made to the same profile will continue to accumulate with the same version number until deployment for the profile is scheduled.
2. When deployment for a profile is scheduled, the current profile version is “locked” to ensure that no new changes can be made to the version.
3. After a profile version is locked, new changes made to the profile will use a new version number. If version 3 of a profile was locked, new changes will be assigned to version 4 up until the point where deployment for profile version 4 is scheduled.
1. Xenvironment queries Xcenter for any open deployments at a fixed interval.
2. When Xenvironment receives deployment details, it processes them in an appropriate manner.
An update message is sent to Xcenter to indicate that each manifest has been successfully received.
Connectivity details are stored so they can be used to download deployed files.
3. Xenvironment stores each deployment either for immediate download or download during the closing process.
If a deployment is scheduled for immediate download, Xenvironment will begin to download the file immediately.
If a deployment is scheduled for download during the close, Xenvironment will wait until the nightly closing process is initiated to begin downloading the file.
4. Xenvironment applies each downloaded deployment at the appropriate time.
If a deployment is scheduled to be applied immediately (applies to MNT files, DAT files, and application updates only), Xenvironment executes the jar. (DataLoader is not used to apply immediate application updates).
Xenvironment will stop Xstore before applying an immediate application update, but it the responsibility of the code within the jar file to restart Xstore, not Xenvironment.
APPENDIX A: About Deployments Version 7.1
If a deployment is scheduled to be applied during the closing process, it will be handled properly during that process.
Dataloader download files are applied via the Dataloader on the lead
Xenvironment register.
If the download data was provided by any feature other than the Configuration
Manager, it is loaded into the DB.
If the download data was provided by the Configuration Manager, it is loaded into the DB only if the system's configuration path includes the associated profile.
Update jar files are applied by distributing them to each system and executing them.
Encryption cipher files are applied by distributing them to each system.
Debit bin files are applied by distributing them to each system.
Configuration Manager jar files are applied by distributing them to each system.
When a deployment cannot be uploaded successfully to Apache, the cause will typically be one or more of the following four issues. See the xcenter-admin.log and server.log files on the Xadmin server to determine which of the issues is the cause for the failure.
1. The Apache URL configured in the xcenter.properties file is incorrect.
2. The Apache credentials configured in the xcenter.properties file are incorrect.
3. The SSL certificate for the Apache server is not located in the truststore file in the xcenter-config\res\ssl folder.
4. The Apache server cannot be reached from the Xadmin system.
When Xenvironment is unable to download a deployment from the Apache server, the cause will typically be one or more of the following three issues. See the environment's process.log file to determine which of the issues is the cause for the failure.
1. The URL provided in the manifest cannot be reached from the store.
2. The SSL certificate needed to communicate with the Apache server is not present in the trusted.ca-bundle file.
3. The Xenvironment role of one or more of the registers in the store is incorrectly configured.
When Xenvironment is unable to transmit status information to Xcenter, the cause is typically related to the DataSourceConfig file's Xcenter DataSource not including a GetUpdates context path. Confirm that this path is present and accurate, and add it if it is missing.
A P P E N D I X
This appendix explains how the store personalities set up in Xadmin are used to create the config path properties. See
Chapter 4, “Profile Management” on page 35 for more
information about setting up store personalities.
The system property dtv.update.config.path.from.Xcenter is the master switch for the retrieval process.
If set to true (default), an attempt will be made to contact Xcenter to obtain the values of the properties dtv.config.path and dtv.base.config.path.
If set to false, Xstore will use its current values. (See “If Not Using Xcenter to Get the
).
When set to true
In Xcenter, a servlet ("config path servlet") handles requests for the config path from
Xstore.
In Xstore, the following property in DataSourceConfig.xml for the "Xcenter" data source indicates the context path for the servlet.
< Property key =" GetConfigPathPath " value =" /xcenter/configpath/GetConfigPath "/>
In conjunction with the Xcenter host name and port, the property value indicates the URL to contact to get the config path values.
APPENDIX B: Personality Maintenance & Config Paths Version 7.1
When Xstore starts, it sends a request to the URL that contains parameters indicating the organization ID, store number, and workstation ID of the machine that is sending the request. (See
“Config Path Retrieval Process” on page 273 ).
In Xcenter, the config path servlet looks up the store personality based on those parameters and assembles the config path properties from the assigned personality and landscape. The response from Xcenter contains a serialized Java Properties object that contains the appropriate values.
If no personality and landscape are assigned to the store, then the specific properties will not be present. Note that in this case, blank values will be used for the dtv.config.path and dtv.base.config.path properties.
Once the property values from Xcenter are obtained, they are compared to the existing values from the configPath.properties files. If either of the property values from Xcenter are different than the property values from the file, the values from Xcenter will be written to the configPath.properties file, the last.updated.date property will be set to the current date and time, and Xstore will shut itself down and be restarted by the wrapper.
Also during the startup process, till/register data from Xcenter is synchronized with Xstore’s lead register. Any till/register data that was updated on the store primary is also updated on other workstation databases when the nightly backup and restore process occurs (in an offline scenario). With this process, it is no longer necessary to manually run till/register setup scripts before starting up the lead register.
Processing Overview
1. Xstore starts up on the lead register or store primary.
2. During the startup process Xstore compares the till/register data from Xcenter and synchronizes the data on the store primary.
The following data objects are synchronized:
Store record
Tax location mapping record
Corresponding org hierarchy records
Workstation records
Tender repository records (till and register records)
Inventory buckets
Inventory location buckets
Version 7.1 User Guide
This section explains how the dtv.config.path and dtv.base.config.path properties are assembled within Xcenter.
This property represents the base features in Xstore that can be enabled or disabled, such as customer loyalty.
The store number is looked up in the cfg_store_personality
table. The personality_id from
that table is used to look up the actual personality in the cfg_personality
table.
The
table contains the base features that have been enabled.
The value in the feature_id column is the actual config path element that is used to enable the feature. Therefore, to build the value of the dtv.base.config.path property, the rows from the base feature table are sorted by the sort_order column and concatenated into one string with each feature preceded by a colon ( : ). The resulting string becomes the value of the dtv.base.config.path property. An example of a complete property value is: dtv.base.config.path=:cust/loyatly:cust/loyalty/award:cust/registry
This property represents all of the overrides that should be considered for a given workstation in a given store. Building this property is a little more complicated than the
"base" version described above. In order to build the value, both the personality and the landscape must be consulted.
First, the personality that was looked up above is used to obtain the profile groups and elements that make up the personality. These are contained within the
table. The rows in this table are sorted by the sort_order column.
Then, the list of sorted rows is traversed and the group_id and element_id from each row are concatenated with a slash ( / ) and all of these pairings are concatenated into one string with each pairing being preceded by a colon ( : ).
Second, the landscape is consulted. Any
cfg_landscape_range records that have a range that
contains the workstation ID of the requesting system are gathered together and sorted
based on the sort order of the profile group in the cfg_landscape_group
table. After the rows have been gathered and sorted, the process is very similar to the personality process described above. The list of sorted range rows is traversed and the profile_group_id and profile_element_id from each row are concatenated with a slash ( / ) and all of these pairings are concatenated into one string with each pairing being preceded by a colon ( : ).
The string representing the landscape is appended to the string that represents the personality and the result becomes the value of the dtv.config.path property. An example of a complete property value is: dtv.config.path=:COUNTRY/CANADA:SS_STORE/
202:STORE_TYPE:OUTLET:REG_TYPE:LEAD:RECEIPT_PRINTER/EPSON_TMT88
The assembled values are put into a Java Properties object with the keys dtv.base.config.path and dtv.config.path and that object is sent back to Xstore.
APPENDIX B: Personality Maintenance & Config Paths Version 7.1
To keep from modifying the system.properties files for installed systems, a file in Xstore holds the dtv.base.config.path and dtv.config.path properties that were obtained from
Xcenter. This file is named configPath.properties and it resides in the root xstore directory on an installed register.
When Xstore receives the properties from the Xcenter servlet, it writes the properties to this file along with a status property, last.updated.date, that indicates the last time the properties were successfully retrieved from Xcenter.
In the event that a retrieval of the properties fails, an additional status property, update.failed, will also be written to this file. This allows a support person to see that the last update failed as well as triggers a pre-flight check in Xstore indicating that updating of the config path from Xcenter failed. The next time that the update succeeds, this property will be removed.
Below, is an example of the contents of a configPath.properties file. The comment will also always be written.
#The contents of this file are machine-generated. The values were retrieved from Xcenter and represent the store personality that is defined there for this store.
#NO MANUAL CHANGES SHOULD BE MADE TO THIS FILE.
#Thu Sep 26 15:00:44 EDT 2013 dtv.config.path=\:COUNTRY/CANADA\:SS_STORE/202\:STORE_TYPE/
RETAIL\:REG_TYPE/LEAD\:HAS_RETURNS/ALL dtv.base.config.path=\:cust/loyalty\:cust/loyalty/award\:order last.updated.date=2013-09-26 12-00-43
This file is only one piece in building the full config path. Along with the addition of this file, some common (and required) elements of the config path have been promoted to hardcoded, reserved word status. A few new elements have also been added to the base.
The config path elements base, version1, MASTER/DEFAULT, and version1/patch no longer appear in any system.properties file. They are now added programmatically at the appropriate place in the overall config path. Also, any dtv.base.config.path and dtv.config.path properties that exist in any system.properties will not be used in deference to the same properties from the configPath.properties file.
The overall config path is assembled as follows:
1. The config element dtv/res/config
2. The value of the property dtv.base.config.path
3. The config element base
4. The value of any property from an included system.properties file that contains a config path property with a negative number qualifier, e.g. dtv.config.path.-37
Version 7.1 User Guide
5. The config element version1
6. The config element MASTER/DEFAULT
7. The value of the property dtv.config.path
8. The value of any property from an included system.properties file that contains a config path property with a positive number, e.g. dtv.config.path.82
9. The config element version1/patch
All of this is assembled in memory and is never saved anywhere, except as a note in the
Xstore log file. The result is the value that will be used as Xstore's config path. While running
Xstore, this is still accessible, as it always has been, by requesting the system property
"dtv.config.path", i.e. System.getProperty("dtv.config.path").
If retrieval of the config path from Xcenter is not being used, the config path is still assembled in the same manner outlined above. The difference is that the dtv.config.path and dtv.base.config.path properties are not retrieved from Xcenter.
If Xstore ever used Xcenter to obtain the config path, and the configPath.properties file contains properties, those properties will continue to be used, even if updating from Xcenter is now turned off. They will no longer be updated from Xcenter.
If the property update.failed is present in configPath.properties, Xstore will always generate the preflight error indicating that the config path could not be updated from Xcenter, even if updating from Xcenter is now turned off. If the last update failed, and you want to turn off updating from
Xcenter, you must manually remove the update.failed property from configPath.properties.
Table B-1: system.properties
Setting
dtv.update.config.path.from.Xcenter
Valid Values Description
true/false Indicates to Xstore if an attempt should be made to contact
Xcenter at startup to obtain the values for the dtv.config.path and dtv.base.config.path properties.
APPENDIX B: Personality Maintenance & Config Paths Version 7.1
Table B-2: Xadmin Security Settings
Privilege
CFG_PERSONALITY_MAINTENANCE
CFG_PROFILE_MANAGEMENT
CFG_LANDSCAPE_MAINTENANCE
CFG_PROFILE_GROUPS
CFG_STORE_PERSONALITIES
Description
Personality maintenance privilege.
Top Level profile management menu privilege.
Landscape maintenance privilege.
This privilege was renamed from
ADMN_PROFILE_GROUPS in previous versions.
Controls access to the store personality maintenance page.
Resource bundles are loaded based on the config path instead of separate bundle-specific paths. When upgrading to a new Xstore version, move any resource bundle files to a config path location or adjust the config path accordingly.
Translations (was dtv.pos.i18n.translation)
Phone numbers (was dtv.pos.i18n.phone)
Hardware (was dtv.pos.i18n.hardware)
Help (was dtv.pos.i18n.help)
Email (was dtv.pos.i18n.email)
Format display (was dtv.i18n.formatDisplay)
Version 7.1
User Guide
See also: Refer to the Xadmin Database Dictionary for a complete list of the Xadmin database tables.
cfg_landscape
Column Valid Values Description
organization_id int (PK) Store's organization identifier.
landscape_id description comments int (PK) string string
A unique identifier for a landscape.
A description of the store landscape that is assigned by the user.
A comment field for more details.
cfg_landscape_group
Column
organization_id landscape_id profile_group_id profile_group_order
Valid Values
int (PK) int (PK) string (PK) int
Description
Store's organization identifier.
The unique ID of the landscape that this register range belongs to.
The profile group ID that this range is assigned to.
Designates the sort order of the groups
(profile_group_id) within this landscape. The order affects how the config path is later generated.
cfg_landscape_range
Column
organization_id landscape_id profile_group_id range_seq
Valid Values Description
int (PK) Store's organization identifier.
int (PK) string (PK) int (PK)
The unique ID of the landscape that this register range belongs to.
The profile group ID that this range is assigned to.
The sequence number of the range for the landscape.
APPENDIX B: Personality Maintenance & Config Paths Version 7.1
Column
profile_element_id string range_start int range_end
Valid Values Description (continued)
int
The profile element ID that this range is assigned to.
The start of the register range.
The end of the register range (if only one register is in the range, then this will be the same as range_start).
cfg_personality
Column
organization_id personality_id description comments
Valid Values Description
int Store's organization identifier.
int string string
A unique identifier for a store's personality.
A description of the personality that is assigned by the user.
A comment field for more details.
cfg_personality_element
Column
organization_id personality_id element_id group_id sort_order
Valid Values
int int varchar(60) varchar(60) int
Description
Store's organization identifier.
The unique ID of the personality that this personality profile belongs to.
The profile element ID with which this personality is associated.
The profile group ID with which this personality is associated.
The order of elements in the list that will be followed when generating the new configuration path for the store that is assigned to this personality.
Version 7.1 User Guide cfg_store_personality
Column
organization_id personality_id landscape_id
Valid Values Description
int Store's organization identifier.
int The unique ID of the personality that this personality profile belongs to.
int (PK) The unique ID of the landscape that this register range belongs to.
cfg_personality_base_feature
Column
organization_id
(PK) personality_id
(PK)
Valid Values Description
int Store's organization identifier.
feature_id (PK) sort_order int A unique identifier for a store's personality. An alphanumeric field used to enter the "short name" of the personality.
varchar (200) A unique identifier for a feature.
int Sort order when displaying code values.
APPENDIX B: Personality Maintenance & Config Paths Version 7.1
A P P E N D I X
The JSF (JavaServer Faces) technology has been removed from the Xadmin application. With the conversion from JSF to GWT (Google Web Toolkit), no new user-modifiable Xadmin settings were added to the application. However, Xadmin can be “personalized” by adding a background image, changing the color scheme, and configuring the panel display order and content.
All menu changes are to data in the cfg_menu_config table in the Xadmin database. See
“cfg_menu_config Table” on page 288 .
The following changes are documented in this appendix:
“Defining Tab Library Properties” on page 286
“Security Settings” on page 287
APPENDIX C: User Interface Configuration
The Reports menu (main menu) was restructured as follows:
Version 7.1
Figure C-1: Reports Menu Expanded
Each report is no longer individually listed under the Reports menu. This was replaced by an
"All Reports" option since the reports are now indexed and searchable within the reports feature. However, it is possible to place a reference to a specific report on the Reports menu.
To do this, concatenate the report ID with the standard reports menu name inside of the value of the cfg_menu_config.menu_name column for the specific report option. Selecting that specific option will then open the reports feature with the specified report pre-selected and the parameter tab for that report displayed.
Any report that is available within the reports feature can be configured as a specific menu option.
1. In the cfg_menu_config table, find the report ID for any report by looking for the record in the "REPORT_VIEWER_MENU" category with a menu_type of "ACTION". The menu_name for any record meeting those criteria is the report ID.
2. Concatenate the standard reports menu name with the desired report ID and separate the two with the vertical pipe symbol ( | ).
Example:
In the following example, assume you want to add the Daily Cash and Sales Report option to the Reports menu.
The menu_name for the "All Reports" option is "REPORT_VIEWER". This opens the reports feature with nothing selected.
The report ID for the Daily Cash and Sales Report is "DAILY_SALES_CASH_REPORT".
To create the menu option that opens the Daily Cash and Sales Report, concatenate the standard reports menu name (REPORT_VIEWER) with the desired report ID
(DAILY_SALES_CASH_REPORT) and separate the two with the vertical pipe symbol ( | ).
The value of the menu_name column for the menu option is:
REPORT_VIEWER|DAILY_SALES_CASH_REPORT
Version 7.1 User Guide
With the removal of JSF, the Xadmin user interface was updated throughout to have a new look and feel to enhance the user's experience. With this update, the options available on the
Home page are completely configurable. Like the main menu, the contents of the Home page are configurable via the cfg_menu_config table in the Xadmin database.
Figure C-2: Xadmin Home Page
The grouping and availability of options on the Home page are completely unrelated to the options on the main menu, and are not meant to be the same. The main menu contains all possible options, while the Home page is designed to contain the options that should be readily available to the user upon login.
From a technical perspective, the options that can be configured on the Home page and the main menu each share a value for menu_name and, at least in the base, a security_privilege.
Sharing a menu name is required. Sharing a privilege, while recommended, is technically optional.
APPENDIX C: User Interface Configuration Version 7.1
The category for the home page options is "HOME_PAGE_MENU". Any record in the cfg_menu_config table that has a category of "HOME_PAGE_MENU" and a parent_menu_name of "ROOT" constitutes a "Home page panel" on the home page. However, simply configuring a root record is not sufficient to make it display.
Following are the requirements to make a panel display on the home page:
The record for the panel must have either no privilege or a privilege that is part of the current user's role. Each of the six panels in base data have a privilege
associated with them. Those privileges are defined in Security Settings below.
At least one option must be configured as a child of the root option.
Of the child options that are configured, the user must have access (privilege) to at least one of them. Every individual menu option has a privilege associated with it.
If any of the above conditions are not met, the panel will not be displayed on the home page.
The menu_small_icon column on the root record controls the image on top of the panel. The value of this column is a relative path to an image that follows the port number in the URL of the application.
The title column on the root record controls the name of the panel.
The title column of each child menu option controls the text that shows for each option on a panel.
The cfg_tab_property table defines all configurable tab properties. If the tab property is not defined in this table, then it is not configurable and not displayed on the Xadmin Tab
Library Configuration page.
To set the default URL, use the URL_NAVIGATOR_MICROS_RETAIL property set in the Xstore TabConfig.xml.
Column Valid Values
tab_id property_id display_component
VARCHAR
VARCHAR
VARCHAR
Description
Tab ID.
Property ID (tab or tabTitle).
Widget used to display configurable tab property (TextBox,CompoBox etc.).
Version 7.1 User Guide
Column
value_type label create_date create_user_id update_date update_user_id
Valid Values
VARCHAR
VARCHAR
DATE
VARCHAR
DATE
VARCHAR
Description
Determines whether the configurable value is defined in Value or
ComplexValue XML tag.
Translation key for label that describes what configurable value is.
The label is placed on the left of each display component.
Created Date.
Created User ID.
Updated Date.
Updated User ID.
The following privileges apply to the home page panels.
Table C-1: Security Settings: Home Page Panels
Privilege
HOME_PAGE_CONFIG
HOME_PAGE_DATA
Description
The privilege that controls access to the "Configuration
Manager" home page panel.
The privilege that controls access to the "Data Management" home page panel.
HOME_PAGE_DEPLOY The privilege that controls access to the "Deployment Manager" home page panel.
HOME_PAGE_SUPPORT The privilege that controls access to the "Support Tools" home page panel.
HOME_PAGE_REPORTS The privilege that controls access to the "Reports" home page panel.
HOME_PAGE_SYSTEM The privilege that controls access to the "System" home page panel.
RPT_GENERAL_ACCESS The privilege that controls access to the "All Reports" menu option.
APPENDIX C: User Interface Configuration Version 7.1
Table C-2: cfg_menu_config Table
PK Attribute/Logical
Rolename
Datatype
X
X category menu_name
VARCHAR (60)
VARCHAR (100) parent_menu_name VARCHAR (100) config_type VARCHAR (120) title menu_type sort_order view_id action_expression active_flag
propagation security_privilege
VARCHAR (60)
VARCHAR (30)
INTEGER
VARCHAR (200)
VARCHAR (200)
BIT
VARCHAR (30)
custom_datasource
_class
VARCHAR (200) custom_datasource
_method menu_small_icon
VARCHAR (30)
VARCHAR (254)
NULL?
Definition
NO
NO
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
YES
Menu category.
Name of menu.
Name of parent menu.
Configuration type for menu (if applicable).
Translation key for display title of menu.
Specifies the type of menu
(REDIRECT_ACTION, LINK,
ACTION, or LINK_GROUP)
Sort order for menu display.
Relative path to view file associated with menu (only applicable to menus with menu_type of
REDIRECT_ACTION and LINK).
EL or method chain to execute when menu is selected.
Determines whether menu is active or not.
conversation propagation strategy to use when linking to another view.
Security privilege required to access menu.
Custom data source to use with report associated with menu (if applicable).
Custom data source to use with report associated with menu (if applicable).
Relative path to image file to use as an icon for menu.
Version 7.1 User Guide
Table C-2: cfg_menu_config Table (continued)
PK Attribute/Logical
Rolename
Datatype
menu_separator description create_date
BIT
VARCHAR (MAX)
DATETIME
NULL?
YES
YES
YES create_user_id update_date
update_user_id
VARCHAR (30)
DATETIME
YES
YES
YES
Definition
Unused
Text description of Menu Item.
Date the table row was created.
User responsible for creating the table row.
Date the table row was most recently updated.
User responsible for updating the table row.
APPENDIX C: User Interface Configuration Version 7.1
A P P E N D I X
Retail locations inside the secured area of the airport.
A Java jar file containing a set of Xstore configuration files.
A file containing data in delimited text format, which will be loaded into database tables using the DataLoader application.
A text file containing a set of range and format data for accepted debit cards.
An XML document containing details for a deployment. These details include the location of the deployed file, a type distinction for the file, and instructions to indicate when the file should be downloaded and when it should be applied.
An encryption key file.
The Apache HyperText Transfer Protocol (HTTP) server program.
APPENDIX D: Glossary Version 7.1
Defines the registers used within a store and specifies the register numbers and functions.
A grouping of at least one or many Profile Group and Profile Element combinations in an ordered list that work together to define a store.
A target group for configurations. A profile may either be the Master profile, which represents the default set of configurations for all store systems, or a Profile Group/Profile element combination that includes configurations for a specific group of store systems.
The child property associated with the Profile Group; for example, Location= Ohio,
California, Iowa, etc.
A collection of configuration elements by type; for example Location, Register Type, Store
Type, etc.
A personality/landscape pairing to define a store; used to create the configuration paths specified in configPath.properties.
The location, or set of locations, that will receive a deployment.
An executable application update.
The Xenvironment lead register system controls the store closing process and is responsible for querying Xcenter for new deployments, downloading deployments and distributing them to other registers in the store, and for sending feedback pertaining to the status of deployments to Xcenter.
The Xstore lead register system is used to open and close the retail location.
A P P E N D I X
This section summarizes the changes to this document for each Xadmin release. Refer to the
Xstore Release Notes for more information about new functionality, enhancements, and improvements to Xadmin since the previous version.
Xstore Version 7.1
Description of Change
Tab Library
Employee Task
POS Log
Added cfg_tab_property table.
End Date and Status fields were modified.
“Publish PosLogs Target Prompt” on page 260 was modified
to include new description format.
Xstore Version 7.0, Doc Version 03 Date 11/2014
Description of Change
Data Manager - Items
Added the serial number check box option to the Basic
Merchandise Item Information table and the Non-
Merchandise Item Information table.
APPENDIX E: Revision History
Version 7.1
Xstore Version 7.0, Doc Version 02 Date 06/2014
Description of Change
About Deployments
Added version tracking of deployments information.
Xadmin Version 7.0, Date 05/2014
Description of Change
Config Path
Added Resource Bundle information.
Added Till/Register Data Processing information.
Deployment Manager
Updated File Upload process.
Support Tools
Updated PosLog Publisher process.
Added primary register responsibility for reporting store version to the Deployed Xstore Versions feature.
Reports
Data Management
Added new output types and Transaction Audit Reports reclassification information.
Added Stock Valuation Year End Roll-up section. (Previously, this function was part of reporting).
Added new Item Type Restriction - Disallow Rain Check.
Added Alternate Store # information.
Added Airport Zone information.
Added Store/Till setup information.
Version 7.1 User Guide
Xadmin Version 7.0, Date 05/2014 (continued)
Description of Change
Cofigurator
Added Currency ID setup information.
Added Deployed Configurations Version Tracking section.
Removed Tender System Config option “Payroll Deduction
Tender Threshold Amount?”: not supported in base Xstore.
Till Accountability till counting options; replaced Total Normal option with Total Short option.
Removed the following Security Config options: Accept Same
Re-Count Amount?, Display Count Summary First On Count
Start?, and Force Re-Count Of Till With Discrepancies Over
Threshold With Override?
Removed the Till Accountability option: Use Till Based
Accountability? (Note: Use Till Accountability, Deposit Bank, and
Deposit Acct configurations are now set up in System Settings.)
Added Deleting Configuration Changes section.
Administration
System Settings
User Interface: Menu
Configuration
Added Reports Category and new report format options.
Added new configuration options for setting up a new store.
Added new appendix for main menu and Home page configuration.
Xstore Version 6.5, Doc Version 05 Date 04/2014
Description of Change
The following changes were made to address the vulnerability (Heartbleed) in
OpenSSL for Apache:
Public Key Certificates
When installing on Linux, OpenSSL 1.0.1g (or a newer
1.0.1 version, if available) should be installed replacing
OpenSSL v1.0.0* Light.
Installing Xstore
2013 C++ Runtimes have replaced Visual C++ 2010
SP1 Runtimes (x86).
APPENDIX E: Revision History Version 7.1
Xstore Version 6.5, Doc Version 04 Date 03/2014
Description of Change
Public Key Certificates
Added new steps for adding Xcenter's cert in
Xenvironment’s trusted ca bundle. Xenvironment needs
Xcenter's cert in its trusted ca bundle because it directly requests deployments from Xcenter. Certs are now required for both Xcenter and the Apache server.
Xstore Version 6.5, Doc Version 03 Date 12/2013
Description of Change
Installing Xstore
Removed references to configuring LDAP in xcenter.properties. Functionality was not implemented,
LDAP is only configured in Xadmin Settings.
Xadmin Version 6.5, Doc ver 02 Date 12/2013
Description of Change
Roles, Users, and
Security Access
Removed xcenter.properties settings for LDAP configuration.
LDAP is no longer configured in xcenter.properties, it is only configured in Xadmin Settings.
Xadmin Version 6.5, Date 10/13
Description of Change
Application has been re-branded: From Xcenter Admin to Xadmin.
Data Management Added Redeploying Data to an Org Node section.
Broadcaster
Appendix
Removed from this user guide, moved to the Xstore
Implementation Guide.
Replication Appendix Removed from this user guide, moved to the Xstore
Implementation Guide.
Version 7.1 User Guide
Xadmin Version 6.5, Date 10/13
Description of Change
Getting Started
Configurator
Added reset and change password instructions.
Added Tab Configuration section.
Added new Discount options.
Added new Receipt Text format options.
Added new Tender options.
Added deployment information for Immediate apply priority.
Removed Profile Management section. (Moved to Profile
Management chapter)
Profile Management
Support
New chapter.
New appendix for technical details.
PosLog Publisher, updated section for ability to publish for multiple stores/days.
Added new alert console information.
User Settings/
Security Access
System Settings
Added LDAP Authentication section.
Added new configuration for the maximum number of POSLog records returned from the database for republishing.
Deployment Manager
Updated for new flow.
Xcenter Admin Version 6.0, Doc ver 02 Date 05/13
Description of Change
Discount Configuration - Revised flow, corrected privilege information
Tender Configuration - Corrected privilege information
Deploying Configuration Changes - Revised flow
Managing the Organization Hierarchy - Revised flow
APPENDIX E: Revision History Version 7.1
Xcenter Admin Version 6.0 Date 04/13
Description of Change
CTL_PERSIST_FAILURE table has been replaced by the RPL_REPLICATION_DATA table for reporting support alert codes.
Added Xcenter Admin Configurations - EnableStoreSpecificOverrides,
DataManagerAutoDeploymentStartTime, DaysBeforeLaunchDate,
DeploymentAutoEmailStartTime, EnableDataManagerAutoDeployment, and
MaxDeploymentResult
Removed Xcenter Admin Configuration - FileDeploymentServiceDirectory
Roles, Users, and Security Access Chapter - Added information for new security access areas, new email field
Settings Chapter - Removed non-valid menu options: Config Path option, Organization ID option, Org Hierarchy level option
Config Manager Chapter - Added Store Specific Overrides option, Added Copy Store
Configurations section, Added Delete Profile Configuration Changes section
Added new Broadcaster Appendix
Support Chapter - Added Replication Status information
Xcenter Admin Version 5.5, Doc Version 02 Date 09/12
Description of Change
Removed Appendix: Loading User Records via DataLoader from book per dev request
Added Automatic External File Delivery section to Deployment Manager chapter
Added Appendix: About Deployments
Added Appendix: Glossary
Version 7.1
Xcenter Admin Version 5.5 Date 08/12
Description of Change
New book for version 5.5.Loading User Records via DataLoader
User Guide
Xcenter Admin Version 5.0 Date 02/12
Description of Change
New book for version 5.0.
Xcenter Admin Version 4.8 Date 07/11
Description of Change
Added employee task and message database configuration information.
Removed “No Access Settings” from Security Privilege Detail configuration.
Added “Overridable” to Security Privilege Detail configuration.
Removed references to ConfiguratorConfig.xml. (No longer supported)
APPENDIX E: Revision History Version 7.1
Doc Version 03 Xcenter Admin Version 4.0 Date 04/11
Description of Change
R
EMOVED ALL REFERENCES TO SYSTEM CONFIGURATION
.
(Not fully supported in base at this time.)
Doc Version 02 Xcenter Admin Version 4.0 Date 05/10
Description of Change
Added Disallow Deals and Disallow Order configuration options to
Item Configuration.
Added Security Privilege and Security Permission DAO information.
The public link to your chat has been updated. You may view and manage your chat links after registration here.
Advertisement
User security roles
System configuration rules
Profile groups and elements
Configuration deployments
Data deployment management
File deployment management
Electronic journal
Reports
Support tools
Xadmin is a web-based application used to administer corporate-based functions such as Xstore configuration setup and maintenance, file management for the Xstore suite, viewing the electronic journal, viewing store reports, monitoring Xstore versions in use at the store and register levels, and monitoring alerts.
Xadmin is a web-based application that you can access through an internet browser by entering the server address in the Address field and pressing [Enter].
Xadmin supports Internet Explorer web browser, version 9.0 and 10.0, and Firefox running on the Windows 7 or Windows 8 operating systems.
How to edit an employee in Xadmin?
To edit an employee using Xadmin, navigate to System -> Xadmin Users or click the Xadmin Users link in the System panel. Then, click Users and Security Access, select the user account you wish to modify, make the necessary edits in the fields provided, and click Save to apply the changes. Note that the User ID and Authentication Type cannot be changed.
Login to continue
