•  Refresh
  • Tools
  •  
  • Expand All
  • Collapse All
  • Locales
  • Get File Link
  • Report Typo
  • Print
  • Export

Tenants

Form ID: (SM203520)

You can use this form to create a new tenant or to modify an existing tenant. Also, by using the form, you can copy the selected tenant to another one, create a snapshot of an existing tenant configuration and data, or restore the tenant configuration and data from a previously created snapshot. For details, on managing tenants, see Tenants: General Information.

In This Topic [Hide/Show]

Back to TopForm Toolbar

The form toolbar and More menu include the buttons and commands described below.

Form Toolbar Buttons

Command Description
Change to Test Tenant Changes the selected tenant into the test tenant.
This button is available if the instance is licensed and the selected tenant’s status is different from Test Tenant.
You won’t be able to later change a test tenant into an active tenant.
Copy Tenant Opens the Copy Tenant dialog box, which you can use to copy the data from the current tenant (that is, the tenant you are signed in to), with all its settings and data, to the tenant that you select in the Destination Tenant box of the dialog box.
To avoid data corruption while copying a tenant, you should activate maintenance mode on the Apply Updates (SM203510) form and deactivate it after you copy the tenant.
If you restore a snapshot created from a tenant with the Active status, or if you copy such a tenant to another tenant with the Test Tenant status, the system will not change the status of the destination tenant.
This button is available if there are more than one tenant in the system.
Create Snapshot Opens the Create Snapshot dialog box, so you can create a snapshot of the tenant database.
To avoid data corruption while creating or restoring a snapshot, you should activate maintenance mode on the Apply Updates (SM203510) form and deactivate it after you create or restore the snapshot.
Hide Warning Hides the warning about unsafe snapshot restoration in the Settings > About box. This warning appears after you have restored (or another administrator has restored) a snapshot that was not taken in maintenance mode.
This button is available when the system is showing the warning about unsafe snapshot restoration in the Settingss > About box.
Optimize Database Opens the Delete Snapshots and Tenants (SM503000) form so that you can delete orphaned snapshots.
Restore Snapshot Opens the Restore Snapshot dialog box, which you can use to restore the tenant data in accordance with the selected snapshot. If the snapshot includes customization data, this data will be restored when you restore the snapshot.
To avoid data corruption while creating or restoring a snapshot, you should activate maintenance mode on the Apply Updates (SM203510) form and deactivate it after you create or restore the snapshot.
 Restoring a snapshot overwrites all the data in the tenant except for any preserved data.
If you restore a snapshot created from a tenant with the Active status, or if you copy such a tenant to another tenant with the Test Tenant status, the system will not change the status of the destination tenant.
Delete Tenant Opens the Delete Snapshots and Tenants form, where you can delete any number of tenants.
View Space Usage Opens the Space Usage (SM203525) form.

Create Snapshot Dialog Box

This dialog box has the following elements.

Element Description
Source Tenant The name and the ID of the tenant that will be used to create a snapshot.
Description A description of the snapshot.
Export Mode The specific settings and data that will be captured when you create a snapshot of the selected tenant. By default, the following options are available:
  • Full: All data related to the tenant
  • Full except Attachments and Wiki: The full data related to the tenant, excluding attachments and wiki articles
  • Full except Attachments: The full data related to the tenant, excluding attachments
  • Settings and Business Accounts: The tenant’s complete set of configuration settings and business accounts, including attachments
  • Settings and Business Accounts except Attachments: The tenant’s complete set of configuration settings and business accounts, excluding attachments
  • Settings except Attachments: The tenant’s configuration settings, excluding attachments
  • Settings only: The tenant’s configuration settings, including attachments
 If the Project Accounting feature is enabled on the Enable/Disable Features (CS100000) form, project-related data is stored as follows for snapshots with the Settings and Business Accounts and Settings and Business Accounts except Attachments export modes:
  • Projects and project tasks are included in the snapshot and assigned the In Planning status.
  • Project templates are included in the snapshot; revenue budget lines and cost budget lines are included in project templates.
  • Common tasks are included in the snapshot along with the budget line information.
