ArchiveOldVersionsJob

View as Markdown

Struct for a job of archiving old versions of documents.

Full name	`MFiles.ArchiveOldVersionsJob`
Proto file	`mfiles/structs.proto`

Fields

Field	Type	Number	Description
`must_be_marked_for_archiving`	`bool`	1	Condition: Document is marked for archiving. False = condition not effective.
`must_be_checked_in_before_utc`	`google.protobuf.Timestamp`	2	If bCheckedInBefore is true, specifies the condition parameter.
`has_must_be_at_least_nversions_older`	`bool`	3	Condition: At least N versions older than the current version. False = condition not effective.
`must_be_at_least_nversions_older`	`int32`	4	If bAtLeastNVersionsOlder is true, specifies the condition parameter.
`has_must_be_at_least_ndays_older`	`bool`	5	Condition: At least N days older than the current version. False = condition not effective.
`must_be_at_least_ndays_older`	`int32`	6	If bAtLeastNDaysOlder is true, specifies the condition parameter.
`must_not_have_version_tag`	`bool`	7	Condition: Has no version tag. False = condition not effective.
`target_file`	`string`	8	Full path to the target file on server.
`impersonation`	`Impersonation`	9	Impersonation information for accessing the archive target files on server.
`options`	`OBJARCHIVINGFLAGS`	10	Bit flags that control the execution of this archiving job. Note: Currently only OBJARCHIVINGFLAG_OVERWRITEEXISTINGFILES, OBJARCHIVINGFLAG_DESTROYAFTERWARDS, and OBJARCHIVINGFLAG_RESETMFA are supported.

Used by methods

IRPCVaultAdmin.ArchiveOldVersions -- Archives old versions of documents that meet the job's conditions into an archive file on the server, or previews how many would be archived.

Used in fields

JobDataUnion.archive_old_versions -- Archiving old document versions job.
ArchiveOldVersionsRequest.archivejob -- The conditions that select the old versions, the target file on the server and the archiving options.