Overview
The Lyftron Provider for PayRun offers the most natural way to access PayRun data from Lyftron with ease and also enables to connect with BI, MDM & ML tools, Data warehouses, Databases and other SAAS based applications with zero code and zero infrastructure requirements. The provider wraps the complexity of accessing PayRun data into easy-to-integrate relational fully managed ANSI Sql format. Make faster and better business decisions with Lyftron’s PayRun data provider and automatically build your data migration pipelines in minutes, not months
The provider hides the complexity of accessing data and provides additional powerful security features, smart caching, batching, socket management, and more.
Key Features
- Comprehensive Delta load mechanism.
- Real-time access to PayRun.
- Comprehensive full support of ANSI Sql to query data with ease.
- Collaborative query processing.
Prerequisites
The user must have credentials for PayRun, Lyftron and your destination data warehouse, lake or database to perform the data pipeline operation with Lyftron
Establishing a Connection with Lyftron's Quickstart Steps
Create your PayRun connection with Lyftron by following the 5 easy steps show below:
Step1. Add your connection
Click on Connect section on the left panel → Click on Add Connection button
Step2. Select your connector
In the connector selection panel, search and click PayRun for your connection
Step3. Enter your connection details
In the Connection String section enter the values of the below parameters. The following connection string is required to establish PayRun connection with Lyftron.
Profile=C:\profiles\PayRun.apip;OAuthClientId=my_oauthclientid;OAuthClientSecret=my_oauthclientsecret;ProfileSettings='EmployerId=ER001';| Key | Value | Field |
| Connection Name | Enter your connection details | Required |
| Profile | C:\profiles\PayRun.apip | Required |
| OAuthClientId | your PayRun oauthclientid | Required |
| OAuthClientSecret | your PayRun oauthclientsecret | Required |
| EmployerId | your PayRun ER001 | Required |
| Logfile** | Use the logfile option to debug your job and provide your connection name to generate the log file. [ConnectionConfigurationPath]\Connection_name_log.tx | Optional |
| Verbosity** | Choose verbosity 1-5 based on the severity of debugging | Optional |
** For more information, check the Lyftron logging and debugging section.
If you want more detailed information about how to establish a connection with Lyftron, click on Lyftron Connection Quick Start guide.
Step4. Test your connection
Once you are done entering your connection details, simply click on the Test Connection button to test the connectivity. In case your connection fails, add Logfile and Verbosity parameters and check the Lyftron logging and debugging section, to debug the error.
Step5. Save your connection
Hurray! Now you have successfully connected with the Lyftron PayRun connector and can utilize the connector to Extract, Warehouse, Analyze, Visualize and Share your data.
Data Model
The provider models the data in APIs into a list of tables that can be queried using standard SQL statements.
Generally, querying APIs tables is the same as querying a table in a relational database. Sometimes there are special cases, for example, including a certain column in the WHERE clause might be required to get data for certain columns in the table. This is typically needed for situations where a separate request must be made for each row to get certain columns.
| Name | Type | Description |
| ActivePayInstructionsReport | Tables | Runs the active pay instructions report |
| AOELiabilityReport | Tables | Runs the AOE liability report |
| BatchJobInfo | Tables | Get the Batch job information |
| BatchJobProgress | Tables | Get the Batch job progress |
| BatchJobs | Tables | Get all Batch jobs |
| BatchJobStatus | Tables | Get the Batch job status |
| CISInstruction | Tables | Get CIS instructions with tag |
| CISInstructions | Tables | Get CIS instructions from sub contractor. |
| CISInstructionTag | Tables | Get CIS instruction tag |
| CISInstructionTags | Tables | Get all tags from the CIS instruction |
| CISJobInfo | Tables | Get the CIS job information |
| CISJobProgress | Tables | Get the CIS job progress |
| CISJobs | Tables | Get all CIS jobs |
| CISJobStatus | Tables | Get the CIS job status |
| CISLine | Tables | Get CIS lines with tag |
| CISLines | Tables | Get CIS lines from sub contractor. |
| CISLineTag | Tables | Get CIS line tag |
| CISLineTags | Tables | Get all tags from the CIS line |
| CISLineType | Tables | Get CIS line types with tag |
| CISLineTypes | Tables | Get CIS line types from employer. |
| CISLineTypeTag | Tables | Get CIS line type tag |
| CISLineTypeTags | Tables | Get all tags from the CIS line type |
| CISTransaction | Tables | Get the CIS transaction |
| CISTransactions | Tables | Get all CIS transactions for the employer |
| DataTypeSchema | Tables | Get XSD schema |
| DataTypeTemplate | Tables | Get the object template |
| DPSJobInfo | Tables | Get the DPS job information |
| DPSJobProgress | Tables | Get the DPS job progress |
| DPSJobs | Tables | Get all DPS jobs |
| DPSJobStatus | Tables | Get the DPS job status |
| DpsMessage | Tables | Gets the DPS message |
| DPSMessages | Tables | Gets the DPS messages |
| DPSMessagesReport | Tables | Runs the DPS message report |
| Employee | Tables | Get employee from employer |
| EmployeeAEAssessment | Tables | Get the auto enrolment assessment |
| EmployeeAEAssessments | Tables | Get the auto enrolment assessments |
| EmployeeCommentaries | Tables | Get links to all commentaries for the specified employee |
| EmployeeCommentary | Tables | Get commentary from employee |
| EmployeeRevision | Tables | Gets the employee by revision number |
| EmployeeRevisions | Tables | Get all employee revisions |
| EmployeeRevisionTag | Tables | Get employee revision tag |
| EmployeeRevisionTags | Tables | Get all employee revision tags |
| Employees | Tables | Get employees from employer. |
| EmployeeTag | Tables | Get employee tag |
| EmployeeTags | Tables | Get all employee tags |
| Employer | Tables | Gets the employer |
| EmployerPensions | Tables | Get pensions from employer. |
| EmployerReportLines | Tables | Gets the report lines from the specified employer |
| EmployerRevision | Tables | Gets the employer by revision number |
| EmployerRevisions | Tables | Gets the employer revisions |
| EmployerRevisionTag | Tables | Get employer revision tag |
| EmployerRevisionTags | Tables | Get all employer revision tags |
| Employers | Tables | Gets all employers |
| EmployerTag | Tables | Get employer tag |
| EmployerTags | Tables | Get all employer tags |
| GrossToNetReport | Tables | Runs the gross to net report |
| Healthcheck | Tables | Get health check status |
| HolidayBalanceReport | Tables | Runs the holiday balance report |
| HolidayScheme | Tables | Get holiday schemes with tag |
| HolidaySchemeRevision | Tables | Gets the holiday scheme revision by revision number |
| HolidaySchemeRevisions | Tables | Get all holiday scheme revisions |
| HolidaySchemeRevisionTag | Tables | Get holiday scheme revision tag |
| HolidaySchemeRevisionTags | Tables | Get all holiday scheme revision tags |
| HolidaySchemes | Tables | Get holiday schemes from employer. |
| HolidaySchemeTag | Tables | Get holiday scheme tag |
| HolidaySchemeTags | Tables | Get all tags from the holiday scheme |
| LastPayDateReport | Tables | Runs the last pay date report |
| NetPayReport | Tables | Runs the net pay report |
| NextPayPeriodDatesReport | Tables | Runs the next pay period report |
| NominalCode | Tables | Gets the nominal code |
| NominalCodes | Tables | Gets the nominal codes |
| P11SummaryReport | Tables | Runs the P11 summary report |
| P32NetReport | Tables | Runs the P32 report |
| P32SummaryNetReport | Tables | Runs the P32 summary report |
| P45Report | Tables | Runs the P45 report |
| P60Report | Tables | Runs the P60 report |
| PayCode | Tables | Gets the specified pay code from the employer |
| PayCodeRevisions | Tables | Get all revisions of the Pay Code |
| PayCodes | Tables | Gets the pay codes by nominal code |
| PayCodeTag | Tables | Get pay code tag |
| PayCodeTags | Tables | Get all pay code tags |
| PayDashboardPayslipReport | Tables | Runs the Pay Dashboard payslips report |
| PayInstruction | Tables | Get pay instructions with tag |
| PayInstructions | Tables | Gets the pay instructions from the specified employee |
| PayInstructionTag | Tables | Get pay instruction tag |
| PayInstructionTags | Tables | Get all tags from the pay instruction |
| PayLine | Tables | Get pay lines with tag |
| PayLines | Tables | Gets the pay lines from the specified employee |
| PayLineTag | Tables | Get pay line tag |
| PayLineTags | Tables | Get all tags from the pay line |
| PayRun | Tables | Gets the pay run from the pay schedule |
| PayRunAEAssessments | Tables | Get the auto enrolment assessments |
| PayRunCommentaries | Tables | Get links to all commentaries for the specified pay run |
| PayRunJobInfo | Tables | Get the pay run job information |
| PayRunJobProgress | Tables | Get the pay run job progress |
| PayRunJobs | Tables | Get all PayRun jobs |
| PayRunJobStatus | Tables | Get the pay run job status |
| PayRunReportLines | Tables | Gets the report lines from the specified pay run |
| PayRuns | Tables | Gets the pay runs from the employee |
| PayRunTag | Tables | Get pay run tag |
| PayRunTags | Tables | Get all pay run tags |
| PaySchedule | Tables | Gets the specified pay schedule from the employer |
| PaySchedules | Tables | Gets the pay schedule from the specified employer |
| PayScheduleTag | Tables | Get pay schedule tag |
| PayScheduleTags | Tables | Get all pay schedule tags |
| Payslip3Report | Tables | Runs the verbose payslip report |
| Pension | Tables | Get pension from employer |
| PensionLiabilityReport | Tables | Runs the pension liability report |
| PensionRevision | Tables | Gets the pension by revision number |
| PensionRevisions | Tables | Get all pension revisions |
| Report | Tables | Runs the specified report definition |
| ReportDefinition | Tables | Get the report definition |
| ReportDefinitions | Tables | Gets all reports |
| ReportingInstruction | Tables | Gets the specified reporting instruction from the employer |
| ReportingInstructions | Tables | Gets the reporting instructions from the specified employer |
| ReportLine | Tables | Gets the specified report line from the employer |
| RTIJobInfo | Tables | Get the RTI job information |
| RTIJobProgress | Tables | Get the RTI job progress |
| RTIJobs | Tables | Get all RTI jobs |
| RTIJobStatus | Tables | Get the RTI job status |
| RTITransaction | Tables | Get the RTI transaction |
| RTITransactions | Tables | Get all RTI transactions for the employer |
| RTITransactionTag | Tables | Get RTI transaction tag |
| RTITransactionTags | Tables | Get all tags from RTI transaction |
| Schemas | Tables | Get a list of all available schemas |
| SubContractor | Tables | Get sub contractors with tag |
| SubContractorRevision | Tables | Gets the sub contractor by revision number |
| SubContractorRevisions | Tables | Get all sub contractor revisions |
| SubContractorRevisionTag | Tables | Get sub contractor revision tag |
| SubContractors | Tables | Get sub contractors from employer. |
| SubContractorTag | Tables | Get sub contractor tag |
| SubContractorTags | Tables | Get all tags from the sub contractor |
| Templates | Tables | Get a list of all available data object tempaltes |
| TransformDefinition | Tables | Get the transform definition |
| TransformDefinitions | Tables | Gets all transform definitions |
Advanced Settings
To view a detailed advanced settings options, go to PayRun Advanced Settings. Complete list of the parameters you can configure in the connection string can be found by clicking Connection String Parameters.