Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
The Main Tab is used to manage connection information and credentials for Salesforce and the target CopyStorm database.
It is a requirement that a CopyStorm database exist prior to running CS:Govern. If that is not the case then, upon switching tabs, CS:Govern will present the user with an error prompt and will then gracefully exit. Note that the CopyStorm database does not have to have data. The minimal requirement is that the Salesforce object tables, along with a handful of CopyStorm metadata tables exist. There are two strategies to consider here:
Strategy 1: Execute CopyStorm with the “Schema Only” option set such that the Salesforce object tables will be created in the CopyStorm database, but no data will be copied. Then CS:Govern can be used to add field encryption rules to the data that will eventually be copied down from Salesforce upon subsequent executions of CopyStorm.
Strategy 2: Execute CopyStorm with the “Schema Only” option unchecked such that the Salesforce object tables will be created in the CopyStorm database, AND data will be copied as well. Then CS:Govern can be used to add field encryption rules to that data, and the generated Custodians can be run to encrypt the data according to the CS:Govern rules that were created.
Regardless of the path taken, in either case a CopyStorm database will be present with the Salesforce object tables and the CopyStorm metadata tables. These are the necessary and sufficient tables required to successfully use CS:Govern.
The Database option specifies the type of database where CS:Govern rules will be installed. If CS:Govern is not installed in the target directory, CS:Govern will automatically install itself on first database connection.
CS:Govern connection parameters are identical to what is used for other CapStorm products. For details see the instructions for CopyStorm.
Though not required, you may save CS:Govern credential information to a file using the File/Save option.
The Edit Field Rules tab is where fields are selected to be protected by CS:Govern. There are two ways to add a table to CS:Govern:
Click on the Add Tables Manually button in the lower left corner. This button will launch a dialog where you can pick one or more tables to add to CS:Govern.
Click on the Discover Sensitive Fields button in the lower left corner. This button will launch a dialog that searches Salesforce field meta data looking for all fields which have Compliance Categories and/or are marked as encrypted. Once the search is complete, the dialog will ask if fields it found should be added to CS:Govern.
When a table is selected from the left section of the tab, a listing of all encryptable fields in the table will be displayed. By definition an



Id
IsDeleted
SystemModStamp
LastModifiedDate
CreatedDate
LoginTime
SentDate
Additionally an encryptable field is one that does not exist outside of the primary CopyStorm database (in other words, it is not a partitioned field. See the Partition Editor reference for more on partitioned fields.)
To add additional fields to CS:Govern protection:
Check the box in the Govern Enabled column for the field. Note that upon saving these changes, an Encrypt Custodian will be generated, and only when those Custodians are run will the CopyStorm data actually be encrypted. For more information about Custodians refer to our Custodians article.
Select one or more Compliance Categories for the field by clicking on the Compliance Category cell.
Optionally change the masking rule assigned with the field. The Masking rule determines what a user will see for the field when they do not have permission to access unencrypted data. For more information about masking rules refer to our Field Compliance Categories And Masking article. For more information related to choosing an appropriate masking rule please refer to our Choosing A Masking Rule article.
To remove a field from CS:Govern protection:
Uncheck the box in the Govern Enabled column for the field. Note that upon saving these changes, a Decrypt Custodian will be generated, and only when those Custodians are run will the CopyStorm data actually be decrypted. For more information about Custodians refer to our Custodians article.
Once CS:Govern field rules have been modified in the editor, they must be pushed to the corresponding CopyStorm database in order for them to take effect. The Save & Protect button writes pending changes to the database AND enables protection for the changes.
Note that upon saving these changes, Encrypt or Decrypt Custodian will be generated, and only when those Custodians are run will the existing CopyStorm data actually be encrypted or decrypted. Newly inserted or updated data will continue to be placed into the CopyStorm database using CS:Govern protection (if encrypted) or in its unmasked form (if no longer being CS:Govern protected.) For more information about Custodians refer to our Custodians article.
For completeness, the Undo Changes button will throw away unsaved changes and restore the editor to match what is currently stored in the CopyStorm database. No Custodians are generated when this action is taken.




