Remove Test Data

About Remove Test Data.

The Remove Test Data (RTD) job is a preparatory step that allows you to remove the appropriate data prior to your tenant going live.

Requirements for marking application setup items for deletion

Requirements for marking application setup items for deletion.

The following steps describe prerequisites for including application setup items in an RTD job. Perform these steps:

  1. To indicate the prefix that should be used in application setup names, go to System Configuration > System Settings and enter the desired prefix in the global.remove.setup.item.prefix setting. You can then preview the items that will be removed prior to running the RTD job. For more information, go to Setup Preview.
  2. To specify which application setup items should be deleted, enter any 2-3 character word as a prefix to the names of application setup items. When adding a prefix in a setup item name, construct it so it adheres to the criteria described in the global.remove.setup.item.prefix description.

Considerations while a Remove Test Data job is in progress

  • While the Remove Test Data job is in-progress, you cannot access the tenant from the UI or by using APIs. Background processes are also suspended during the Remove Test Data job and will resume upon completion.
  • After you submit a Remove Test Data job request, you can still make changes to the request and perform testing on the tenant up until the operation begins.
  • After a tenant has been moved to a Live state, you cannot run a Remove Test Data job on it.
  • If the Remove Test Data job fails, the tenant is automatically rolled back to its original state.

Data management during Remove Test Data

Reviewing results of RTD job

After the Remove Test Data has completed, you can review whether the appropriate data was removed from the system. Upon completion of the RTD job, the system emails recipients with the following reports attached:

  • Application Setup Blocking Reference Report- Indicates which application setup items were not removed because they are referenced by another setup item. The report includes the following columns:

    Example of entries in report

    • First row — The building block called ZzzDatePattern_Weekly is being referenced by a Leave Type building block called ZzZLeaveTypes.

    • Second row — The building block called ZzzTestCompany1 is being referenced by a Leave Shift Template building block called ZzZLeaveTypes.

    This table contains an example of entries in the Application Blocking Reference Report.

    This table is an example of entries in the Application Blocking Reference Report.

    App Setup Category

    Setup Building Block

    Building Block (Name)

    Referenced By

    Referenced By (Name)

    Status

    Accruals

    Date patterns

    ZzzDatePattern_Weekly

    Leave Types

    ZzZLeaveTypes

    failed

    Business Structure

    Business Structure Location

    ZzZTestcompany1

    Shift Template

    ZZZShift

    failed

    • App Setup Category— Application Setup Category refers to the category under which the application setup item falls. For example, Accruals or Business Structure.

    • Setup Building Block— The type of application setup item that was marked for deletion. For example, Date Patterns or Taking Limits.

    • Building Block (Name)— The specific application setup item that was marked for deletion. For example, AccrualProfile1 or Date2.

    • Referenced By— The building block type of the application setup item that is blocking the item in the Building Block (Name) column.

    • Referenced By (Name)— The name of the application setup item item that is blocking the item in the Building Block (Name) column.

    • Status— Failed indicates that the application setup item was not removed.

  • Remove Test Data Report- Indicates which setup items (domain and specific setup item) were included in the RTD job and a comparison of the number of items present on the system before and after the report has been run.

Run the Remove Test Data job

To remove test data that was generated while the tenant was in Implementation state, perform these steps:

Note: Prior to running Remove Test Data, enter any 2-3 character long word, such as "ZZZ," as a prefix to the names of application setup items that you would like removed before the tenant goes live. To indicate the prefix that should be used in application setup names, go to System Configuration > System Settings and enter the desired prefix in the global.remove.setup.item.prefix setting.
  1. Go to Application Setup > System Configuration > Production Readiness.
  2. Click Remove Test Data.
    Important: You cannot submit an RTD job for deletion of live transactional data. The next step in the RTD process helps to prevent users from accidentally deleting data from a live tenant. If you indicate that the customer's tenant is live, you will not be able to submit an RTD job.
  3. The Remove Test Data Confirmation panel appears. Select one of the following options:
    • Customer is Live (has begun collecting data used to process payroll) — Select Live if the customer's tenant is currently in production. You cannot continue with the RTD job request and a message appears that instructs you to not run the RTD job. To prevent login issues, request a Flag as Live job to remove guardrails.
    • Customer is Implementing (has not yet gone live) — Select Implementation to access the RTD slide-out.
  4. Expand Transactional Data.
    1. The setting for All employee transactional data will be removed is selected by default.
    2. Check Scheduling to preserve certain scheduling transactional data (shifts, availability, patterns and day locks).
    3. Check Workload Planner to delete Workload Planner data. This option appears on systems with the Advanced Scheduling solution only.
  5. Expand Application Setup Data.
    1. Check Select All to indicate that all eligible setup items will be removed.
    2. To indicate that specific types of setup data should be removed, check one or more of the following options:
      • Select All
      • Accruals
      • Pay Policies
      • Business Structures This option appears on systems with the Advanced Scheduling solution only.
      • Display Preferences
      • Advanced Scheduling This option appears on systems with the Advanced Scheduling solution only.
  6. Expand Employees.
    Note: The purpose of this feature is to delete test employees that are used in user-adopted testing. It relies on the value of the ID for that employee as specified on the Person Information page. If you specify an ID (also referred to as personnum), that employee’s record and all their transactions will be deleted.
    • To remove a total of 5 or fewer employee IDs, you can enter the employee IDs in to the text box according to the instructions in the field.
    • To remove a maximum of 100 employee IDs, click Choose File to upload a CSV file which will contain person numbers of employees to be deleted. Browse to select the appropriate .csv file and click Upload. If the personnum is valid, a list of personnums and corresponding names appears. If the personnum is invalid, a warning appears with a list of personnums and corresponding names.
  7. Enter emails of recipients to whom notifications should be sent about the job status.

    Emails are sent to notify users of the following statuses:

    • Submitted
    • In progress
    • Completed
    • Failed
    • Cancelled
    • Tenant rollback failure
    • Maximum Remove Test Data retries to the Tenant Management System
    • Background process failed after Remove Test Data Provisioning is success.
  8. Click Review to review the information you just entered.
  9. Click Submit.
  10. When you create the CSV file, all personnums values in the file must be in the first column. If personnum values appear in another column that is not the first column, the Remove Test Data job will not delete them. For more information, refer to the following example:
    Example of CSV file with personnum values in different columns