Process Definitions for Archiving

Redwood provides the following process definitions for archiving, they are to be used to archive chains and processes which have reached a final state. The process definitions are written in RedwoodScript; you can create your own based on these to combine one or more of the archiving phases.

note

Active Archiving Server requires a specific license key.

Archive_Feeder_Configure

You use this process definition to set up a connection between Redwood Server and the Active Archive.

Parameters

Parameter	Description	Purpose	Direction	Data Type	Default Value
pServer	Server Name	An optional name for the Active Archive for use within Redwood Server	In	String
pServerURL	Server URL	The URL to the Active Archive, for example http://archive.example.com:50200/archive-server	In	String
pCatalog	Catalog	The catalog you intend to use for archiving chains and processes, the default value is default when you install the Active Archive	In	String
pRootDirectory	Folder	The Folder to store the chains and processes inside the Active Archive catalog	In	String
pUsername	Username	A username with sufficient privileges to publish in Active Archive	In	String
pPassword	Password	The password to the above user, it will be saved in encrypted form in a credential inside Redwood Server	In	String
pArchivedJobName	The default name for an archived job. The length of the evaluated string is limited to 255 characters and will be truncated to 255 characters if necessary.	In	String	${JobDefinition} (${JobId})
pArchivedJobFileName	The default name for an archived job file.	In	String	${JobDefinition} (${JobId}) ${JobFile.Name}
pAllowDeleteUnarchived	Allow unarchived chains and processes to be deleted?	If you set this to No, you will not be able to delete chains and processes that have not been archived, yet.	In	String	False

Archive_Feeder_Delete

You use this process definition to remove archived chains and processes, which have been verified as been archived, from Redwood Server.

Parameters

Parameter	Description	Purpose	Direction	Data Type	Default Value
pServer	Server Name	An optional name for the Active Archive for use within Redwood Server	In	String	False
pTestMode	Test Mode?	Do you want to perform a test run before actually deleting chains and processes?	In	String	False
pStartDate	Starting	Restrict the list of chains and processes to ones for which the deletion date is on or after this date	In	Date Time Zone	False
pEndDate	Ending	Restrict the list of chains and processes to ones for which the deletion date is on or before this date	In	Date Time Zone	False

Archive_Feeder_JobList

This process definition is used by Archive_Feeder_Process to do the actual archiving. The parameters are filled by Archive_Feeder_Process, you should not submit this job.

Archive_Feeder_Mark_DateStatus

This process definition allows you to mark chains and processes based on the deletion date and final status.

Parameters

Parameter	Description	Purpose	Direction	Data Type	Default Value
pServer	Server Name	An optional name for the Active Archive for use within Redwood Server	In	String	False
pOverwrite	Overwrite?	Do you wish to overwrite the archive status of the chains and processes?	In	String	False
pRecursive	Recursive	Do you want to include child chains and processes in the archive process?	In	String	False
pDeletionDate	Deletion Date	The deletion date of the chains and processes to mark	In	Date Time Zone	False
pStartDate	Starting	Restrict the list of chains and processes to ones for which the deletion date is on or after this date	In	Date Time Zone	False
pEndDate	Ending	Restrict the list of chains and processes to ones for which the deletion date is on or before this date	In	Date Time Zone	False
pStatus	Status	Include chains and processes of this status	In	String	False

Archive_Feeder_Mark_Filter

This process definition allows you to mark chains and processes for archiving based on a chain filter; only chains and processes in a final state can be marked for archiving.

This process definition has a number of parameters that are identical the corresponding parameters of Archive_Feeder_Mark_DateStatus.

Parameters

Parameter	Description	Purpose	Direction	Data Type	Default Value
pJobFilter	Filter	The chain filter to use for marking the chains and processes; note that only chains and processes in a final state can be marked	In	String	False

Archive_Feeder_Mark_SQL

This process definition allows you to specify an SQL query to select all chains and processes that you wish mark for archiving.

This process definition has a number of parameters that are identical the corresponding parameters of Archive_Feeder_Mark_DateStatus.

Parameters

Parameter	Description	Purpose	Direction	Data Type	Default Value
pSQL	SQL	In	String	False

Archive_Feeder_Process

This process definition is used to perform the archival of chains and processes. It calls Archive_Feeder_JobList to perform the actual archiving.

Parameter	Description	Purpose	Direction	Data Type	Default Value
pArchiveTemp	Archive Temporary Directory on Redwood Server	In	String	False
pBatchSize	Batch Size	How many chains and processes do you want to archive in one batch? When you want to archive a great number of chains and processes, you might wish to split them up in batches. The optimal number of chains and processes per batch is very system-dependent and it depends on the performance of the central Redwood Server, the network, and the Active Archive.	In	Number	False
pQueue	Fallback Queue	The fallback queue to use if no queue has been specified	In	String	False
pUpdateInterval	Update Interval	How often to update the JobList's status, default is every 10 chains and processes.	In	Number	False
pSucceeded	Succeeded	The number of successfully archived chains and processes	Out	Number	False
pFailed	Failed	the number of chains and processes that could not be archived	Out	Number	False
pIgnored	Ignored	The number of chains and processes that were ignored, for example, because they did not have a final status	Out	Number	False

Archive_Feeder_Verify

This process definition verifies whether the chains and processes have been archived successfully.

See Also

• Configuring Redwood Server for Archiving
• Archiving Chains and Processes