The CopyStorm/Director Global Parameters page is used to specify the locations for CopyStorm/Director configuration data. The web-based editor’s capabilities are a subset of the primary stand-alone . For more information see the stand-alone .

The CopyStorm/Director Job Searcher searches for jobs defined in the CopyStorm/Director database.

If your organization is not managing 100s of CopyStorm backups, the only control you may need is the “Search for Jobs” button.

The top portion of the page contains parameters limiting the jobs returned when the “Search for Jobs” button is clicked. You can find descriptions for these parameters on the Job Editor page.

The bottom part of the page contains jobs found in the most recent search.

In addition, the hyperlinks in the job list will open an editor for the selected job. This editor is web-based and contains a subset of the functionality of the Java-based editor.

The CopyStorm/Director web tool includes a dashboard suitable for interactive job monitoring.

• All active jobs are listed in the top half of the dialog, along with the status of the most recent run.

• When a job is running, the bottom half of the dialog displays the log file generated by the job as it is running.

  • When the job completes the log file viewer disappears.

• Above the job list are a handful of parameters controlling the display characteristics of the page, including:

  • How often the CopyStorm/Director database is polled.

  • How many running tasks are displayed per row.

  • How many rows and columns are displayed for a log file.

In addition, the hyperlinks in the job list will open an editor for the selected job. This editor is web-based and contains a subset of the functionality of the Java-based editor.

The CopyStorm/Director Job Editor supports the creation and editing of jobs and tasks. Its capabilities are a subset of the primary stand-along Job Editor — for more information see the Job Editor documentation.

The web-based Job Editor differs from the stand-alone Job Editor in the following ways:

• It cannot be used to start or stop tasks.

• It cannot launch the CopyStorm or CopyStorm/Medic GUI.

The CopyStorm/Director GUI is distributed in two formats — a stand-alone Java application and a web browser application. In most situations either (or both) applications can be used to edit or view the CopyStorm/Director database and the choice of which to use is up to your organization.

• The stand-alone Java application has a few more capabilities than the web browser application, most of which are related to its ability to stop and start local processes.

• The primary advantage of the web application is that it can run anywhere on your network. In addition it has a dynamic dashboard suitable for near real-time monitoring of CopyStorm backups.

Setting up the web browser application is slightly more complex than the “unzip and go” approach of the Java application.

Note that the following instructions apply to Tomcat versions up to but NOT including Tomcat 10. Tomcat 8 and Tomcat 9 will work fine.

Due to the fact that the Tomcat service is not running as a SQL Server User with privileges to connect to the database, steps need to be taken to configure Director when using SQL Server as the backing data source.

• Create a user by going to Start => Settings => Accounts => Family & other users => Add someone else to this PC (click on “I don’t have this person’s sign-in information”) => Add a user without a Microsoft account

• Once this user is created (for example, SqlServerTomcat), change the Account Type to Administrator

• Right click on the Tomcat service in the Windows Services window and select Properties from the drop-down menu. On the Log On tab of this view, click the This Account radio button, and enter the account name that was just created (precede this name with a ‘/’) and enter the password you used when creating the user.

The CopyStorm/Director web application uses a datasource with the resource name “jdbc/CopyStormDirector”.

The entry should look like the following example from our test servers:

The CopyStorm/Director web application is packaged in a file located at:

• [CopyStorm/Director install directory]/war/CopyStormDirector.war

There are several ways to deploy the war file. Your Apache/Tomcat administrator will know how to deploy it using your organizations standards.

Open the URL and you should see a screen like:

CopyStorm/JobRunner requires that the credentials for a CopyStorm/Director database be specified. There are two ways to specify credentials:

• Explicitly as clear text on the command line.

• Explicitly as an encrypted token on the command line.

The clear text approach is simple but not very secure. For example:

• CopyStormJobRunner.bat -cstype postgresql -csdatabase //localhost/copystormjob -csuser root -cspassword helloworld

The command line arguments shown are exactly the same data that is required to launch CopyStorm/Director.

