Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
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:
property
varchar
Yes
The identifier for a specific application property.
propertyValue
varchar
Yes
The value associated with a specific application property.
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:
id
integer
Yes
Unique identifier assigned to this record.
configFileClassification
varchar
Yes
The name of the configuration stored.
product
varchar
Yes
The CapStorm product associated with the configuration file, i.e. CopyStorm, CopyStorm/Medic
fileFormat
varchar
Yes
The file extension for the configuration file.
configFileName
varchar
Yes
The type of configuration file that is being described.
currentVersionId
integer
No
The most up to date version of the configuration file. This id maps to the ConfigurationFileVersion table.
isDeleted
boolean
Yes
True if the application considers the configuration file as deleted, otherwise false.
createdDate
datetime
Yes
The date and time when the record was created.
modifiedDate
datetime
Yes
The date and time when the record was last modified.
lastModifiedBy
varchar
Yes
The user who last modified the record.
createdBy
varchar
Yes
The user who created the record.
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:
id
integer
Yes
Unique identifier assigned to the record by the application.
configFileId
integer
Yes
The unique id of the configuration file in the ConfigurationFile table.
configFileVersion
varchar
Yes
The version of the record. Multiple versions of a configuration file can be stored.
contents
varchar
Yes
The actual file body of the configuration file.
notes
varchar
No
Optional notes associated with the configuration file.
isDeleted
boolean
Yes
True if the configuration file version is considered deleted, otherwise false.
createdDate
datetime
Yes
The date and time when the record was created.
modifiedDate
datetime
Yes
The date and time when the record was last modified.
lastModifiedBy
varchar
Yes
The user who last modified the record.
createdBy
varchar
Yes
The user who created the record.
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:
id
integer
Yes
Unique identifier assigned to the task log chunk.
taskLogId
integer
Yes
The unique id of the CopyStormTaskLog which has chunked its log file.
sequenceNum
integer
Yes
The chunk’s position for a given log entry in the database.
logFile
varchar
No
The contents of the log file chunk.
createdDate
datetime
Yes
The date and time when the record was created.
lastModifiedDate
datetime
Yes
The date and time when the record was last modified.
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:
id
integer
Yes
Unique identifier for the record.
group_name
varchar
Yes
The name of the group.
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:
name
varchar
Yes
The name of the object associated with the counter.
value
integer
Yes
The current counter utilized for the next job.
The CopyStormGlobalConfig table contains information required to launch CopyStorm and CopyStorm/Medic tasks.
The following table describes each field in the CopyStormGlobalConfig table:
version
varchar
Yes
Used by CopyStorm/Director to determine the version of the database schema installed.
configDir
varchar
Yes
The name of a directory containing CopyStorm and CopyStorm/Medic configuration files accessible to CopyStorm/Director.
copyStormDir
varchar
Yes
The name of a directory which contains a CopyStorm installation.
copyStormMedicDir
varchar
Yes
The name of a directory which contains a CopyStorm/Medic installation.
defaultCopyStormConfig
varchar
Yes
The name of the CopyStorm configuration to use by default.
defaultCSMedicConfig
varchar
Yes
The name of the CopyStorm/Medic configuration to use by default.
defaultDatabaseType
varchar
Yes
The type of CopyStorm database to use by default (e.g. sqlserver).
The CopyStormTaskFamily table is used to register names used to group CopyStormTask records.
The following table describes each field in the CopyStormTaskFamily table:
jobtype
varchar
Yes
The type of job, i.e. CopyStorm, CopyStormMedic
familyname
varchar
Yes
The name of the family associated with the job type.
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:
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:
The kind of task to run. Supported values include:
CopyStorm
CopyStormMedic
family
varchar
Yes
The high-level group name for this task. The default value for this field is “Default”.
configProfile
varchar
Yes
The name of the configuration file used to run this task. It must be a CopyStorm or CopyStorm/Medic configuration file.
maxRunTimeMinutes
integer
No
If specified, this task will be forcibly killed if it runs for longer than this many minutes.
scheduledMinute
varchar
No
A list of minutes at which the task should run. There must be a value in this column for a task to be considered by CopyStorm/JobRunner.
scheduledHour
varchar
No
A list of hours at which the task should run. If this value is blank, the task will run every hour.
scheduledDay
varchar
No
A list of days when the task should run. If this value is blank, the task will run every day.
optionArgs
varchar
No
Indicates which CopyStorm/Medic operation should be performed. This column is ignored for CopyStorm tasks.
jvmArgs
varchar
No
Adds Java JVM arguments to the Java instance running the task. The most common use of this parameter is to increase Java’s maximum memory.
nextRunTime
datetime
No
Computed by CopyStorm/JobRunner and contains the next time the task is scheduled to run.
createdDate
datetime
Yes
The date on which this task was created.
lastModifiedDate
datetime
Yes
The date on which this task was last modified.
id
integer
Yes
A unique integer id assigned to the task by CopyStorm/Director.
jobId
integer
Yes
The unique id of the CopyStormJob which owns this task.
jobType
varchar
Yes
id
integer
Yes
Unique identifier assigned to the job by CopyStorm/Director. This value may be used to refer to the job using the CopyStorm/JobRunner application.
name
varchar
Yes
Unique, human-readable name assigned by a user to this job.
sfInstanceType
varchar
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.
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:
Yes
Indicates whether the target Salesforce is a Production, Sandbox, or DatabaseDotCom instance.
sfUsername
varchar
No
An optional username that will be used to login to Salesforce.
sfPassword
varchar
No
An optional password that will be used to login to Salesforce.
sfLoginHost
varchar
No
Used to override the Salesforce host used to process login requests.
dbType
varchar
Yes
The target CopyStorm database type.
dbUsername
varchar
No
An optional username that will be used to login to the CopyStorm database.
dbPassword
varchar
No
An optional password that will be used to login to the CopyStorm database.
dbConnectionString
varchar
No
An optional JDBC connection string that will be used to connect to the CopyStorm database.
active
char
Yes
Indicates if tasks defined for the job should be considered for execution. Possible values are “Y” and “N”.
deleted
char
Yes
Indicates if the user has deleted the job from CopyStorm/Director. Possible values are “Y” and “N”. Jobs in this state can be undeleted.
description
varchar
No
A block of text describing the purpose of the job.
createdDate
datetime
Yes
The date on which the job was created.
lastModifiedDate
datetime
Yes
The date on which the job was last modified.
username
varchar
Yes
The name of the user with a property.
property
varchar
Yes
The name of the property associated with a user.
propertyvalue
varchar
No
The value of the property associated with a user.
createddate
datetime
Yes
The date and time when the property was created.
lastmodifieddate
datetime
Yes
The date and time when the property was last modified.
group_id
integer
Yes
The unique identifier for the group associated with an authority.
authority
varchar
Yes
The permission associated with a specific group.
COPYSTORM_INVOKE
Launch CopyStorm application permission.
COPYSTORM_CONFIGURE
Update CopyStorm configuration file permission.
RESTORE_RUN
Execute CopyStorm/Restore processes permission.
RESTORE_INVOKE
Launch CopyStorm/Restore application permission.
RESTORE_CONFIGURE
Update CopyStorm/Restore configuration file permission.
RESTORE_DEPLOY_METADATA
Deploy metadata in CopyStorm/Restore permission.
MEDIC_RUN
Execute CopyStorm/Medic tool permission.
MEDIC_INVOKE
Launch CopyStorm/Medic application permission.
MEDIC_CONFIGURE
Update CopyStorm/Medic configuration file permission.
DIRECTOR_RUN
Execute CopyStorm/Director actions permission.
DIRECTOR_CONFIGURE
Update CopyStorm/Director configuration permission.
DIRECTOR_USER_ADMIN
Ability to navigate to the “Access Control” tab in CopyStorm/Director
ODATA_VIEW_DATA
Access to the Data Viewer permission.
DATABASE_MANAGEMENT
Access to the “Database Management” tab permission.
SALESFORCE_CREDENTIAL_CONFIGURE
Access to the “Salesforce Credentials” tab permission.
DATABASE_CREDENTIAL_CONFIGURE
Access to the “Database Credentials” tab permission.
QUICKSTART_WIZARD_CONFIGURE
Ability configure best practice wizards (Quick Start, Snowpark Setup, etc.)
ODATA_VIEW_DATA_PROD
Access to the Data Viewer to view production data.
RESTORE_PROD
Ability to restore data in CopyStorm/Restore to a production Salesforce instance.
MEDIC_PROD
Ability to execute CopyStorm/Medic tools against a production Salesforce instance.
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:
name
varchar
Yes
A unique name for the record describing the database.
databaseName
varchar
Yes
The name of the database in the database server.
description
varchar
Yes
A description of the database configured.
preventDeletion
boolean
Yes
True if the database can be deleted by the application, otherwise false.
databaseType
varchar
Yes
The type of database being used. Acceptable values include: ‘PostgreSQL’, ‘Oracle’, ‘MySQL’, ‘SQLServer’
databaseUsage
varchar
Yes
How the database is utilized, i.e. CopyStorm, Tracker
connectionModel
varchar
Yes
The XML formatted connection information for the target database.
iscustom
boolean
Yes
True if the database was created outside of the application, otherwise false.
createdDate
datetime
Yes
The date and time when the record was created in the database.
modifiedDate
datetime
Yes
The date and time when the record was last modified in the database.
lastModifiedBy
varchar
Yes
The user who last modified the record in the database.
createdBy
varchar
Yes
The user who created the record in the database.
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:
id
integer
Yes
Unique identifier assigned to the wizard configuration by the application.
name
varchar
Yes
A human-readable name assigned by a user to this configuration.
type
varchar
Yes
The type of wizard configuration that is stored in the record.
config
varchar
Yes
The actual configuration information in JSON format. The information stored here is dependent on the ‘type’
createdDate
datetime
No
The date and time when the configuration was first created.
createdBy
varchar
No
The user who created the configuration.
lastModifiedDate
datetime
No
The date and time when the configuration was last modified.
lastModifiedBy
varchar
No
The user who last modified the configuration.
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:
id
integer
Yes
Unique identifier assigned to this record by CopyStorm/Director.
taskId
integer
Yes
The unique id of the CopyStormTask to which this log applies.
jobId
integer
Yes
The unique id of the CopyStormJob which owns this log.
jobType
varchar
Yes
The kind of task which ran. Supported values include:
CopyStorm
CopyStormMedic
startTime
datetime
Yes
The datetime at which this task was started.
endTime
datetime
No
The datetime at which this task ended. If this value is null then the task is still running.
processId
integer
No
The system process id of the task. CopyStorm/JobRunner uses this value to detect processes that have died without notification when a system is rebooted or the CopyStorm/JobRunner is terminated manually.
errorFree
char
No
Indicates if the task was without errors (Y), failed (N), or is still running (null).
logFile
clob
No
All stderr and stdout messages generated by the task.
createdDate
datetime
Yes
The date on which this log record was created.
lastModifiedDate
datetime
Yes
The date on which this log record was last modified.
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:
id
integer
Yes
A unique identifier for the record.
username
varchar
Yes
The name of a user for group assignment.
group_id
integer
Yes
The id of the group for user assignment.
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:
id
integer
Yes
A unique identifier for the table entry.
action
varchar
Yes
The action taken for a configuration file i.e. AddConfigFile, ModifyConfigFile.
actionObject
varchar
No
A JSON-formatted string defining the configuration file with action.
actionDetails
varchar
No
Human-readable string defining the action taken place.
databaseUser
varchar
No
The database user who performed the action.
osUser
varchar
No
The operating system user who defined the action.
osHostname
varchar
No
The host name of the operating system where the action was performed.
osIpAddress
varchar
No
The IP address of the operating system where the action was performed.
fingerprint
varchar
No
A unique identifier describing the user and environment where the action was performed.
createdDate
datetime
Yes
The date and time when the record was created.
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:
name
varchar
Yes
A unique identifier to describe the stored credentials.
connectionType
varchar
Yes
The type of connection associated with the credentials, i.e. Salesforce, Database
credentialType
varchar
Yes
The type of credentials that are stored, i.e, OAuth, Username and Password
loginHost
varchar
No
An optional host endpoint utilized by the credentials for Salesforce connections.
credentials
clob
Yes
The actual credentials being stored. Format of this field is dependent on the connectionType and credentialType.
isactive
boolean
Yes
True if the credentials can be utilized, otherwise false.
createdDate
datetime
Yes
The date and time when the record was created.
modifiedDate
datetime
Yes
The date and time when the record was last modified.
lastModifiedBy
varchar
Yes
The user who last modified the record.
createdBy
varchar
Yes
The user who created the record.
username
varchar
Yes
The name of the user.
password
varchar
No
The hashed password for the user for login.
enabled
boolean
Yes
True if the user can log in, otherwise false.
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:
Stores credential information for Salesforce and databases. Passwords are encrypted.
Defines the relationship between application users and permissions assigned.
Contains configuration information for the application.
Metadata and connection information for CopyStorm and tracker databases.
Best practice wizard state and information for creating CopyStorm jobs.
Metadata about configuration files used by CapStorm products.
Information on who made configuration file changes and when.
Individual versions of saved configuration files.
Login credentials for Salesforce instances and their corresponding backup databases.
Information about where to find CopyStorm and CopyStorm/Medic installations. This table also contains the location of CopyStorm configuration files.
Supports a database-independent approach for generating integer sequence values.
A description and schedule for each CopyStorm or CopyStorm/Medic task contained within a parent CopyStormJob record.
Registered names used to group CopyStormTask records.
Status and Log file for a single run of a CopyStormTask. This table can be used to determine which tasks have run, which tasks are running, and which tasks are orphaned.
Segmented job log file information for efficient storage.
Defines authorities assigned to specific groups.
Links individual users to specific groups in the system.
Stores distinct groups within the system.
Stores custom properties associated with individual users.
Stores authentication details for system users.