Reflection 3.X Series: User's Guide

Installation

To install Reflection 3.1.0, follow these simple steps:

  1. After downloading the .zip Reflection file, unzip the compressed folder and open it to see its contents.
  2. Double-click the Reflection Setup package.
  3. Click the Run button to start the Setup Wizard.
  4. From the Setup Wizard, click Next.
  5. Select the folder path where Reflection will be installed. To use the default folder path, click Next.
  6. Confirm the installation by clicking Next one more time.
  7. Enter the License Key that was provided to you and click Validate.
  8. The installation process will finish and you will see confirmation that Reflection has been successfully installed. Click Close to exit the wizard.

That’s it! You’re ready to configure Reflection.

Configuration

In order to begin using Reflection for the first time, there are some configuration steps you’ll need to follow.

  • You will find Reflection launch shortcut on your desktop and in the programs menu under Riptide Software > Reflection
  • Launch the app.
  • In the Admin Console Click Settings

Settings Window

Tab 1: General Parameters

You have now the option to change your License Key in Reflection on the General Parameters Tab of the Settings window. Our Bring Your Own License (BYOL) option for Reflection requires a license to be entered by the user during installation. To change the License Key entered during installation, follow these steps:

  • With the Settings Window open, on the General Parameters Tab:
    1. Click the Change License Key button.
    2. A pop-up window will show up with the field for you to add the license key and additionally configure any proxy server for use to reach Internet.
    3. Enter you license key and then click Validate

generalParameters

Tab 2: Email Configuration

Reflection allows you to notify users whenever Reflection finishes running or encounters a problem. This feature uses the Simple Mail Transfer Protocol (SMTP) of your email provider. You will have to provide an outgoing email service such as GMail to make use of this feature.

Emailsettings

Tab 3: Salesforce

  • With the Settings Window open, on the General Parameters Tab:
    1. Enter your Salesforce User ID, Password, and Security Token. Select the Server Type for your credentials (i.e production or sandbox), and configure proxy if needed to connect to internet.
    2. Click Apply.

Service Settings

  • Set the API Call limit per day to salesforce API. Default is 0, which means no limit

SalesForceSetting

Note: You can click Authenticate to verify the credentials you provided are correct.

Tab 4: Data Storage

Setup procedure is same for all databases. Follow these simple steps:

  • With the Settings Window open, on the General Parameters Tab:
    1. Click Settings and then click Data Storage.
    2. Under Database Credentials, select the type of database you want to connect to from the Database Type drop-down menu (Database options are Mysql, Oracle, SQLServer, PostgreSQL, or Redshift). Enter your Server, Database, Port, User ID, and Password. Select the indexing you want to be automatically created by Reflection. Note: You can click Authenticate to verify the credentials you provided are correct.
    3. Under Binary Data Processing, select your binary storage method – database only, local folder, S3 only, or S3 and database.
    4. If you select S3 to store your attachments, documents, etc., you will need to set up your S3 credentials and file security level (if you do not select S3 binary data processing, you can skip to the last step).
      • Enter your S3 Client ID, Client Secret, and S3 Bucket Name. Select the File Security Level and click Save.
      • Note: If you type a bucket name in the S3 Bucket Name field that doesn’t exist, that bucket will be created for you in your Amazon S3.
    5. Click Save.

DataStorageSettings

Reflection & Oracle

In order to use Reflection for Oracle you need to have the Oracle Data Access Components (ODAC) installed on the machine running Reflection. It is available to download from the Oracle website here:

http://www.oracle.com/technetwork/topics/dotnet/downloads/index.html

Reflection & MySQL

MySQL allow you to select the type of engine you want on the backend InnoDB or MyIsam.

MySQL has a low limit on the max packet allowed size, in order to avoid the max_allowed_packet error. Set your max_allowed_packet to a high value such as 500M. The memory won’t be allocated unless it is needed by MySQL. If you aren’t reflecting attachments or massive amounts of data, you can set this value to 100M.

RDS Configuration

Reflection for AWS gives you the option to backup your data to Amazon RDS. RDS databases are connected the same way as other database. Simply enter your connection information the same way you would for any other database server. Setting up Reflection for RDS may require additional security configuration settings in your Amazon Security Groups.

 

Tab 5: Processing

Setting Up Object Processing Groups

