View source for PEC-WFM/Current/ETLRef/AutoPurg

{{Article
|Standalone=No
|DisplayName=Purge procedures and parameters
|TocName=Purge procedures and parameters
|Context=Learn how to safely and efficiently purge data in the WFM ETL database.
|ComingSoon=No
|Platform=PureEngage
|Role=Administrator
|Prereq=
|Section={{Section
|sectionHeading=
|anchor=
|alignment=Vertical
|Media=
|image=
|structuredtext=The WFM ETL database script includes the following database-stored procedures used to enable purging of the ETL database:
{{{!}} class="wikitable"
{{!}}-
{{!}}{{!}}'''Procedure'''<br />
{{!}}{{!}}'''Description'''<br />
{{!}}-
{{!}}{{!}}WFM_PURGE_PROC<br />
{{!}}{{!}}The main procedure, used to call all the procedures below, passing a date that is calculated by subtracting a specified number of days from the current date.
<br />This procedure is designed to be executed regularly (daily or more often) as a scheduled task.

Use the following parameters with this procedure:

*<tt>@DAYS_BACK_FOR_DAY</tt>—Purges daily granularity data that is older than the specified number of days from the current day. For example, if this parameter value is<tt>10</tt>, WFM purges data that is older than 10 days prior to today (data for the 10 days prior to today, plus today's data is retained).
*<tt>@DAYS_BACK_FOR_TIMESTEP</tt>—Purges 15-minute granularity data that is older than the specified number of days from the current day. See the example above.
*<tt>@MAX_PURGE_CHUNK</tt>—Specifies the maximum number of records to purge in one pass.
{{!}}-
{{!}}{{!}}WFM_PERF_PURGE_PROC<br />
{{!}}{{!}}Purges performance statistics data older than a given date.
<br />Use the following parameters with this procedure:

*<tt>@PURGE_DATE</tt>—Specifies the purge date. Data older than this date is purged.
*<tt>@MAX_PURGE_CHUNK</tt>—Specifies the maximum number of records to purge in one pass.
{{!}}-
{{!}}{{!}}WFM_SCH_PURGE_PROC<br />
{{!}}{{!}}Purges schedule data older than a given date.
<br />Use the following parameters with this procedure:

*<tt>@PURGE_DATE</tt>—Specifies the purge date. Data older than this date is purged.
*<tt>@MAX_PURGE_CHUNK</tt>—Specifies the maximum number of records to purge in one pass.
{{!}}-
{{!}}{{!}}WFM_ADH_PURGE_PROC<br />
{{!}}{{!}}Purges adherence data older than a given date.
<br />Use the following parameters with this procedure:

*<tt>@PURGE_DATE</tt>—Specifies the purge date. Data older than this date is purged.
*<tt>@MAX_PURGE_CHUNK</tt>—Specifies the maximum number of records to purge in one pass.
{{!}}-
{{!}}{{!}}WFM_CFG_PURGE_PROC<br />
{{!}}{{!}}Purges configuration data (uses no parameters).<br />
{{!}}}
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Specifying the number of records to delete
|anchor=
|alignment=Vertical
|Media=
|image=
|structuredtext=When using the <tt>@MAX_PURGE_CHUNK</tt> parameter in the procedures described in the table above, be sure to carefully weight it to prevent overtaxing the database server if there are already millions of records that need purging. 

Genesys recommends that you limit the number of records to be deleted in one pass to avoid large transactions and allow the database to purge gradually, during subsequent executions of scheduled purging tasks.
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Frequently asked questions
|anchor=FAQ
|alignment=Vertical
|Media=
|image=
|structuredtext={{NoteFormat|The information presented here is provided to help you understand how the WFM ETL database processes data, but if issues arise that need troubleshooting, ask your Genesys Professional Services representative for assistance.|2}}

The information in these FAQs might be useful when you are purging the database:

'''Q:''' Can you suppress or deactivate the data production for the <tt>TIMESTEP</tt> tables?<br />
'''A:''' No, only the complete subsystem (Perf, Sch, Adh) can be disabled.

'''Q:''' When the '''DaysBack''' option is set to a value of <tt>30</tt>, can you purge the <tt>TIMESTEP</tt> tables to a retention time lower than 30 days—using an extreme example, <tt>TRUNCATE TABLE</tt> every night? In this case, would ETL try to recreate the last 30 days of data?<br />
'''A''': Yes, you can purge <tt>TIMESTEP</tt> tables to a retention time lower than the one specified for <tt>DAY</tt> tables. No, ETL would not try to recreate those tables unless there was a change in the main WFM database for those days and data was synchronized back to ETL. When data is synchronized for some date(s), both <tt>TIMESTEP</tt> and <tt>DAY</tt> tables are synchronized simultaneously. 

'''Q:''' Is Genesys planning to develop a feature, now or in future versions, that would improve the handling of the huge <tt>TIMESTEP</tt> tables or provide a way to deactivate them?<br />
'''A:''' Currently, nothing is planned, but we might consider a feature of disabling <tt>TIMESTEP</tt> tables. Please submit a feature request.

'''Q:''' What is the best way to start purging the <tt>TIMESTEP</tt> tables?<br />
'''A:''' Depending on the scenario, you might want to schedule a task that would call a main purging procedure at regular intervals. For example, using these parameters: <tt>WFM_PURGE_PROC</tt> (<tt>730</tt>, <tt>0</tt>, <tt>100000</tt>)—where the values in brackets represent the <tt>@DAYS_BACK_FOR_DAY</tt>, <tt>@DAYS_BACK_FOR_TIMESTEP</tt>, and <tt>@MAX_PURGE_CHUNK</tt> tables, consecutively.
|structuredtextwide=
|FAQHeading=
|Status=No
}}
}}