The View Compliance Assignments tab displays all CS:Govern fields that have been assigned a selected Compliance Category, and organized in a table with one line per field. For each field in the list a user can remove it from the selected Compliance Category. Note that it does not remove the field from CS:Govern protection. It only changes which Compliance Categories that protection is assigned to. For example, if the field is protected and assigned to HIPAA and PII, but the intent was to only have it assigned to HIPAA, then removing the assignment to PII is as simple as selecting PII from the Filter drop-down and clicking the Remove button next to the field.


A CS:Govern Custodian is a small secure process used to perform long running tasks on a CS:Govern enabled CopyStorm database.
Here are a few examples where a Custodian is important.
Example 1: A User adds a protection rule to the field Attachment.Body and the CopyStorm database already has 1.2 million Attachment records. Someone needs to protect the existing 1.2 millions Attachment records WHILE CopyStorm continues to backup modified or new Attachments. The solution is an EncryptFields Custodian which will faithfully work to protect Attachment.Body fields until all of them are protected.
Example 2: A User removes protection from the Contact.HomePhone field AFTER CS:Govern has protected all (or part) of the Contact.HomePhone values. Someone needs to decrypt the Contact.HomePhone fields WHILE CopyStorm continues to backup modified or new records (without protection). The solution is a DecryptFields Custodian which will faithfully work to unprotect Contact.HomePhone fields until all of them are unprotected.
Example 3: A user wishes to change the masking rule for an existing protected field, from Asterisks to Lorem Ipsum. The solution is to use the Edit Field Rules tab to change the masking rule on the desired field, and then Save & Protect the change to the database. A RemaskFields Custodian will be automatically generated and can be used to apply the masking rule change to all records for the field’s table in the database. Additionally, all new records or all modifications to the existing records will use the new masking rule.
The Custodians tab’s role is to view, run, create, and otherwise manipulate CS:Govern Custodians.
To run/start a Custodian:
Right-Click on Custodian
Choose the Run Custodian option.
The Custodian will immediately begin processing data and its progress can be viewed by clicking on the Search button. While a Custodian is running several bits of information will be updated:
Last Update — Indication of how long the job has been running in a format such as 1h23m17s.
Process Id — the system process assigned to the Custodian by the operation system.
#Modified — the number of records updated so far.
LastRecord — the Salesforce Id of the most recent record scanned by the Custodian.
Once a Custodian completes, it will be marked inactive, and the Finished column will be set to the date on which the Custodian finished.
To view detailed information about a Custodian.
Right-Click on a Custodian and choose the View Details option.
Or Double-Click on a Custodian.
A Zombie Custodian is a Custodian which terminated unexpectedly without cleaning up after itself. This can happen when:
The Custodian Task Manager is killed manually while Custodians are running.
An admin reboots a computer while the Custodian Task Manager is running.
Plus three dozen of random variations of “the box crashed.”
The Zombie Harvest process looks for Custodians which indicate that they are running (by having a non-blank Process Id) and cleans up those whose Process Id is not running. “Clean Up” puts a Custodian into an “In Progress” state, making it eligible to be resumed by the Custodian Task Manager.
If the Zombie Harvest happens quickly (the normal case) then the only change you may see is a Process Id value disappearing from the list of Custodians. If the Zombie Harvest takes more than a second then it will display a progress dialog.
Though CS:Govern Custodians can be started from the main Custodian tab, the best practice is to manage the running of Custodians using the Custodian Task Runner.
The Custodian Task Runner is a command line tool which inspects the CS:Govern database tables to determine what Custodians should be running.
The Customer Task Runner is easily scheduled as an automatic task.
The Custodian Task Runner is smart enough to detect when a Custodian failed to complete normally and will automatically resume a Custodian. Example: If a computer is rebooted during protection of Attachments, the Custodian Task Runner will automatically resume Attachment protection.
The primary purpose of the Custodian Task Runner tab is to generate a command line which can be scheduled to run Custodians. The generated command lines support the following command line arguments.
The Custodian Runner generates and displays command lines based on the current CS:Govern configuration.
Three different command lines are generated:
Local Computer: This command line can be run directly on the current computer.
Windows: This command line will work on a Windows computer. You will need to replace {GovernInstallation} with the path to CS:Govern (example: c:\Capstorm\CSGovern)
Linux or Mac: This command line will work on a Linux or Mac computer. You will need to replace {GovernInstallation} with the path to CS:Govern (example: /opt/Capstorm/CSGovern)
The Edit User Access Rules tab is used to specify the Compliance Categories accessible to database users and roles. Basically, a field and user must have at least one common Compliance Category in order for a user to see unencrypted field data.
If a database user is not in the User Access Rules table and not a member of a database role in the table (directly or indirectly) then the database user will be denied access to CS:Govern protected fields. “Denied Access” means that they will see the Masked value for any CS:Govern field they try to read.
If a database user is in the User Access Rules table (directly or because of database role membership) then they will be able to view encrypted data for any CS:Govern protected field which matches one of the Compliance Categories assigned to the user.
Examples:
Suppose database user “henry” is in the User Access Rules table and his Compliance Categories include Public and PII. When reading CopyStorm field data, “henry” will be able to view any field in the Public or PII compliance categories unencrypted. For CS:Govern fields in other compliance categories “henry” will see the masked value.
Suppose database user “mary” is not in the User Access Rules table but “mary” is a member of the database role “HumanResources” in the User Access Rules table. If “HumanResources” can see unencrypted data in PII fields, then so can “mary”.
Suppose database user “greg” is in the User Access Rules table but no compliance categories have been set his record. User “greg” will not be able to see any decrypted field values.
To add a new database user or role to the CS:Govern rules:
Click on the Add Additional Users or Roles button. This will launch a dialog for selecting users and roles.
Edit the Compliance Categories for the newly added user or role.
Click on the Save button to write changes to the CopyStorm database. After the save operations CS:Govern will be using the rules.
Removing a user is simple: Click on the Remove button at the far right of any user or role record.
Once a user or role is selected set the Compliance Categories accessible to the user or role.
The View Field Rules tab lists all fields added to CS:Govern (including those not yet saved or protected) and provides limited editing capabilities. The purpose of this tab is to list just the fields in CS:Govern.
There are several editing operations that can be performed on fields using the tab.
Remove a field from CS:Govern protection by unchecking the box in the Govern Enabled column.
Modify the Compliance Categories assigned to a field.
Modify the Masking Rule associated with a field.
Of course, pending CS:Govern changes can also be Saved & Protected, or Undone using the standard buttons at the bottom of the tab.
The Admin Log is used to record administrative tasks performed with CS:Govern along with details necessary to reconstruct a task. At minimum the following tasks are recorded.