Salesforce objects can be grouped in order to specify different reflection parameters and schedule. There are two default groups, one to include and one to exclude groups. New groups can be created/deleted as the user sees fit. To move an object from one group into another, select the first group, from the list on the right select the objects in that group that you want to move, and then drag them over to the target group. You can also search for a specific object name and the list will show what group it is included in.

objects_settings

Every group (except the Excluded Group) can be configured to tell Reflection how data should be handled and what to do with deleted/archived records.
  • You can choose to reflect chatter feeds, metadata, and attachments by checking those options. Keep in mind that reflecting attachments will make the reflection process take longer based on how many files you are reflecting and their size.
  • You also have the option to choose what Objects you want to include or exclude. For example, if you only want your Accounts, Contacts, and Leads, you can set Reflection to only retrieve those from Salesforce.

Group Processing Options:

  • Drop & Recreate Tables: existing database tables will be recreated on every run.
  • Remove & Reload Tables: existing data till be deleted on every run, and all records in Salesforce will be pulled on every run.
  • Load New & Changed Records: only those records that were created or updated since the last run will be pulled from Salesforce.
  • Only do record count: simply count the amount of records that existing in the local database and Salesforce.

Archived & Deleted Records Processing:

  • Ignore: completely ignore archived/deleted records in Salesforce. If a record was previously reflected, and then deleted within Salesforce, it will remain in the local database.
  • Reflect & Preserve: all archived/deleted records will be processed together with non-deleted records and will be kept in the local database.
  • Reflect & Remove: archived/deleted records will be processed together with non-deleted records and then deleted from the local database. This is done in order to delete all those records that already exist in the database and were recently deleted in Salesforce.
  • Recycle Bin: only reflect archived and deleted records.

ProcessingGroupSettings

Groups can also be configured according to the schedule at which Reflection should process them. This can be set by selecting a Reflection Interval, and entering a value for the parameters according to the selected interval. A more granular schedule can be set up by clicking on the “Customize” button. You can specify by hours, minutes, days of the month and days of the week when should a group be processed.

schedule_settings

Tab 6: Performance

You can select the number of workers that should be dedicated for each part of the reflection process.

  • Bulk API Job Workers: These workers handle the creation and completion of bulk jobs within Salesforce. Setting this will affect the maximum number of jobs that Reflection can have open in Salesforce at any specific moment.
  • Bulk API Data Workers: These workers handle the data obtained from the finished bulk jobs. Increasing this number will allow Reflection to work faster as more data is processed at the same time, but will also increase the amount of memory used.
  • Soap API Data Workers: These workers handle soap queries to Salesforce. Increasing this number will allow Reflection to work faster as more data is processed at the same time, but will also increase the amount of memory used.

performance_settings

Restoration with Reflection

Once you have successfully connected to Salesforce and a database, you can proceed to run Reflection.

  • Click Service and then click Restore.

Reflection will display a new window that will assit you in quering the local database for the record intened to be restored in Salesforce.

Restoration Window

 

After verifying all the credentials and successfully connecting to Salesforce and your database, Reflection will start the process of Restoring your data.

When Reflection finishes running, you will get a report on the overall results of the process.

Running Reflection Manually (Run Once)

After you have completed configuring Reflection, providing the Salesforce and database credentials and setting a schedule for the processing groups you have created, you can proceed to run Reflection. The Run Once option will cause all Enabled processing groups to execute one time, immediately. The RunOnce Option can be initiated by:

  • Click Service and then click Run Once, or press Ctrl + 1.
    Note: In order to execute a Run Once the Reflection Service must not be running

Reflection will display your computer information, Reflection information, and Reflection settings.

ReflectionRunning

 

After verifying all the credentials and successfully connecting to Salesforce and your database, Reflection will start backing up your Salesforce objects and data.

Once Reflection finishes running, you will get a report on the overall results of the process.

Running Reflection on Sceduled Intervals
(Reflection Service)

  • After you have completed configuring Reflection, providing the Salesforce and database credentials and setting a schedule for the processing groups you have created, the Reflection Service can be started by completing the following step:
    1. From the Admin Console CLick Service > Start or by pressing Ctrl + S.
      • Proper function of this feature requires that once started the service be left running
      • Keep in mind that your Salesforce org has a limited number of API calls allowed every 24 hours. Reflecting too often could use up all your allotted Salesforce API calls.
  • Once the service is started Reflection will process the Processing Groups you have created on the schedule you have specified in the Group Processing Options window.

License Agreement

For information on the license Agreement please view http://support.riptidesoftware.com/reflection/license-agreement/