Customization project files are included in a snapshot even when you create snapshots in Full except Attachments and Wiki or Full except Attachments export modes. So, you no longer have to re-import your customizations after restoring snapshots.
Prepare for Export A check box that indicates to the system (if selected) that the snapshot should be prepared for export—that is, the snapshot’s data should be saved to a file.
Export Format The format of the files the system uses to save the exported data. The box is available if the Prepare for Export check box is selected. The following options are available:
  • Binary: The exported data is saved in a collection of .adb files.
  • XML: The exported data is saved in a collection of .xml files.
The dialog box has the following buttons.
OK Creates the snapshot in accordance with the selection options.
Cancel Clears the dialog box settings.

Restore Snapshot Dialog Box

The dialog box has the following elements.

Element Description
Destination Tenant The name and the ID of the tenant to which the snapshot data will be restored.
Name The automatically generated snapshot name, which includes the tenant name and the date and time stamp.
Description A description of the snapshot.
The dialog box has the following buttons.
OK Initiates data restoration from the snapshot in accordance with the options you have selected.
Cancel Clears the settings and closes the dialog box.

Back to TopSummary Area

You use these settings to create a new tenant or to select an existing one for maintenance.

Element Description
Tenant ID The tenant identifier, which was generated automatically by the system when the tenant was created.
Tenant Name The tenant name that is used on the site map.
Login Name The name of the tenant that is displayed in the info area (in a multitenant system) and on the Sign-In page.
Due to integration with OData, the value in the Login Name box cannot contain the following special symbols: ,;:+=?^<>/\{}[]|#$%&@
Status The status of the tenant. The system sets the tenant status to one of the following:
  • Active: A live tenant that has been used in production
  • Test Tenant: A test tenant that has been used for testing application features and for training purposes. The system applies this status to a tenant automatically when it is used in the trial version of Acumatica ERP.
  • Unlicensed: A tenant that was created after the license limit for tenants was reached. You cannot work with this tenant in the system.

Back to TopSnapshots Tab

This tab provides information about the available snapshots.

Table Toolbar

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

Button Description
Import Snapshot Opens the Upload the Snapshot Package dialog box, which you can use to initiate the import of the snapshot.
Through the web interface, you can import snapshots only if their size does not exceed 1 GB. To restore snapshots larger than 1 GB, use the Acumatica ERP Configuration wizard. Note that the restoration of larger snapshots is limited to those in XML format only. For details, see Managing Tenants Locally.
Delete Snapshot Opens the Delete Snapshots and Tenants form, where you can delete any number of snapshots.
Prepare in XML Format Creates a .zip file that contains the snapshot data. The exported data is saved in a collection of .xml files. Snapshots are stored in the same database that holds the other data of the tenant.
Prepare in Binary Format Creates a .zip file that contains the snapshot data. The exported data is saved in a collection of .adb files. Snapshots are stored in the same database that holds the other data of the tenant.
Export Snapshot Initiates the export of the snapshot file to the specified storage by using the storage provider. You configure the provider and the storage for snapshots on the Update Preferences (SM203505) form.
Change Visibility Toggles between the visibility settings of the snapshot in the tenant you are signed in to. A snapshot can have either of the following types of visibility:
  • Normal visibility: A snapshot with normal visibility is associated with one of the tenants and is shown in the list of snapshots on the Snapshots tab only when you have selected the tenant associated with the snapshot in the Tenant ID box of the Summary area; the associated tenant is displayed in the Tenant ID column of the snapshot row.
  • Increased visibility: A snapshot with increased visibility is available in the list of snapshots on the Snapshots tab regardless of which tenant you have selected in the Tenant ID box of the Summary area; the Tenant ID column is blank for such snapshots.
    		•  Even snapshots with increased visibility are not visible if you sign in to another tenant.