To launch with an encrypted token requires a bit of setup but keeps intruders from seeing a visible password.

• The credential token is a DES-256 encrypted string.

• Example: CopyStormJobRunner.bat -cscredentials “u0JmFcF4te6InFu0owWtmRTpxMsqwnFp9MXeR7hf2LbQtxHgaHsaGt7i8CeYscQ9ZjvOObWGE6Frh2gLOIVILIruq7mYeXuUJLaYOxFuMCHKtxb4wBu5l+HoN41d1hWe+tLKNFuvyDUJEC9hMSWvkg==”

The process to generate a credential token involves one of:

• Opening the Job Runner tab on the CopyStorm/Director GUI and copying the generated token.

• Running CopyStorm/JobRunner on the command line with clear text credentials and the action “-action makeCredentials”.

Capstorm recommends that an encrypted token always be used. However, anywhere CopyStorm/Director database are illustrated in the documentation, either form of credentials may be used.

Release Date: 12-Jan-2024

This is a minor feature and bug fix release. As always, existing CopyStorm/Director configuration files are backwards compatible.

Patch Levels

Update Job History to be Color-Coded

The Job Status and History tables in CopyStorm/Director have been updated with a color scheme to indicate success and failure. Successful jobs are marked in green, jobs with errors are marked in red, and jobs that have not yet finished are not marked with a color.

The CopyStorm/Director UI has been reviewed and updated to better support a wider range of screen resolutions.

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:

CopyStorm/JobRunner is the command line tool used to run jobs defined by CopyStorm/Director.

• CopyStorm/JobRunner is typically scheduled as a job using a native scheduler (e.g. Windows Scheduler or CRON).

  • In this mode it will read job scheduling data from the CopyStorm/Director database and run the appropriate jobs.

• CopyStorm/JobRunner can be used to force jobs to run outside of their normal schedule.

In the following diagram, the CopyStorm/JobRunner is outlined in red:

There are two steps to using CopyStorm/JobRunner:

• Specify credentials for a CopyStorm/Director database.

• Run the application from a command line prompt or a scheduler.

CopyStorm/JobRunner’s main purpose is to execute jobs defined in a CopyStorm/Director database — the first procedure that must be understood is how to pass database credentials to CopyStorm/JobRunner. Please read and understand the before trying to run CopyStorm/JobRunner.

• — complete command-line reference for CopyStorm/JobRunner.

Release Date: 16-Dec-2017

This is a feature and minor bug fix release.

Adding a few key indexes to CopyStorm/Director’s control tables improved job monitoring queries significantly.

The web browser based tools now include links to the corresponding documentation on learn.capstorm.com.

Support DPI detection in Java 9 and work well on 4K displays.

When a system crashes, is rebooted, or if the CopyStorm/JobRunner application is manually terminated; the CopyStorm/Director database will contain data indicating that jobs are running when they were terminated unexpectedly. This article explains how CopyStorm/JobRunner recovers from this situation.

The answer is that all of these cases are handled the same way:

• Each time CopyStorm/JobRunner starts a task, the system process id of the task is stored in the CopyStorm/Director database.

• Each time CopyStorm/JobRunner starts it looks for tasks configured as running in the CopyStorm/Director database which have disappeared from the system.

  • If found, the jobs are marked as completed and given a log file status of “Process died without notifying Copystorm/Director.”

• Any job detected as dying unexpectedly is rescheduled using the job’s scheduling parameters.

When job completion is detected using this approach the CopyStorm/Director database may indicate that the last status of an unusually high number of jobs was “Error”. This is likely to happen if a job was terminated during a reboot and will be recovered from automatically the next time the job is scheduled.

The CopyStormTaskLog table contains a record for each time a CopyStormTask has been executed. This table can be used to determine:

• The success or failure status of a task.

• The current state of a task — complete or running.

• The log file generated by the task.

Records in this table are created by the CopyStorm/JobRunner application.

The following table describes each field in the CopyStormTaskLog table:

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 ConfigurationFile table stores metadata about configuration files used by CapStorm products. It serves as the central reference for tracking versions, associations, and the status of each configuration file within the system.

