contentACCESS documentation-version 6.0

  1. Introduction to contentACCESS
    1. Services provided by contentACCESS
    2. Software requirements
      1. contentACCESS prerequisites
  2. contentACCESS setup package
    1. Installation of contentACCESS
      1. EULA
      2. Installation type
      3. Components
      4. Prerequisites
      5. Base folder
      6. Service settings
      7. Database connection
      8. contentACCESS Central Administration
      9. contentACCESS Web Services (Proxy)
      10. contentACCESS Portal
      11. Preview service
      12. Central login
      13. Virtual drive
      14. Search service
      15. Search service (V2)
      16. SMTP server
      17. Overview
      18. Installation
      19. Summary
  3. contentACCESS components
    1. contentACCESS Central Administration
      1. Central administration login
      2. contentACCESS Automated single sign on
      3. Central Administration logout
      4. contentACCESS Central Administration user interface
    2. contentACCESS Portal
      1. Logging in to contentACCESS Portal
      2. contentACCESS Portal Automated single sign on
    3. Virtual drive
    4. contentACCESS Web Services (Proxy)
    5. Central login page
  4. contentACCESS Tools
    1. Installing Outlook forms
    2. Legacy email archive connectors
    3. Legacy archive connector for Metalogix Archive Manager Exchange Edition (MAM EE)
      1. Installing Legacy MAM retrieve service and its configuration on the MAM server
      2. Configuration of the MAM server in contentACCESS Central Administration
    4. Legacy archive connector for Email Lifecycle Manager (ELM)
    5. Installing TECH-ARROW’s WinShortcutter
    6. contentACCESS Outlook add-in
      1. Installation of contentACCESS Outlook add-in
      2. How to use contentACCESS Outlook add-in
  5. Tenants in contentACCESS
    1. How to create a new tenant
      1. How to edit and disable a tenant
    2. Tenant limitations
    3. How to provide access to a tenant (adding new tenant administrators)
    4. Tenant administrator invitation types
    5. Tenant associations
      1. Tenant - database association
      2. Tenant - user association
    6. Tenant deletion
  6. General system configurations
    1. Connection
    2. User interface
    3. Users in contentACCESS
    4. Invitations
    5. Roles
      1. Creating roles
      2. Role details
      3. Role assignment
      4. Defining specific permissions of a role assignment
      5. Editing roles, editing role assignments
      6. Role cloning
      7. General use cases of how to create/assign roles
      8. Managing access to contentACCESS objects
    6. Login providers
      1. Login providers’ context menu options
      2. External login provider configuration
        1. Configuring Google OAuth
        2. Configuring Office 365 login provider
        3. Exchange login provider
        4. External AD login provider
      3. Associating an enabled provider with a user login
      4. contentACCESS users in third party systems
    7. System
    8. Licensing
      1. How to activate your license key
    9. Notifications
    10. System logs — how to find out possible misconfigurations / reasons of potential system/job failures
    11. Configuration auditing
    12. Archive auditing
    13. Distributed environment in contentACCESS — Clusters
    14. Statistics
    15. Legal hold
    16. Task runner
    17. Indexing
    18. SMTP Servers
    19. SMTP Mappings
    20. Sharing job
    21. Sharing settings
    22. How to create/configure databases — All databases
  7. Common features
    1. Databases
    2. Schedules
    3. Retentions
    4. Storages
      1. Amazon S3
      2. Google drive storage
      3. Datengut storage
      4. Azure storage
      5. Disk storage
      6. HybridStore
      7. Perceptive storage
      8. Kendox storage
    5. Exchange connections
      1. Exchange performance settings – turning off the Exchange throttling policies
      2. Mixed Exchange environments in the Email Archive system
    6. Importing contentACCESS configurations from files
      1. Manual import of Exchange servers/groups/mailboxes to the contentACCESS Address book
      2. Importing File Archive root folders to be archived
  8. Creating new jobs in contentACCESS
  9. Jobs’ page, jobs’ context menu
  10. Filtering in jobs
  11. File Archive
    1. Introduction to File system archive
    2. File archive settings
    3. File archive Databases
    4. File archive System settings
    5. File archive Retentions
    6. File archive Storages
    7. Root folders
    8. Aliases
    9. File archive Schedules
    10. Provisioning settings and managing access to contentACCESS Portal
      1. File system provisioning job description
    11. Remote agents (file archive)
    12. Global rules (remote file archive)
    13. Configuring aliases
    14. Configuration of jobs available in contentACCESS File Archive
    15. Configuration of File archive retention changer job
    16. Configuration of File system archive job
      1. File system archive job description
    17. Configuration of a File system restore job
      1. File system restore job description
    18. Configuration of File system recovery job
      1. File system recovery job description
    19. Configuration of Delete job in File archive
      1. File system delete job description
    20. Configuration of File system shortcut synchronization job
      1. File system shortcut synchronization job description
    21. Configuration of Remote shortcutting job
      1. File system remote shortcutting job description
    22. Active/inactive documents in File system archive
  12. Email Archive
    1. Important settings before creating an Email Archive job
    2. Database settings
    3. Email archive System settings
      1. Hybrid exchange settings
      2. Email archive registration on Azure portal for Modern authentication
    4. Email archive Provisioning settings
      1. Email archive provisioning job description
    5. Retention settings
    6. Shortcuts in email archiving
    7. Storing of archived emails
      1. LoboDMS storage
    8. Creating email archive schedulers
    9. User experience
      1. Exchange 2013+: Mail app in OWA 2013+ or on MS Outlook 2013+ desktop version
      2. Exchange 2010: OWA 2010 integration
    10. Address book objects
      1. Adding address book objects manually
      2. Removing groups and mailboxes from the Address book
    11. Granting access rights for mailbox users and explicit users to view the mailbox archive
      1. Creating contentACCESS Portal users (option 1)
      2. Manage access to a mailbox archive (option 2)
    12. Database and store assignment in email archiving
      1. How to assign database, storage and index zone to an Exchange group?
      2. How to assign database, storage and index zone to a mailbox?
      3. How to move data from source database/storage into a second (target) database/storage?
    13. Mail app access
    14. Remote agents (email archive)
    15. PST import
      1. PST import job description
    16. Creating Email archive jobs: archive, restore, recovery, delete, mailbox move, shortcut synchronizaion, shortcut repair
    17. Email archive job
      1. Email archive job configuration
      2. Email archive job description
      3. Email archive journal processing
        1. Recommendations after turning on journal archive
      4. Archiving of rights protected messages
    18. Email archive retention changer job
    19. Email restore job
      1. Email restore job configuration
      2. Email restore job description
    20. Email recovery job
      1. Email recovery job configuration
      2. Email recovery job description
    21. Configuration of Delete job in Email archive
      1. Email delete job description
    22. Journal post processing job
      1. Journal post processing job configuration
    23. Mailbox move job
      1. Mailbox move job configration
      2. Mailbox move job description
    24. Shortcut synchronization job
      1. Shortcut synchronization job configuration
      2. Email shortcut synchronization job description
    25. Shortcut repair job
      1. Shortcut repair job configuration
      2. Email shortcut repair job description
    26. Public folder archiving
      1. How to configure a job to archive public folders
      2. Public folders in the contentACCESS Portal archive
      3. User permissions to public folders
      4. Public Folder archiving in mixed Exchange environments
    27. Access to private emails and archiving them
    28. SMTP archiving
  13. SharePoint archive plugin
    1. SharePoint Archive settings
    2. SharePoint Archive job configuration
      1. SharePoint archive job description
    3. SharePoint archive retention changer job configuration
    4. SharePoint recovery job configuration
      1. SharePoint recovery job description
    5. Configuration of Delete job in SharePoint archive
      1. SharePoint delete job description
    6. SharePoint archive Provisioning settings
      1. SharePoint provisioning job description
    7. SharePoint Publishing job
      1. SharePoint publishing job description
    8. SharePoint in the contentACCESS Portal archive
  14. OneDrive archive
    1. OneDrive Archive job configuration
    2. OneDrive archive Jobs
  15. GDPR plugin
    1. GDPR Settings
      1. GDPR Databases
      2. GDPR Schedules
      3. GDPR Index zones
    2. GDPR Processing
      1. GDPR File system settings
      2. GDPR Exchange settings
      3. GDPR Applications
      4. GDPR Jobs
        1. GDPR File system job
          1. GDPR file system job description
        2. GDPR Exchange job
          1. GDPR Exchange job description
        3. GDPR Application job
          1. GDPR application job description
  16. Teams archive
    1. Teams archive databases
    2. Teams archive System settings
    3. Teams archive Provisioning settings
    4. Teams archive Address book
      1. Removing objects from Teams archive Address book
    5. Teams archive Licensing
    6. Teams archive Jobs
      1. Teams archive job
      2. Teams chat archive job
      3. Teams recovery job
        1. Teams recovery job description
      4. Configuration of Teams archive retention changer job
      5. Configuration of Delete job in Teams archive
        1. Teams archive delete job description
  17. Custom plugins
    1. Email management job configuration
    2. Storage replication plugin
    3. Sharing plugin
    4. Datengut plugin
    5. Email synchronizer plugin
    6. Categorize to Public folders plugin
    7. LoboDMS plugin
  18. ThreatTest
    1. ThreatTest configuration
      1. ThreatTest Databases
      2. ThreatTest System settings
      3. ThreatTest Schedules
      4. ThreatTest User experience
      5. ThreatTest Statistics
      6. ThreatTest Job
    2. Using ThreatTest App
  19. officeGATE
  20. contentACCESS Mobile
  21. Virtual drive configurations
  22. Teams application
  23. Application settings
  24. Terms of use
  25. FAQ
    1. Download sample for the file to be imported does not work
    2. Archiving is not working if MAPI is set to communicate with the Exchange server
    3. Virtual drive is still appearing after the uninstall
    4. Outlook forms problems
    5. Unable to open shortcuts of archived files on the server side
    6. Samples are not shown using 'Show sample" option in the Import dialog
    7. Do I need to create separate tenants for file archiving and email archiving
    8. What is the recommended database size for email, file and Sharepoint archiving
    9. The TEMP folder is running out of space when archiving big files
    10. The attachment could not be opened
    11. After updating Exchange 2013, the EWS connection might not work in contentACCESS
    12. If Windows authentication is not working in contentACCESS and an alias was created for contentACCESS
    13. contentACCESS Outlook add-in certificate issue
    14. PowerShell scripts for setting up Email archive
    15. Solution for Outlook security patches
    16. Solution for Outlook security patches through GPO
    17. Solution for indexing PDF files
    18. O365 SuperUser mailbox configuration
    19. Office365 journaling
    20. Organizational forms
    21. Multifactor authentication
    22. Region setting
    23. contentACCESS Mail app installation issue
    24. Azure app registration
  26. Troubleshooting