Upload Snapshot Package Dialog Box

You use this dialog box to select a snapshot that is stored externally and import it into the system. This dialog box has the following elements.

Element Description
Choose File The snapshot that you want to import into the system.
Include Data From Custom Columns A check box you select to import customization data from the snapshot.
If you import customization data, this data will be restored when you restore the snapshot.
Check Database Structure Before Import A check box that indicates whether the system should preliminarily match the data from the snapshot with the database structure in the Acumatica ERP instance where you want to import the snapshot. If this check box is selected, the matching is started when you click the Upload button, before the system imports the snapshot. If any fields from the snapshot do not match the database structure, the snapshot is not imported and an error message is generated.
We recommend that you select this check box only if the database structure was customized in the Acumatica ERP instance where the snapshot was taken.
The dialog box has the following buttons.
Upload Initiates the import of the snapshot in accordance with the selected options.
Close Clears the settings and closes the dialog box.

Table Columns

Column Description
Name The system-generated, read-only snapshot name, which includes the tenant name and the date and time stamp.
Description The description of the snapshot.
Ready for Export A check box that indicates to the system (if selected) that this snapshot is packed into an archive file and can be immediately downloaded.
Size (MB) The size of the snapshot (in MB).
Creation Date The date when the snapshot was created.
Version The version of the application installed when the snapshot was created.
Export Mode The content option used to create a snapshot. For more information, see Snapshots: General Information.
Tenant ID The tenant the snapshot is associated with if the snapshot has normal visibility. The column is blank if the snapshot has increased visibility. You select a snapshot, and then click Change Visibility on the table toolbar to toggle the visibility of the snapshot.
Customization The names of the customization files (separated by commas) that were used by the tenant when the snapshot was created.
Snapshot ID An alphanumeric string identifying the snapshot.
Is Safe A check box that indicates (if selected) that the snapshot was taken in maintenance mode and contains consistent data. If this check box is cleared, this indicates that the snapshot was not taken in maintenance mode and may contain corrupted data. We do not recommend that you restore unsafe snapshots for production use.

Back to TopSnapshot Restoration History Tab

On this tab, you can see which snapshots have been restored and when each restoration occurred.

The table toolbar includes only standard buttons. For the list of standard buttons, see Table Toolbar.

Table Columns

Column Description
Name The system-generated, read-only snapshot name, which includes the tenant name and the date and time stamp.
Description The description of the snapshot.
User The name of the user who restored the snapshot.
Restoration Date The date when the snapshot was restored.
Version The version of Acumatica ERP instance that was used when the snapshot was restored.
Is Safe A check box that indicates (if selected) that the snapshot was taken in maintenance mode and contains consistent data. If this check box is cleared, this indicates that the snapshot was not taken in maintenance mode and may contain corrupted data.
Dismissed A check box that indicates (if selected) that the warning about unsafe snapshot restoration in the Help > About box was hidden (that is, some user clicked the Hide Warning button).
Snapshot ID An alphanumeric string identifying the snapshot.

Back to TopUsers Tab

This tab shows the users who have access to the tenant and a variety of read-only information about them.

Table Toolbar

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

Button Description
Manage User Navigates to the Users (SM201010) form so you can view more information about the user you selected.

Table Columns

Column Description
Username The username of this user of the tenant.
Activate Account A check box that indicates whether the user account is active.
First Name The first name of the user.
Last Name The last name of the user.
Email The email account of the user.
Phone The phone number of the user.
Comment Any comments provided for the user account.
Is Online A check box indicating whether the user is currently online.
Temporary Lock Out Account A check box that indicates whether the user account may be temporarily locked out if the user doesn’t provide proper authentication on the specified conditions.
Force User to Change Password on Next Login A check box that indicates whether this user will be forced to change his or her password on the next login.
Allow Password Recovery A check box indicating whether password recovery is allowed for the user account.
Password Never Expires A check box indicating whether the password for this user account is defined as never expiring.