Mirror121 Administrator Guide

Mirror121 application communicates with Salesforce via Web Services. We are using API library provided by Salesforce itself. It contains Partner API for synchronous calls and Bulk API for asynchronous calls. This library needs Authentication credentials which can be set in Settings (see Salesforce settings).

Mirror121 runs on any reasonably fast PC. See the minimal recommended hardware configuration.

These requirements expect that only Mirror121 runs on that machine. You will need to run separate database server for mirror database. Of course you may use your existing infrastructure for that database.

Java is a piece of software that has to be installed on your computer. Mirror121 does not work without it. Currently, we support AdoptOpenJDK 11 LTS (HotSpot).

On Windows, an up-to-date version of Java is included in the installation package. On Linux or Mac, you have to install it yourself.

Mirror121 runs on Apache Tomcat web server which is included in the installation package. We upgrade the Tomcat to the latest version on a regular basis.

Mirror121 uses two databases.

Configuration DB and mirror DB may use different database servers. However, the best practice is to have one database server containing two databases. For more information see Database Configuration section.

Mirror121 runs on all modern web browsers such as Google Chrome, Mozilla Firefox and Internet Explorer 8 or higher.

Mirror121 is operating system agnostic. It can run on any system which supports Java.

Optionally, you can install Mirror121 as a service. The service will automatically start when operating system starts.

If you have installed Mirror121 manually from an archive file, just follow these steps.

On this page you can provide a license which you received to your mailbox.

Enter information about Salesforce instance. You can test the configuration using Test Connection button.

Test Connection button checks:

Specify a database where all the data mirrored from Salesforce will be stored. Currently, Mirror121 supports Oracle, SQL Server, PostgreSQL and MySQL/MariaDB. You can test the configuration using Test Connection button.

Test Connection button checks:

Application allows users to subscribe to synchronization notifications. To deliver email to these users the SMTP server must be configured. If you want to enable notifications please specify URL of SMTP server and credentials. You can test the configuration using Test Connection button.

Mirror121 provides two authentication options.

Here you can see a summary of all settings. If you want to change the configuration you can do so by clicking on "Change *" in a particular section.

After clicking the "Finish" button Mirror121 stores and processes all the settings. The Login page shows up and Mirror121 is ready to use.

For Mirror121 to be able to send notifications SMTP server has to be configured. On the page Settings / Notifications Management / SMTP Server you can specify its URL, port and credentials and security option.

Security option defines if and how the communication with SMTP server is encrypted:

At the bottom of the page there is a button called Test Connection. It validates the configuration and send testing email to the email address you provide it the dialog window.

To create a new notification you need to input an e-mail address. You can also choose specific synchronization you want to be informed about. Then you will choose what events you want to be notified about.

All added notifications are in a notification table. To cancel sending of notifications you can delete them by selecting a checkbox next to desired email address and clicking on Delete button.

Choose "Internal Database" in the Security Realm field. Then, don’t forget to create a user Create New User with administrator permissions before you logout. Otherwise, you’d lock yourself out and would not be able to login and change settings.

LDAP configuration is a bit more complicated than Internal database so let’s look at all the attributes in detail.

After you fill in all the fields you should test your configuration using "Test Connection" button. This is really important because if the configuration is invalid you would lock yourself out and won’t be able to login to Mirror121 at all.

After Test connection popup window opens, provide credentials of the user you will use to login to Mirror121. We will test if the user can login and what permissions are assigned to him.

If everything went fine you will see a green message. If something goes wrong we print an error message.

Mirror121 supports Single Sing-On over SAML 2.0 protocol and Web SSO profile.

If you use Internal database security realm you can create a new user. You have to provide its username, password, timezone and roles. See User Roles chapter so that you can decide which role you want to assign to the user. There is usually no need to add more than one role (except for the API Caller role).

On user detail page you can see user’s information summary - his or hers username, selected timezone, roles and permissions.

The application uses cache for retrieving Salesforce meta-data (what tables Salesforce works with, which columns they have etc.). Because of caching some data could be out of date. Typical example is list of Salesforce tables available to synchronize. Default reload interval of cache is 24 hour.

If you want to clear the cache manually go to Settings menu, choose General Settings and click on Clear All Caches button.

Activity Log Retention removes old activity logs after the specified number of days (30 days by default). It removes activity logs from both configuration database and filesystem. Removing logs from filesystem saves you disc storage whereas removing logs from configuration database improves its performance. This is particularly true if you have a lot of synchronizations running very often.

If you are upgrading from Mirror121 < 3.2.0 this feature is disabled. On new installations it is enabled. You can change the settings on General Settings page.

Allows you to configure consistency check. On fresh installations the consistency check is enabled by default. On existing installations it is disabled.

If enabled Mirror121 will skip the records which it failed to insert or update. If that happens the synchronization will finish with a warning (you can configure notifications not to miss any warning).

If Mirror121 skipped a record you have to analyze the root cause of the issue and fix it. Then you download the missing records using Differential synchronization, Synchronize from or Clean and synchronize.

There is a limit of how many records will Mirror121 skip at maximum. Let’s say you have a table with hundreds of thousands records and Mirror121 fails to insert all of them. Then you want the synchronization to fail also because there must be a global issue (like failing database connection, permissions in Salesforce, etc.). On the other hand if just one record fails then you want to end up with a warning and fix the one records separately.

By default Mirror121 stores data to mirror database in UTC. UTC is the most convenient and recommended way to store dates and times especially if your organization spans across several timezones. If you need to access and see date and time fields formatted in specific time zone, Mirror121 provides two ways to achieve that:

License key is generated string (about 600 characters long) which includes information about Mirror121 application. If you don’t have any key yet please visit our website.

For changing timezone click on the planet icon next to timezone in the left bottom.

{{link-h2-web}[H2 Database Engine] is a lightweight open source Java SQL database. We have embedded H2 into Mirror121.
The database is created automatically by Mirror121 based on connection url information from mirror121.properties file.

When creating a new database please use utf8 encoding and utf8_unicode_ci collation.

When creating a new database please choose a collation that suits your needs the best.

When creating a database please make sure to use AL32UTF8 character set.

When creating a new database please use UTF8 encoding. Values for lc_collate and lc_ctype properties are provided automatically. If you need to change them please refer to the official PosgreSQL documentation.