Using Data-Driven Web Services › Schedule Data Purges

Schedule Data Purges

You schedule how often Data Repository purges all data that is older than the specified retention periods. You can modify the start hour, start minute, and you can modify the start second. By default, the Data Aggregator purges data every day at 2:00:00 AM.

Follow these steps:

1. Enter the following information in a web browser:

   http://hostname:port/rest/globalretentionscheduledefinition
   

   hostname:port

   Specifies the Data Aggregator hostname and the port number where you are accessing the REST web services from.

   The globalretentionscheduledefinition webservice endpoint URL.

2. Take note of the ID that is assigned to the globalretentionscheduledefinition.
3. Look for the elements that have StartMinute, StartHour, and StartSecond. Use this information to determine whether you want to modify the start hour, start minute, or start second when old data is purged.
4. Open a REST client editor or HTTP tool that sends requests and gets responses and set the Content-type to application/xml.
5. Enter the following criteria:
   • URL: http://hostname:port/rest/globalretentionscheduledefinition/ID

     ID

     Is a unique identification number that is assigned to the globalretentionscheduledefinition.

   • HTTP method = PUT
   • Enter the time values that you want to change in the Body tab of the HTTP Request pane.

     For example:

     <GlobalRetentionScheduleDefinition version="1.0.0">
       <StartMinute>28</StartMinute> 
       <StartHour>17</StartHour> 
       <Enabled>true</Enabled> 
       <Status>Scheduled to run everyday at 17:28:00</Status> 
      </GlobalRetentionScheduleDefinition>
     

     Important! Be sure that there is no white space at the beginning of each of these lines, otherwise the PUT operation fails.

     In this example, the start hour has been changed to 17 and the start minute has been changed to 28.

     Note: To disable the purge job, set <Enabled> to false. To reenable the purge job, set <Enabled> to true.

   Results are returned in the Body tab of the HTTP Response pane.

   For example:

   <GlobalRetentionScheduleDefinitionList>
   <GlobalRetentionScheduleDefinition version="1.0.0">
     <ID>9</ID> 
     <StartMinute>28</StartMinute> 
     <StartHour>17</StartHour> 
     <Enabled>true</Enabled> 
     <JobStatus>Has never run</JobStatus> 
     <Status>Scheduled to run everyday at 17:28:00</Status> 
     <StartSecond>0</StartSecond> 
   <Item version="1.0.0">
     <CreateTime>Thu Dec 15 15:52:20 EST 2011</CreateTime> 
     <Name>Global Retention Schedule Definition</Name> 
     </Item>
     </GlobalRetentionScheduleDefinition>
     </GlobalRetentionScheduleDefinitionList>
   

   In this example, data that is older than the specified retention periods will be purged every day at 17:28:00.