Job Definitions for Archiving
Redwood provides the following Job Definitions for archiving, they are to be used to archive Workflows and processes which have reached a final state. The Job 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 Job 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 Workflows and processes, the default value is default when you install the Active Archive | In | String |
|
| pRootDirectory | Folder | The Folder to store the Workflows 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 Workflows and processes to be deleted? | If you set this to No, you will not be able to delete Workflows and processes that have not been archived, yet. | In | String | False |
Archive_Feeder_Delete
You use this Job Definition to remove archived Workflows 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 Workflows and processes? | In | String | False |
| pStartDate | Starting | Restrict the list of Workflows 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 Workflows and processes to ones for which the deletion date is on or before this date | In | Date Time Zone | False |
Archive_Feeder_JobList
This Job 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 Job Definition allows you to mark Workflows 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 Workflows and processes? | In | String | False |
| pRecursive | Recursive | Do you want to include child Workflows and processes in the archive process? | In | String | False |
| pDeletionDate | Deletion Date | The deletion date of the Workflows and processes to mark | In | Date Time Zone | False |
| pStartDate | Starting | Restrict the list of Workflows 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 Workflows and processes to ones for which the deletion date is on or before this date | In | Date Time Zone | False |
| pStatus | Status | Include Workflows and processes of this status | In | String | False |
Archive_Feeder_Mark_Filter
This Job Definition allows you to mark Workflows and processes for archiving based on a Workflow filter; only Workflows and processes in a final state can be marked for archiving.
This Job 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 Workflow filter to use for marking the Workflows and processes; note that only Workflows and processes in a final state can be marked | In | String | False |
Archive_Feeder_Mark_SQL
This Job Definition allows you to specify an SQL query to select all Workflows and processes that you wish mark for archiving.
This Job 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 Job Definition is used to perform the archival of Workflows 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 Workflows and processes do you want to archive in one batch? When you want to archive a great number of Workflows and processes, you might wish to split them up in batches. The optimal number of Workflows 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 Workflows and processes. | In | Number | False |
| pSucceeded | Succeeded | The number of successfully archived Workflows and processes | Out | Number | False |
| pFailed | Failed | the number of Workflows and processes that could not be archived | Out | Number | False |
| pIgnored | Ignored | The number of Workflows and processes that were ignored, for example, because they did not have a final status | Out | Number | False |
Archive_Feeder_Verify
This Job Definition verifies whether the Workflows and processes have been archived successfully.