The following table describes each field in the ConfigurationFile table:

Release Date: 5-Jan-2023

This is a minor feature, bug fix, and Salesforce API version upgrade release. As always, existing CopyStorm/Director configuration files and databases are backwards compatible.

CopyStorm/Director database encryption has been updated to support AES256 for credential storage.

CopyStormJobSequence Table

The CopyStormJobSequence table is used to support a database-independent approach for generating integer sequence values. When creating new jobs or tasks within the application, the counter stored in the value field on this table for different object counter is utilized. For example, the name field can have the name CopyStormJob, and whenever a new CopyStormJob record is created, the integer stored in the value field will be utilized for the job id.

The following table describes each field in the CopyStormJobSequence table:

Release Date: 28-Apr-2026 This is a feature and bug fix release. As always, existing CopyStorm/Director installations are backwards compatible.

Patch Levels

Important: Salesforce Username/Password Login Deprecated

Salesforce API version 65 deprecates the SOAP username/password login endpoint. Customers should migrate to an external client application configured with OAuth. Jobs using a login type that does not support API 65 will automatically fall back to API 64, and an exception will be logged at the start of each job as a reminder to migrate.

This exception can not be eliminated until OAuth authentication is used.

Salesforce API Version Fallback for Username/Password Logins

The "Fallback API Detected" error does not stop your jobs from running - it is informational, and indicates that scheduled jobs are not able to use the most recent Salesforce API features. The error will be resolved when updating to JWT (or other OAuth) authentication.

Please reference .

This release updates CopyStorm/Director to use Salesforce API version 65.

Improved application performance when navigating and exporting Task History.

Forcing a specific CopyStorm job to run on demand requires three things:

• Database credentials for the CopyStorm/Director database.

• The unique integer Job Number for the job containing the task to run.

• The family to which the job belongs.

All of this data is visible when viewing a job in the CopyStorm/Director GUI:

Release Date: 2025-Apr-01

This is a minor feature and bug fix release. As always, existing CopyStorm/Director configuration files are backwards compatible.

Release Date: 14-Nov-2016

This is a minor bug fix release.

Fix a Database Schema Modification Exception

When installing a brand new CopyStorm/Director instance, the application could try and create a column in the control tables twice.

Release Date: 22.Aug.2024

This is a bug fix version upgrade release. As always, existing CopyStorm/Director configuration files are backwards compatible.

Patch Levels

Job History User Interface: Improvement

• Fix an issue where Standard Error/Standard Output is fully loaded in memory when viewing Job History. The fix results in faster page rendering.

Users Table (Platform Only)

The Users table stores authentication details for system users. It is the primary table for determining login credentials and account status.

The following table describes each field in the Users table:

CapStormPlatformConfig Table

The CapStormPlatformConfig table contains configuration information for the application. This table is a formatted as a key-value pair structure to store metadata about the application configuration. The primary information stored in the table pertains to versioning of the application aligning to the version of the database schema.

The following table describes each field in the CapStormPlatformConfig table:

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:

Once the CopyStorm/Director application is installed, a number of global parameters must be initialized before the first CopyStorm job will run:

• The root directory of a preexisting CopyStorm installation.

• The root directory of a preexisting CopyStorm/Medic installation.

• A directory for storing CopyStorm configuration files accessible to the CopyStorm/Director program.

Group_Authorities Table (Platform Only)

The Group_Authorities table defines authorities (permissions) assigned to specific groups within the application. Each record links a group to a particular authority, enabling role-based access control at the group level.

The following table describes each field in the Group_Authorities table:

The following table describes available authorities within the application including a description.

ApplicationCredential Table

The ApplicationCredential table maintains secure, reusable credential information used for authenticating against external systems such as Salesforce or database connections. It supports different connection and credential types with flexible formats.

The following table describes each field in the ApplicationCredential table:

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.

Step 1: Create a New Job

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:

ConfigurationFileVersion Table

The ConfigurationFileVersion table stores individual versions of configuration files used by CapStorm products. Each entry corresponds to a specific version of a file recorded in the ConfigurationFile table, including its full content and associated metadata.

The following table describes each field in the ConfigurationFileVersion table:

CopyStormTaskLogFile Table

The CopyStormTaskLogFile table stores segmented pieces (“chunks”) of large task log files generated by job runs of CopyStorm and CopyStorm/Medic. Each chunk represents a portion of the full log associated with a specific CopyStormTaskLog record. This allows for scalable storage and retrieval of log data.

The following table describes each field in the CopyStormTaskLogFile table:

The CapStormPlatformDatabase table stores metadata and connection information for databases registered with the application. Each record represents a distinct database environment, including its type, intended usage, and configuration details.

The following table describes each field in the CapStormPlatformDatabase table:

The ConfigurationFileAdminLog table records a historical log of actions performed on configuration files, including details about the action, the environment, and the user responsible. This enables traceability auditing, and troubleshooting for configuration changes.

The following table describes each field in the ConfigurationFileAdminLog table:

CopyStorm/Director is comprised of three major components:

• The CopyStorm/Director Database contains definitions of all CopyStorm jobs, their history, and the schedule(s) for when they should run.

• The CopyStorm/Director application is a rich GUI for editing and searching the content of a CopyStorm/Director Database.

• The CopyStorm/JobRunner is a command-line tool that runs jobs defined in the CopyStorm/Director Database.

The relationships between components are illustrated in the following diagram:

Release Date: 19-Dec-2025

This is a minor feature and bug fix release. As always, existing CopyStorm/Director configuration files are backwards compatible.

Patch Levels

Minimum Java Version Change

With the release of CopyStorm/Director 2.64.3, the minimum supported Java version is 17. As always, the Windows distribution of CopyStorm/Director includes a supported Java environment.

CopyStorm/Director 2.64.3 introduces support for scheduling CopyStorm/Restore configurations. New task types for CopyStorm/Restore are available in the CopyStorm/Director GUI, and both Restore Candidate Scans and Record Recoveries can be scheduled.

UserPreferences Table (Platform Only)

The UserPreferences table stores custom properties associated with individual users. These properties allow the system to maintain flexible, user-specific attributes without modifying the core user schema.

The following table describes each field in the UserPreferences table:

Group_Members Table (Platform Only)

The Group_Members table links individual users to specific groups in the system. It is a many-to-many relationship bridge between the user and group entities, allowing users to inherit the authorities assigned to their groups.

The following table describes each field in the Group_Members table:

Release Date: 5-Aug-2025

This is a minor feature, bug fix, and Salesforce API version upgrade release. As always, existing CopyStorm/Director configuration files are backwards compatible.

Patch Levels

Salesforce API Update

This release updates CopyStorm/Director to use Salesforce API version 64.

CopyStorm/Medic Tool Support

This release introduces support for scheduling the CopyStorm/Medic tool.

• Resolved a filtering issue with the “Jobs that did not run today” quick-search.

This article explains how to add CopyStorm/JobRunner to your system scheduler so it will run unattended on a schedule you specify.

The first step is to create a CopyStorm/JobRunner command that can be successfully ran from the command line. The easiest way to do this is to open the Job Runner tab in the CopyStorm GUI and copy the command already generated:

It is a good idea to put the command line into a script file. Within this documentation, the script was put into a file named:

• Windows: C:\bin\MyCopyStormJobRunner.bat

• Linux/Mac: /usr/local/bin/MyCopyStormJobRunner.sh

The CopyStormGlobalConfig table contains information required to launch CopyStorm and CopyStorm/Medic tasks.

The following table describes each field in the CopyStormGlobalConfig table:

Before starting to set up a CopyStorm/Director job:

• Make sure the CopyStorm configuration files to be used are stored in the directory indicated on the (formerly called the Global Configuration) tab.

There are three steps remaining:

• Review the . It describes how to define and schedule a job.

Groups2 Table (Platform Only)

