James A. Pattie > business-payroll-1.3 > Business::Payroll

Download:
payroll/business-payroll-1.3.tar.gz

Dependencies

Annotate this POD

View/Report Bugs
Module Version: 1.3   Source  

NAME ^

Business::Payroll

SYNOPSIS ^

  use Business::Payroll;
  
  my $file = "payrollIn.xml";
  my $string = "";  # If dynamically created or read from STDIN.

  my $payroll = Business::Payroll->new();
  if ($payroll->error())
  {
    die $payroll->errorMessage();
  }

  my $result = $payroll->process(file => $file, string => $string);
  my $output = $result->generateXML();

  # now you either print it or write to a file.
  print $output;

DESCRIPTION ^

This is the base package for the Business::Payroll Module. It can be used programmatically per the synopsis above or with standalone xml files. There are two perl scripts included with this module to update and process the xml files. The standard procedure would be

  1) Create xml file by hand or use example from this doc as a template.  This is called 'raw' data.
  2) 'cook' the data by running the process_payroll script.  (no arguments will give help output)
  3) For the next pay period you can manually copy and change the previous raw data or run update_payroll
  4) Repeat step 2

NOTE: There are no requirements on file names. We use two directories of input and output files and use dates for file names. You can also put all files in one directory and name them something like input_DATE.xml output_DATE.xml.

Example:

<?xml version="1.0" encoding="ISO-8859-1"?> <payroll type="raw" version="1.0" date="20040713" period="biweekly" genSysId="20040628-20040711"> <person id="1" name="Person A" marital="single"> <country name="US" gross="1362.00" allow="2" withHold="0.00" grossYTD="13166.00" federalYTD="1071.00" method=""> <state name="MO" gross="1362.00" allow="1" withHold="5.00" method=""> </state> </country> </person> <person id="2" name="Person B" marital="single"> <country name="US" gross="541.00" allow="1" withHold="0.00" grossYTD="9899.00" federalYTD="835.00" method=""> <state name="MO" gross="541.00" allow="0" withHold="2.00" method=""> </state> </country> </person> </payroll>

Exported FUNCTIONS ^

scalar new()

        Creates a new instance of the object.
        takes:

bool isValid(void)

        Returns 0 or 1 to indicate if the object is valid.  The error will be available via errorMessage().

Business::Payroll::XML::OutData process(file, string)

  Processes the xml data specified in the file or the string.  If both
  are specified, then the string takes precedence.
  
  Returns an instance of Business::Payroll::XML::OutData which holds 
  the perl data structure and can be turned into XML by calling it's 
  generateXML() method.

NOTE ^

All data fields are accessible by specifying the object and pointing to the data member to be modified on the left-hand side of the assignment. Ex. $obj->variable($newValue); or $value = $obj->variable;

AUTHOR ^

Xperience, Inc. (mailto:admin@pcxperience.com)

SEE ALSO ^

perl(1)

syntax highlighting: