Archive Management
Batch job name: Archive Management
Archive: Optional
For more information on this job, see the Job Details in the Administration Console
An operations web console that allows batch jobs to be scheduled, run manually and monitored. The console also provides for viewing and modification of business and user applicable system configuration.: In the console, navigate to System Maintenance > Jobs. In the Job List, click the name of job to open its Job Details screen.
The Archive Management purge job is responsible for the dropping and optional archive of customer
In the context of the Cloud Monetisation Platform, an individual or organisation who has signed an agreement to take goods and services from a service provider. A customer receives a bill associated with one or more subscriptions, and can be a single end user or a large company with many subscriptions assigned to one agreement. transaction data partitions for the PrepaidUsage and PrepaidRatedUsageAllowance tables.
The job creates an InterfaceBatchHeader record for each invocation, and initially sets the stage to Batch and status to In Progress. The job looks for the partitions associated with PrepaidUsage and PrepaidRatedUsageAllowance tables.
The job drops the partitions that have been created prior to or on the calculated purge date. If the archiverequired property is set to yes, a copy of the partition is transferred to the archive directory on the archive server prior to dropping the partition. This copy is stored on the archive server as a CSV
Comma Separated Values. A simple file format used to store tabular data, such as a spreadsheet or database. CSV files can collect the data from tables so that it can be input to another table-oriented application such as a relational database application. file. The archive server hostname, username, password and port are set as properties for the job in the Administration Console.
For each partition that is removed the job creates an InterfaceBatchDetails record as follows:
-
CustomerLevel = Empty
-
CustomerReference = Empty
-
TransactionDescription = e.g.
prepaid usageor
The consumption of services, for example a subscriber using call minutes. partition 12-August-2021 purgedprepaid usage partition 12-August-2021 archiveddepending on whether an archive was requested or not -
Ensures that the
isRetainfield is set totrue.
After all partitions are removed, the job updates the InterfaceBatchHeader record, by setting the status to Complete.
Selection criteria
The job accepts a single parameter - Days to Retain. This represents the number of days worth of data to retain. The job subtracts this parameter from the current date to calculate a purge date. Only data dated on or before the calculated purge date is purged. Partitions are created daily; any partitions with a creation date prior to the calculated purge date are removed. Any transaction data prior to the retention period will be permanently removed.
A value of zero (0) is not allowed as a parameter.
Tables Impacted:
- PrepaidUsage
- PrepaidRatedUsageAllowance
Running the purge job
In the Administration Console, you can create a schedule for the purge job or run it as needed.
To run a job:
- Navigate to Daily Operations > Jobs.
- In the Job List, select the checkbox for the job that you want run.
- Click Run Now.