Difference between revisions of "Retain Blackberry"

Revision as of 20:12, 29 December 2014

The BlackBerry module allows the collection of BlackBerry phone data from the Enterprise server into the Retain system. BES 5.x and 10.x are supported.

To archive the BlackBerry information, the BlackBerry Enterprise Server must be configured to log phone calls, PIN, BBM and SMS data. The server log files are what Retain uses to collect the information about phone activity, and as such no software or modification needs to be made to any system phones. If the BlackBerry server has not been configured to log the data, Retain will be unable to archive the information.

For BES 5.x, instructions to modify the logging in the BlackBerry Enterprise Server can be found in the BlackBerry Enterprise Server help file. (Found under Start | Programs | BlackBerry Enterprise Server | Help | BlackBerry Manager Help)

For BES 10.x, users must be set on EMM – Regulated mode and have the logging set to ‘yes’ for all types desired. Balanced mode users will not have logs created for them in the BES system and as a result will not be archived.

Installing the BlackBerry Module is incredibly simple. Essentially, the module needs to be enabled and configured with the BES log file location. Afterwards, the data is treated the same as any other data entering the Retain archive. Data is archived in the database under the user/phone it originated from and can be searched and viewed through the Search Messages interface.

BlackBerry Module Configuration

- Open an Internet Browser and go to your Retain Web Management page (http://ip_address/RetainServer)

- Log in as Administrator or as a user with Administration rights

- Under the Configuration section on the left side navigation pane click Module configuration

- Select BlackBerry under Unconfigured Modules

- There are two tabs within the BlackBerry Module configuration.

   Core Settings - To enable the BlackBerry Module, select the ‘BlackBerry Module’ from the module page and click ‘configure’. The BlackBerry module needs to be enabled on this page 
   to make it active in the Retain system. Before data can be archived, the BES log file path must be provided.
 
   The log file location must be the address to the log files from the Blackberry Server. Regardless of where the worker is installed, local or remote to the Blackberry Server, it must have
   direct file access to the logs. This access can be accomplished through a shared folder or location, but it must be available to the Retain worker. Appropriate access through firewalls or
   network security must be made available if the worker is not installed on the BES system.

   SMTP Connector - In order to allow the forwarding of BES items out of the Retain system, the Blackberry Module needs to be configured with an SMTP connector. This connector will 
   provide an outlet into the mail system, for Blackberry data to be forwarded if desired. 
   
   The amount of configuration necessary for the SMTP Connector depends on the specific setup of the SMTP system. If a username and password are required for the host SMTP system,
   then it must be provided. If it is not required, the configuration of the username and password is optional. 
   
   The address of the Mail Server, the SMTP Mail From Address, and the SMTP Mail To Address, must all be configured for the system to function correctly. The ‘to’ address
   is the destination address where the data will be forwarded to. The ‘from’ is the specified ‘from’ address. 
   
   In addition, the ‘Enable SMTP Connector’ option must be enabled in the‘jobs’ configuration for the Blackberry section.

Schedule

Schedules define WHEN to perform the data collection as defined in a JOB. A Job defines what SCHEDULE, PROFILE and WORKER to use.

 -You can create as many schedules as you need. 
 -Schedules have no functionality until they are associated with one or more JOBs. 
 -They can be shared across multiple JOBs. 
 -You cannot DELETE a schedule that is currently associated with a JOB.
 -Schedules can be recurring or one-time.

SINGLE schedules are configured with one start time, and one date.To keep jobs from queuing up to the worker, select the box to do not resend a job that has an elapsed start time. Otherwise, a job will queue up on the worker if a previous job has not yet completed, causing the new job to start as soon as the current job is complete or terminated.

RECURRING schedules are configured using a start and interrupt time, and which days to start on. Choose when on which days you want this schedule to trigger a job. You may specify maximum job duration. If the job runs longer than the time limit you set, it will be interrupted. For cases where you do not want the job to be interrupted – for example, with a job you know will last longer than 22 hours, you may prevent the schedule from interrupting the job. Don’t forget to “Save Changes”.

Profile

A profile assigned to a job tells the system what to archive. Message types, status, date ranges, excluding or including specific users, private or public folders or both, and redundancy check settings are all configured under the profile. The profile defaults to collecting all data, with no date restrictions. After Retain has finished collecting data the first time, you'll want to narrow the date range and criteria considerably, or pay a high price in performance.

To create a new profile to archive BlackBerry data, first select the ‘add profile’ button and name the profile. Then continue configuring as desired.

Core Settings:

The Core Settings tab holds the enabling setting, which allows jobs connected to this profile to run. This must be checked before jobs will run.

Message Settings:

The Message Settings tab can be used to exclude or include specific data types for this profile. By default all types of messages will be archived. All BlackBerry data which is selected to be archived MUST be logged in the BlackBerry Enterprise Server or the data will not be available for Retain to archive it.

Scope:

The Scope tab dictates how pervasive the attached archiving jobs are, and what kind of duplicate checking is done, or not done, in the Retain system. The Date Range instructs Retain to scan for, and archive, messages after, or before, a certain date. This is useful if only specific chunks or areas of mail are to be archived. The duplicate check either scans for all messages, or instructs Retain to only look for messages which are newer than the Item Store Flag, which is a time-stamp on the system. All messages newer than the time stamp will be archived by Retain if the item store flag is utilized, but Retain will ignore all messages which are older. It is recommended to have at least the first job archive everything, with the item store flag checked to archive everything possible in the logs, while setting the item store flag. Subsequent jobs should use the duplicate check and the item store flag to only archive new data afterwards.

Advanced:

If you want to be more specific as to what to dredge or not to dredge, add the criteria here. Each line will be logically AND-ed together. Think “Dredge all items where the following is true:” Criteria A and Criteria B and Criteria C etc.

You may select based on:

 -Subject
 -Sender
 -Recipient
 -Size
 -Attachment Name

Whether they are equal to, not equal to, whether they contain or do not contain the item you specify. This gives you great flexibility and granularity. It allows you to customize dredges and retention for many different groups, or even individuals.

Worker

The worker is the part of Retain that actually pulls the data from the message system servers. The Worker contacts the Retain Server and gathers information on which jobs are associated with it, when to start them, and which items to get. Workers can only run one job at a time. Workers are not module specific, but may require module specific settings. These settings, where applicable, are found under the module specific tab.

Worker Configuration From the Retain home page, click Workers. 1) Click “Add Worker”.

