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.

Form 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.

Table 1. Form Toolbar Buttons
Command	Description
Change to Test Tenant	Changes the selected tenant into the test tenant. CAUTION: 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.
Create Snapshot	Opens the Create Snapshot dialog box, so you can create a snapshot of the tenant database. Note: We strongly recommend that you create snapshots in maintenance mode (that is, when the system is locked out for maintenance, as described in To Schedule the System Lockout). Otherwise, snapshots can contain corrupted data (for example, if any transactions were in progress during the creation of the snapshot).
Hide Warning	Hides the warning about unsafe snapshot restoration in the Tools > 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 Tools > 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. CAUTION: Restoring a snapshot overwrites all the data in the tenant except for any preserved data.
View Space Usage	Opens the Space Usage (SM203525) form.

Table 2. Create Snapshot Dialog BoxThis 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 Attention: In the snapshots with the Settings and Business Accounts and Settings and Business Accounts except Attachments export modes, all projects and project tasks are assigned the In Planning status. (The projects are available in the system if the Project Accounting feature is enabled on the Enable/Disable Features (CS100000) form.)
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.

Table 3. Restore Snapshot Dialog BoxThe 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.

Tenant Summary 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.
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 MYOB Advanced. Unlicensed: A tenant that was created after the license limit for tenants was reached. You cannot work with this tenant in the system.
Snapshot Entitlement	The number of snapshots that can be saved at any one time. When this entitlement is reached, a new snapshot cannot be taken until an existing one is deleted. Note: This entitlement applies to the entire site, not just this company.
Snapshot Current	The current number of snapshots in the system.

Snapshots Tab

This tab provides information about the available snapshots.

Table 4. Table ToolbarThe 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.
Prepare For Export	Creates a .zip file that contains the snapshot data. Snapshots are stored in the same database that holds the other data of the tenant. The following options are available: Binary Format: The exported data is saved in a collection of .adb files. XML Format: The exported data is saved in a collection of .xml files.
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. Note: Even snapshots with increased visibility are not visible if you sign in to another tenant.

Table 5. Upload Snapshot Package Dialog BoxYou 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. Note: 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 MYOB Advanced 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. Note: We recommend that you select this check box only if the database structure was customized in the MYOB Advanced 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 6. 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.

Snapshot 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 7. 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 MYOB Advanced 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.

Users Tab

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

Table 8. Table ToolbarThe 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 9. Table Columns
Column	Description
Username	The user name 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.