Académique Documents
Professionnel Documents
Culture Documents
User Guide
Release 15.0
E69502-01
December 2015
Contents
Send Us Your Comments ................................................................................................ xi
Preface ............................................................................................................................ xiii
Audience .............................................................................................................................. xiii
Documentation Accessibility ............................................................................................. xiii
Example #4 ..................................................................................................................... 10
Creating Atoms ..................................................................................................................... 10
LaunchMaster Configurations ..................................................................................... 14
Chains ..................................................................................................................................... 15
Example ........................................................................................................................... 15
Inserting an Atom or Chain Into a Chain ................................................................... 15
Example ........................................................................................................................... 16
Creating Chains.............................................................................................................. 16
Denymarkers ......................................................................................................................... 17
Allowmarkers ........................................................................................................................ 17
3 Configuring the Oracle Retail Xenvironment Engine ............................................. 19
Overview ................................................................................................................................ 19
About this Chapter ........................................................................................................ 19
Base Oracle Retail Xenvironment Directory Structure and Contents ............................ 19
The Main Directory: <root_directory>........................................................................ 19
Subdirectory: <root_directory>\bin ........................................................................... 19
Subdirectory: <root_directory>\cust_config\version1............................................ 20
Subdirectory: <root_directory>\res\data .................................................................. 20
Subdirectory: <root_directory>\download ............................................................... 20
Subdirectory: <root_directory>\ext ............................................................................ 20
Subdirectory: <root_directory>\log ........................................................................... 20
Subdirectory: <root_directory>\marker .................................................................... 20
Subdirectory: <root_directory>\poll .......................................................................... 20
Subdirectory: <root_directory>\res\ssl ..................................................................... 20
Subdirectory: <root_directory>\support ................................................................... 21
Subdirectory: <root_directory>\tmp .......................................................................... 21
Subdirectory: <root_directory>\wwwroot ................................................................ 21
Configuring the Oracle Retail Xenvironment Engine ...................................................... 21
environment.properties ................................................................................................ 21
local.properties ............................................................................................................... 22
Register-Specific Configurations ................................................................................. 23
System Configurations .................................................................................................. 23
actions.properties ........................................................................................................... 25
alerts.properties.............................................................................................................. 25
update.properties ........................................................................................................... 25
version.properties .......................................................................................................... 27
4 Configuring Oracle Retail Xenvironment GUI ......................................................... 29
Overview ................................................................................................................................ 29
About this Chapter ........................................................................................................ 29
Oracle Retail Xenvironment UI Directory Structure and Contents ............................... 29
Subdirectory: <root_directory>\ui_config................................................................. 29
vi
Example................................................................................................................ 31
Message Structure .......................................................................................................... 32
SecurityConfig.xml ........................................................................................................ 32
Example................................................................................................................ 33
system.properties ........................................................................................................... 33
AlertsConfig.xml ............................................................................................................ 34
Example................................................................................................................ 35
MenuConfig.xml ............................................................................................................ 35
Context Configuration .................................................................................................. 35
Pop-up Menu Configuration ........................................................................................ 36
Menu Key Configuration .............................................................................................. 36
Example................................................................................................................ 39
PromptConfig.xml ......................................................................................................... 40
Example................................................................................................................ 40
DialogConfig.properties ............................................................................................... 41
Button Graphics ............................................................................................................. 41
Window Size and Location ........................................................................................... 42
Window Background .................................................................................................... 42
Button Type Configuration .......................................................................................... 43
FontConfig.xml .............................................................................................................. 44
Example................................................................................................................ 44
probescripts_{OS}.properties........................................................................................ 45
5 Oracle Retail Xenvironment Processing ................................................................. 47
Overview ................................................................................................................................ 47
About this Chapter ........................................................................................................ 47
Log Files ................................................................................................................................. 47
xenvironment.log ........................................................................................................... 47
Trickle Polling........................................................................................................................ 48
Uploads ........................................................................................................................... 48
Downloads ...................................................................................................................... 49
Deployment ........................................................................................................................... 49
The Store Close Process ........................................................................................................ 50
Packaging of Upload Files (Creating pospoll.zip) ..................................................... 51
File Archive Updates ..................................................................................................... 51
Archive Structure ........................................................................................................... 52
update.properties ........................................................................................................... 52
vii
Example................................................................................................................ 52
scripts............................................................................................................................... 52
Application Update Processing Example ................................................................... 53
Manual Closing Options ...................................................................................................... 54
Processing of Application Updates ............................................................................. 54
Processing of Cipher Files............................................................................................. 55
Processing of debit.txt File ............................................................................................ 55
6 Using Oracle Retail Xenvironment ........................................................................... 57
Overview ................................................................................................................................ 57
About this Chapter ........................................................................................................ 57
Starting Oracle Retail Xenvironment ................................................................................. 57
Graphical User Interface (GUI) ........................................................................................... 58
On-Screen Keyboard ..................................................................................................... 58
Features ........................................................................................................................... 59
In-Window Keyboard ................................................................................................... 59
Message Screen .............................................................................................................. 60
View Message Details.................................................................................................... 60
Clear Message................................................................................................................. 60
POS Status .............................................................................................................................. 61
Register Status ................................................................................................................ 61
Process Steps................................................................................................................... 62
Alert Detail...................................................................................................................... 62
Apps................................................................................................................................. 62
About ............................................................................................................................... 63
Systems Support/Attention ................................................................................................ 63
Menu Buttons ........................................................................................................................ 64
Status Bar................................................................................................................................ 65
Support Menu........................................................................................................................ 66
System Menu ......................................................................................................................... 67
Hotkeys .................................................................................................................................. 68
Password Protected Functions ..................................................................................... 69
Plugins .................................................................................................................................... 70
Run a Chain or Atom .................................................................................................... 70
Tech Support Menu ....................................................................................................... 71
Task List .......................................................................................................................... 71
Switch to Task ................................................................................................................ 72
Kill Task .......................................................................................................................... 73
View Marker Files .......................................................................................................... 73
System Information ....................................................................................................... 74
Overview......................................................................................................................... 74
List Services .................................................................................................................... 75
List Processes .................................................................................................................. 75
viii
ix
Does the structure of the information help you with your tasks?
Do you need different information or graphics? If so, where, and in what format?
If you find any errors or have any other suggestions for improvement, then please tell us
your name, the name of the company who has licensed our products, the title and part
number of the documentation and the chapter, section, and page number (if available).
Note: Before sending us your comments, you might like to
check that you have the latest version of the document and if
any concerns are already addressed. To do this, access the
Online Documentation available on the Oracle Technology
Network Web site. It contains the most current
Documentation Library plus all documents revised or
released recently.
Send your comments to us using the electronic mail address: retail-doc_us@oracle.com
Please give your name, address, electronic mail address, and telephone number
(optional).
If you need assistance with Oracle software, then please contact your support
representative or Oracle Support Services.
If you require training or instruction in using Oracle software, then please contact your
Oracle local office and inquire about our Oracle University offerings. A list of Oracle
offices is available on our Web site at www.oracle.com.
xi
Preface
Oracle Retail Xenvironment User Guide describes the installation, upgrade, and
configuration of Oracle Retail Xenvironment release 15.0.
Audience
This User Guide is intended for anyone responsible for the installation, upgrade, and
configuration of Oracle Retail Xenvironment 15.0.
Documentation Accessibility
For information about Oracle's commitment to accessibility, visit the Oracle Accessibility
Program website at
http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.
Customer Support
To contact Oracle Customer Support, access My Oracle Support at the following URL:
https://support.oracle.com
When contacting Customer Support, please provide the following:
xiii
Preface
An updated version of the applicable Oracle Retail document is indicated by Oracle part
number, as well as print date (month and year). An updated version uses the same part
number, with a higher-numbered suffix. For example, part number E123456-02 is an
updated version of a document with part number E123456-01.
If a more recent version of a document is available, that version supersedes all previous
versions.
(Data Model documents are not available through Oracle Technology Network. You can
obtain them through My Oracle Support.)
Conventions
The following text conventions are used in this document:
Convention
Navigate:
Note:
Important:
code
xiv
Meaning
This is a navigate statement. It tells you how to
get to the start of the procedure and ends with
a screen shot of the starting point and the
statement the Window Name window
opens.
This information is provided to improve your
understanding, simplify a task, or point out
special circumstances.
This information is important for the user to be
aware of. For example, information that can
help prevent the loss of data.
This is a code sample. It is used to
display examples of code.
1
Introduction
Overview
The main purpose for the Oracle Retail Xenvironment application consists of three
important functions:
The Oracle Retail Xenvironment application is installed on a POS register and provides a
communication link between the lead and non-lead registers. (See Responsibilities of
Both Lead and Non-Lead Registers.) An internal messaging framework enables Oracle
Retail Xenvironment to send messages between the Oracle Retail Xenvironment engine
and the Oracle Retail Xenvironment UI, between a lead register and non-lead registers,
and between Oracle Retail Xenvironment and the Dataserver.
The messaging framework also allows messages to be sent back and forth between
Oracle Retail Xenvironment and the Oracle Retail Xstore Point-of-Service POS
application. Thus, Oracle Retail Xstore Point of Service can notify Oracle Retail
Xenvironment, by Xstore, or remotely via HTTPS messaging. when a specific task must
be completed. For example, store closing processes handled by Oracle Retail
Xenvironment are started automatically when Oracle Retail Xstore Point of Service sends
a message through this communication link.
Chapter 2, Atoms and Chains provides information about atoms and chains, what
they do, how they are used, and how they are created and configured.
Chapter 3, Configuring the Oracle Retail Xenvironment describes the files and
directory structure for the Oracle Retail Xenvironment engine, and how they are
used in configuration.
Chapter 4, Configuring the Oracle Retail Xenvironment UI describes the files and
directory structure for the Oracle Retail Xenvironment UI, and how they are used in
configuration.
Chapter 6, Using Oracle Retail Xenvironment describes how to use Oracle Retail
Xenvironment. This includes a description of the UI and the screens and options
found in it.
Introduction
Appendix A: Appendix: The Close Process: Atom by Atom goes through each
atom and chain in the Close store chain, describing the actions performed by each
atom and chain.
Security
On a register running Oracle Retail Xenvironment, the user is restricted to only the tasks
that are displayed and available through Oracle Retail Xenvironment's graphical user
interface (GUI). The tasks that you make available can be configured to be run from onscreen buttons, keystrokes, and menus. All tasks can be password-protected to ensure
that only employees with the proper permission level can run security-restricted
commands.
TLS-Encrypted Communication
To ensure PCI compliance, Oracle Retail Xenvironment requires authenticated, TLSencrypted communications with Oracle Retail Xstore Point of Service and with other
systems running Oracle Retail Xenvironment. All systems must use TLS to communicate
with Oracle Retail Xenvironment 15.0.
User Interface
Oracle Retail Xenvironment uses a screen layout that is similar to Oracle Retail Xstore
Point of Service. Information is displayed in a focus bar, view port, and status bar.
Functions and actions can be performed through a row of menu buttons placed near the
bottom of the screen.
The Oracle Retail Xenvironment interface is intended to replace the default operating
system shell. Figure 1-1 shows the Start Screen of the Oracle Retail Xenvironment UI.
Please Note
POS Status
System Support/
System Attention
Menu Buttons
Notification Area/Process Status
Status Bar
Please Note: Displays messages and alerts from Oracle Retail Xstore Point of Service
and Oracle Retail Xenvironment.
Menu Buttons: A row of buttons that are used to perform functions available in
Oracle Retail Xenvironment. To use the buttons, either touch them on a touchscreen
monitor, click them with the mouse cursor, or press the associated shortcut key.
Functions and actions can also be performed through hotkeys.
Introduction
Status Bar: Displays information describing the register system, store location, and
updates from processes run by the user through Oracle Retail Xenvironment.
(see below).
For a description of Oracle Retail Xenvironment installation, see the Oracle Retail
Xstore Suite Implementation and Security Guide.
For more information about the directories created by the Base Oracle Retail
Xenvironment installation, see Base Oracle Retail Xenvironment Directory Structure
and Contents, Chapter 3.
For more information about the directories created by the Oracle Retail
Xenvironment GUI installation, see Oracle Retail Xenvironment UI Directory
Structure and Contents, Chapter 4.
Windows: c:\environment
Linux: /opt/environment
Windows: c:\updates
Linux: /opt/updates
When Oracle Retail Xenvironment receives this message, it assumes control and
processes the closing steps that are defined in a configuration file. These steps are
enumerated and described in The Store Close Process, Chapter 5.
Software Updates
Oracle Retail Xenvironment has a built-in framework that can be used to perform
software upgrades. The primary purpose of this framework is to upgrade the Oracle
Retail Xstore Point of Service and Oracle Retail Xstore Payment software. However, it can
also be used to upgrade other software packages, such as applying Windows service
packs. This process runs as part of the closing process.
Note: Once the upgrade packages are downloaded to each
Introduction
Description
start-xstore
shutdown-xstore
execute-dataloader
Initiates DataLoader.
commandprompt
Chain Name
Description
CLOSE_STORE
check-and-apply-updates
restore-nightly-db-backup
2
Atoms and Chains
Overview
Oracle Retail Xenvironment actions are defined in components called atoms and
chains. These two components are the basic units that contain the actions executed by
Oracle Retail Xenvironment.
Atoms and chains may be triggered by the GUI, or they may be triggered by Hotkey
operations. They can be invoked on a schedule, as part of a startup sequence, as part of
the closing sequence. They may also be used for remote execution.
Atoms - Describes what atoms are, what they do, and how to create and configure
them.
Chains - Describes what chains are, what they do, and how to create and configure
them.
Denymarkers - Describes what denymarkers are and how they are used.
Allowmarkers - Describes what allowmarkers are and how they are used.
Naming Rules
Atom and chain names can include the following characters:
Numbers (0-9)
Dashes (-)
Underscores (_)
Atoms
An atom is a single action that may be executed. An atom is a configurable component
that consists of a Java class (.class), any accompanying arguments, and any
configuration options. Atom configurations are found in the file actions.properties.
Example
The atom shown below starts the Oracle Retail Xstore Point-of-Service application:
atom.start-xstore.class=LaunchMaster
windows.atom.start-xstore.args=%{s:xstore.dir.root}/xstore.bat
linux.atom.start-xstore.args=%{s:xstore.dir.root}/xstore.sh
atom.start-xstore.hide=True
atom.start-xstore.wait=False
atom.start-xstore.disabled=%{b:xstore.disabled}
atom.start-xstore.cwd=%{s:xstore.dir.root}
windows.atom.start-xstore.windowtitle=Oracle Retail Xstore
Point of Service
windows.atom.start-xstore.windowclass=SunAwtDialog
Invoking the start-xstore atom calls the LaunchMaster function using an argument
that contains the complete path to a shell script. In the example above, the atom's name is
start-xstore, and the atom's class is LaunchMaster.
The atom's argument in Windows and Linux:
%{s:xstore.dir.root}/xstore.bat (Windows)
%{s:xstore.dir.root}/xstore.sh. (Linux)
In addition the class and arguments, several configuration options are set in this atom.
The hide attribute is set to True, the wait attribute is set to False, and so on. And, on
Windows only, the windowtitle and windowclass configurations are used to
determine if Oracle Retail Xstore Point of Service is running already and, if it is running,
switch to it.
Atom Aliases
Aliases can be assigned to atoms, allowing an atom to be used multiple times in a given
chain (each atom in a single chain must have a unique name), as well as provide
shortened or simplified atom references. Aliases may be set for frequently referenced
functions.
For example, the following line in actions.properties creates an alias
dataserver-backup-xstore-pre-poll that, when called, will run the atom
dataserver-oracle-backup-xstore-pre-poll, when database.platform is
set to a value of oracle.
alias.dataserver-backup-xstore-pre-poll.action=
dataserver-%{s:database.platform}-backup-xstore-pre-poll
Note: The rules for atom alias names are the same as those
Permit Times
Permit times configure the days and times of the week when an atom can start running.
The times configured are the only times when the atom can start.
Permitted start times for atoms are configured using the following format:
atom.name.permitted_start_times=<day_of_week>,<time>,<duration
>[;...]
The first three letters of the day of the week being configured (all lower-case), for
example sun, mon, tue, wed, thu, fri, or sat.
An asterisk (*) indicating that all the days of the week are being configured.
<time> - The time of day the time period starts (in 24-hour clock).
[;...] - Use semicolons to separate additional day(s) of the week, time(s), and
duration(s) to the permit time period.
Disallow Times
Disallow times configure the days and times of the week when an atom cannot start
running. Atoms cannot start within the times configured.
Disallowed start times for atoms are configured using the following format:
atom.name.permitted_start_times=!<day_of_week>,<time>,<duratio
n>[;...]
! - Include this NOT symbol to set times when the atom will NOT run.
The first three letters of the day of the week being configured (all lower-case).
An asterisk (*) indicating that all the days of the week are being configured.
<time> - The time of day the time period starts (in 24-hour clock).
[;...] - Use semicolons to separate additional day(s) of the week, time(s), and
duration(s) to the disallow time period.
Example #1
atom.example1.permitted_start_times=*,19:00,3
The example1 atom can start running at any time between 7:00 PM and 10:00 PM on any
day of the week.
Example #2
atom.example2.permitted_start_times=wed,4:00,3;thu,22:00,4
The example2 atom can start running at any time between 4:00 AM and 7:00 AM on
Wednesday, or any time between 10:00 PM Thursday and 2:00 AM Friday.
Example #3
atom.example3.permitted_start_times=!*,8:00,12
The example3 atom cannot start running at any time between 8:00 AM and 8:00 PM on
any day of the week.
In other words, the atom CAN start running at any time between 8:00 PM and 8:00 AM.
Example #4
atom.example4.permitted_start_times=!sat,19:00,3;!sun,19:00
,5
The example4 atom cannot start running at any time between 7:00 PM and midnight on
either Saturday or Sunday.
In other words, the atom CAN start running at any time Monday through Friday, or
anytime between 12:00 AM and 7:00 PM on either Saturday or Sunday.
Creating Atoms
It may be necessary to create a custom action to accomplish a task. You may configure a
new atom in the file actions.properties (see actions.properties, Chapter 3) by
following these steps:
1.
10
Assign the atom to a class. Refer to Table 2-1: Common Classes for Creating
Custom Atoms for Class detail.
2.
Determine the atom's required set of arguments. For information about the
arguments for each class, refer to Table 2-1: Common Classes for Creating Custom
Atoms below.
3.
Within the actions.properties, add the atom using the correct prefix (atom.)
and suffix (.class and .args):
atom.theAtomName.class=
atom.theAtomName.args=
Description
LaunchMaster
CopyFiles
This class is used to copy files from one location in the file
system to another.
Additional configurations:
MakeDirectory
Class
Description
MoveFiles
RemoveFiles
12
Class
Description
RotateFiles
Unzip
Class
Description
Zip
LaunchMaster Configurations
The LaunchMaster class includes several important configurations, such as how an atom
is executed, the options used in its execution, and what LaunchMaster should do if there
are errors. The LaunchMaster class has the following configuration options:
14
.cwd - Sets the current working directory used by the script during execution.
.drsafe - [True/False] Determines whether the atom can be run while the
system is in disaster recovery mode. Only atoms with this configuration set to True
can run while the system is in disaster recover mode.
If set to True, the return value from the command is used. A value of 0 or 99
indicates successful execution and 20 indicates a warning; any other value
indicates an error.
If set to False, a return value of 0 indicates successful execution; any other value
is an error.
.xname - Displays a status message in Oracle Retail Xstore Point of Service. This
configuration applies to all atoms and chains.
.xcode - Displays a status message in Oracle Retail Xstore Point of Service. This
configuration applies to all atoms and chains.
Chains
A chain is a component that includes multiple atoms or chains, each of which is an
action, and is listed in the sequence in which it should be performed. Chain
configurations are found in the actions.properties file (see actions.properties,
Chapter 3).
Example
This chain checks for updates and applies them:
lead.chain.trickle-polling.atoms=unzip-uploaded-tricklepackages
create-final-trickle-polling-package poll-trickle
process-pre48-trickle-downloads execute-dataloader-trickle
The lead keyword at the start of the chain limits this chain to only run on the lead
register. If the chain only runs on nonlead registers, the chain would start with the
nonlead keyword. Chains that run on both lead and nonlead registers do not specify
either lead or nonlead.
In the example above, the chains name is trickle-polling and it executes the atoms
in the order that they are listed:
1.
2.
3.
4.
5.
chain.<chain_name>.<insertbefore/insertafter>.<atom_name>=<new
_atom> [<new_atom2> ...]
Multiple new atoms and chains can be inserted in the same location in a chain by listing
multiple, space-separated atoms.
Example
In this example, there is a chain named example. Its default configuration consists of the
atoms atom1, atom2,and atom3. The configuration of this chain would be the
following:
chain.example.atoms=atom1 atom2 atom3
Three atoms are to be added to the chain: begin,stop, and pause.
1.
To insert the atom begin to the start of the chain, add the following configuration to
the cust_config/version1/actions.properties file:
chain.example.insertbefore.atom1=begin
2.
The following configuration inserts the atom stop at the end of the chain:
chain.example.insertafter.atom3=stop
3.
Either of the following configurations will insert the atoms pause and resume
between atom1 and atom2:
chain.example.insertafter.atom1=pause resume
-ORchain.example.insertbefore.atom2=pause resume
When the three configurations above are made, the chain will now be equivalent to the
following (note that the following line will not actually appear in any file):
chain.example.atoms=begin atom1 pause resume atom2 atom3
stop
Creating Chains
If you need to combine multiple atoms into a new chain, follow these steps:
1.
Give the chain a unique name, such as my-new-chain. To avoid possible future
collision, include a unique prefix, like the retailer ID.
2.
Identify the atoms and/or chains that will be included in the chain. Enter each atom
or chain in the order that it will be executed and separate it with a space from the
others. For example:
atom1 atom2 chain3 atom4
3.
Enter the chain into the file actions.properties with the required chain prefix
(chain.) and suffix (.atoms).
For example:
chain.my-new-chain.atoms=atom1 atom2 chain3 atom4
Note: The atoms= and chains= lists are no longer
16
Denymarkers
Denymarkers are used to prevent a chain or atom from running. If a denymarker is set
for a chain or atom, the chain or atom will not run if the marker file exists in the marker
directory (see Subdirectory: <root_directory>\marker, Chapter 3 for more
information).
For example, if the following line exists in the actions.properties file:
chain.CLOSE_STORE.denymarkers=close.err
the chain CLOSE_STORE will not run if the marker file close.err exists in the marker
directory.
Wildcard characters are allowed. Space-separated lists of filenames can be used to
indicate multiple possible filenames. For example, if the following line exists in the
actions.properties file:
atom.start-xstore-auto.denymarkers=*.err *.wrn
xstore.running
the atom start-xstore-auto will not run if any file ending in either .err or .wrn
exists in the marker directory, or if the file xstore.running exists in the marker
directory.
Allowmarkers
Allowmarkers are used to control whether a chain or atom can be run. If an allowmarker
is set for a chain or atom, the chain or atom will only run if the marker file exists in the
marker directory (see Subdirectory: <root_directory>\marker, Chapter 3 for more
information).
For example, if the following line exists in the actions.properties file:
chain.CLOSE_STORE.allowmarkers=close.ready
the atom CLOSE_STORE will not run unless the marker file close.ready exists in the
marker directory.
Wildcard characters are allowed. Space-separated lists of filenames can be used to
indicate multiple required files. For example, if the following line exists in the
actions.properties file:
atom.start-xstore-auto.allowmarkers=*.xst *.dta
xstore.installed
the atom start-xstore-auto would only run if at least one file ending in .xst, at
least one file ending in .dta, and the file xstore.installed exist in the marker
directory.
18
3
Configuring the Oracle Retail Xenvironment
Engine
Overview
This chapter describes the files used to configure the Oracle Retail Xenvironment engine.
This includes information about the directories and files used in configuration, the
content of those directories and files, and how configuration is performed.
Important: This chapter should only be used by customers
Base Oracle Retail Xenvironment Directory Structure and Contents describes the
directory structure used by Oracle Retail Xenvironment.
Configuring the Oracle Retail Xenvironment Engine explains how Oracle Retail
Xenvironment is configured for customers.
Subdirectory: <root_directory>\bin
This directory contains the native binaries used by Oracle Retail Xenvironment.
Subdirectory: <root_directory>\cust_config\version1
Configuration files containing customer-specific updates to the files in the
<root_directory>\config directory. Any configurations entered into files in this
directory override the configurations in the files in the <root_directory>\config
directory. All overrides are performed on a setting-by-setting basis, not a file-by-file
basis.
Subdirectory: <root_directory>\res\data
This directory stores .dat files containing details about updates that have been
processed, and one .dat file that tracks registration information. These files are accessed
during the update process. In some cases, additional subdirectories may be created in
this directory to store files or database backups.
Subdirectory: <root_directory>\download
This directory is used as a location for registers to place files that have been copied from
other registers. For example, when the Lead Register is preparing the PosLog files, it
copies them from each register to the directory <root_directory>\download\tmp
and then prepares the polling upload file(s).
Subdirectory: <root_directory>\ext
This directory contains miscellaneous shell and binary files. Directly under
<root_directory>\ext are shell scripts invoked by Oracle Retail Xenvironment
actions.
Within this directory is the subdirectory <root_directory>\ext\win32\util (on Windows)
or <root_directory>\ext\win32\util (on Linux). This subdirectory contains
binary files, most of which are troubleshooting and/or support tools.
Subdirectory: <root_directory>\log
This subdirectory contains the log files produced by the Oracle Retail Xenvironment
application.
Subdirectory: <root_directory>\marker
This directory is used for marker files. A marker file provides a way for a register to
flag (i.e. indicate) the status of a currently running process. One important marker file
is SYSCLOSE.XST, which is created on the Lead Register when the closing process is
running.
Subdirectory: <root_directory>\poll
This directory is used to include additional files in the pospoll package. Oracle Retail
Xenvironment automatically copies files here for inclusion in the polling package, and
any additional files added to this directory will also be included in the package. This
directory also contains a trickle/ folder that is used for trickle polling.
Subdirectory: <root_directory>\res\ssl
This directory contains the TLS certificates.
20
Subdirectory: <root_directory>\support
This directory contains packages generated by the capture logs function.
Subdirectory: <root_directory>\tmp
This directory contains temporary files used by Oracle Retail Xenvironment.
Subdirectory: <root_directory>\wwwroot
This directory is used with the web server. It is the root directory for any child folders
to be made available for download through HTTPS.
environment.properties
The environment.properties file defines the following properties used by Oracle
Retail Xenvironment:
Available Roles - Defines the names of the roles to which registers can be assigned.
Environment Variables - Defines paths used internally to locate certain files needed
for specific tasks in Oracle Retail Xenvironment.
Root Directory - Indicates the root directory where Oracle Retail Xenvironment was
installed.
Marker File Variables - Defines the names and paths for marker files used by Oracle
Retail Xenvironment.
Zip File Database Configurations - Defines the names and paths of files in .zip
format that are used during various operations.
Operating System Options - Sets configuration options that affect the operating
system and the users ability to interact with it.
POS Options - Configures properties that are specific to the point-of-sale software
running on the local register.
Hostname for Registration - Forces a specific hostname for registration (this should
only be used in the rare case that the engine is unable to get the correct hostname).
IPC Ports - Determines the default network ports used by Oracle Retail
Xenvironment client and server functions.
Broadcast Markers - Defines marker files that are broadcast from any register to any
other register in the store (by default, the only file broadcast is the close.err
marker, which is created in the lead register). For more information about marker
files, see Denymarkers, Chapter 2 and Allowmarkers, Chapter 2.
marker.pollok: the directory and file used to flag the closing process and indicate
that polling has been completed.
Example:
marker.reboot=%{s:environment.dir.root}/marker/ reboot.xst
(The space after /marker/ is intentional and must be included.)
pos.dir.download: the destination directory for the update files that are distributed
to non-lead registers by the polling service.
Example:
pos.dir.download.src=%{s:xstore.dir.root}/download/
pos.dir.db: the directory for the database data file(s) and/or database directory.
Example:
windows.pos.dir.db=c:/xstoredb
local.properties
This file configures register information for Oracle Retail Xenvironment. This
configuration file contains the following settings:
1.
Register settings - properties defining the register, its connections to other systems,
and whether the system is a lead or non-lead register.
2.
System settings - properties indicating whether the database is disabled and whether
Oracle Retail Xstore Point of Service is present on the register.
If a customized version of Oracle Retail Xstore Point of Service is installed, this file must
be configured out of the box. Automated installation methods are available to
customers, but if this file must be configured manually, you must perform RegisterSpecific Configurations and System Configurations.
22
Register-Specific Configurations
Note:
System Configurations
database.disabled - Whether the database is disabled on the local system. When set
to True, database-related functionality is disabled. Defaults to False if not specified.
Example:
database.disabled=False
poll1.disabled - Whether Oracle Retail Xenvironment will wait for the pollok.xst
marker file to exist during the close process and, when it does, execute any steps
related to the first polling session; this includes the CLOSE1 section of the
poll.bat/poll.sh file.
Example:
poll1.disabled=False
24
actions.properties
The actions.properties file contains definitions of both atoms and chains.
An atom is an internal function that Oracle Retail Xenvironment can invoke. A chain is a
list of atoms that are executed sequentially to perform a task. For example, there is a
chain to perform the startup process in Oracle Retail Xenvironment and a chain to
perform the close process. See Atoms and Chains, Chapter 2 for more information
about atoms and chains.
When an atom is added to the actions.properties file, the associated class must be
defined, including any parameters or arguments required by the atom. An example of an
atom definition in the actions.properties file follows. This atom checks to see if
there are any new updates:
atom.check-and-download-updates.class=CheckUpdates
atom.check-and-download-updates.errmarker=check-and-downloadupdates.err
atom.check-and-download-updates.disabled=%{b:updates.disabled}
alerts.properties
The alerts.properties file determines which files are used to store alerts. The alerts
can be either errors or warnings. The internal name for the type of alert is assigned to
each associated file. For example, the following configuration indicates that
errClosingFailure alerts will be sent to the CLOSE.ERR file:
CLOSE.ERR=errClosingFailure
update.properties
Oracle Retail Xenvironment is responsible for distributing software upgrades. Normal
upgrades are downloaded from the home office and performed during the store closing
process. The file update.properties is used by Oracle Retail Xenvironment on all
registers (lead and non-lead) to determine when the upgrade files are made available for
download, and the local destination directories used to store the files.
The Oracle Retail Xenvironment application running on the Lead Register is responsible
for recognizing that new files have been downloaded from the home office. When files
are found, the Lead Register makes the files available to all non-lead registers for
downloading. Therefore, the Lead Register acts as the file producer, while the non-lead
registers act as consumers.
As a consumer, each register is responsible for sending a request to the Lead Register to
determine whether update files are available. The file update.properties is used by
the non-lead register to determine where to send these requests.
Each RSS feed used for file distribution is configured using the following format:
rss.category.<feedname>.<property>
where:
<feedname> is the name of the feed. This can be one of the following values:
<property> is the property being set for the feed. This can be one of the following
values:
filter: Specifies the naming convention of the download files that belong to a
specific download category. A filter value must be defined for each
<feedname>.
For example:
rss.category.jre.filter=^.*-jre-.*-.*\\.zip$
web_location: Determines the directory on the web server URL that Oracle
Retail Xenvironment will check for updates on the feed.
For example, using the configuration:
rss.category.cipher.web_location=/updates/cipher
And a webserver name of <hostname>, Oracle Retail Xenvironment will check
for updates at the URL https://<hostname>:9096/updates/cipher.
ready_marker: Determines the path and filename of the marker file that is used
to indicate that a software upgrade is ready for processing. The marker file is
used to prevent multiple worker threads from processing the same software
upgrade more than once.
For example:
rss.category.debitbin.ready_marker=
%{s:rss.category.debitbin.source_directory}/update.ok
26
For example:
rss.category.cipher.destination_directory=
%{s:xstore.dir.root}/res/keys
version.properties
This file, located in the Oracle Retail Xenvironment root directory, contains application
version number information used by Oracle Retail Xenvironment during bootup. This
file is changed when Oracle Retail Xenvironment is updated.
28
4
Configuring Oracle Retail Xenvironment GUI
Overview
This chapter describes the files used to configure the Oracle Retail Xenvironment GUI.
This includes information about the directories and files used in configuration, the
content of those directories and files, and how configuration is performed.
Important: This chapter should only be used by customers
Configuring the Oracle Retail Xenvironment UI explains how the Oracle Retail
Xenvironment UI is configured for customers.
Subdirectory: <root_directory>\ui_config
This subdirectory contains all of the default configurations for the Oracle Retail
Xenvironment UI.
Subdirectory: <root_directory>\ui_cust_config
Configuration files containing customer-specific updates to the files in the
<root_directory>\ui_config directory. Any configurations entered into files in
this directory override the configurations in the files in the
<root_directory>\ui_config directory.
Overrides can only be performed on some of the files in the
<root_directory>\ui_config directory, not all of them.
AppServices.properties
This file determines which GUI application services are available in Oracle Retail
Xenvironment. Each setting takes the form of ServiceName.PLATFORM=true/false,
where:
For example:
TaskSchedulerService.WINDOWS=true
SystemLogMonitorService.LINUX=false
Note: When changing the application services availability,
ContextConfig.xml
This file defines Contexts in Oracle Retail Xenvironment. These Contexts determine the
configurations for the different Oracle Retail Xenvironment screens.
IPCClientConfig.xml
This file defines the IPC messages sent to the Oracle Retail Xenvironment engine from
the Oracle Retail Xenvironment GUI. These messages are used by the Oracle Retail
Xenvironment GUI to communicate with the Oracle Retail Xenvironment engine. All IPC
messages configurations are defined within the
<IPCClientConfigs> element.
The <IPCClientConfigs> element contains the following elements and attributes:
30
<message> - This element contains the message that is sent. This message must
be contained within a CDATA section to prevent parsing by the local XML
parser. For a sample IPC message, see Message Structure.
Example
<IPCClientConfigs xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
<client_config servicename="PythonInitialization"
address="https://127.0.0.1" port="9096"
extension="/gui/pyinit"
enabled="true">
<message>
<![CDATA[<ns0:Envelope
xmlns:ns0="http://schemas.xmlsoap.org/soap/envelope/"><ns0:Header
><xhead><msg_id>0001</msg_id><msg_type>IPCRequest</msg_type><dest
ination>SERVER</destination><priority>1</priority><source>POS</so
urce><create_timestamp
/><charset>850</charset></xhead></ns0:Header><ns0:Body><methodCal
l><methodName>Initialize</methodName><params><param><name>Initial
ize</name><value>Initialize</value></param></params></methodCall>
</ns0:Body></ns0:Envelope>]]>
</message>
</client_config>
...
</IPCClientConfigs>
Message Structure
The message information contained in a <message> elements CDATA section consists
almost entirely of standard formatting information. The information that must be
configured is highlighted in the following structure example:
<ns0:Envelope xmlns:ns0="http://schemas.xmlsoap.org/soap/envelope/">
<ns0:Header>
<xhead>
<msg_id>0001</msg_id>
<msg_type>IPCRequest</msg_type>
<destination>SERVER</destination>
<priority>1</priority>
<source>POS</source>
<create_timestamp />
<charset>850</charset>
</xhead>
</ns0:Header>
<ns0:Body>
<methodCall>
<methodName>ATOM_NAME</methodName>
<params>
<param>
<name>PARAMETER_NAME</name>
<value>PARAMETER_VALUE</value>
</param>
</params>
</methodCall>
</ns0:Body>
</ns0:Envelope>
In the example above,
one <param> element for each parameter to be sent to the atom (containing
<name> and <value> subelements) must be included within the parent <params>
element.
all the other information in the formatting sample is static and must be included in
the message as shown above.
SecurityConfig.xml
This file defines the security configurations for the Oracle Retail Xenvironment GUI. Each
security configuration has the following elements:
32
<passwordPrompt> - The translation key for the prompt displayed when the
security configuration is called.
Example
<SecurityConfigs xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
<SecurityConfig>
<type>SYSTEM_PASSWORD</type>
<classname>dtv.env.security.validate.SystemPasswordValidator
</classname>
<passwordPrompt>_systemPasswordPrompt</passwordPrompt>
<failMessageKey>_systemPasswordInvalid</failMessageKey>
<encrypted_formula decrypter="Encrypter" />
<interactive>true</interactive>
</SecurityConfig>
...
</SecurityConfigs>
system.properties
The UI version of the system.properties files defines system information, display
information, and general configurations used by the Oracle Retail Xenvironment UI.
The most commonly used configurations in the system.properties file are listed
below.
Note: If you need to make changes to any configuration not
Format.Time - The format of the time. This configuration has the following options:
Format.Date - The format of the date. This configuration has the following options:
yyyy-MM-dd - [DEFAULT]
Frame.Width - The width of the frame in pixels. Only used if the style is set to
CENTERED or POSITIONED.
[DEFAULT] - 1024
Frame.Height - The height of the frame in pixels. Only used if the style is set to
CENTERED or POSITIONED.
[DEFAULT] - 768
Frame.X - The x-coordinate location of the top-left corner of the frame, where 0 is the
left corner of the screen. Only used if the style is set to POSITIONED.
[DEFAULT] - 0
Frame.Y - The y-coordinate location of the top-left corner of the frame, where 0 is the
top of the screen. Only used of the style is set to POSITIONED.
[DEFAULT] - 0
HideMouse - Indicates whether the mouse cursor is displayed or hidden off of the
screen.
Locale.Country - The two-letter ISO-3166 country code for the location of the system.
[DEFAULT] - US
AlertsConfig.xml
The alerts displayed in the Oracle Retail Xenvironment UI are configured in the
AlertsConfig.xml file. Each alert has the following elements:
34
Example
<Alerts xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
<alert>
<alert_key>ALERT_UNDEFINED</alert_key>
<main_msg_key>_ALERT_UNDEFINED</main_msg_key>
<sub_msg_key>_blank</sub_msg_key>
<priority>1</priority>
<action></action>
<prompt_key>SYSTEM_ERROR</prompt_key>
<bring_ui_to_foreground>false</bring_ui_to_foreground>
</alert>
...
</Alerts>
MenuConfig.xml
The MenuConfig.xml file determines the configuration of the menus displayed in each
Context in the Oracle Retail Xenvironment UI.
The MenuConfig.xml file contains four sections that configure different portions of the
interface.
Context Configuration - Configures the buttons along the bottom of the Oracle
Retail Xenvironment UI for each Context in the application.
Menu Key Configuration - Configures the buttons that are referenced by the
Context Configuration, Hotkey Registration, and Pop-up Menu Configuration
sections.
Context Configuration
In Oracle Retail Xenvironment, the buttons along the bottom of the main UI change
depending upon the current context of the application. All the context configurations are
contained within the <ApplicationContext> element.
The <ApplicationContext> element contains the following elements and attributes:
<Context> - This element defines the set of configurations for one context.
id - This attribute defines the identifier used to refer to the context configuration.
roleid - This attribute determines the Role ID that a user must be assigned to access
the context. A Role ID of EVERYONE allows all users to access the context.
osType - This attributes determines the operating system in which the context is
available.
<PopupMenu> - This element defines the set of configurations for one pop-up
window.
name - This attributes defines the name used to refer to the pop-up window.
osType - This attribute determines the operating system on which the pop-up
window is displayed. A value of ALL indicates that the pop-up window is available
on all operating systems.
<MenuKey> - This element defines one menu key in Oracle Retail Xenvironment.
name - This attribute defines the name used to refer to the Menu Key.
keyFunction - This attribute determines the translation key displayed on the Menu
Key.
keyLabel - This attribute defines the translation key displayed on the Menu Key or
Menu Option (if on a menu).
style - This attributes defines either the style of the button (if appsMenu is not set,
or is set to false) or the image file used as an icon (if appsMenu is set to true).
keyEventCode - This attribute defines the Java KeyEvent that selects the Menu Key.
keyMaskCTRL - If this attribute is set to true, it indicates that the [CTRL] key must
be pressedalong with the keyEventCodeto activate the Menu Key (used only for
hotkeys). This can be used in conjunction with the keyMaskALT and keyMaskSHIFT
attributes to create multiple-key hotkey combinations.
36
keyMaskALT - If this attribute is set to true, it indicates that the [ALT] key must
be pressedalong with the keyEventCodeto activate the Menu Key (used only
for hotkeys). This can be used in conjunction with the keyMaskCTRL and
keyMaskSHIFT attributes to create multiple-key hotkey combinations.
keyMaskSHIFT - If this attribute is set to true, it indicates that the [SHIFT] key
must be pressedalong with the keyEventCodeto activate the Menu Key (used
only for hotkeys). This can be used in conjunction with the keyMaskCTRL and
keyMaskALT attributes to create multiple-key hotkey combinations.
PromptConfirm - This attribute indicates whether a confirmation prompt is
displayed after selecting the Menu Key. If this attribute is set to true, Oracle Retail
Xenvironment will display a confirmation prompt ([DEFAULT] = false).
PromptConfirmMessageKey - This attribute defines the translation key displayed
in the confirmation prompt after selecting the Menu Key. This attribute is only valid
if PromptConfirm is set to true.
PromptPassword - This attribute indicates whether a password prompt is
displayed after selecting the Menu Key and, if PromptConfirm is set to true, after
the confirmation prompt. If this attribute is set to true, Oracle Retail Xenvironment
will prompt for a password ([DEFAULT] = false).
PromptPasswordStyle - This attribute refers to the password that must be entered
in the password prompt (see SecurityConfig.xml for more information). This
attribute is only valid if PromptPassword is set to true.
ActionCommand - This attribute determines the type of action that is run when the
Menu Key is selected. This attribute has the following possible values:
ALERT_DELETE - Deletes the alert currently in focus from the alert list.
IPC_RUN - Opens a dialog window that prompts the user to enter the name of an
atom or chain for Oracle Retail Xenvironment to run.
Run - This attribute determines the action performed by the Menu Key. The action is
of the type defined by the ActionCommand attribute. For example, if
ActionCommand=IPC_ATOM, the Run attribute contains the name of the atom or
chain that is run. If ActionCommand=EXECUTE, Run contains the executable file
that is run.
Run.Arguments - This attribute defines the list of arguments that are sent to the
command defined by the Run attribute.
Wait.Millis - This attribute defines the number of milliseconds after running the
command that Oracle Retail Xenvironment will display the Please Wait message.
osType - This attribute determines the operating system in which the Menu Key is
available. A value of ALL indicates that the Menu Key is available on all operating
systems.
touchScreenOnly - This attribute determines whether the Menu Key is only
displayed on touchscreen systems, or if the Menu Key is displayed on all systems.
This attribute has the following possible values:
appsMenu - This attribute determines whether the Menu Key is displayed in the
Apps area (see Apps, Chapter 6) or on the row of buttons (see Menu Buttons,
Chapter 6). This attribute has the following possible values:
<Roles> - This element contains a list of all the roles that are permitted to use
this Menu Key.
<Role> - Determines one role that has permission to use the Menu Key.
id - The ID for the Role that has permission to use the Menu Key. A value of
ALL gives access permission to every role.
38
Example
<Menu dtype="BodyPanel"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="MenuConfig.xsd"
Debug.Outline="false">
<Application_Context>
<Context id="MAIN_CONTEXT" roleid="EVERYONE" osType="ALL">
<ActionKey menukey="VK_ESCAPE" sortOrder="1" />
<ActionKey menukey="VK_F1_BLANK" sortOrder="2" />
<ActionKey menukey="VK_F2" sortOrder="3" />
<ActionKey menukey="VK_F3" sortOrder="4" />
<ActionKey menukey="VK_F4_BLANK" sortOrder="5" />
<ActionKey menukey="VK_F5_BLANK" sortOrder="6" />
<ActionKey menukey="VK_F6_BLANK" sortOrder="7" />
...
</Context>
...
</Application_Context>
<!-- THIS SECTION IS NOT CUST_CONFIG OVERRIDABLE -->
<HotKeysRegistered>
<HotKey name="HOTKEY_CMD" osType="ALL"/>
<HotKey name="HOTKEY_BRING_TO_FRONT" osType="ALL"/>
...
</HotKeysRegistered>
<PopupMenus>
<PopupMenu name="SupportMenu" osType="ALL">
<PopupMenuKey name="SUPPORT_MENU_STOP_XSTORE"
sortOrder="1"/>
<PopupMenuKey name="SYSTEMMENULOGOFF" sortOrder="2" />
<PopupMenuKey name="SYSTEMMENUSHUTDOWN" sortOrder="3" />
<PopupMenuKey name="SYSTEMMENUREBOOT" sortOrder="4" />
</PopupMenu>
...
</PopupMenus>
<MenuKeys>
<MenuKey name="SUPPORT_MENU_STOP_XSTORE" keyFunction="_blank"
keyLabel="_supportMenuStopXstore" style="NORMAL"
keyEventCode="KeyEvent.VK_UNDEFINED" keyMaskCTRL="FALSE"
keyMaskALT="TRUE" keyMaskSHIFT="FALSE" PromptConfirm="true"
PromptConfirmMessageKey="_confirmRunShutdownXstore"
PromptPassword="true" PromptPasswordStyle="SYSTEM_PASSWORD"
ActionCommand="IPC_ATOM" Run="shutdown-xstore"
Run.Arguments=""
Wait.Millis="1800" osType="ALL">
<Roles>
<Role id="EVERYONE" />
</Roles>
</MenuKey>
<MenuKey osType="ALL" name="APPS_SYSTEM_INFO"
touchScreenOnly="false" ActionCommand="SYSTEM_INFO"
style="res/graphics/appsinfopanel/apps-info.png"
keyLabel="_SystemInfoTouch" keyFunction="_blank"
Run.Arguments=""
Run="" PromptPasswordStyle="SYSTEM_PASSWORD"
PromptPassword="true"
PromptConfirmMessageKey="_blank" PromptConfirm="false"
KeyEventCode="KeyEvent.VK_UNDEFINED" appsMenu="true">
<Roles>
<Role id="EVERYONE"/>
</Roles>
</MenuKey>
...
</MenuKeys>
</Menu>
PromptConfig.xml
The PromptConfig.xml file defines the UI Prompt windows. Each prompt has the
following elements:
<key> - This element defines the key used to identify the Prompt.
<type> - This element determines the style of the Prompt window. This element
has the following possible values:
<watermark> - Contains the path and filename used to locate the watermark
file used in the background of the Prompt.
<majorMsgKey> - Contains the translation key used for the Prompts message.
Example
<PromptConfig xmlns:xsi="http://www.w3.org/2001/XMLSchemainstance">
<Prompts>
<Prompt>
<key>BLANK</key>
<type>ANNOUNCE_FOCUSBAR</type>
<watermark>res/graphics/bgpanels/iconquestion.png</watermark>
<title>_focusbarTitle</title>
<majorMsgKey>_blank</majorMsgKey>
</Prompt>
...
</Prompts>
</PromptConfig>
40
DialogConfig.properties
The DialogConfig.properties file defines window and button configurations
Oracle Retail Xenvironment dialog windows. For example, the
DialogConfig.properties configures the Cancel, Continue, Yes, and No buttons:
Button Graphics
The button graphics used for all buttons are determined by the following configurations:
Button.Normal.Icon=<normal_button_image>
Button.Disabled.Icon=<disabled_button_image>
Button.Pressed.Icon=<pressed_button_image>
Dialog.X determines the location of the window along the screens width and
<window_x_location> is replaced by the number of pixels from the upper left
corner of the screen to the upper left corner of the window.
If this configuration is not set, the dialog window will be centered in the screen.
Dialog.Y determines the location of the window along the screens height and
<window_y_location> is replaced by the number of pixels from the upper left
corner of the screen to the upper left corner of the window.
If this configuration is not set, the dialog window will be centered in the screen.
Window Background
The background of the window is determined by the following configuration:
Body.BG.Icon=<background_image>
where Body.BG.Icon determines the image used as the window background and
<background_image> is replaced by the directory and filename of the image
displayed.
42
confirmAgree is the name of the key. In this case, it is the Yes button that is used
by the Confirmation Prompt window (Figure 4-2: Confirmation)
keyEventCode indicates that it is configuring the keyboard action that selects that
button (in addition to clicking on the button with the mouse or touching the button
on a touchscreen).
KeyEvent.VK_Y defines the event that selects that button. In this case, it is pressing
the [Y] key. This key is displayed in the lower-left corner of the button.
This option is commonly changed for internationalization purposes. For example, on
a French system, this option would be changed to KeyEvent.VK_O for Oui.
.keyFunction - The translation key displayed in the lower-left corner of the button.
.keyEventCode - The keyboard action that selects that button. It must be one of the
valid, Java-enumerated key events
FontConfig.xml
The FontConfig.xml file configures Font styles for use by the Oracle Retail
Xenvironment UI. Each
Font style has the following element and attributes:
<Font> - This element delineates one Font style configuration. This element has the
following attributes:
name - This attribute defines the name used by the Oracle Retail Xenvironment
UI to refer to this Font style.
family - This attribute defines the font family used by the Font style. This
attribute has the following possible configuration values:
style - The type of font in the Font style. This attribute has the following possible
configuration values:
Example
<Fonts dtype="BodyPanel"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:noNamespaceSchemaLocation="FontConfig.xsd">
<Font name="XENV_SMALL" family="SansSerif" style="Bold"
size="12" />
<Font name="XENV_PLUGIN_UTILS" family="Monospaced"
style="Normal"
size="12" />
<Font name="XENV_VERSION_DIALOG_TITLE" family="Arial"
size="20" />
...
</Fonts>
44
probescripts_{OS}.properties
These files are used to retrieve information displayed in the System Information screen.
For more information about these configurations, or if you need help changing these
files, speak with your Oracle product representative.
46
5
Oracle Retail Xenvironment Processing
Overview
This chapter describes how Oracle Retail Xenvironment processes files during regular
operation, and during the close process.
Log Files describes the xenvironment.log file and the type of information it
contains.
Trickle Polling describes the trickle polling process and its actions.
The Store Close Process provides a general overview of the actions performed
during a nightly store closing procedure.
Manual Closing Options explains how to perform closing tasks manually, rather
than allowing the automated process to perform them.
Log Files
Oracle Retail Xenvironment generates the following two log files:
xenvironment.log
xenvironment-ui.log
All log entries show their logging levels. This helps users determine the logging level that
should be configured for Oracle Retail Xenvironment.
xenvironment.log
The main log file is xenvironment.log. Very little happens in Oracle Retail
Xenvironment without some part of it being logged here.
To locate an event in xenvironment.log, first navigate to the approximate date/time
of the event that you want to find. After you find the date/time, search for the name of
the atom in question. When an atom is executed, one of several possible action codes will
be generated and shown in the log.
SUCCESS:
For example:
INFO 2015-12-02 10:46:41,313 [ActEx-630296533] [Atom] Action
[CheckUpdates ::
oracle.retail.xenvironment.atoms.update.CheckUpdates]
complete. State: SUCCESS, Result: Downloaded updates
successfully. ::
oracle.retail.xenvironment.atoms.Atom.runAtom(Atom.java:106)
INFO 2015-12-02 10:46:41,315 [ActEx-630296533]
[onRouter$1ActionExecutor] Action [check-and-download-updates]
returned state [SUCCESS] with message [Downloaded updates
successfully.] ::
oracle.retail.xenvironment.action.ActionRouter$1ActionExecutor
.run(ActionRouter.java:92)
BYPASS:
For example:
INFO 2015-12-02 10:54:02,927 [ActEx-630296533]
[onRouter$1ActionExecutor] Action [bypass-if-no-updates-toapply] returned state [BYPASS] with message [Did not find any
matching files.] ::
oracle.retail.xenvironment.action.ActionRouter$1ActionExecutor
.run(ActionRouter.java:92)
Note: The BYPASS return value indicates that the atom
WARNING:
For example:
INFO 2015-11-24 14:35:04,771 [ActEx-891328242]
[onRouter$1ActionExecutor] Action [cleanup-reboot-postclosemarker] returned state [WARNING] with message [Marker file
/Users/dandrzejewski/dev/EclipseWorkspaces/NewEngine/xenvironm
ent/marker/reboot-postclose.xst not found.] ::
oracle.retail.xenvironment.action.ActionRouter$1ActionExecutor
.run(ActionRouter.java:92)
Note: If a non-existent atom is listed in a chain, an error will
Trickle Polling
Trickle polling can be used to upload files from the system and download update files
during the day. Trickle uploads and downloads are run on a schedule set in each
registers scheduled task configuration.
Uploads
When enabled in both Oracle Retail Xenvironment and Oracle Retail Xstore Point of
Service, the system can generate and upload trickle data using third-party polling
solutions. Two chains are responsible for managing trickle uploads:
48
trickle-polling: This chain runs only on the lead. It combines the trickle packages
uploaded from the nonleads and runs a trickle polling session to upload the file to
the home office. This chain runs the following atoms:
poll-trickle: This atom calls, depending upon the operating system, the
poll.bat (Windows) or poll.sh (Linux) script with a parameter of
"TRICKLE", which runs all the processes in the TRICKLE section of the script.
This file is created by the Tech Services group for each customer.
Downloads
Oracle Retail Xenvironment is responsible for downloading the files on a schedule set in
the lead registers scheduled task configuration and processing the updates in those files.
Deployment
The deployment process performs updates to the system by downloading and processing
updates from Xcenter (a part of Oracle Retail Xstore Office).
There are two times when updates can be deployed:
Forced - Forced deployments run all deployments, both immediate and store-close,
that need to be run by Oracle Retail Xenvironment. A forced deployment runs during
the store close procedure initiated by an Oracle Retail Xenvironment upgrade. See
step 65 Appendix A: The Close Process: Atom by Atom.
Store Close - These configurations are deployed by the store close procedure, which
is detailed in The Store Close Process. Software updates, cipher keys, debit bin
files, DataLoader files, and configurator changes can only be deployed during store
close. However, they can be uploaded immediately, for processing at store close.
Note: Any immediate updates that have not yet been
If updates are available Oracle Retail Xstore Office sends a deployment manifest to
Oracle Retail Xstore Point of Service.
Oracle Retail Xstore Point of Service forwards the deployment manifest to Oracle
Retail Xenvironment for processing.
If the Oracle Retail Xenvironment system is not the lead register, the non-lead
register sends the manifest file to the lead register.
On the lead register, Oracle Retail Xenvironment checks the deployment manifest.
Any updates that are to be applied and/or downloaded immediately are retrieved
from the Apache HTTP server where they are stored. The files are saved in the
download staging directory.
<environment_directory>\deployment\download_staging\immediat
e for immediate deployments.
<environment_directory>\deployment\download_staging\close for
store close deployments.
Any updates that are to be downloaded and applied at store close are scheduled for
download from the Apache HTTP server during the close process.
For immediate updates, the updates are applied as soon as they are received.
Note: In case of emergency, immediate updates can be made
For store close updates, the store close applies the updates. See The Store Close
Process for a description of the process.
50
1.
2.
3.
4.
5.
6.
7.
8.
9.
registers.
12. A nightly reboot of the registers.
Relate logs
2.
3.
4.
5.
The contents of the /extract directory are extracted to the specified directory (see
update.properties).
6.
7.
8.
Archive Structure
The archive within the .tar.gz file has the following structure, where / is the root
directory of the .tar.gz archive:
/config - Adds or updates properties in the .properties file in the override directory
for the directory specified in the update.properties file.
For example, if the directory in the .tar.gz archive is
/configupdate/environment/config/actions.properties, the file
<environment_root>/cust_config/version1/actions.properties will
be updated through this directory.
/scripts - Batch files and shell scripts that are run by the update process.
update.properties
This file contains the following configurations:
Example
The following update.properties file will unpack the archive to the directory c:\temp and
will create backups of the c:\temp\env and c:\temp\env_install directories.
dir.root=c:\temp
dir.list.backup=c:\temp\env c:\temp\env_install
scripts
In the file archive, the /scripts directory contains the file preupd.bat (in Windows)
or predupd.sh (in Linux), and the file postupd.bat (in Windows) or postupd.sh (in
Linux), and all the appendant files used by those scripts.
52
The script preupd.[bat/sh] runs before any other backup step, including the
directory backup step.
During the polling session, the files xstore-update.jar and xstoreupdate.jar.sig are downloaded by the Lead Register and placed in the update
directory (c:\updates\inbox\xstore in Windows, /opt/updates in
Linux).
2.
A flag file named update.ok is created by the polling session. This indicates to the
Lead Register that the download of the update was completed. Processing will not
proceed without this file being present.
3.
If the file update.ok is not present, the update was not downloaded successfully.
Therefore, the update will not be processed.
4.
5.
During the closing process, the update is copied to the update upload directory
(<root_directory>/wwwroot/updates/xstore) to make it available to the
non-lead registers.
6.
The RSS feed file xstore-rss.xml is updated with information about the new
update.
7.
The Lead Register sends a message to the non-lead registers requesting that they
check for and apply new updates.
8.
Upon receiving the message, the non-lead registers download the file xstoreupdate.jar and place it in the update directory.
9.
10. After each non-lead register successfully executes the update, the register deletes the
file xstore-update.jar from the update directory, and the file xstoreupdate.sig from the certification directory.
11. After the Lead Register has completed processing the update, it sends out inquiry
messages to all of the other registers asking if they have completed the update
process.
12. When each non-lead register successfully executes the update, the register sends a
A copy of the original update is kept on the Lead Register in the update upload
directory. If a register was not online at the time of the close, that register can
download and process the update during the next close.
2.
If signature validation is enabled, copy the signature .sig file(s) to the appropriate
directory.
3.
Create a file named update.ok and place it into the appropriate directory. The file
is a simple text file that may be created with any text editor such as Notepad.
Note: The file update.ok can be empty. Oracle Retail
Close the system through Oracle Retail Xstore Point of Service, and wait for the close
to complete. Update processing occurs late in the process, so it might be a while
before the updates are processed.
5.
Once the store is closed, validate that the update was processed:
6.
7.
Look for the update and signature file (if applicable) in the directory
<root_directory>/wwwroot/updates/<update_type>, where
<update_type> is the type of update.
54
8.
2.
Close the system through Oracle Retail Xenvironment, and wait for the close to
complete. Cipher file propagation occurs late in the closing process, so it might be a
while before the files are processed.
4.
Once the store is closed, validate that the cipher files were processed:
a.
Check to ensure that the new cipher files are found in the directory
<xstore_root>/res/keys on all systems.
b.
c.
2.
Close the system through Oracle Retail Xenvironment, and wait for the close to
complete. Debit file propagation occurs late in the closing process, so it might be a
while before the files are processed.
4.
Once the store is closed, validate that the debit.txt file was processed:
a.
Check to ensure that the new debit.txt file is found in the directory
<xstore_root>/res/keys on all systems.
b.
c.
6
Using Oracle Retail Xenvironment
Overview
This chapter describes the use of Oracle Retail Xenvironment. This includes information
about how to start Oracle Retail Xenvironment and how to use the graphical user
interface (GUI) that provides access to the Oracle Retail Xstore Point-of-Service
application and Windows functions.
Important: This chapter should be used only by customers
Graphical User Interface (GUI) describes the Oracle Retail Xenvironment GUI and
how to use it.
On-Screen Keyboard
To provide touchscreen systems with the functionality available in a desktop system,
Oracle Retail Xenvironment can be used to launch the operating systems on-screen
keyboard that can perform all the actions of a physical keyboard.
This on-screen keyboard can be used to access hotkey functions, switch between
programs using [Alt]+[Tab] commands, or enter data into fields.
58
Features
The on-screen keyboard always stays on top of all other windows and applications.
To use the [Shift], [Ctrl], or [Alt] keys, touch that key on the on-screen keyboard,
then any other keys to be used with them.
For example, to use [Alt]+[Tab] to move through application, touch [Alt], then touch
[Tab] as many times as necessary to change to the proper application.
When entering data, the on-screen keyboard will provide auto-complete options
along the top of the keyboard, based on the characters entered. To select an autocomplete option, touch it.
In-Window Keyboard
The in-window keyboard is different than the on-screen keyboard described above. The
in- window keyboard is only used to enter data into an Oracle Retail Xenvironment
window on a touchscreen system. This in-window keyboard can be used to enter a
password into a password prompt, or enter the name of a chain or atom into the Run a
Chain or Atom prompt.
This keyboard cannot be used to enter hotkey combinations, nor can [Alt]+[Tab]
commands move control from Oracle Retail Xstore Point of Service to Oracle Retail
Xenvironment.
Message Screen
The message screen in the upper left portion of the GUI displays messages for Oracle
Retail Xenvironment. These messages may be informational or they may indicate
problems. The message screen shows both the message and a count of the total number
of messages received by Oracle Retail Xenvironment. These messages are generally
related to polling or the closing process.
Click the Previous button or press the [A] key to view the previous message.
Click the Next button or press the [F] key to view the previous message.
Clear Message
To clear a message from the message screen, do the following:
60
1.
2.
Oracle Retail Xenvironment asks for your user name and password (see Password
Protected Functions).
3.
Enter your user name and password, then click the Continue button, or press the
[Enter] key. This is the user name and password you use to log into Oracle Retail
Xstore Point of Service.
4.
5.
Enter the system password, then click the Continue button, or press the [Enter] key.
6.
The message is cleared from Oracle Retail Xenvironment and the marker file for the
message is deleted from the system.
POS Status
The POS Status screen provides information describing the current state of the POS
system. The POS Status screen, located on the right side of the GUI, includes five
different status areas, each of which shows different information.
To see the information provided in the different status areas, click on or touch the title
bar for the status area, or use the [Page Up] and [Page Down] keys to navigate through
the status areas, or use the number keys to select a specific status area.
Register Status
The Register Status area shows the current status of the registers in the store.
Process Steps
The Process Steps area is used during the close process and disaster recovery. It displays
the status of each step as it is performed.
Alert Detail
The Alert Detail area displays alerts that require attention. These alerts are found
through error and warning marker files (see Subdirectory: <root_directory>\marker,
Chapter 3for more information about marker files).
Apps
The Apps area provides access to plugins and applications that can be accessed and used
through Oracle Retail Xenvironment. See Menu Key Configuration, Chapter 4 for
information about configuring this area.
62
About
The About area contains the Copyright information and the general disclaimer.
Systems Support/Attention
The Systems Support/Attention screen, located in the lower left portion of the GUI,
displays Windows process navigation information. This screen provides information on
how to return focus to Oracle Retail Xenvironment or Oracle Retail Xstore Point of
Service.
Figure 6-12: System Support Activate Oracle Retail Xstore Point of Service
If Oracle Retail Xenvironment is not currently in focus, the Attention screen displays
a message reminding the user how to return to either Oracle Retail Xenvironment or
Oracle Retail Xstore Point of Service.
If there is currently an error marker in the system, the System Support screen
displays a message alerting and notifying the user to review the error.
Menu Buttons
Some of the operations and menus available in Oracle Retail Xenvironment are accessed
through the buttons located near the bottom of the screen. To access a menu or operation
through Oracle Retail Xenvironment button, press the button on a touchscreen monitor,
click the button using the mouse, or press the shortcut key indicated on the button.
Oracle Retail Xenvironment Buttons
Description
Support
System
Capture Logs
64
Status Bar
The status bar displays system information for the register running Oracle Retail
Xenvironment.
Description
Support Menu
The Support Menu contains menu items that affect Oracle Retail Xstore Point of Service
and the Windows system that runs Oracle Retail Xenvironment. To select a menu option,
click the option with a mouse or touch it on a touchscreen monitor, then click or touch
the Continue button.
Stop Xstore - Stops the Oracle Retail Xstore Point-of-Service application that is
running on the local system.
Logoff System - (Windows only) Exits the Windows session for the currently loggedin user and returns to the Windows login screen. Note that it does not shut down or
reboot the system.
66
System Menu
The System Menu is used to interact with the operating system. Depending on your
systems configuration, the System Menu might vary from the example below. To select a
menu option, click the option with a mouse or touch it on a touchscreen monitor, then
click or touch the Continue button.
Run Atom - Run a chain or atom (see Run a Chain or Atom). This option only
displayed on systems with touchscreen support enabled.
Plugins - Run a Plugin (see Plugins). This option only displayed on systems with
touchscreen support enabled.
Tech Support - Open the Tech Services menu (see Tech Support Menu). This
option only displayed on systems with touchscreen support enabled.
Task List - Open the Task List window. (See Task List).
Marker File List - Display a list of marker files currently in use by Oracle Retail
Xenvironment (see View Marker Files).
Hotkeys
Many of the actions and functions available in Oracle Retail Xenvironment are accessed
through Hotkey combinations. These Hotkey combinations are certain keys or
combinations of keys pressed simultaneously.
Note: Use the On-Screen Keyboard to use hotkeys on a
Description
ALT + V
Switch to Oracle Retail Xstore Point of
Service
F8
Run
CTRL + ALT + R
Tech Services
CTRL + ALT + X
Command Prompt
ALT + F1
Print Screen
CTRL + ALT + P
<environment_root>log/xenv_ps.jpg
68
Item
Description
System Information
CTRL + ALT + I
CTRL + ALT + T
CTRL + ALT + L
Plugins
CTRL + ALT + Y
Disaster Recovery
ALT + R
1If
the Oracle Retail Xenvironment Engine is not running, or if the Oracle Retail
Xenvironment GUI cannot communicate with the Engine, most hotkeys will not work.
Because of this, an additional Command Prompt hotkey combination is available,
allowing service personnel to access the system and perform maintenance. For example,
this backdoor can be used if there is a misconfiguration, or if a certificate expires.
Enter your user name and password. These are the user name and password you use
to log into Oracle Retail Xstore Point of Service.
2.
3.
4.
Plugins
Oracle Retail Xenvironment can run custom utilities that are specially designed for
Oracle Retail Xenvironment, but are not part of the base software. These utilities are
accessed through the Plugin menu.
Note: For more information about plugins, speak with your
Oracle representative.
To use a plugin, do the following:
1.
Press the [CTRL]+[ALT]+[Y] hotkey combination, or select Plugins from the System
menu to open the plugin menu.
Note: To use some plugins on a touchscreen system, you
The plugin menu opens. All the plugins available for Oracle Retail Xenvironment are
listed in this menu.
2.
3.
4.
2.
3.
4.
5.
Enter your user name and password. This is the user name and password used to log
into Oracle Retail Xstore Point of Service.
6.
7.
Enter the proper password, then select Continue or press [Enter] to continue.
8.
A window opens prompting for the name of the chain or atom to run.
9.
Enter the name of the chain or atom you are running, then select Continue or press
[Enter] to run the chain or atom.
10. The chain or atom runs. The Run Status of the atom or chain will be displayed in the
70
Stop Dataserver - Stops the Dataserver application that is running on the local
system.
Restart Dataserver - Stops and restarts the Dataserver application that is running on
the local system.
Stop Xstore and Dataserver - Stops both the Oracle Retail Xstore Point-of-Service
and Dataserver applications on the local system.
Start Xstore and Dataserver - Stops and restarts both the Oracle Retail Xstore Pointof-Service and Dataserver applications on the local system.
Start Xstore Mobile - Stop and restart Oracle Retail Xstore Point-of-Service Software
Mobile access.
Stop Xstore Mobile - Stop Oracle Retail Xstore Point-of-Service Software Mobile
access.
Start Xservices - Stop and restart access to Oracle Retail Xstore Point-of-Services
Services.
Task List
Users can open a Task List window that displays all the processes running on the system.
This window can be used to bring other applications to the front, and allows users to kill
processes from within Oracle Retail Xenvironment.
To use the Task List, do the following:
1.
Press the [CTRL]+[ALT]+[T] hotkey combination, or select Task List from the
System menu to open the Task List window.
2.
3.
Enter your user name and password. This is the user name and password used to log
into Oracle Retail Xstore Point of Service.
4.
5.
Enter the proper password, then select Continue or press [Enter] to continue.
6.
Switch to Task
To switch to another application through the Task List, do the following:
72
1.
2.
3.
The application opens in the foreground and the Task List window closes.
Kill Task
To kill an application through the Task List, do the following:
Important: Child processes cannot be killed through the Task
2.
3.
Press the hotkey combination [CTRL]+[ALT]+[L], or click Marker File List in the
System Menu (see System Menu).
2.
Click the Get Marker Files button, or press the [F8] key.
4.
The View Marker Files list is populated with the files in the marker file directory.
The files to be displayed are configured in the following configurations in the file
C:\environment\ui\config\system.properties:
# -----------------------------------------------------# Marker file list viewer
# -----------------------------------------------------MarkerFilePath=/environment/marker
MarkerFileMask=*
System Information
The System Information screen displays information describing the system that is
running Oracle Retail Xenvironment. This information includes a general overview of the
system, the services that are currently running on the system, the processes currently
running, and the printers that are configured in the system.
Press the [Esc] key to exit the System Information screen.
The information in the System Information screen is organized by tabs. Click or touch the
tabs to move from one tab to the next. The System Information screen contains the
following tabs:
Overview
List Services
List Processes
List Printers
Overview
The Overview tab provides general information about the computer that is running
Oracle Retail Xenvironment, such as the computer make, model, network configuration,
and hardware.
74
List Services
The List Services tab displays a list of all the services installed on the system running
Oracle Retail Xenvironment and shows whether the service is currently running.
List Processes
The List Processes tab displays all the processes currently running on the system.
List Printers
The List Printers tab displays all the printers currently configured in the system.
76
7
Disaster Recovery
Overview
This chapter describes the disaster recovery procedure and the operations performed
during disaster recovery.
In Oracle Retail Xenvironment, disaster recovery is necessary when a lead register goes
down and a non- lead register needs to take over the lead register role.
Requirements
The disaster recovery procedure requires the following:
Database backups and updates will not be performed while a non-lead register is
acting as the lead register.
Important: The Disaster Recovery procedure does not
Only the atoms and chains with the .drsafe option set to True will run. All other
atoms and chains will be locked out (for more information, see Atoms and Chains,
Chapter 2).
The only chain running on any system will be on the new lead register. All atoms run
on nonlead registers will be called by notify atoms on the lead register, and all
return values from these atoms will be interpreted by these notify atoms.
All of the properties changed on the store systems will be saved in one file on the
lead register.
Convert a Register to Lead describes the procedure for converting a non- lead
register to a lead register.
Restore the Lead Register describes the procedure for returning a temporary lead
register to the non-lead role.
Custom Actions describes the method for configuring custom actions that will be
performed whenever a non-lead register in the store network is being converted to a
lead register, or actions that will be performed whenever the lead register is restored.
Disaster Recovery
Press the [Alt]+[R] hotkey combination, or select the Disaster Recovery option from
the System menu.
2.
3.
4.
5.
Enter your user name and password. This is the user name and password you use to
log into Oracle Retail Xstore Point of Service.
6.
7.
Enter the System Password, then click Continue or press the [Enter] key.
8.
Select Convert this Register to Lead, then click Continue or press the [Enter] key.
78
2.
3.
4.
5.
Enter your user name and password. This is the user name and password you use to
log into Oracle Retail Xstore Point of Service.
6.
7.
Enter the System Password, then click Continue or press the [Enter] key.
8.
Select Restore Original Lead Register, then click Continue or press the [Enter] key.
Custom Actions
During disaster recovery, Oracle Retail Xenvironment can perform custom actions that
add necessary functionality to the disaster recovery process. These actions are configured
through atoms that are run during the convert and restore processes.
Disaster Recovery
Convert a Register
The dr-custom-convert-action atom is run on each register in the store during the
process of converting a nonlead register to a lead register in disaster recovery mode. This
atom has the following default configurations:
lead.atom.dr-custom-convert-action.class=noop nonlead.atom.drcustom-convert-action.class=noop atom.dr-custom-convertaction.drsafe=True
atom.dr-custom-convert-action.disabled=True
To add custom actions to the convert process, configure the atom with all the
necessary settings (seeAtoms and Chains, Chapter 2), and set the .disabled
configuration to False.
80
A
Appendix: The Close Process: Atom by
Atom
The Store Close Process, Chapter 5 describes the important functions performed by the
store closing process, which is controlled by a chain named CLOSE_STORE. This section
provides a sequential list of each atom that is called by the CLOSE_STORE chain on the
lead register, and gives a brief description of the task the atom performs.
In addition to standard close atoms, Oracle Retail Xenvironment also provides close
hooks. These hooks access certain, custom scripts that can perform additional functions.
These hooks are named according to their locations in the process flow.
notify-create-sysclose-marker: This atom notifies all systems that the store is being
closed and creates a marker file indicating that the store is closing.
2.
remove-sysopen-marker: This atom removes the marker file indicating that the store
is open.
3.
4.
remove-regopen-marker: This atom removes the marker file (if it exists) indicating
that the register is open.
5.
6.
wait-for-trickle-and-immediate-updates-to-complete: This atom waits for tricklepolling updates and immediate updates to complete before the close process
continues.
7.
8.
ForwardCallToStoreClose: Sends a message to all Oracle Retail Xstore Point-ofService registers informing them that the store is closed. Upon receiving this
message, the store status indicator in the Oracle Retail Xstore Point-of-Service status
bar turns red.
9.
b.
PosLog.xml
CommissionLog.xml
commonlog.xml
customers.xml
inventory.xml
InventoryCount.xml
payroll.xml
remc.xml
seclog.xml
timecard.xml
workers.xml
For example, on Register #3, the file poslog.xml is copied to poslog.3.xml.
c.
d.
xstore.log
dataserver.log
e.
xenvironment.log
xenvironment-ui.log
f.
The files copied to <xstore_root>/upload/ in steps b-e are archived into the
file <xstore_root>/upload/package.tgz. Once the files are entered into
the archive, the files are removed from the directory.
<xstore_root>/log. This allows support personnel to see what files were present
in the directory at this point in the closing process.
12. copy-tlogs-to-polling-directory: This atom creates copies of Oracle Retail Xstore
82
PosLog.xml
CommissionLog.xml
commonlog.xml
customers.xml
inventory.xml
InventoryCount.xml
payroll.xml
remc.xml
seclog.xml
timecard.xml
workers.xml
xstore.log
dataserver.log
19. copy-envlogs-to-polling-directory: This atom copies the files from the directory
xenvironment.log
directory <xstore_root>/upload.
26. cleanup-package-archive-directory: This atom removes all the old, archived package
files.
27. wait-for-polling-packages-complete: This atom allows the close process to wait until
the polling packages in the non-lead registers have been created before continuing.
28. get-polling-packages: In this atom, the Lead Register retrieves and labels the polling
package files from the non-lead registers by performing the following steps for each
register:
a.
b.
When the file has been retrieved, the Lead Register renames the file with the
format <Register>-package.tgz.
For example, the package.tgz file downloaded from Register #2 is renamed
REGISTER2-package.tgz.
<root_directory>/download/tmp directory.
31. log-poll-dir: This atom logs the contents of the directory
84
36. poll-close1: This atom launches the CLOSE1 section of the file
files in the backup directory in the Oracle Retail Xstore Point-of-Service database
directory.
52. delete-db-backup-1: This atom deletes the existing Oracle Retail Xstore Point-of-
the Oracle Retail Xstore Point-of-Service database to the configured backup file.
54. zip-db-backup-pre-upd: This atom zips/archives the Oracle Retail Xstore Point-of-
Service database backup file into the file prepolldb.zip. in the backup directory in
the Oracle Retail Xstore Point-of-Service database directory.
55. delete-db-backup-pre-upd: This atom deletes the existing Oracle Retail Xstore Point-
Service.
58. shutdown-dataserver-pre-upd: This atom shuts down Dataserver.
59. shutdown-xservices: Shuts down Oracle Retail Xstore Point-of-Service Services.
60. shutdown-xstore-mobile: Shuts down the Oracle Retail Xstore Point-of-Service
for Oracle Retail Xstore Point of Service and Dataserver to shut down before
continuing.
62. process-pre48-downloads-rep: If the Oracle Retail Xstore Point-of-Service version is
less than 4.8, this atom copies .rep download files to the Oracle Retail Xstore Point-ofService download directory for processing; then, after processing the file, the process
repeats until all the files have been processed. If the Oracle Retail Xstore Point-ofService version is 4.8 or greater, this atom is disabled.
63. process-pre48-downloads-mnt: If the Oracle Retail Xstore Point-of-Service version is
less than 4.8, this atom copies .mnt download files to the Oracle Retail Xstore Pointof-Service download directory for processing; then, after processing the file, the
process repeats until all the files have been processed. If the Oracle Retail Xstore
Point-of-Service version is 4.8 or greater, this atom is disabled.
64. UPDATES - This chain processes the updates that are ready to be performed. See
deployments.xst marker file is present, this chain will run all deployments, both
immediate and store-close, that need to be run by Oracle Retail Xenvironment.
Note: In almost all cases, this atom is only used by the
86
database backup file into the file prepolldb.zip. in the backup directory in the
Oracle Retail Xstore Point-of-Service database directory.
72. move-db-backup-to-upload: This atom moves the file xstoredb.zip to the
directory <root_directory>/wwwroot/dbbackup/.
73. rotate-uftp-server-log: This atom rotates the uftp server log files.
b.
c.
d.
Restore the database from the xstoredb.zip backup file, replacing the existing
Oracle Retail Xstore Point-of-Service database.
e.
f.
Remove the marker file restore.db when all steps are complete.
76. run-uftp-server: This atoms runs the UFTP server used to multicast database files to
Lead Register.
83. shutdown-dataserver: This atom shuts down the data server on the Lead Register.
84. delay-twenty-seconds: This atom provides a waiting period that gives processes
Linux systems).
89. start-xservices-postclose: Restart Oracle Retail Xstore Point-of-Service Services on
2.
3.
4.
5.
execute-dataloader: Run the DataLoader. The actions of this atom depend upon the
version of Oracle Retail Xstore Point of Service:
If the Oracle Retail Xstore Point-of-Service version is 4.8 or greater, this atom
runs the DataLoader, which downloads, manages, processes, and archives all of
the download files.
If the Oracle Retail Xstore Point-of-Service version is less than 4.8, this atom is
disabled.
6.
7.
8.
9.
update-feeds: This atom updates the different feeds in Oracle Retail Xenvironment if
there are files in any of the update inboxes, along with the required flags.
10. notify-process-updates: The Lead Register sends a message to all non-lead registers
b.
c.
locations.
88
This step is typically used so that the Lead Register can copy the cipher files to the
directory <xstore_root>/res/keys.
13. apply-updates-java: Applies updates to Java located in the directory
<update_directory>/java.
14. apply-updates-env: Unpacks and processes .tar.gz archive files located in the
directory <update_directory>/env.
15. apply-updates-xstore-immediate: Apply any immediate updates to Oracle Retail
<update_directory>/xstore.
17. apply-updates-xadmin: Process any .zip files located in the directory
<update_directory>/xadmin.
18. move-unprocessed-updates-xstore: This atom moves all unprocessed Oracle Retail
updates.
20. cleanup-update-sigs-xstore: This atom cleans up .sig files for Oracle Retail Xstore
Point of Service.
21. cleanup-updates-env: This atom cleans up Oracle Retail Xenvironment updates.
22. cleanup-update-sigs-env: This atom cleans up .sig files for Oracle Retail
Xenvironment.
23. remove-old-archived-pre48-downloads: This atom removes old archived
downloads. If the Oracle Retail Xstore Point-of-Service version is 4.8 or greater, this
atom is disabled.
24. middlex-item-load: If MiddleX is used on the system, this atom loads an item file
90