2) Put the name of the worker in the “Worker” box. Example: “BES Worker 1”.

3) Check the Connections Tab to be sure the Retain Server IP address settings are correct This tells the Worker where the Retain Server is located. Server Host Name or IP address must be correct, this should be populated automatically but double check for accurace. The server Connection setting must be able to resolve to the Retain Server if placed in a browser address bar. The connection tab holds very importand contact information for the worker's connection to the Retain Server. Make sure that the Retain Server connection address is correct, or the Retain Worker will not be able to talk to the server.

4) The Module Specific tab contains information specific to individually configured modules. The settings specified here are tied only to the specific worker configured, and does not affect the rest of the system. In General this setting may be ignored unless required. If required, input the appropriate information.

5) After you have checked and set your settings, click “Save Changes” before browsing to another page to finish creating and to save your worker.

After the worker has been saved, two additional tabs become visible for settings on the worker. You MUST save changes on a newly created worker before the ‘Bootstrap’ tab is available to be used. The status tab for the new worker will not hold any pertinent information until a job has been run or the worker has registered to the server and is in communication. Once a job has been completed, information will be displayed on the general status of the selected Worker.

6) After you have saved the changes, the Bootstrap tab appears (see below). Click “Download File” to save the configuration to a local workstation.

7) Save this file to your hard drive in a place where you can find it. Click “Save”.

8) Open a new browser window and type: http://< your-RetainWorker-ip >/RetainWorker

When a worker has not been initialized a screen will appear asking you to upload a bootstrap file.

9) Upload the bootstrap file.

 -Click “Browse” to find the file you just downloaded to select it
 -Click “Open”.
 -Click “Upload File”.
 -If the upload went well, you will see a message that says "Configuration Complete. From now on, you'll have to log in as a user (such as the initially created admin user) with the Manage Workers right:

After you click the “Continue” button, you will be returned to the login page.

10) Login as Admin. 11) Verify the Retain Server connection success by selecting the Server Connection tab.

BlackBerry Job

Blackberry Jobs All data collection for the Blackberry module is configured through the Blackberry job interface. The jobs here combine the Profile, the Schedule, and a Worker together to archive the specified server logs. A Job must have a Profile, Schedule, Worker, and a selected server, before it can be saved or run. To create a new job, click, ‘Add Job’, and configure and save.

Core Settings The core settings tab contains the basic configuration. Select the ‘Job enabled’ option to enable archiving. Also select a Schedule, Profile, and Worker to complete the job. If the SMTP Send is enabled, the worker will forward BES message data

