This manual assumes that:

• You're already using a PayGlobal database.
• You use multiple versions and databases in one Hr.ini file, which is the recommended setup.
• You have a supervisor user profile and you can run the entire PayGlobal upgrade procedure.
• You're a member of the sysadmin fixed server role, with security permissions to restore an SQL database.

If you upgrade your live database and your data has integrity errors, then you might not be able to process a pay successfully until these errors are corrected.

When you run IntegrityChecker.exe, the application requires other files to be present. If these files are missing or are an incorrect version, then the application will not start, and an error message appears.

You use the Integrity Checker in the following situations:

Validating your database in preparation for upgrade

The Integrity Checker requires an Hr.ini file. If Integrity Checker cannot find the Hr.ini, then it will not start, and an error message will appear. During the Integrity Checker procedure, you can select a database to check from the list of company databases in the Hr.ini file.

If your Hr.ini is not in the same folder as the Integrity Checker, then you can specify the location of Hr.ini using the command line (such as, IntegrityChecker.exe C:\Temp\Hr.ini). Alternatively, you can copy your Hr.ini temporarily into the same folder as IntegrityChecker.exe while you run the Integrity Checker, and then delete the copied file when the process is complete.

Validating your database in preparation for using Self-Service

The Self-Service Integrity Checker does not require an Hr.ini file because Self-Service automatically uses the database specified in Config Editor. See Run Integrity Checker for Self-Service.

You should run the Integrity Checker on your database before you upgrade. When you installed PayGlobal, the Integrity Checker was copied to the same folder as Hr.exe.

1. Back up the database that you want to check.
   You should always take a backup of your database before you run any major database processes.
2. Navigate to the Integrity Checker folder.
3. Double-click IntegrityChecker.exe.
   The Select a PayGlobal database page appears.

4. Select the required database from the Choose a company database combo list, which displays all companies in the Hr.ini file.

   UI Text Box
   type warning
   If you select a database on an incompatible version, then the following type of message appears. You should not continue because the results may be incorrect, or an error may occur.

5. Click Next.
   The Select the tables page appears.
   You should select all tables and all rules to ensure that all of your data is checked.
   

6. Ensure that all tables are selected.

7. Click Next. The Select the rules page appears.
   

8. Ensure that all rules are selected. See Integrity Checker Rules.

   UI Text Box
   type warning
   If your database has Effective Rates enabled you MUST tick the Rate overlaps rule.

   The Keys valid rule has options that you can configure in the Options for rule section. The first time that you use this rule, you should use the "LogOnly" option.

   UI Text Box
   type note
   When you have selected a rule that may update your database, the following message appears: "One or more of the rules you have selected may alter your data. It is recommended that you backup your database before continuing. Do you want to continue?" Click Yes to go to the next page. Click No to return to the rules selection page.

9. Click Next. The Begin integrity checking page appears.

10. Click Start.
    A two-stage progress bar and status messages are displayed while the tables are checked by each rule. To cancel the process, you can click the Cancel button, which allows the rule that is currently running to complete before the integrity check is terminated.

    UI Text Box
    type warning
    If you cancel the process, then any changes that have already been made to the database are not rolled back.

    The Displaying database integrity check results page appears, which displays a summarised list of violations.

    To view more information about the integrity check, click the View audit log button. See Integrity Checker Audit log.

    The audit log shows which tables and records have problems, which rules were violated, and the errors that were corrected. The audit log is saved in the selected company's Log folder and has the prefix "Database_Integrity_Check".

11. Click Finish.

    UI Text Box
    type warning
    Make sure to fix any errors that the Integrity Checker finds before you upgrade your database. If the Integrity Checker finds errors that you cannot correct, then contact Customer Support who may need to book a consultant to fix the errors.

You must select the tables that you want to check and the integrity rules to run. Most of the integrity rules are designed to run for every table that you select, but some rules are tied to specific tables and will ignore your table selection. If you configure any rules that will update the database, then a warning message will appear advising you to back up your database.

This rule checks for known pairs of date columns in the database and ensures that these date ranges are consistent; the start date must be less than or equal to the end date, or one or both dates may be null. For example, a pay period date range with Start date = 14/02/2020, End date
= 08/02/2020 is invalid. This rule does not automatically correct errors.

This rule ensures that any values for a field that has been designated as an enumeration (field that has a predefined set of values, such as a combo list) are within a pre-defined set. For example, values for the Rate.FactorOperator field should be Multiply, Divide, Add or Subtract. This rule does not automatically correct errors.

