for on-premise databases

Installation

The Reflection installation process consists of the following steps:

  • After downloading the .zip Reflection file, unzip the compressed folder and open it to see its contents.
  • Double-click the Reflection Setup package.
  • Next, click the Run button to start the Setup Wizard.
  • From the Setup Wizard, click Next.
  • Select the folder path where Reflection will be installed. You can accept the default path by clicking Next.
  • Confirm the installation by clicking Next one more time.
  • Enter your License Key and then click Validate.

  • The installation process will finish and you will see confirmation that Reflection has been successfully installed. You can Close the wizard.

That’s it for the installation! Simple and straightforward.

Configuration

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

Setting Your Salesforce Credentials

  • Click Settings and then click Set Salesforce Credentials, or just press F6.
  • Next, enter your Salesforce User ID, Password, and Security Token. Select the Server Type for your credentials (i.e production or sandbox) and click Save.

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

Setting Up Your Database Credentials

Target Database Setup

Setup is same for all databases.

  • Click Settings and then click Set Target Database.
  • You will now be able to choose your Database. In this section we will connect to a MySQL database. Enter in your Server, Database, Port, User ID, and Password. Select any indexing properties you want and click Save. Note: You can click Authenticate to verify the credentials you provided are correct.

Setting Your S3 Credentials

If you would like to use S3 to store your attachments, documents, etc., you’ll need to set it up.

  • Click Settings and then click Set S3 Credentials, or just press F8.
  • Next, enter your S3 Client ID, Client Secret, and S3 Bucket Name. Select the File Processing and File Security Level and click Save.

  • 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.
  • The File Processing section will default to only reflect to your local database, but you can choose to reflect your files to S3 or both.
  • The File Security Level section defaults to Authorized, but you can choose to make your files Private or Public.

Running Reflection Manually

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

  • Click Service and then click Run Once, or press Ctrl + 1.

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

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 reflect results.

Setting Your Reflection Parameters

  • Click Settings and then click Set Reflection Parameters, or just press F4.

Most settings in this window are optional, but different users have different needs.

  • Reflection Interval – This option allows you to set how often you want Reflection to run. Click Customize and pick the minutes, hours, and days that work for your needs. In this example, we are setting Reflection to run every first of the month at 6:30 AM.

  • In order for this feature to work, you need to start the Reflection service and leave it running. You can do that by clicking Service > Start or by pressing Ctrl + S. 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.
  • 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.

Licensing Reflection

You have now the option to change your License Key in Reflection in the Reflection Parameters window. Our Bring Your Own License (BYOL) flavor of Reflection requires a license to be entered by the user. To do this, follow these steps:

  • Press F4, to open the Reflection Parameters window.

  • Click the Change License Key button in the License Key section.

  • A Reflection License dialog will pop up, in which you will need to enter your License Key, and then click Validate to verify that the license entered is valid, and save it into your settings.

Setting Your Reflection Levels

Reflection allows you to select different options for your reflect level. Go to Settings > Set Reflection Level and choose 1 of the following 4:

  • Drop & Recreate Tables – Existing objects/tables being reflected will be dropped, recreated, and every record coming from Salesforce will get inserted. This is a process similar to the first time you reflect all your data.
  • Remove & Reload Data – All the data in the objects/tables being reflected will be deleted and all the records coming from Salesforce will be inserted into the existing tables.
  • Load New & Changed Records – Only new and changed records coming from Salesforce will be inserted/updated in your local database.
  • Only Do Record Counts – This setting won’t reflect any data to your local database, it will show a comparison of the records in Salesforce against the records in your local database.

Setting Archived & Deleted Record Processing

Reflection allows you to choose four (4) main options for your archived and deleted records processing. Go to Settings > Set Archived & Deleted Record Processing and choose one of the following:

  • Ignore – Archived and deleted records in Salesforce will not be reflected into your local database.
  • Reflect & Preserve – Archived and/or deleted records in Salesforce will be reflected along with all the other objects you selected in your Reflection Parameters.
  • Reflect & Remove – Archived and/or deleted records in Salesforce will be reflected along with all the other objects you selected in your Reflection Parameters. These records will be removed from your database.
  • Recycle Bin – Only archived and deleted records will be reflected to the local database.

Setting Email Configurations

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.

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 at the following link:

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

Reflection & MySQL

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.

Reflection for AWS

for AWS Redshift & RDS

Redshift Configuration

The AWS version of Reflection supports reflecting to Amazon Redshift. Redshift requires S3 in order to function.

  • You will be prompted to set your S3 credentials before setting your Redshift credentials.
  • Click OK and proceed to enter your Client ID, Client Secret, and S3 Bucket Name.
  • The File Security Level section defaults to Authorized, but you can choose to make your files Private or Public.

  • 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.
  • After you have set your S3 credentials, you can proceed to enter in your Redshift credentials.

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. See the Redshift section of this document for more information.

License Agreement

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