The Data Expiration is an option to place a timestamp on the data in the Retain database, which allows for ease of automation for the deletion manager. In addition, devices such as NetApp, Centera, Caringo, and Hitachi HCAP may use this number to enforce hardware level protection of the stored item so that no one (including Retain) may delete the item before its expiration date. Job Expiration is not retroactive for mail in the database, and only applies to mail archived by the job that it is active for. The base folders and criteria are specified under the custom expiration dates accessed through the ‘Add’ button at the bottom. All messages included in any specified folders will have a different date or be exempted from the standard expiration date. In order to have messages with custom job or folder expiration dates properly expire, the deletion management date scope must be set to delete messages with an Expiration Date older than 1 day.

Mailboxes The mailboxes tab contains the target users, and BES servers to be archived by the selected job. Under the Mailbox tab, select the BES server to be included in the Job. The list of available BES servers is configured from the Modules page. Once selected, all users associated or present on the BES server are included. Once a job has been run, the user list will be populated and further configuration is possible. The job may also be restricted to specific users, specified on the ‘Include Users’ list, or restricted to exclude users listed on the ‘Exclude’ list. To add users, expand the User’s option box and select the users to be archived. Users may be selected through the user search interface, spawned through selecting the ‘add user’ button. If there are users listed, then the users listed in the ‘Include Users’ box are the ONLY included users, while those listed in the ‘Exclude’ window are excluded from the jobs.

Notification All errors, summaries, and statistics may be sent in an email notification to a desired address on job completion. If it is desired to be notified, configure the notifications under this tab. At least one of the two notification options must be selected in order for an email notification to be created.

Status On initial creation, there will be nothing of interest shown under the ‘Status’ tab, as the job is under creation or has not yet run. However, after a job has been run, or has begun, the ‘Status’ tab becomes a monitoring tool to report on exactly how much mail and mailboxes have been archived, along with any errors encountered.

Level 2

Installation and Setup

In order to archive for BlackBerry certain steps need to be in place

- The users device needs to be in Regulated Mode

 If the user device is not set to regulated mode the information will not be available for archive

- The BlackBerry Enterprise Server needs to provide log files for Retain to Archive from.

 Retain will Dredge the log file created by the BlackBerry Enterprise server in order to gather the information it needs for the Archive.
  

- The BlackBerry Module needs to be configured on the Retain Server

 Configuring the Blackberry module is done in a few short steps. 
  - Enable the job.  If the enable job button is not checked no jobs will be sent to the Retain Worker
  - Blackberry Enterprise server configuration.  You can name the server anything you would like. The
    log file path is critical to the success of a job.  The location of the Blackberry Enterprise log files 
    is entered.  The location must be either an NFS share or a Samba Share.

- A Schedule, Profile, Worker and Job need to be created on the Retain Server.

 - The schedule determines how often the job will archive new data
 - The profile allows you to set what type of messages you will archive, what scope/range of messages will be included, etc
 - The worker is responsible for the communication between the Retain Server and the Blackberry Enterprise Server.  
 - The Job is where all the components come together.  You will chose the schedule, profile and worker that you want to use.  
   You can also select what mailboxes you want to archive.  You can archive an entire system or specific users

Archive Display and Interaction

Archived information is displayed within the users 'store' according to category. General information about the message/phone call is displayed on the main screen. Such as the From, Recipient, subject and date.

Opening the message will provide specific details about the message. You will be presented with a Message tab and a Properties tab.

-The message tab will show you who the message is To and From, the subject and will show you the contents of the body of the message.
-The properties tab gives specific information
  - Item Type - Type of communication (BBSMS, BBMMS, etc)
  - Box Type - Tells you if the message/phone call was sent or received
  - Owner UID - Users Blackberry PIN 
  - Read - if the message was opened or not
  - Confidential 
  - Indexing - Tells you if the message has been indexed for searching
  - Created - Created date
  - Delivered - Date Delivered
  - Stored - Date stored in Retain
  - Expiration Date - Date set for deletion if deletion management has been setup in Retain
  - Begin Date - Shows time lapse of message or phone call
  - End Date - Shows time lapse of message or phone call
  - Path - Give the directory path for the message/phone call

Additional Properties

  - postoffice - Post office that holds/held the message
  - email System
  - domain
  - internet
  - abSystem

Audit

  - Information under this section will show an audit trail.  Such as when the message was archived, the IP address that archived it

Back to Retain Module Configuration