This rule checks whether referential integrity is respected in the database. For example, the AwardCode in the Employee table must refer to an Award record in the Award table. Nulls are an acceptable value. This rule runs for every table that you have selected, but only checks a specific subset of columns that were identified as foreign keys, are of type "string", and are used by the PayGlobal framework. This rule does not automatically correct errors.

This rule checks whether any of the table's key values have leading or trailing white space, and that all keys are uppercase. The check includes the primary key (unique identifier), such as EmployeeCode on the Employee table, and all foreign keys, such as AwardCode on the Employee table.

This rule runs for every table that you have selected, but only checks a specific subset of columns that were identified as unique identifiers or foreign keys, are of type "string", and are used by the PayGlobal framework.

This rule supports a basic correction that you can specify with the Correction Action option:

• LogOnly (default) performs no correction.
• RemoveForeignKeyLeadingAndTrailingSpaces removes any leading and trailing white space from foreign keys, provided the changes can be made safely.

The first time you use this rule, you should use the "LogOnly" option. This option allows you to see any problems with your database so that you can check and correct these problems if required.

Values are modified only when a foreign key is invalid. Unique identifiers cannot be updated in this manner.

To change the CorrectionAction:

1. On the Select the rules to use during integrity checking page, click the Keys valid rule.
2. In the Options for rule section, select CorrectionAction = LogOnly.

This rule checks that core fields are not null, particularly in makeup tables. For example, a record in the CourseCourseResource table that has a null CourseCode would be reported as an error. This rule does not automatically correct errors.

This rule checks that NLX clauses for payroll rules are valid. The check includes employee, qualifying and action clauses.

Clauses are syntactically correct

Check identifies whether the NLX clauses can be recognised before they are run. The clauses must be syntactically correct and all of the function names that are used must be recognised.
Common syntax errors are:

• mismatched parentheses
• mismatched curly parentheses
• missing or extra commas
• mismatched quotes
• misplaced quotes
• incorrect function names.

Parameter lists are correct

The Integrity Checker checks that the parameter list for each function is correct.

The number of parameters must be correct. For example, when you post the award code for the allowance that will be generated (NlxPrArAllwPostAwardCode), there should be only one parameter, which is the award code to use.

The parameters are a list of values (in curly parentheses) and the list contains the correct number of values. For example, when rounding an accumulator to the nearest given value (NlxPrArAccumRndN), one parameter is enclosed in curly parentheses. This parameter should be a list with two values; the first value is the rounding factor and the second value is the index of the accumulator.

The parameters supplied are the correct type. For example, when adding a value to an accumulator (NlxPrArAccumAdd), there is one parameter that is a list of values. The first value in this list is the index of the accumulator that the value will be added to. This value is an integer, such as 1,2,3, which means this value must be:

• The result of a function evaluation that is an integer.
• A string that can be recognised as an integer (‘4’ is a valid string, ‘4.2’ and 'text' are not).

Updating an accumulator from an entity field

Accumulators can be updated from the following entities:

• Pay period
• Internal company
• Master (TransCurrentMaster)
• Employee
• Employee Award
• Employee ACC.

The following example shows a clause that is used to update an accumulator from an entity: NlxPrArAccumFieldPost(‘Salary’), NlxPrArAccumEmField(‘1’)
The following checks are performed:

• The field name exists (including user defined fields).
• The field represents a numerical type. For example, you would not accumulate from the birth date.

Retrieving entity field values

When you apply a qualifying clause, PayGlobal compares the values on the left-hand side against a list of values on the right-hand side. For example, for the oEQ(NlxEmField(‘DaysWorked’),{’0’}) clause, 'DaysWorked' is the field in the Employee table, and '0' is the field value.

The Integrity Checker checks whether the list on the right-hand side is compatible with the left- hand side.

Date type functions are also verified to ensure that they are dates and use one of the following formats: 'YYYYMMDD' or 'YYYY-MM-DD hh:mm:ss.mmm'.

Updating an employee field from an accumulator

The following type of clause updates an employee field from an accumulator: NlxPrArFieldAccumPost(‘Salary’),NlxPrArEmFieldAccum(‘1’)
The following checks are performed on this type of clause:

• The field exists (including user defined fields).
• The field is a numeric type. For example, you would not update the employee birth date from an accumulator.

Updating an employee field to a specified value

The following type of clause updates an employee field to a specified value:

NlxPrArFieldPost(‘Salary’),NlxPrArEmField(‘$10A00’)

The following checks are performed on this type of clause:

• The field exists (including user defined fields).
• The value is appropriate.
• The employee code is never updated.
• Referential integrity is respected. For example, when you update the employee award code, you must use an award code that is in the awards table. This applies to all foreign key entries.