The Groups2 table stores distinct groups within the system. Groups are used to organize users and assign authorities collectively, allowing role-based access control without the need to manage permissions for individual users.

The following table describes each field in the Groups2 table:

Release Date: 31-July-2023

This is a minor feature and bug fix release. As always, existing CopyStorm/Director configuration files are backwards compatible.

Patch Levels

Add Configuration File for Additional Java Parameters

A new XML configuration file may be used to add additional parameters to the Java runtime used to launch CopyStorm/Director – this allows additional parameters (e.g. “-Xmx”) to be added outside of the CopyStorm/Director launch script.

CopyStorm/Director has been updated to resolve a Windows-specific issue with SQL/Server integrated security connections in Java 17.

Release Date: 16-Dec-2016

This is a feature and minor bug fix release.

Patch Levels

The web browser based tools now include a dashboard which dynamically monitors and shows the progress of all active CopyStorm/Director jobs.

Previous releases required the CopyStorm/Director Metadata to be in the default schema.

Previous releases would always pass encrypted credentials on the command line even when a task was set up to use the credentials in the CopyStorm configuration file. This would cause a hard to diagnose error if the encrypted credentials in the database did not match the credentials in the configuration file.

Previous releases would not fully paint a new task on the GUI task editor when it was the new task (a window resize event was needed). This bug is fixed.

Jobs that are marked as inactive or deleted now are indicated by a status of “Inactive” (or “Deleted”) with a gray background.

The Global Configuration tab has a new button, Reload Configuration Data, that will rescan the configuration directory for changes (e.g. new or removed configuration files).

Controls have been added to the bottom of the Find Jobs tab for launching CopyStorm or CopyStorm/Medic.

If the -silent flag is passed to the JobRunner.bat script then the JobRunner will not longer display a blank “CMD” window when it is running. In previous versions a blank “CMD” would display even when the JobRunner was launched via Windows Scheduler.

When the log file for a task is being viewed it will now be updated to match the running log file of a task. By default, the update interval is every 10 seconds.

The CapStormWizardConfig table is used to store information about best practice configurations in CapStorm/Platform applications (i.e. CS:Container or Snowflake CapStorm Salesforce Connector). Primary information for the configuration is stored in the config field. The structure of the data in the config field is dependent on the type of configuration record that is stored. All CapStorm best practice wizards have a designated type that maps to a specific structure to be stored. All information in the config field is JSON formatted.

The *createdDate, createdBy, lastModifiedDate,*and lastModifiedBy fields are audit fields to describe when and who initially created configuration records as well as when and who made the last modification.

The following table describes each field on the CapStormWizardConfig table:

CopyStorm/Director is designed to simplify the management of CopyStorm for organizations with many Salesforce instances. The simplification is gained by centralization of:

• CopyStorm job scheduling.

• CopyStorm status monitoring and reporting.

• CopyStorm log organization and archival.

For example, the following diagram illustrates a company with three Salesforce instances (Autos, Motorcycles, and Boats) with multiple CopyStorm jobs running against each instance:

Release Date: 31-Mar-2023

This is a minor feature, bug fix, and Salesforce API version upgrade release. As always, existing CopyStorm/Director configuration files are backwards compatible.

Patch Levels

Fix False-Positive Job Status

Resolved an issue that could cause successful CopyStorm jobs to be marked as failed in Director.

Fix Schema Upgrade Issue

Resolved an issue that could cause CopyStorm/Director database schema upgrades to be incorrectly applied.

The CopyStormTask table describes each CopyStorm and CopyStorm/Medic task that can be ran against its parent CopyStormJob Salesforce instance. This table also describes the schedule under which each job should be ran by CopyStorm/JobRunner.

CopyStormDirector also defines a view, CopyStormTaskView, which combines information in the CopyStormTask table with the most recently executed task (and its status).

The following table describes each field in the CopyStormTask table:

Release Date: 18-Dec-2018

This is a minor feature and bug fix release. As always, existing CopyStorm/Director configuration files are backwards compatible.

