# Auto Upgrade ## Revision History | Date | Description | | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | 08/09/2015 | Changes include the enhancements introduce. | | 04/25/2016 | Auto Upgrade Feature Reference Update. | | 05/18/2016 | Review Updates. | | 09/15/2016 | Format Update. | | 09/22/2016 | Enhancement Update on Site Controller. | | 02/10/2017 | 2017/format updates. Added TLS 1.2 Backoffice consideration. Added note that Commander SMS applications may need updates along with controller/POS software upgrades. | | 02/28/2017 | Added Auto-Applied Upgrade. Expanded glossary terms. | | 05/17/2019 | Updated with feedback from training team. | | 07/04/2019 | Updated information about why new features are not enabled by default for roles. | ## GLOSSARY OF TERMS The following terms and definitions will assist the reader with understanding the content of the Feature Reference. | Terms | Definitions | | ------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ASM | Annual Support Maintenance | | Auto Upgrade | This feature allows a site to initiate a complete software upgrade without requiring the presence or expertise of a VASC, or intervention from Verifone Technical Support Center. | | DCR | Dispenser Card Reader | | EPS | Electronic Payment Server | | HASP | Hardware Against Software Piracy. A HASP Hardware Key, also called a "dongle", is a software copy protection device that plugs into the USB port of the computer. Upon startup, the application looks for the key and will run only if the key contains the appropriate code. | | LAN | Local Area Network | | POS | Point of Sale | | POS System | Includes the POS terminals, site controller and the electronic payment server. | | TLS | Transport Layer Security is a cryptographic protocol providing communications security over a computer network. | | USB | Universal Serial Bus | | VASC | Verifone Authorized Service Contractor | | VRSD | Verifone Remote Software Download is Verifone's automated remote software download solution. | | WFTPD | Windows FTP Daemon is a stand-alone FTP server for Windows. | ## Overview ### Feature Description The Auto Upgrade feature allows a site to initiate a complete software upgrade without requiring the presence or expertise of a Verifone Authorized Service Contractor (VASC), or intervention from the Verifone Technical Support Center. Verifone Remote Software Download (VRSD) is Verifone's automated remote software download solution. All available datasets within the site controller are backed up during the Auto Upgrade process along with Transaction logs, reporting data (including totalizers), and card holder data. Closing the daily report prior to performing the Auto Upgrade is crucial to prevent loss of batch settlement details should the upgrade have any issues. ### Requirements •Commander Site Controller or RubyCi •Broadband Internet Connection ### Supported Hardware Configurations •Commander Site Controller with C18 •Commander Site Controller with Topaz •Commander Site Controller with Ruby2 •RubyCi with Topaz •RubyCi with Ruby2 ### Related topics * [Release 53 & Higher UI Reference](/feature-references/feature-references/release-53-and-higher-ui-reference.md) — Review UI changes that can appear after an upgrade. * [App Selector](/feature-references/feature-references/app-selector.md) — See how C18 application defaults are retained across upgrades. * [Self Checkout](/feature-references/feature-references/self-checkout.md) — Check role updates and behavior that may change after upgrading to a SCO-capable base. ## Configuring Auto Upgrade {% hint style="danger" %} The following information is critical to the Auto Upgrade process. Review this entire chapter prior to beginning. Perform and follow the steps outlined in this document according to store policies and procedures. {% endhint %} ### Advanced Preparation {% hint style="warning" %} *Stop all store operations prior to and during the Auto Upgrade* *process:* * *All Cashiers must be logged out.* * *All fuel dispensing must be completed. If necessary,* *cover all pump handles with paper bags.* * *All POS Terminals must remain idle.* * *No merchandise or fuel is to be sold.* {% endhint %} Prior to initiating Auto Upgrade: * •Ensure all Point of Sales Systems devices are connected and functioning without any communication errors. * •The payment host must be online for the upgrade to be applied. For example, the site should be processing credit/debit. * •The POS receipt printer must be functioning in order to print Auto Upgrade messages and instructions. * •Perform a Period Close from the POS terminal: CSR Functions > Reporting Menu. Close the Period (Shift/Day) and trigger a Network Batch close. * •Print Period Close Reports from the POS terminal: CSR Functions > Reporting Menu. Print all period reports, network reports, cashier reports, payroll reports, etc., typically printed as part of Close or reconciliation process. {% hint style="info" %} *Yearly reports can be disabled to speed up the installation process.* *See the Reporting section for steps to disable and enable yearly* *reports.* {% endhint %} * •Confirm that all available reports for network totals have been saved or printed. Print or save each of the network reports before proceeding. * •Transmit all report information from the POS terminal to the back office system, ifapplicable to the site configuration. * •Optional: while the Auto Upgrade will preserve data sets in the site controller, you may also perform a secondary backup with SMS Import/Export prior to applying the upgrade. {% hint style="warning" %} *Due to enhanced security requirements, Backoffice software* *systems must now use TLS 1.2 security protocol. Please check with* *your Backoffice provider for system compatibility prior to applying* *upgrades.* {% endhint %} ### Real Time Allow up to one hour for the Auto Upgrade process to complete. Length of the upgrade process depends on the scope of the upgrade and the amount of data being backed-up and restored. Contact the VeriFone Technical Support Center if any extended delays or issues occur. During the Auto Upgrade: * •Do not manually turn off or reboot the system at any time during the process. * •The system will reboot several times during the upgrade process. * •Ensure there are no power disruptions during the upgrade process. ![](/files/af84b00fbc788ca567d70877ba5880043336b687) ## Using Auto Upgrade ### Transferring Update Package The following methods are used to transfer an Auto Upgrade package to the system: #### Using a USB Flash Drive on the POS Terminal 1. Connect the USB drive containing the Auto Upgrade package (Overlay.sig and Overlay.Zip) from the application folder to the POS terminal.\ **NOTE:** *These files must be in the root directory of the USB Drive.* 2. From the POS terminal, go to: CSR Func > Maintenance menu. 3. Click **\[Check for USB Updates].** 4. Follow the instructions on the POS terminal. #### Using the Package Sender **1.**From the software application folder, double click **\[Auto\_Upgrade.jar]** to select and run the file.
2.Confirm the Package *Type: Package Archive* ![](/files/301e8e11a9e1114585a8323702adfb09588946d6) 3.Click **\[Browse] to** choose the Package File to send.
4.Click to select the **overlay.zip file** from the CD image files. ![](/files/3e1440e4136705d3cf0a4a117c5520d0c0ff18f3) 5.Click **\[Open].**
6.Click **\[Install].**
The Auto-Upgrade Software installer progress window is displayed. ![](/files/6c33d343a7ae642e568c600ec097b05cb002ef32) #### Using Verifone Remote Software Download (VRSD) Merchants with an active Annual Support Maintenance (ASM) contract are eligible to receive software updates through the Verifone Remote Software Delivery (VRSD) service. For Verifone Remote Software Download detailed information, visit the Verifone Support page at >> Petro & Convenience >> Products and Services >> Software Updates (VRSD). Merchant’s must submit a VRSD Upgrade Request using the online request form located on the Verifone Technical Support portal at . Click the link for \[TechSupportChat or Email].
Enter the following: 1. Select the Department/Category for your Chat/Email: Petroleum and Convenience. 2. Select how you would like to communicate with Tech Support: Email. 3. Select the Reason for Contacting Us: VRSD Upgrade Request. 4. Enter First and Last Name, Phone Number and Email Address. 5. Select Input Type: Service ID. 6. Enter the Input Value: ASM Service ID. 7. Key in a detailed description, for example:\ Current Application Version: Buypass 2.06.00.\ Requesting Application Version Upgrade. 8. Click **\[Submit].**
E-mails will be sent to the address provided with the upgrade request providing status updates and instructions for applying the upgrade. The Auto Upgrade package should arrive automatically within 48-72 hours. Real-time status updates are available from the POS Cashier Functions menu. Go to **CSR Functions >> Select Maintenance >> Check for VRSD Updates**. The system responds with an update status prompt. **Select \[Yes]** to check for updates. The system response shows the updated software download status: “Download is Scheduled.” #### Using the RCI Client Utility If directed by Verifone, request a copy of the RCI Client Utility manual for further instructions. ### Manual Applied Upgrade {% hint style="warning" %} *Prior to initiating the auto upgrade process, confirm all POS* *terminals are logged out of sales and all fuel pumps are idle.* *Do not start the auto upgrade process if the Advanced* *Preparation section has not been reviewed.* {% endhint %} After the software upgrade download has been transferred by one of the above methods: 1.The Commander Site Controller will display an alarm message on all POS ***terminals: “ X.XX.XX Available”.*** 2.From a POS terminal, go to: CSR Func > Maintenance. The Register Maintenance Function Menu will display. 3.Click **\[Apply Upgrade].** When applying the upgrade package, the error message "PMC Not Ready" indicates that the site controller is not communicating with the payment network.
The system will initiate the Auto Upgrade process ***and begin “Checking for upgrades.”*** 4.When prompted to ***“Print Instructions?”,*** select **\[Yes]** to print the Auto Upgrade Instructions. Sample of Printed Auto Upgrade Instructions: ![](/files/e6fbd1c8b00902a41ad5661f8dc56c77f1e53b7b) *5.Select **\[Yes]** when prompted to **“Apply Upgrade Now?”** and begin the Auto* Upgrade process. ### Auto Applied Upgrade Once the software upgrade download is completed, a message is shown on the POS terminals that an update is available to be applied. The upgrade may be initiated manually, or the system may be configured to automatically initiate the upgrade if it is not manually run within a set number of days. Systems configured to auto apply upgrades have reduced problems associated with the timely update of new software, or with updates not being applied at all. For systems configured for auto applied upgrade: * Upgrades will be applied after a set number of days from the date the upgrade package is received locally by the Commander System Auto Upgrade engine. Days remaining for the upgrade will be counted based on a change in calendar date. * A daily notification reminds the site about the pending upgrade. This action is only implemented on Verifone POS terminals, and at this time does not support third party POS terminals. * A daily notification reminds the site to print upgrade instructions. The final notification on execution date will provide basic prerequisite upgrade instructions. * Before the automatic upgrade is triggered, the latest day close report will be printed. * Once triggered, messages displayed on the POS registers and a Fuel Site Pause will prevent further activity or sale(s) before applying the upgrade automatically. * The system will apply upgrades automatically only when the period close is complete on all registers. The Auto Upgrade framework checks the readiness of all client POS terminals prior to initiating the software upgrade. * The upgrade process will not begin if any unsettled post pay fuel transactions exist in the system. The upgrade process will be on hold until such transactions are cleared, and an the alarm ‘Upgrade Cannot Proceed’ will display on the POS terminals while printing the daily report prior to the scheduled upgrade {% hint style="info" %} *Upgrades will **not** be automatically applied if there are pending* *transactions or unsettled post pay fuel transactions open in the* *system.* {% endhint %} #### Requirements * Sites must already be on Base 44+ for this functionality. * System properties must be set to enable the Auto-Applied Upgrade. Software upgrades would then be auto-applied on the next downloaded base-level upgrade. #### Enabling Auto Applied Upgrade To enable the feature, the logged in use must have permissions to edit System Permissions. 1.Navigate to Initial Setup>System Properties.
*The system parameter apply.upgrade.forcefully is the controlling variable. By default* the parameter value is set to ‘no’.
*2.Locate and select the apply.upgrade.forcefully parameter.* 3.Edit the parameter value and set the value to ‘yes’. 4.Click **\[Save].**
#### Ready Enabled Auto-Applied Upgrade Some major oil brands have chosen for their corporate and affiliate sites to have this feature enabled in their software download packages. In these instances, the *apply.upgrade.forcefully value is already set within the application to ‘yes’, and* *cannot be edited or changed. In those software packages, the apply.upgrade.forcefully* System Property is hidden and not accessible when viewing the systems Properties list. ![](/files/56bc8dc29a15b61e86c77c7cf9339b7914178cbf) #### Auto Applied Upgrade Process *The System Property apply.upgrade.forcefully is set to ‘yes’. This is either included in* the current software package, or can be enabled manually.
During daily operations, once the software upgrade has been received by the POS *system, cashiers are notified there is an Upgrade Pending.* On the day of the software download, an alert message states the software upgrade will be automatically applied when the daily counter has reached the execution date. The site may manually initiate the software upgrade at the end of the day close at any time prior to the counter expiration. On the day the software upgrade is received by the POS system, when the user initiates the period close by accessing the POS Reporting Functions Menu >Close Day/Month/Year Report, an Auto Upgrade message is displayed. The notification states that the software upgrade will be automatically applied when the daily countdown has reached the execution date, although the upgrade may be applied manually if the site chooses to do so. If the software upgrade is not applied manually, the system is then set to automatically apply the upgrade at the end of the business day when the daily counter reaches the execution date. An alert message states the software upgrade will be automatically applied at the end of that day close. When the daily counter has expired and reached the execution date, and the user initiates the period close by accessing the POS Reporting Functions Menu >Close Day/ Month/Year Report, an Auto Upgrade message is displayed. The notification states that the software upgrade will be automatically applied as part of the period close. ### Upgrade Status Window If the site is running Commander Site Controller feature set 37 or above, the Auto Upgrade process is split into two phases: •Phase One: System Upgrade •Phase Two: Historic Data Restore After all Phase One tasks are complete, the site is fully functional to perform sales and other operations. Phase Two tasks will run in the background and do not interrupt any site operations. A typical phase two task is restoring previously closed totals data. The POS terminal displays the Upgrade Status Window with progress bars indicating the status of the executing task and overall installation progress. Along with the current task information, the status window also includes the status of previously executed tasks. ***The message, “Please wait,*** ***server reboot in progress...”*** appears in the progress bar area during stages of the Commander Site Controller reboot. After all Phase One tasks ***show “Completed”,** the* overall status shows 100% completed and the status *message **“Auto Upgrade*** ***Phase 1 Completed” is*** displayed. *When the system message displays **“Auto Upgrade Phase 1 Completed. Phase 2 in*** ***progress (restoring previously closed totals)”,** do one of the following:* •Click **\[OK]** to dismiss the overlay message and continue with Sales or other site operations. •Perform no action until upgrade phase two is complete; the upgrade status window will continue to be displayed on the POS terminal. *During Phase Two, a **“Restore (Stage 2)”** status message is displayed on the POS* terminal. At any point during Phase Two, tasks can be monitored on any POS terminal by selecting **CSR Func > Maintenance > Show Upgrade Status**. If the site is running Commander Site Controller feature set 38.15 or above, the Auto Upgrade Phase Two activity, restore historic totals, will have a timeout of 2 hours 30 minutes. Historic data for reporting is restored in reverse chronological order. That is, the latest period’s data is restored first followed by the previous period’s data and so on; this process repeats until the oldest available period data is restored. If the time taken to restore historic data exceeds the specified timeout, the restore process terminates. In case of termination due to timeout, the Upgrade Summary Report will include details about the range of restored report periods. After the upgrade is complete, a message ***window displays confirming the “Upgrade*** ***Completed Successfully.”*** Click **\[OK]** to close the window**.** During the Auto Upgrade process, the following succession of messages are displayed in the Upgrade Status window of the POS terminal: * •Preparing for Upgrade * •File Download (Stage1) * •Comm Check (Stage1) * •Software version check * •Upgrade of upgrade engine * •Upgrade of upgrade engine Completed * •Update Upgrade Status * •Backup (Stage1-12) * •SC Application Installation * •Application Installation (Stage2) * •Restore (Stage1-11) * •Payload Update * •Site Initialization * •Clean up * •Client Restart / Lookup (Stage1) * •Restore (Stage2) * •Clean up ### Post Upgrade Steps {% hint style="warning" %} ***Wait until all Pumps and Dispenser Card Readers (DCRs) are*** ***fully loaded prior to logging back onto the system, even if the*** ***POS terminal screens show “Upgrade Completed.”*** {% endhint %} •Print the Upgrade Summary Report and verify the status of each task is listed as ***Completed.*** •If Yearly Reports were disabled, enable the reports (see Appendix). •Contact Verifone Technical Support if: * ***–If Failed or Completed with Errors** status are found.* * –If any error messages were printed at the POS receipt printer during the upgrade. * –If a registration prompt screen is encountered, call the Verifone Help Desk at 1-800-519-7225 opt 2 to request a new registration key. VASCs may re-register systems on the Verifone Premier Portal. {% hint style="info" %} *After completing the software updates, applications within the* *Commander Site Management Suite may need to be re-installed.* *This includes the Site Report Navigator, Site Transaction Manager,* *and the Commander Import export utility.* *These programs can be downloaded from Support.Verifone.Com* *under their respected SMS Installers folder.* {% endhint %} {% hint style="info" %} *After completing the software updates, all the new functions are* *not enabled by default for the existing users of the system. A* *Manger would need to assign the new functions to the required* *roles.* *This commonly affects features such as* [*Self Checkout*](/feature-references/feature-references/self-checkout.md) *and* [*App Selector*](/feature-references/feature-references/app-selector.md)*.* {% endhint %} #### Initialize DCRs If the DCRs fail to update during the upgrade process: 1.Initialize the DCRs via the Config Client: Forecourt > Initialization > DCR.
2.Select **\[All DCRS]** > click **\[OK].**
3.Confirm the initialization > click **\[OK].**
## Reporting ### Upgrade Summary Report
The Upgrade Summary Report provides a summary of the Auto Upgrade which can be printed. To access the Upgrade Summary Report from the POS terminal, go to: **CSR Func > Maintenance > Print Upgrade Summary**. #### Report Details The Upgrade Summary Report provides the following details: •software version before and after upgrade •overall upgrade status •upgrade begin and end times •task details * –task name * –target device * –time taken for task execution * –task status * • Completed * • Completed with Errors * • Failed ### Yearly Reports #### Disable Yearly Reports 1.From the Configuration Client, go to: > Reporting > Report Configuration.
2.Select **\[Yearly] from Period Configuration.** 3.Select **\[No]** for Roll Up DB Reports > click **\[Save].**
#### Enable Yearly Reports 1.From the Configuration Client, go to: > Reporting > Report Configuration.
2.Select **\[Yearly]** from Period Configuration. 3.Select **\[Yes]** for Roll Up DB Reports > click **\[Save].**
--- # Agent Instructions: Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter: ``` GET https://docs.verifone.com/feature-references/feature-references/auto-upgrade.md?ask= ``` The question should be specific, self-contained, and written in natural language. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.