6.13.Distributed environment in contentACCESS — Clusters

Why is it efficient to use clusters? A server cluster is a group of independent servers (nodes) working together as a single system to provide high availability of services for clients. When a failure occurs on one computer in a cluster, resources are redirected and the workload is redistributed to another computer (node) in the cluster. It can happen that one processing job is currently running on a processing node, but a server failure occurs and the server will shut down. In this case a second, alternative node (either with “Job runner” or “Universal” role) can pick the task up to finish the archiving process. To achieve this, the running of this particular job should be allowed on any available node.

contentACCESS’s cluster technology guard against the following types of failure:

✓ System and hardware failures, which affect hardware components such as CPUs, drives, memory, network adapters, and power supplies.

✓ contentACCESS’s application and service failures, which affect the software, its applications and essential services.

Thanks to clustering in contentACCESS, the user can make the job processes scalable, and thus increase the performance. The user may decide how the nodes should be used, and how the work processes should be divided between them. The jobs can be run on a specific or any available node. It is also possible to install the full contentACCESS on one node and the contentACCESS server part on another nodes to ensure a better performance for job processing and for contentACCESS as a whole. It is also possible to use the nodes in a balanced mode; in this case the nodes are selected according to their Memory and CPU usage. The actually running jobs on the node will be considered as well.