None
If specified, there will be no output from the runner unless and error occurs.
-apacheLog
None
If specified then the Apache Commons Logging framework will be used.
-cscredentials
String
The argument to this flag is an AES256 encrypted version of the credentials required to connect to the CopyStorm database used by CS:Govern . It is possible to specify the credentials on the command line in an unencrypted form, but this approach is not recommended.
-action
run status
The “-action run” command switch tells the runner to start active Custodians which are not currently running. The runner will wait for the all custodians to be finished before exiting and will automatically detect new Custodians added before it exits The “-action status” command switch tells the runner to print out tables of currently running and pending Custodians.
-custodians
Comma separated list of Ids
Run only the specified Custodians. The “Id” for a Custodian is listed as the first column on the Custodians Tab.
-maxJobs
20
The maximum number of Custodians to run concurrently.


-silent
Protect
Generate and install CS:Govern protection code on a table.
Add User
Add a new access rule for a database user or role.
Modify User
Modify the rules for an already defined CS:Govern user record.
Delete User
Delete a user/role from CS:Govern.
Delete Field
Delete a Salesforce field from CS:Govern protection. Note that the code which protects the field will not be updated until a corresponding Protect task is executed.
Admin Log records are listed in a simple table with the following columns:
Id
Internal unique id for a log record.
Action
The task type of the log record. See the list at the top of this page for all actions.
Object
The database object affected by the action. The type is dependent on the action and may be a Field Name, a Database Table, A User Name, etc. The type value is generally obvious from the action.
Database User
The database user who performed the action.
OS User
Rotate Encryption Keys
Generate and install new encryption keys. All subsequently encrypted data will use this key.
Add Field
Add a new field to those to protect with CS:Govern.
Create Encrypt Table