The CopyStormTaskFamily table is used to register names used to group CopyStormTask records.

The following table describes each field in the CopyStormTaskFamily table:

The CopyStormJob table is the root descriptor for all tasks associated with a single Salesforce instance. It contains login credentials for a Salesforce instance and its corresponding CopyStorm backup database.

Note that both Salesforce and CopyStorm backup credentials are optional and will override any credentials specified in the corresponding CopyStorm configuration file. However, credentials stored in this table are useful when a common CopyStorm configuration file needs to be used for many different Salesforce and CopyStorm databases.

CopyStormDirector also defines a view, CopyStormJobView, which combines information in the CopyStormJob table with the most recently executed task (and its status).

The following table describes each field in the CopyStormJob table:

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:

Release Date: 17-Apr-2024

This is a minor feature, bug fix, and Salesforce API version upgrade release. As always, existing CopyStorm/Director configuration files are backwards compatible.

Patch Levels

Add More Medic Tools

This release introduces CopyStorm/Director support for scheduling additional CS:Medic tools:

• Count Records

• Fix Doc Links

• Find Permission Errors

• Refresh Columns

• Resolve an issue preventing the job log from correctly color-coding on MacOS.

If you’ve seen the following behavior with CopyStorm/Director:

Screenshot: Duplicate CopyStorm jobs in CopyStorm/Director

Please review your Windows Task Scheduler configuration for CopyStormJobRunner.bat. Ensure that:

• Exactly one Task is configured to launch CopyStormJobRunner.bat

• In the Settings of the Task Declaration

  • “If the task is already running, then the following rule applies:” is set to “Do not start a new instance“

The following screenshots provide an example configuration that will run the CopyStormJobRunner.bat script every 10 minutes, starting at 20:00, every day.

Screenshot: CopyStormJobRunner Triggers Example

Screenshot: CopyStormJobRunner Settings Example

If you’ve ensured that the Windows Task declaration is configured correctly, and you’re still seeing CopyStorm/Director launch multiple jobs at the same time, please review the History for the Task.

In practice, we’ve seen Windows Task Scheduler run a task multiple times at the configured trigger time – even with the “Do not start a new instance” task rule applied.

Your History tab may look something like this:

Screenshot: CopyStormJobRunner History Example

In the screenshot above, you can see multiple Action Started Task Categories at the 04:00:04 timestamp – meaning that multiple instances of CopyStormJobRunner.bat are running concurrently.

1. Disablethe current CopyStormJobRunner Windows Task.

2. Createa new CopyStormJobRunner Task with the same configuration as the previous Task.

3. Monitor the History for the newly created task – ensure that you see exactly one Action Started Task Category at the expected execution time.

Please contact immediately if you notice further issues after following these steps.

Installing CopyStorm/Director does not touch any system files or registry values — you should not need an administrator.

Step 1: CopyStorm/Director Database Setup

CopyStorm/Director uses a database to store information about jobs, schedules, and status. Before using CopyStorm/Director this database must be created.

The database type can be any of the following:

• SQL/Server

• Oracle

• PostgreSQL

• MySQL

Capstorm recommends creating a database and a database user for the sole purpose of managing CopyStorm/Director data. What “creating a database” entails is slightly different for the various database engines but a DBA will know what to do.

1. Download CopyStorm/Director from or from the link sent to you by Capstorm.

2. Unzip the downloaded file into any directory. A single directory named CopyStormDirector will be created.

3. Go to the newly created CopyStormDirector directory and run the launcher appropriate for your operating system:

   1. Windows: CopyStormDirector.bat

After a successful connection the CopyStorm/Director tool will appear, with the File System Configuration (formerly called the Global Configuration) tab selected. At this point you are ready for .

CopyStorm/Director is designed to simplify the management of CopyStorm when an organization has many Salesforce instances:

By managing jobs in a central database, CopyStorm/Director provides solutions to several different problems faced by organizations with many Salesforce instances:

• A single scheduled program (CopyStorm/JobRunner) can be used to launch all CopyStorm jobs.

  • This reduces the complexity of CRON (Linux/Mac) and Windows Scheduler setup and maintenance.

• CopyStorm/Director prevents duplicate jobs from running at the same time.

• Log files from CopyStorm jobs are kept in a central database rather than a difficult to maintain file directory structure.

• CopyStorm/Director automatically analyzes log files and provides reports on jobs that experienced problems.

• When operators reboot a system, jobs that were in progress are automatically restarted after the reboot is complete.

• Different CopyStorm jobs with different purposes can be scheduled on the same Salesforce instance with no risk of job overlap.

• Job description and history is maintained in a documented relational database, allowing third-party reporting if needed.

• CopyStorm/Director management tasks can be accessed via either a native desktop application or a web browser.

Is Copystorm/Director worthwhile if a site has a single Salesforce instance? Yes. Time spent installing CopyStorm/Director will be paid back many times by its ability to manage and analyze log files. Not all Salesforce API hiccups are equal, and CopyStorm/Director knows which are important.

• Read the guide to become familiar with the core components of CopyStorm/Director.

• Read the Getting Started articles. They will guide you through the installation and setup of CopyStorm/Director.

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.

Step 1: Add a User

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.

The CopyStorm/Director application comes in two flavors:

• The CopyStorm/Director Desktop

• The CopyStorm/Director Browser Application

Capstorm recommends starting with the desktop version. The web browser application can always be configured later and used concurrently with the desktop version.

CopyStorm/Director Desktop

• Windows: XP/Vista/7/8/Server, both 32 and 64-bit.

• Linux: Ubuntu, RHEL, Suse, Fedora, etc…

• Mac OS

• VMWare, Amazon/AWS, Microsoft Cloud, and other hosted environments.

• Java 7 or higher.

  • A Java JRE is packaged with CopyStorm/Director Windows distributions.

• Servlet container using Java 7 or higher.

  • Capstorm develops using Tomcat7 and Jetty.

Both flavors of CopyStorm/Director require a relational database and a user with CREATE/ALTER TABLE permissions. The database can be any of the following:

• SQL/Server

• Oracle

• PostgreSQL

• MySQL

Release Date: 16-Dec-2024

This is a minor feature, bug fix, and Salesforce API version upgrade release. As always, existing CopyStorm/Director configuration files are backwards compatible.

Patch Levels

Salesforce API Update

This release updates CopyStorm/Director to use Salesforce API version 62.

Task History Retention: Feature

New option to set the number of logs to retain for each CopyStorm or CopyStorm/Medic job. This parameter is set per task, which allows logs for key jobs to be retained longer than jobs for less critical jobs. If this parameter is left blank, all logs will be retained. Reference for details.

Resolve an issue that could cause the first run of tasks to cause multiple tasks under the same CopyStorm/Director job to launch in parallel.

CopyStorm/Director manages data about CopyStorm jobs in a relational database. Managed data includes:

• Schedules of which jobs should run.

• Status of running jobs.

• Log files and status of completed jobs.

The relational database type can be any supported by Capstorm.

See below for all tables in the CopyStorm/Director database:

CopyStorm/JobRunner supports the following command line options:

The following sample command lines illustrate how the various options are used.

sh CopyStormJobRunner.sh -action runScheduled -cscredentials “xyzzy”

Note: It is bad practice to use clear text credentials on the command line.

CopyStormJobRunner.bat -action runScheduled -cstype postgresql -csdatabase //localhost/copystormjob -csuser root -cspassword mypassword

sh CopyStormJobRunner.sh -action runScheduled -maxJobs 10 -cscredentials “encrypted-credentials-string”

sh CopyStormJobRunner.sh -action makeCredentials -cstype postgresql -csdatabase //localhost/copystormjob -csuser root -cspassword mypassword

sh CopyStormJobRunner.sh -action runCopyStorm -jobs 1,5 -cscredentials “encrypted-credentials-string”

sh CopyStormJobRunner.sh -action status -cscredentials “encrypted-credentials-string”