There are 3 main node roles available in contentACCESS (can be adjusted from the context menu of the particular node).

✓ Universal: this type can be used for all operations performed in contentACCESS;

✓ Model provider (retriever) type can be used to publish models, i.e. this type is used to connect client applications with contentACCESS and to retrieve items through these client applications;

✓ Job runner (processing) type was developed to run jobs (plugin instances) in contentACCESS.

The user must decide, which role type he assigns to a particular node, how he divides work processes between the nodes, and how he makes the work processes more effective. A typical use case is when a customer installs the contentACCESS server, Central Administration and contentACCESS Portal on one node and contentACCESS server on a second node. Then he sets the first node to “Universal”, the second to “Job runner”, assigns File system archive jobs to the first node and the Email archive jobs to the second node.

Now, let’s assume that contentACCESS is already installed one the first “main” node (TANEWS), where the file system archive jobs are running. Our customer has decided to buy TECH-ARROWS’s Email archive and he would like to run email archive jobs on a second node. To achieve this, he needs to install the contentACCESS server on a second node (e.g. TECHNB0002).

Before the user starts to install any contentACCESS component on a second node, it is always recommended to set the node to disabled (to prevent the new node from picking up new tasks before it is fully configured). We set now the default role type to “Job processing”, as we will use it to run the email archive jobs. For more information about these default cluster settings please refer to section System, section “Cluster settings”.