Checking that generated transactions are correct

When constructing a current allowance or a current deduction to be paid, the following checks are performed:

• The associated allowance or deduction exists.
• The award, reason, position and other associations (foreign keys) exist.
• Superannuation fund allowances or deductions are not posted for Superannuation funds that do not exist.
• Superannuation fund field names are one of the following:
  • AllowSalarySAmountCode
  • AllowSalarySPercentCode
  • DeducSalarySAmountCode
  • DeducSalarySPercentCode
  • EmployeeAmountCode
  • EmployeePercentCode
  • EmployerAmountCode
  • EmployerPercentCode
  • OtherMemberAmountCode
  • OtherMemberPercentCode.

Unlike most of the other rules, this rule is run independently of the tables that you select. This rule checks a specific set of NLX tables: PayrollRuleEmployeeClause, PayrollRuleQualifyingClause and PayrollRuleActionClause.

This rule does not automatically correct errors.

If the Check Database Structure command finds errors in your database, you can still use and upgrade PayGlobal.

1. Log in to PayGlobal.
2. In the PayGlobal Tree, navigate to Administration > Maintenance > Check Database Structure.
3. Double-click Check Database Structure. The following message appears:
   

4. Click No to generate a report only.
   PayGlobal checks your database structure, and an audit log Confirm message appears.

5. Click Yes or press Enter to view the audit log.
   If your audit log lists any database structure issues, then check whether they were caused by objects that you added the database. If this is the case, then do not remove your objects, just close the log and continue the upgrade.
   If your audit log contains "Index not found" errors, then run the Standard Reindex command to recreate the indexes (see Help topic 235).
   If your audit log does not list any database structure issues, then close the log and continue the upgrade.

1. Go to the URL specified in the Release email sent to you by PayGlobal and download your tax upgrade version.

2. Extract the PayGlobal zip file to a convenient location on your computer.
   The PayGlobal zip file contains the MSI installation file install instructions, and release notes.

   UI Text Box
   type note
   We recommend saving the MSI installation file in the Versions root folder so you can use the patch tool if required. See file structure in Upgrading PayGlobal.

3. Record the location of the files and the upgrade version number on your upgrade worksheet.
   You will use the contents of this file in the upgrade section.

   UI Text Box
   type note
   If any files are missing or you cannot open them, then please contact MYOB PayGlobal Support.

1. Log on to PayGlobal.

2. In the menu bar, click Help > About.
   
   In this example the current PayGlobal version is 4.31.0.0.

3. Record your current version number on your upgrade worksheet.

4. Click the Details tab.
   This page displays important information about your database.
   

5. Record the Application directory on your upgrade worksheet.

6. Click OK to return to the main PayGlobal window.

1. On the PayGlobal menu bar, click the Pay Status button or press Ctrl+Y.

2. In the Pay Status window, click the PR Seq tab.
   The PR Seq tab shows the status of pay periods that are opened, processed or closed. The following table explains the icons used on the PR Seq tab.

   Icon	Meaning
   	Pay period is open.
   	Pay period is open and processed.
   	Pay period is closed.

3. Click OK to return to the main PayGlobal window.

The backup file will not contain the files in the Perm and Rept folders of your live database. After you create a new test database, you need to copy these files from your live database into the corresponding folders in the test database. See Copy Customised Database Files

1. Navigate to the Administration > Backups > Backup command.
2. Double-click the Backup command.
3. In the Backup window, click the Backup button.

4. Click Close.

   UI Text Box
   type warning
   Repeat this backup procedure for all your live company databases.

1. Navigate to the Administration > Maintenance > Apply Referential Integrity run command.
2. Double-click the Apply Referential Integrity command.
   The Referential Integrity Setup form appears.
   If Referential Integrity is turned ON is displayed on the first line, then you must turn referential integrity off before you upgrade.
   

3. Check that Remove referential integrity from the database is selected.

4. Click OK.
   A progress bar appears followed by an audit log message.

5. Check the log and then press Esc to return to the Referential Integrity Setup form.

6. Press Esc or click Close to return to the main PayGlobal window.

1. Exit PayGlobal by clicking File > Exit, and then clicking Yes in the Confirm box.
2. Exit Microsoft Outlook.
3. Exit all other Windows-based programs.
4. If you use scheduler, then stop the PayGlobal Scheduler Service.
   • Vista: Navigate to Control Panel > System and Maintenance > Administrative Tools > Services. Right-click the PayGlobal Scheduler Service and select Stop.
   • Windows 7 and Windows 8: Navigate to Administrative Tools > Services. Right-click the PayGlobal Scheduler Service and select Stop.