Apply Updates

Form ID: (SM203510)

You can use this form to manage minor Acumatica ERP updates (that is, updates that are released between major versions of the product).

The ability to update an instance by using the web interface is not available for SAAS customers of Acumatica Business Cloud. For details, contact your Acumatica support provider.

In This Topic [Hide/Show]

Form Toolbar
   Schedule Lockout dialog box
Current Version Area
Updates Tab
   Table Toolbar
   Table Columns
Update History Tab
   Upper Table Columns
   Lower Table Toolbar
   Lower Table Columns

Back to TopForm Toolbar

The form toolbar includes standard buttons and form-specific buttons and commands. For the list of standard buttons, see Form Toolbar and More Menu. The form-specific commands can be shown as buttons on the form toolbar, as commands on the More menu, or in both places. These commands are listed in the following table in alphabetical order.

Command

Description

Repair Database

Initiates the process of updating or repairing the database. This button is unavailable when the online database update is not available for the current version of Acumatica ERP.

Reset Caches

Clears all in-memory caches in the system, all data in the current user session, and the cached information about the schema of the following: APIs, import and export scenarios, and certain types of forms (generic inquiries, dashboards, and pivot tables).You invoke this button when the system is updating information for these entities slowly.

Restart Application

Initiates the process of restarting the Acumatica ERP instance.

Schedule Maintenance

Opens the Schedule Lockout dialog box, which gives you the ability to schedule a lockout. This button changes to Stop Maintenance when the system is locked out.

Stop Maintenance

Unlocks the system. This button appears when the system is in lockout mode.

Update Statistics

Updates statistics for tables in the Acumatica ERP database. You click this button if you want to update statistics between times when the default updates of statistics on the database server are performed, in order to optimize database queries.

We recommend that you click this button only when you know that updating statistics helps to optimize the performance of your Acumatica ERP instance, because updating statistics causes queries to be recompiled, which may take a lot of time.

Schedule Lockout dialog box

By using this dialog box, you can schedule system lockout. The dialog box includes the elements described below.

When the lockout is in effect, the following happens in the system:

Only users that have the Administrator role can sign in to the system.
The system stops all processes that were run by a schedule.

Element	Description
Lock Out At	The planned date and time of the system lockout.
Reason	The reason for the lockout. The reason is displayed on the Sign-In page when the system is locked out.
Lock Out All Sites	A check box that indicates (if selected) that all sites installed on the same database as the current site will be locked out. If you want to lock out only the current site you clear the check box. By default, this check box is selected.
The dialog box has the following buttons.
OK	Sets the lockout time and closes the dialog box.

Back to TopCurrent Version Area

The read-only boxes in the Current Version area provide information about the current version of the application and the date when it was last updated.

Element	Description
Current Version	The version of the application installed or of the update last installed.
Last Update Date	The date when the application update was last updated.

Back to TopUpdates Tab

The Updates tab includes version information about the Acumatica ERP instance, and a table showing the available minor updates. The table includes the update packages available locally and the update packages available on the update server whose address is specified on the Update Preferences (SM203505) form.

Upgrading between major versions by using the web interface is not supported because of significant changes in the system. You should use the Acumatica ERP Configuration wizard instead.

Element	Description
Restriction Key	An optional password to be used to access unpublished versions.

Table Toolbar

The table toolbar includes standard buttons and buttons that are specific to this table. For the list of standard buttons, see Table Toolbar. The table-specific buttons are listed below.

Button	Description
Upload Custom Package	Uploads the custom package, which contains an update, from the local computer or network to the website.
Download Package	Downloads the update package from the update server.
Install Update	Initiates the process of installing the selected update.
Validate Customization	Starts the process of validating the compatibility of the currently published customization code with the code of the selected product version. This button appears when validation is turned on in the `web.config` file (it is turned on by default). If you have published customization projects in your Acumatica ERP instance, we recommend that you click this button before each update of your Acumatica ERP instance by using the web interface.

Table Columns

Column	Description
Version	The version of the update package.
Published Date	The date when the version was published.
Restricted	A check box that indicates (if selected) that this update is unpublished and has restricted access. To use it, provide the restriction key.
Ready to Install	A check box that indicates (if selected) that this update has been uploaded or downloaded to the website and can be installed.

Back to TopUpdate History Tab

The Update History tab provides information about updates that have already been installed. The tab includes two tables: the upper table includes update history, and the lower table holds information about errors you got during the update.

Upper Table Columns

The columns in the upper table are described below. The table toolbar includes only standard buttons. For the list of standard buttons, see Tables.

Column	Description
Maintenance ID	The system-generated number of the update installation.
Maintenance Components ID	The system-generated number of the update component.
Host	The computer from which the process of updating had been initiated.
Component Name	The name of the updated component.
Component Type	The type of the updated component.
From Version	The version that had been installed before.
To Version	The version of the application update.
Started On	The time when the installation had begun.
Finished On	The time when the installation had been completed.

Lower Table Toolbar

The table toolbar includes standard buttons and buttons that are specific to this table. For the list of standard buttons, see Table Toolbar. The table-specific buttons are listed below.

Button	Description
Skip Error	Marks the selected line as skipped, so it will not appear on the login screen.
Show Log File	Opens the text file with the log of update operations.
Clear Log File	Clears the text file with the log of update operations.

Lower Table Columns

Column	Description
Error ID	The reference number of the error.
Error	The description of the error.
Stack	The stack showing you the order in which the error details were generated.
Script	The details of the script related to the error, which are automatically generated by the system.
Skipped	A check box that shows if the error was skipped.

Apply Updates

Form ID:  ([~/?ScreenId=SM203510|SM203510]){br}

You can use this form to manage minor Acumatica ERP updates (that is, updates that are released between major versions of the product). [anchor|#note_ljy_fvx_gtb]((({S:Warn}The ability to update an instance by using the web interface is not available for SAAS customers of Acumatica Business Cloud. For details, contact your Acumatica support provider.
))){br}{TOC}
==Form Toolbar==[anchor|#_8380db12-587a-41a9-a96e-820576185289]
The form toolbar includes standard buttons and form-specific buttons and commands. For the list of standard buttons, see [HelpRoot_Interface\Form_Toolbar|Form Toolbar and More Menu]. The form-specific commands can be shown as buttons on the form toolbar, as commands on the More menu, or in both places. These commands are listed in the following table in alphabetical order.
{| class="checklist" | width="100%" 
|- 
!width="19%" ! Command
!width="80%" ! Description
|- 
| '''Repair Database'''
| Initiates the process of updating or repairing the database. This button is unavailable when the online database update is not available for the current version of Acumatica ERP.
|- 
| '''Reset Caches'''
| Clears all in-memory caches in the system, all data in the current user session, and the cached information about the schema of the following: APIs, import and export scenarios, and certain types of forms (generic inquiries, dashboards, and pivot tables).
You invoke this button when the system is updating information for these entities slowly.
|- 
| '''Restart Application'''
| Initiates the process of restarting the Acumatica ERP instance.
|- 
| '''Schedule Maintenance'''
| Opens the '''Schedule Lockout''' dialog box, which gives you the ability to schedule a lockout. This button changes to '''Stop Maintenance''' when the system is locked out.
|- 
| '''Stop Maintenance'''
| Unlocks the system. This button appears when the system is in lockout mode.
|- 
| '''Update Statistics'''
| Updates statistics for tables in the Acumatica ERP database. You click this button if you want to update statistics between times when the default updates of statistics on the database server are performed, in order to optimize database queries.[anchor|#note_nn2_sqb_nqb]((({S:Warn}We recommend that you click this button only when you know that updating statistics helps to optimize the performance of your Acumatica ERP instance, because updating statistics causes queries to be recompiled, which may take a lot of time.
)))
|}[anchor|#table_zgv_2b4_nm]
===Schedule Lockout dialog box===
By using this dialog box, you can schedule system lockout. The dialog box includes the elements described below.[anchor|#_acda5444-52a6-46d2-96d5-cf0b2fdc8945]((({S:Warn}When the lockout is in effect, the following happens in the system:[anchor|#_7d3778af-423f-4f5d-887b-edbd030c092c]
*Only users that have the ''Administrator'' role can sign in to the system.
*The system stops all processes that were run by a schedule.
)))
{| class="checklist" | width="100%" 
|- 
!width="20%" ! Element
!width="80%" ! Description
|- 
| '''Lock Out At'''
| The planned date and time of the system lockout.
|- 
| '''Reason'''
| The reason for the lockout. The reason is displayed on the Sign-In page when the system is locked out.
|- 
| '''Lock Out All Sites'''
| 
A check box that indicates (if selected) that all sites installed on the same database as the current site will be locked out. If you want to lock out only the current site you clear the check box.{br}

By default, this check box is selected.
|- 
| colspan="2" | The dialog box has the following buttons.
|- 
| '''OK'''
| Sets the lockout time and closes the dialog box.
|}[anchor|#1]
==Current Version Area==
The read-only boxes in the Current Version area provide information about the current version of the application and the date when it was last updated. 
{| class="checklist" | width="100%" 
|- 
!width="20%" ! Element
!width="80%" ! Description
|- 
| '''Current Version'''
| The version of the application installed or of the update last installed.
|- 
| '''Last Update Date'''
| The date when the application update was last updated.
|}[anchor|#2]
==Updates Tab==
The '''Updates''' tab includes version information about the Acumatica ERP instance, and a table showing the available minor updates. The table includes the update packages available locally and the update packages available on the update server whose address is specified on the [HelpRoot_FormReference\SM_20_35_05|Update Preferences] ([~/?ScreenId=SM203505|SM203505]) form.((({S:Warn}Upgrading between major versions by using the web interface is not supported because of significant changes in the system. You should use the Acumatica ERP Configuration                            wizard instead.
)))
{| class="checklist" | width="100%" 
|- 
!width="20%" ! Element
!width="80%" ! Description
|- 
| '''Restriction Key'''
| An optional password to be used to access unpublished versions.
|}
===Table Toolbar===[anchor|#_65269710-84a8-4584-b9d9-78b91ce5a8d1]
The table toolbar includes standard buttons and buttons that are specific to this table. For the list of standard buttons, see [HelpRoot_Interface\Details_Toolbar|Table Toolbar]. The table-specific buttons are listed below.
{| class="checklist" | width="100%" 
|- 
!width="20%" ! Button
!width="80%" ! Description
|- 
| '''Upload Custom Package'''
| Uploads the custom package, which contains an update, from the local computer or network to the website.
|- 
| '''Download Package'''
| Downloads the update package from the update server.
|- 
| '''Install Update'''
| Initiates the process of installing the selected update.
|- 
| '''Validate Customization'''
| 
Starts the process of validating the compatibility of the currently published customization code with the code of the selected product version. {br}

This button appears when validation is turned on in the <tt>web.config</tt> file (it is turned on by default).{br}

If you have published customization projects in your Acumatica ERP instance, we recommend that you click this button before each update of your Acumatica ERP instance by using the web interface. 
|}[anchor|#table_gnn_3v5_x3]
===Table Columns===
{| class="checklist" | width="100%" 
|- 
!width="20%" ! Column
!width="80%" ! Description
|- 
| '''Version'''
| The version of the update package.
|- 
| '''Published Date'''
| The date when the version was published.
|- 
| '''Restricted'''
| A check box that indicates (if selected) that this update is unpublished and has restricted access. To use it, provide the restriction key.
|- 
| '''Ready to Install'''
| A check box that indicates (if selected) that this update has been uploaded or downloaded to the website and can be installed.
|}[anchor|#3]
==Update History Tab==
The '''Update History''' tab provides information about updates that have already been installed. The tab includes two tables: the upper table includes update history, and the lower table holds information about errors you got during the update.
===Upper Table Columns ===The columns in the upper table are described below. The table toolbar includes only standard buttons. For the list of standard buttons, see [HelpRoot_Interface\Details_Table|Tables].
{| class="checklist" | width="100%" 
|- 
!width="20%" ! Column
!width="80%" ! Description
|- 
| '''Maintenance ID'''
|  The system-generated number of the update installation.
|- 
| '''Maintenance Components ID'''
| The system-generated number of the update component.
|- 
| '''Host'''
| The computer from which the process of updating had been initiated.
|- 
| '''Component Name'''
| The name of the updated component.
|- 
| '''Component Type'''
| The type of the updated component.
|- 
| '''From Version'''
|  The version that had been installed before.
|- 
| '''To Version'''
|  The version of the application update.
|- 
| '''Started On'''
|  The time when the installation had begun. 
|- 
| '''Finished On'''
|  The time when the installation had been completed. 
|}[anchor|#table_skh_kx5_x3]
===Lower Table Toolbar===[anchor|#_65269710-84a8-4584-b9d9-78b91ce5a8d1]
The table toolbar includes standard buttons and buttons that are specific to this table. For the list of standard buttons, see [HelpRoot_Interface\Details_Toolbar|Table Toolbar]. The table-specific buttons are listed below.
{| class="checklist" | width="100%" 
|- 
!width="20%" ! Button
!width="80%" ! Description
|- 
| '''Skip Error'''
| Marks the selected line as skipped, so it will not appear on the login screen.
|- 
| '''Show Log File'''
| Opens the text file with the log of update operations.
|- 
| '''Clear Log File'''
| Clears the text file with the log of update operations.
|}
===Lower Table Columns===
{| class="checklist" | width="100%" 
|- 
!width="20%" ! Column
!width="80%" ! Description
|- 
| '''Error ID'''
| The reference number of the error.
|- 
| '''Error'''
| The description of the error.
|- 
| '''Stack'''
| The stack showing you the order in which the error details were generated. 
|- 
| '''Script'''
| The details of the script related to the error, which are automatically generated by the system. 
|- 
| '''Skipped'''
| A check box that shows if the error was skipped.
|}