Documentation144
To install any contentACCESS component on a second node, start to run the contentACCESS setup package on the selected server (TECHNB0002). First, you will be required to select the installation type. As we are now installing a contentACCESS component (a node) in an existing contentACCESS environment, we select the “Additional component” option:

installation-type-3-1

In the next step you will be asked to specify the central database connection that is already used. Enter the server name, where the database is already installed (in our case it is installed on our 1st node called “TANEWS”), enter the name of the already existing system database (in this case it is “CONTENTACCESSDB”; can be checked on the SQL server), type here the database user credentials and the database schema.

central-db-conn-3-1

Important!!! In the Database connection settings either a domain user must be specified (if Windows authentication is used), or an SQL user’s credentials must be added to connect to the database.

Further you need to select the components to be installed. As mentioned above, in this use case we select the contentACCESS server to install on this second node:

select-components-3-1

Finish the installation process of this second node. Now, let’s check the available nodes in the Central Administration.

Status pane of nodes, grid of nodes, available operation from the nodes’ context menu: Nodes, where contentACCESS components are installed, can be viewed with navigating to System tab ⇒ Services ⇒ Cluster, in the nodes’ grid below the status bar (displayed with green color on the below displayed screenshot).

Screenshot: Nodes’ grid

There are 3 control buttons available in the status pane of the available nodes:

✓ “+ New cluster group” button allows the administrator to create new cluster groups;

✓ “refresh” button serves to reload the last cluster status from the database;

✓ “disable auto refresh”/”enable auto refresh” buttons serve to disable/enable auto refresh (in every 5 seconds) of the last state from the database.

After clicking on the + New cluster group, a pop-up window will open. Here the administrator can specify the name of the group and also description (not necessary). Click OK.

Nodes can be added to the cluster group using the Manage nodes option from the context menu.

The cluster group can be then assigned to tenants, where the tenant’s jobs will run only on the nodes assigned to the tenant’s cluster group. This feature is useful for hosting solutions, where contentACCESS nodes are located in multiple data centers. In such cases, the tenant’s data will be processed by the nodes, which are geographically the closest to the tenant’s resources.

The node, where contentACCESS Central Administration is installed, is marked with a bold black color.

Documentation148

How can a node be configured? Node configurations are available for the user from the node’s context menu, by clicking on “Edit” in the dropdown list and configuring it in the “Change node” dialog.

In this dialog it is possible to set up the following node configurations:

Enable/disable a node with checking/unchecking the Enable checkbox;

Change the role assignment of the selected node with selecting the role type from the Role dropdown list;

Set the maximum count of jobs that can parallel run on the node (option Max. job count).

Set the mode to Maintenance by checking the Maintenance mode checkbox.

The following information are available in the nodes’ grid, when reading from left to right:

Status: This column marks if the selected node is online or offline, i.e. if it is ready to process tasks or not.

Documentation151
The node can have one of these 3 statuses:

The green (Documentation151.1) spot means, that the node is enabled, i.e. its service is running and the node is ready for processing;

The yellow (Documentation151.2) spot means, that the node is disabled, i.e. its service is stopped and the user cannot run any plugin on it. However, the server is still running. The yellow spot appears also for Maintenance mode.

The red spot (Documentation151.3) means that the contentACCESS server on the selected node is currently turned off. A node in offline status can be started again with starting up its service (“GATE.contentACCESS” windows service must be started).

Our TECHNB0002 node was installed in disabled mode, which is indicated with a yellow spot in the status column:

Documentation152
A node can be enabled/disabled with opening the node’s context menu, clicking on “Edit” and checking/unchecking the “Enabled” checkbox in the “Change node” dialog:

Server name: The server name, where the contentACCESS node is installed, is displayed here. Our first node is installed on server “TANEWS”, and the second node installed on “TECHNB0002”.

Documentation154

Server IP: The IP of the server, where the node is installed, is displayed here.

Documentation155

Memory usage, CPU usage, Overall load: Displays actual information about the load balance of the selected node. If the cluster selection strategy is set to “Balanced”, then the nodes will be selected for the tasks and they should perform according to these values. If the node is in offline status, the value will be “0”. If the value is more than 70%, then the value will get a red background color.

Documentation156

Running job count: Informs the user about the currently running job count on a specific node. On the screenshot below we can see that two file system archive jobs are running on node “TANEWS”. The user may open the details of these 2 job runs by clicking on the arrow sign at the left side of the row:

Documentation157

Role: A node can be either universal, job runner or model provider; the role type of the particular node can be viewed here. As we can see, our “TANEWS” node has “Universal” role assigned and “TECHNB000” has “Job runner” role assigned.

Documentation158
The assigned roles can be edited by clicking on “Edit” in the node’s context menu and setting the desired node in the “Change node” dialog.

If we are planning to use a node for multiple tasks in the future, we can modify its role to “Universal”.

Max. job count: The maximum count of jobs, that can run in parallel on a node, can be viewed right here. The number of jobs that can run on a node can be limited. In case of our nodes this job count is unlimited.

Documentation160
This value can be adjusted with opening the “Change node” dialog from the node’s context menu. Click on “Edit” in the node’s context menu, and set the desired value in the dialog. Now we set this value to “10”:

If 10 jobs are running in parallel on this node and we want to start up a new (11th) job on this node, the job will be in waiting status until the processing node is available again.

Documentation162
If our 11th job can run on any available node, then another node will pick it up for processing. The node, where the job should run, depends on the job settings. For more information check section Jobs’ page, jobs’ context menu.

Enabled: A node can either be enabled (it is online, and its service is currently running) or disabled. A node is disabled when it is running, but it is unavailable for further processing tasks. By default, the nodes are in enabled state, but it is recommended to set them here as disabled in case of planned system updates, or if any failure occurred and the problem must be fixed.

Documentation163

To enable/disable nodes – open the “Change node” dialog by clicking on “Edit” in the node’s context menu, and check/uncheck the “Enabled” checkbox in the dialog.

The times of Last start/Last stop and Last ping are available in the right part of the grid.

Maintenance mode: This column shows if the selected node is in Maintenance mode. When a node is in Maintenance mode, no new jobs can be started on it, but the running jobs continue to run.
Once the running jobs are finished, the administrator can do a maintenance on the node:

  • update
  • patch
  • restart
  • or other necessary actions.

The node in maintenance can serve the clients further. Once the maintenance is finished, the Maintenance mode should be reset (i.e. back to normal).

The node can be put to/out of Maintenance mode by two ways:

1. Context menu -> Edit -> check the Maintenance mode checkbox

2. Context menu -> Set to maintenance/Reset maintenance


How to assign a job to the selected node? Now we will assign an Email archive job to the “TECHNB0002” node. We navigate to the Email Archive tab ⇒ Archive ⇒ Jobs on the ribbon, and open the Jobs’ page. Here we click on + new to create an email archive job, which will be assigned to this node.

The “Add new job instance” dialog will open. Here we set up the desired job, and select “TECHNB0002” from the “Run on node” dropdown list. Then we click on “Add”.

Documentation166
We need to configure the newly added job on its job configuration page. For more information about how to configure processing jobs, please refer to the respective sections.

Now we can enable the TECHNB0002 node.

The node will start to run the assigned job at the time, which is configured in the job’s scheduler settings.

Important!!! When configuring a job that may run in a cluster, the system the administrator must specify a storage and a database that is accessible by all the nodes in the cluster. If a node, which picks up the job, can’t access the configured storage or database, the job will fail and will not execute the task:

  • In the database repository settings of the database (selected for the job) the administrator must establish the connection with SQL user credentials. If an explicit user is not specified, the contentACCESS service user will be used and the service must run under the same domain user. This ensures that the database can be accessed by the job, regardless of where it is running.
  • The administrator must specify the storage as a network share (e.g. ServerNameRootFolderSubfolder) in the storage repository settings of the storage (specified for the job), so it can be later accessible by the job from anywhere.

How to shut down a node? In certain cases it might happen that a node should be turned off. This operation can be done from the context menu of the selected node. Click on the ellipses (…) and select “Shutdown” option from the dropdown list. With this action the contentACCESS service on the selected node will be turned off, and the node will get a red color (offline). Node shutdown is a deferred action and it might take 1 minute.

If you are quite sure that you want to shut down the node, answer “OK” for the following pop-up window:

Note: If you are about to turn off the node where Central Administration is running, a next pop-up window will warn you about this again.

How can a node be deleted? With this action the user may delete a node from the node list. Only nodes with offline status can be deleted. When the contentACCESS service is started up again, the node will appear on the list. To delete it, click on it, open its context menu by clicking on the ellipses (…), then select “Delete”.

contentACCESS will ask the user again, if he is sure about deleting the node.

Documentation172

Yes No Suggest edit
Help Guide Powered by Documentor
Suggest Edit