EO Stub Data Archive/Restore - HRUTEB

You can improve system performance by using the EO Stub Data Archive/Restore utility to archive data in the Employee Online check stub table (hr_eostub). Archiving data reduces the size of the table. You can restore the data later if needed.

Run a backup prior to archiving data. Archive data files should be regularly backed up in case of hardware failure.

Utility Options

Archive data for specific Begin and End dates, a pay period, or a combination of both.
Display the list of archived files along with their archive criteria.
Restore the data back to the hr_eostub table using the criteria used when they were archived.
Launch the archive utility job immediately or schedule it for a later date.

Required Setup

If 20.11 is installed and configured on the system, this should already be set.

The Workflow web server must have the location of the file folder defined where the archived data files will be stored. The file folder must have read, write, and delete permissions for the workflow process (user).

This file folder location is defined in the registry key: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\BITECH\IMAGE under the string value: FileServerRootPath.

The Workflow 7i web server should have the proper web.config with connection string defined.

This web.config file is in a folder defined in the registry key: HKEY_LOCAL_MACHINE\SOFTWARE\Wow6432Node\BITECH\SERVICES under the value: SVC Root Path.

Selection Criteria

Begin Date: Enter the begin date for the records you want to archive. If you use this in combination with a pay period, enter the begin date of the pay period. Otherwise, enter a date from which you want data archived.

End Date: Enter the end date for the records you want to archive. If you use this in combination with a pay period, enter the end date of the pay period. Otherwise, enter a date later than the begin date to determine the range of archived data.

Period as (YYccIII, YY= Year, cc = Pay Cycle and III = Number): Enter a single pay period number to archive.

Display Archive History (No parameter required): Select this option to display the filenames in the storage file folder based on the naming description.

Archive the data (Dates and/or Period required): Select this option to create archive data files for the records that match the selection criteria.

Restore the data (Dates and/or Period required): Select this option to restore the archived data files that match the selection criteria.

Processing Logic for Archiving Data

The process verifies the required setup and validates the user parameters. To archive the data, enter begin and end dates, a pay period, or both dates and a pay period.

Archive the Data

Select this option to create archive data files for the records matching the selection criteria.

Data files are created with the following naming format:

If Pay Period, Begin Date, and End Date is provided: EoStub_P<Pay Period>_D<BeginDate>_D<End Date>_E.xml. For example: EoStub_P1102010_D01152011_D01312011_E.xml
If only Pay Period is provided: EoStub_P<Pay Period>_E.xml. For example: EoStub_P1102010_E.xml

The E at the end of the file name means the file content is encrypted. The encryption key used is client specific. It will be the same client-specific encryption key that BusinessPlus uses for all its encryption.

If TEST and PROD environments have different encryption keys, then the archived file from one environment will not work on another environment.
It is advised to not change the encryption key once the data is encrypted because then the process will not be able to decrypt the data file which was encrypted with the older key.

Display Archive History

Select this option to display the filenames in the storage file folder based on the naming description. Archived data files history displays the details of the criteria (date ranges or pay periods) used for the archive file. Use the same details to restore the data in the table.

You do not need to enter any other criteria when you select this option.

Restore the Data

Select this option to restore the archived data files that match the selection criteria. Use the same criteria from the archive process to restore the data back to the table.

If data was archived using a date range and you enter a wider date range, the process will restore the data from all files that fall within the given date range.
If data was archived using a pay period and date range, enter the same parameters to restore the data from the given file.