BackupAgent Management Console 4.4.1 Administrator Manual 1. Product information Product: BackupAgent Management Console Version: 4.4.1 2. Benefits The Management Console allows you to manage accounts and backups. It serves the Online Backup Clients.
Freemium accounts The BackupAgent Management Console is fully configurable. All settings, texts and graphical appearances can be changed: Email communication is fully configurable for every email Management Console appearance can be changed Support links, download links and registration links can be changed 4. Working with the Management Console The management console (MC) offers web-based access to control all backup activities of endusers (Users).
If you log in, a dashboard will appear to give a quick overview of the end-users’ backup and restore status. In the right top corner a drop down menu offers all possible languages for the MC. You can easily switch between languages. In general the Administrator MC has 7 menus: Home (dashboard) User management Group management Server License Support Logout Each menu item will be described in the following paragraphs. 4.
The user tab shows: The user name of the account The user profile (license type) Account size Status Usage Client version (version of the Backup Client the user uses) Last backup Last restore The accounts are sorted by their username. You can click on any column to sort the accounts in another way. If you click on the “+” left of the username, you can view the status of the last five backups.
The difference between 'My accounts' and 'All accounts' is that 'My accounts' will show all accounts directly under the Administrator, while 'All accounts' will also show accounts in all Groups. It is possible to show accounts per group as well. Besides this, you can also choose to show only the accounts that have been active the last seven days, or new accounts that have been added the last seven days. Groups The system can also support Groups for managing user accounts.
There are three search options for finding user: Search on user information Search on Group Search on account date User information To search on user information use the top left drop down menu. It offers multiple fields to search on: User name First name Last name Email Account type Storage location Company Fill in part of the name or description to look for all user accounts that contain part of the text. (e.g.
If you found a specific user, you can click on the user name to view all details of the account. You can also delete multiple accounts, remove user data, recalculate usage, deactivate or clean corrupted files by checking the checkboxes on the left of the data grid. If an account is checked the extra available actions will appear: You can select all the accounts on the screen, by checking the top box. You can then select an action to execute.
To add a user, you must set user info and account info.
Account type: An amount of data to reserve for the user User profile: Can be a Workstation or a Server user Maximum bandwidth: A limitation to the maximum upload speed can be set Storage location: The storage location to store the files Active: Activates the account if checked Restore active: Allows the user to restore data Enable auto remove: Sets date on which the account expires and will be removed Send act.
Personal Reports Account history Client logs Personal In this tab you can change the personal information of the user, change user account type, reset user password and remove the user. You can also manually deactivate the account or deactivate the restore option in the client for the account. Do not forget to confirm your action by clicking the ‘Update’ button at the bottom.
Account history In this tab you can see when the user account has been modified and by whom. Client logs Here you can view all client logs which are made after backup or restore. This covers all functionality for managing users as an Administrator.
4.4 Group Management Next to users, the system offers you to define groups that can distribute user accounts. Through the ‘Group management’ menu, just like in ‘User management’, you can: Find Groups Add Group Note: It is also possible to add a subgroup for an existing group. By default you will be able to create up to 3 levels deep of nesting of subgroups. This can be done by enabling the option ‘Allow sub group management’ when creating a group. 4.4.
Fill in part of the name or description to look for in order to find all accounts that contain part of the text. (e.g. looking for ‘BA’ for a username will find ‘BA1’, ‘myBA’ and ‘a BA’). Click on the ‘User name’ to change information of a specific Group. You will be able to change the Group information as well as Group Restrictions and Additional information. If the Group is a Private Label group, you also have the possibility to edit some Private Label options. 4.4.
To add a Group, you must set the credentials of the Group: Parent: Choose the parent the group will belong to.
Maximum Workstation CALs: Maximum of Workstation users the group can create. Maximum Server CALs: Maximum of Server users the group can create. Maximum storage (GB): Maximum of storage, in GB, the group can use to create new accounts. Note: Setting the restrictions to '-1' will indicate that the restriction has no limit. Allow trial accounts: Here you can specify if the trial accounts are allowed. Allow accounts upgrade: Here you can specify if the group is allowed to upgrade the users.
Storage locations: Check storage locations the Group can assign accounts to. Default storage location: The default location which is assigned if a user registers at this Group. User account upgrade: Specifies if users are allowed to upgrade their own accounts. User account downgrade: Specifies if users are allowed to downgrade their own accounts. From Email: The sender email address of the Group’s communication with users. Max.
All URL fields are optional. If they are not filled out they will link to the default URLs (set by BackupAgent). In case of a Private Label Group, extra links must be filled out: Terms URL: URL for the terms and conditions of services of the Group Registration URL: Alternative registration URL Download URL: Alternative client download URL Upgrade URL: Alternative account upgrade URL. Support URL: The URL links to if the user clicks on the ‘support’ link.
The Groups are shown in the ‘Group’ tab on the home dashboard. To view or change settings of (Private Label) Groups, click on the ‘User name’ of the specific Group. This way it is also possible to reset the Group password. This covers all functionality for managing Groups as an Administrator. 4.5 Server Management For server management the MC offers functionality divided in four submenus: Server settings Private Label settings Change password Event viewer 4.5.
Server settings have four tab pages. Each tab page holds a category of settings. 4.5.1.1 Server settings tab The server tab displays all server behaviour settings: Usage logging: Allows the server to log all file transfers of users. Max. backup reports: The total number of backup reports that are saved per user. Max. use account for sending warning mail: When the limited percentage is reached or has passed, the user will receive a warning email.
Log error to the event log: This will log errors to the Windows Event log in case of serious problems accessing the database. Show registration link: Enabling it will enable the registration link in the login page. User can change password: Enabling it allows the user to change their own password. User can change account information: Enabling it allows the user to change their own account information.
This tab gives an overview of all storage locations available for users to store their backups on. The locations are displayed in a datagrid: You can change the settings of a storage location by clicking on ‘Edit’ or add a new storage location by clicking ‘Add storage location’. In both cases a detailed view of the storage location will appear. When adding or changing a storage location the following fields are available: UNC Zip / MongoDB Storage name: Friendly name of the storage location.
Note: The default values which are installed for MongoDB after a setup, are as follows: MongoDB Server/Database: mongodb://localhost/CloudBackupService MongoDB User Name: CloudBackupServer Windows Azure Storage name: Friendly name of the storage location. Storage account: The name of the Windows Azure account. Account key: The unique access key to the Windows Azure storage. Amazon S3 Storage name: Friendly name of the storage location.
Tick the box ‘Default storage location’ to determine whether this location is the default location to which the user is assigned, for example in the case of a public registration. Click on ‘Add’ or ‘Update’ to confirm the addition or change of the storage location. In case of changing the existing storage location, this location can be removed by clicking on ‘Remove storage location’. Note: Removing a storage location is only allowed if no users are using the storage location for their backups.
This local account is loaded by BackupAgent to impersonate the network user to login to the network path. 4.5.1.4 Account tab The account tab allows you to specify all the available account types for users. You can add new account types, activate account types and deactivate account types. You can choose which default trial account you want to set for new customers. To do this, just select a size in the drop-down menu and click on ‘Update’.
Note: If the license allows you to use freemium accounts then this is added by default and can be selected from the ‘account type’ pull down menu when adding a user. Freemium accounts are for both workstations and servers and they do not expire like trial accounts do. They can have a maximum size of 2 GB. Maintenance service tab Cloud Backup Maintenance Service processes reporting information and performs related maintenance tasks.
SendNoBackupWarningMail: Sends a warning mail to the accounts from which no backups have been received for the number of days specified in group management. Storage Maintenance: Maintains storage consistency and account size by verifying existing data inside user accounts. 4.5.4 Private Label settings Through the ‘Private Label settings’ you can change all appearances of the BackupAgent Server software. Use these settings to change all cosmetics and link directions to other parts of your website.
Upgrade URL: URL where the user is directed to when clicking on the ‘larger account’ link in the registration page or the link that is inserted in the email when a trial account is about to expire. Home URL: URL where the user is directed to when logging out. Client download URL: URL of the setup file of the (Private Label) BackupAgent Online Backup Client . This link will show on the Home page when logged in as a user.
UploadDisabled: Sends an email after the account is full. AccountAlmostFull: Sends an email with a warning if the account reaches the warning limit. ForgotEncryptionKey: Sends a reminder of the encryption key to the user AccountUpgraded: Sends a notification to the administrator and user if the account is upgraded. BackupReport: Sends a backup report after the backup is finished. RestoreReport: Sends a restore report after the restore is finished.
The view shows all email settings. You can change: BCC: A BCC recipient of the sent email Subject: The email subject Content type: Either text or HTML Email text: The content of the email. The content can contain escape fields which are replaced by user settings or settings of the parent Group/Administrator.
ServiceName UpgradeLink ParentUser URL For the backup and restore status reports extra fields are available: LongDate StatusText Computer ClientVersion OS StartDate EndDate Duration TotalFiles TotalSize BackupSources BackupUnavailableSources NewFiles NewFilesSize PatchFiles PatchFilesSize UnchangedFiles SkippedFiles ChangedFiles ChangedSize UploadSize SkippedFiles NonExistentResources Note: These fiel
Click on ‘Update’ to save the changed email content. Click on ‘Cancel’ to cancel the change. You can also click on ‘Test Email’ to see the result of your changes. Content tab The content tab allows you to personalize the welcome text in the default.aspx page on all available languages: Click on the language to change the content and title of the welcome page for the specific language. Click on ‘Update’ to save the changed content. Click on ‘Cancel’ to cancel the change.
The header and footer combination must contain a closing and matching HTML combination. The MC tag (escape field for custom stylesheet) is also required and can be inserted from the top right on the screen into the header by double-clicking on the tab: The screenshot shows a correct format of the header and footer to show 'Hello' on top of the Management Console and retain the stylesheet from within the Management Console using the MC_HEAD_TAG. Click on ‘Update’ to save the changed content.
Message The message tab allows you to create a message which will be shown in all Online Backup Clients that are connected to this Backup Server. You can publish a text message in the "Message text" box and a URL of can be placed in the "Message link" box. Note: The message will be shown in the Online Backup Client of all users. Also of the users that are assigned to a Group. 4.5.5 Change Password Click on ‘Change password’ to change the Administrator password.
Click on ‘Update’ to save the changed content. Click on ‘Cancel’ to cancel the change. 4.5.6 Event Viewer Open the Event Viewer to look up unexpected errors with backup accounts. Click on the ‘+’ sign in front of the error to view details. All errors which might occur in the management console will be logged here. In some cases the error might concern the backup of a specific user. The error identifier can link an error on the server directly to an error in the logs of a client.
The license can be updated by clicking on the ‘License upgrade’ tab. This tab offers a field to insert (copy-paste) an encrypted license provided by BackupAgent BV. Click on ‘Update’ to update the license. Note: If the domain name for the provided license does not match the domain name of the machine, you will get a warning that the DNS/IP address from the license does not resolve into a local IP address.
