The CopyStorm/Director application is a visual tool for editing the contents of a CopyStorm/Director database. CopyStorm/Director is a Java application that will run on all platforms supported by Capstorm.
CopyStorm/Director is outlined in red in the architectural diagram below:
When CopyStorm/Director is launched it will always require credentials for its corresponding database.
CopyStorm/Director will automatically remember the most recently used credentials for the current user.
The most recently used credentials are encrypted and stored in the file $HOME/.capstorm/CopyStormDirector.properties.
Encryption is performed using DES-256 with an unpublished secret key.
A typical encrypted database credential token looks like:
“>+XivzBaVHtPWN7wuBWQS454c2rWv76pk2+fMILleNtVCWK+++exzHk7CkrM1RfgXTLiXAGM15RR674Xy5+jEZQtzHrgxllFX8wx25FbQr7iH0tmcWAGghiYpnRe+7VIS
There are no special setup requirements for the database except that the corresponding user:
Must be able to create/alter tables and views.
Must be able to insert/update/delete/select from any table/view created.
CopyStorm/Director automatically creates the necessary schema if it is missing.
After entering credentials, click on the “Select” button to connect to the CopyStorm/Director database and launch the configuration editor:
One of the first steps in setting up a new CopyStorm/Director database is to establish a few key global parameters. The File System Configuration tab is used to establish all required global parameters.
If you fail to enter all values or enter a value incorrectly, the system will detect and report the issue when a task runs.
Documentation for each parameter is included as part of the tab:
The Job Editor tab is used to create a new job and corresponding tasks. The Job Editor table can also be used to view the history, status, and log data for each task.
Before creating a new job, click on the “Clear Editor” button. The most important data to enter is:
Job name — a unique, human-readable name for the job.
Description — a detailed description of the purpose of the job.
The two check boxes control job behavior:
If the “Active” box is not checked the tasks in the job will not be ran by CopyStorm/JobRunner.
If the “Deleted” box is checked the job will be considered deleted but still kept in the CopyStorm/Director database.
After entering a name and description, the next step is to enter credentials for both the Salesforce instance and the CopyStorm database associated with the job.
A CopyStorm/Director job may have multiple tasks, each of which are scheduled to run at different times. In the following screenshot a single CopyStorm task has been created:
The “Log Retention” is an optional input that allows specification for the number of log files to kept for a specific task. If the input is left blank, all logs are kept.
The run schedule for a task is set using the Schedule Editor. Click on the “Actions…” button to launch this editor.
Parameters on the left of the dialog control when a task should run. For help on the format click on the link in the help part of the dialog. As you enter scheduling constraints the system will display the computed schedule on the right-hand side of the dialog. Note that nothing is saved unless you click on the “Update Task” button.
Adding a CopyStorm/Medic task follows the same procedure with one extra required parameter. The extra parameter is used to specify the CopyStorm/Medic tool to run.
A variety of actions are available for a Task — to see the list of actions click on the “Actions…” button next to the task. Task actions include:
“Show Schedule” shows a read-only version of the schedule for the next 10 runs of the job.
“Edit Schedule” displays the Schedule Editor for the task.
“Run CopyStorm GUI” launches the CopyStorm application using the configuration file associated with the task.
“Start Task” starts the task as a background job. The background job will continue to run if the CopyStorm/Director application is closed.
The History tab displays the results of each task execution. The date range of tasks displayed can be changed using the “History From … thru” editor:
“Stop Running Task” stops the background process running this task. This option is disabled if the task is not running.
“Delete Task” removes the task from the job.
The Find Jobs tab is used to search for jobs in the CopyStorm/Director Database. For sites with 10 or fewer jobs defined, clicking on the “Search” button will find all jobs. For sites with a lot of jobs the search criteria at the top of the page allow easy filtering of the list.
To run a job search:
Optionally fill in one or more query parameters.
Click on the “Search” button.
Once one or more jobs are found, click on a job name to load it into the Job Editor.
The following screenshot illustrates the major features of the Find Jobs tab:
The Access Control tab is used to configure access control/authorization for the core CapStorm applications (CopyStorm, CopyStorm/Medic, CopyStorm/Restore, and CopyStorm/Director). The Access Control editor table can be used to add new and edit existing CapStorm application users and assign pre-defined roles to users. These pre-defined roles will determine the level of access (available functionality) granted to the assigned user when using the aforementioned supported applications.
NOTE: This functionality is disabled if using the desktop Swing GUI version of the application suite. In this case, the Access Control tab will be grayed out.
Click on the “Add User…” button.
This will open a pop-up dialog where you can enter the following:
Username — a unique username.
Password — a strong password.
Enabled — this checkbox determines whether the user will be enabled or disabled upon creation.
Then click the “Save” button to add the user.
After adding a user, you can assign the user a role.
Three pre-defined roles are available:
Super Admin — a top-level administrative role. A user with this role can perform any operation in any application including configuration of Access Control.
Admin — a slightly restricted administrative role. A user with this role can perform any operation in any application except configuration of Access Control.
Configurator — a user with this role can edit configurations for all applications, but cannot invoke any of the applications (cannot run jobs).
The “Production Enabled” check-box will enable/disable any operation that is allowed by the assigned role against a production database or Salesforce org. For example:
A user that has been assigned the “Configurator” role but has the “Production Enabled” check-box unchecked cannot edit a production configuration.
A user can be enabled/disabled by clicking the “Is Enabled” check-box or deleted by clicking the “Remove” button.
When you are finished making changes to the Access Control configuration, click the “Save Changes” button at the bottom of the editor table. A pop-up dialog will appear where you can validate and confirm/deny all staged changes.
You can also undo all staged changes by clicking the “Undo Changes” button.
The Access Control configuration is stored and reflected in a sub-schema of the CopyStorm/Director database schema that consists of the following five tables and a single view:
users
authorities
groups2
group_authorities
These tables, and the view, are required for the functionality of the Access Control subsystem to function properly.
Job Number(s)
Unique job number (or numbers) to find. For example:
1
1,5,7
1-10
2-19,14
Job Name
Find jobs where the name matches the query. Use a * for a wildcard.
user_group_authorities_view (view)
Description
Find jobs where the query text appears in the description. Use * for a wildcard.
Salesforce User
Find jobs where the Salesforce user matches. Use * for a wildcard.
Quick Search
Select an item from the menu to run a common query. For example,
Jobs running now.
Jobs that ran today.
Jobs that did not run today.
Jobs created in the past 7 days.
Connection String
Find jobs where the CopyStorm database connection string contains the query. Use * for a wildcard.
CopyStorm Profile
Find jobs where the CopyStorm profile matches the query. Use * for a wildcard.
CopyStorm/Medic Profile
Find jobs where the CopyStorm/Medic profile matches the query. Use * for a wildcard.
Last Status
Limit the to jobs with a status of:
Running — a task defined in the job is running.
Success — the last reported status of the job was success.
Failure — the last reported status of the job indicated a problem.
Include Jobs
Limit to jobs which are:
Active — the job is available to run.
Inactive — the job is not available to run but has not been marked as deleted.
Deleted — the job has been marked as deleted.
Created
Find jobs created within a date range. A date can be specified in the following formats:
2015-11-22
22-Nov-15
11/22/15 (USA Style)
22.11.2015
22-11-2015
20151122
11/12
22.11
Yesterday
Today
Modified
Find jobs modified within a date range. See the Created options for accepted date formats.
Last Run
Find jobs that ran within a date range. See the Created options for accepted date formats.
Next Run
Find jobs scheduled to run within a date range. See the Created options for accepted date formats.
Search
Run a search given the current query criteria.
Reset
Reset all search criteria to their default values.