Create the CS:Govern database table that holds encrypted data for a corresponding Salesforce table.
The operating system who performed the action.
Host Name
The name of the host computer in use when the action was performed.
Host Address
The IP address of the host computer running CS:Govern.
Created (UTC)
The timestamp when the action was performed.
Details
Details about exactly what was changed in the database.

The View Table Rules tab displays all CS:Govern fields organized in a table with one line per table. For each table in the list a user can:
Double click on a table to launch a dialog of information about the table.
Right click on a table to launch a context menu with operations such as:
Reinstall Protection — upgrade the CS:Govern protection rules (even if the code thinks this is unnecessary).
Install Protection — apply CS:Govern rules to just the selected table.
Remove Protection — remove CS:Govern protection for all fields in the table.
View Details — show CS:Govern details about the table. The same details can be displayed using a double-click.
Of course, pending CS:Govern changes can also be Saved & Protected, or Undone using the standard buttons are the bottom of the tab.
Double-clicking on a table will show a dialog with details about a table and its protection.
The lower part of the dialog lists each field protected in the table. The following table lists each field property displayed.
Salesforce Table
Name of the Salesforce table. This may be different than the CopyStorm database table name.
Deployed
Yes if the database protection code has been deployed to the database. No if there are changes pending deployment.
Storage Table
Name of the database table used to store encrypted field values.
Decryption Function
Name of the function which can decrypt field values. Of course, it will decrypt a field only if the current database user has permission to see a field. Note: This function should made executable for all users.
Insert Trigger
Id
Internal unique CS:Govern id for a field.
Field
Salesforce API name for a field.
Guardian Masking Rule
Rule for showing field data to a person without permission to see the unencrypted value.
Compliance Category
Semi-colon separated list of compliance categories assigned to the field.
Deployed
Yes if the field is protected. No if there are pending changes to be deployed for the field.

Name of the CS:Govern created insert trigger on the CopyStorm table. This trigger is foundational to how CS:Govern enforces transparent encryption. Note: Often the Insert and Update trigger are the same.
Update Trigger
Name of the CS:Govern created update trigger on the CopyStorm table.
Delete Trigger
Name of the CS:Govern created delete trigger on the CopyStorm table. When a record is deleted by CopyStorm the trigger automatically deletes the corresponding encrypted data for the record.
Truncate Trigger
If a database supports triggers on TRUNCATE operations, CS:Govern will install a trigger on a CopyStorm table to mimic truncate operation. Most database do not support this type of trigger.
Insert Function
Some databases require the code for a trigger to be separate from a trigger declaration (PostgreSQL for example). When required, this is the function invoked by the insert trigger.
Update Function
Some databases require the code for a trigger to be separate from a trigger declaration (PostgreSQL for example). When required, this is the function invoked by the update trigger.
Delete Function
Some databases require the code for a trigger to be separate from a trigger declaration (PostgreSQL for example). When required, this is the function invoked by the deletetrigger.
Truncate Function
Some databases require the code for a trigger to be separate from a trigger declaration (PostgreSQL for example). When required, this is the function invoked by the truncate trigger.

