PYFG - PY961C
PY to AR Interface Controls
The individual lines of the common code (Numeric Values/Codes/Descriptions) may appear in any order. The value in the Codes field identifies the parameter, and values in the Numeric Values and/or Descriptions fields provide the needed parameter controls.
If more than 5 of the options described above need to be used, additional common codes may be defined. The additional common codes have a Code Category of PYFG and a Code Value of PY961C## (where ## is a sequential number starting with 01).
Keyword is the name of the option being defined and must be entered in the Associated Codes field exactly as shown. The values entered in the Numeric Values and/or Descriptions field are then used in defining that keyword.
Code Category: PYFG
Code Value: PY961C
Short Description: DEBUG. Reserved for SBI debug control.
Medium Description: Client Code (e.g., SBI, AEA11, etc.)
Long Description: Client Name
Associated Numeric Values (holds values associated with keywords)
1: [1] through [8]
2: %
3: $ and cents
4: [number of months]
5: Reserved for future use.
Associated Codes (holds keywords)
1: CDH MISC CD. Use this keyword to specify which Misc Code Box (1 through 8 may be specified in the Numeric Value field) of a CDH definition will hold the AR to PY Interface identifying code. The code(s) to look for are specified in the Descriptions field of this parameter. Commas (with no spaces) must separate multiple codes. For instance, if applicable CDHs are to be coded with either ARIX or ARPY, then the Description field will contain ARIX,ARPY. Up to six codes may be specified.
2: RATE. If keyword RATE is used, the value in the Numeric Value field of this parameter is considered a percentage to be calculated against the amount of an applicable CDH to arrive at a fee. If the fee rate is 10% it should be entered as .10000, for example. After the fee amount is calculated, it will be multiplied by the value of CALC MONTHS, described below. RATE and FLAT are mutually exclusive, e.g., only one may be used.
3: FLAT. Use this keyword when the fee is a constant dollar amount. Note that in both cases, whether (fee) RATE or FLAT (fee amount) is used, the actual fee amount will be multiplied by the value of CALC MONTHS, described below, to arrive at the total fee. RATE and FLAT are mutually exclusive, e.g., only one may be used.
4: CALC MONTHS. Use this keyword to indicate the number of months to be calculated. That is, the amount extracted for a particular CDH during the payroll period specified at run-time will be multiplied by the value of CALC MONTHS. The default is one (1). If this parameter is missing, the reporting range is from the period begin date through the period end date and no multiplying or prorating of the amount or fee takes place. If CALC MONTHS has a value greater than one, the following calculation will arrive at the total AR amount for the reporting range: The reporting range extends from the begin date of the reporting period to the last day of the month calculated by adding CALC MONTHS to the begin month of the period. CALC MONTHS can be prorated by the program on an individual basis if an employee has an applicable CDH assignment that ends prior to the end of the reporting range. For instance, if a period is entered at run time that has begin and end dates of 01/01/2005 and 01/31/2005, respectively, and the value of CALC MONTHS is 3, then the reporting range is actually January 1, 2005, through March 31, 2005. If an employee to be reported has an applicable CDH assignment with an end date of 02/28/2005, then, for this employee, the multiplier will be two instead of three. Note that the calculation is done in whole months only, therefore, if the employee’s CDH assignment end date in this example is for any date in February, the multiplier will still be two.
5: FINANCE CODE. Supplies the account, division and bank ID. Up to 8-character value that will be placed in the finance (fee) code field of the AR Set file created by this process.
6: FILE. Used to supply a name for the AR Set file to be created. If this keyword is not defined, no file will be generated. The file name entered in the Descriptions field may be up to 8 characters, but must start with an alpha character. If a specific name is to be supplied, enter that name in the Description field. The name can be up to eight characters long but must start with a letter (A-Z). If the name is to consist of an alpha-character(s) and the period number of the period being processed, use the xxPERIOD format where xx is a one or two-character code (the first character must be alphabetic) and the word PERIOD. The PERIOD portion of the file name will be replaced with the period number. For example, if ARPERIOD is entered in the Description field of this keyword, the file name generated will be AR0601001 when processing payroll period 0601001.
7: BATCH. The name of the set (batch) created. The set name entered in the Descriptions field may be up to 16 characters. If ARPERIOD is entered in the Descriptions field, however, the word PERIOD will be replaced with the last 6 digits of the period number being processed. For instance, if the period being processed is 0601001 the resulting set name will be AR601001.
8: USER DEBUG. Used to specify a particular user in the Descriptions field. Only this user will be able to see debug statements scroll on the terminal when the appropriate debug flag is entered in the Short Description of this common code.
Associated Descriptions (holds values associated with keywords)
1: xxxx,yyyy,zzzz
2: Not required
3: Not required
4: Not required
5: FINANCE CODE
6: FORMTEXT or filename
7: FORMTEXT or batchname
8: BSI
Common Code Overrides
Values for FINANCE CODE, RATE, FLAT, and CALC MONTHS set defaults at a global level. These values may be overridden at the contribution/deduction level by using the Associated Values and Descriptions fields of an applicable Contribution/Deduction definition.
Enter any of the RATE, FLAT, or CALC MONTHS keywords in any one of the 10 Description fields of the CDH definition and the desired value in the corresponding Value field. Note that RATE and FLAT, as described in the common code above, are mutually exclusive.
To override FINANCE CODE, enter this keyword in one of the 10 Description fields of the CDH definition, followed by a space, followed by the finance code to be used.