Schema

This topic describes how MOVEit Automation keeps track of histories of task runs and file transfers. MOVEit Automation manages its database automatically, so very few sites will need the information contained in this topic. Both MySQL and Microsoft SQL Server are supported.

MOVEit Automation uses an ODBC-compliant database to store statistics and status information on task runs and file transfers. To configure the database, see MOVEit Automation Config Utility. See also Trimming the database.

The database contains the following tables:

Stats

Stats contains one record for each attempt to send a file.

Field Name	Type	Description
ID	bigint	A record ID which is incremented automatically for each record added to the table. Primary key.
LogStamp	char	Date/time of record
TaskID	int	The ID of the task.
Node	int	The failover node number of the copy of MOVEit Automation that logged this record. This is 0 if failover is not being used.
NominalStart	char	The time when the task started or was scheduled to start. There is a key that consists of TaskID and NominalStart.
Action	char	The action being logged. Values: `get` - logged only if there is an error retrieving a file. Successful gets are not logged; instead, we wait until sending or processing the file before logging it. `send` - logged after trying to send a file. Most statistics records are of this type. `process` - logged after running a script. `delete` - logged if there is an error deleting a file. `internal` - logged if there is an internal error.
SourceHost	char	The source host of the file. This is the "friendly" name configured in MOVEit Automation Admin, not the IP domain name. For process records, the name of the host if per-file, or blank if per-task.
SourceFilename	char	The filename of the source file. On send records, for process-created files, the script-assigned name. For unzipped files, reflects the original file. On process records, the name of the source file if per-file, or blank if per-task.
SourceFilenameOnly	char	The filename of the source file, without the pathname.
SourceFileID	char	The ID of the source file if it originated from MOVEit Transfer. If not, value is empty.
SourceNBytes	double	The number of bytes in the source file. Always 0 for process-created files. For unzipped files, reflects the original file's size.
SourceDuration	double	The number of seconds the download took. Always 0 for process-created files. For unzipped files, reflects the original file's transfer.
DestHost	char	The destination host of the file. This is the "friendly" name, not the IP domain name. For process records, the name of the script.
DestFilename	char	The filename of the destination file. For process records, empty.
DestFilenameOnly	char	The filename of the destination file, without the pathname.
DestFileID	char	The ID of the destination file if it was sent to MOVEit Transfer, else empty.
NBytes	double	Number of bytes transferred. 0 if there is any error. For records of successful sends, always populated, even for process-created files. In case of upload error: 0. For process records: always 0.
DestDuration	double	The number of seconds the upload took. For process records, the time taken by the script. (Note inconsistency with NBytes.) In case of upload error, this is 0, to be consistent with NBytes.
ErrCode	int	An error code, where 0 indicates success.
Message	char	An error message, or other text describing this action. Usually empty if success.
Hash	char	Cryptographic hash of this record and the previous record's hash. This is used to implement tamper detection.

Task Runs

The table TaskRuns contains one record for each run of a task.

Field Name	Type	Description
ID	bigint	A record ID that is incremented automatically for each record added to the table. Primary key.
LogStamp	datetime	Date/time of record
TaskID	int	The ID of the task.
NominalStart	char	The time when the task started or was scheduled to start. TaskID and NominalStart together uniquely identify a record. There is a key that consists of these two fields.
TaskName	char	Name of task.
TimeStarted	char	The date and time the task started.
TimeEnded	char	The date and time the task ended.
StartedBy	char	Who started the task. If a remote logged-in user started the task (via Run Now), this is the username. If a user from localhost started the task, this is `Local`. If the scheduler started the task, this is `Scheduler`.
Success	char	Values: Failure, Success, No xfers. No xfers is logged when no matching files could be found.
FilesSent	int	The number of files successfully sent.
TotalBytesSent	double	The number of bytes successfully sent. This is a double because not all databases support huge integers, and the number may exceed the capacity of a 4-byte integer.
HasBeenRead	int	A flag used by MOVEit Automation Admin to keep track of whether the operator has said "don't show me this task run again". The default value is 0. Value is set to 1 to mean the task should not be shown anymore.
LastErrorType	int	The type of the last error. Values: 0 = no error; 5 = warning; 6 = error; 7 = internal error
LastErrorText	char	The text of the last error, if any.
Hash	char	Cryptographic hash of this record and the previous record's hash. This is used to implement tamper detection.

Task Groups

The table TaskGroups contains the task groups and their members. This table duplicates the information in the configuration file, and is provided only as a convenience for organizations doing custom report generation from the database. The task groups table is updated every time the user edits the task groups with MOVEit Automation Admin.

FieldName	Type	Description
GroupName	char	The name of a task group. There might be several records with the same GroupName, one for each task belonging to this group.
TaskID	int	The ID of a task belonging to this group. A task can belong to several groups, so there might be several records with the same TaskID.

Audit table

The audit table (introduced in MOVEit Automation 4.0) includes one record for each configuration change made by an administrator:

Field Name	Type	Description
ID	bigint	A record ID that is incremented automatically for each record added to the table. Primary key.
LogTime	char	The date/time stamp of when the change was made.
Node	int	The failover node number, or 0 if failover is not being used.
Action	char	The action being performed, such as `cfgsec_update`.
TargetType	char	The type of entity being changed, such as `task`.
TargetID	int	The ID of the entity being changed, such as 239634085.
TargetName	char	The name of the entity being changed, such as `Detroit Monthly Summary`.
CentralVersion	char	The version of MOVEit Automation that was in use, such as `3.5.6.0.`
ClientIP	char	The IP address of the client application that performed the action. This address might be different from the IP address when using the Web Admin Client. Example: `192.168.1.45`
AgentBrand	char	The name of the client program, such as `MOVEit Automation Admin`.
AgentVersion	char	The version of the client program, such as `3.5.6.1`.
Username	char	The username of the user who performed the action, such as `lukey.`
IPAddress	char	The IP address of the user who performed the action, such as `129.168.1.45`.
Error	int	An error code; 0 if no error.
ErrorText	char	An error message, if Error was not 0.
Message	char	Optional details of the change.
Hash	char	Cryptographic hash of this record and the previous record's hash. This is used to implement tamper detection.