The Web Service Integration Dashboard within the Administration Portal provides the ability to configure and monitor transactions via the Web Services Platform. This feature is used for the initial connection and ongoing maintenance associated with the Web Services platform by providing insights into the actual data being returned from the available Web Methods.
Enterprise vs. Administration Portal Dashboards
The Web Services Dashboard will be accessible from two locations within the system: Enterprise Portal and Administration Portal.
If you are currently using the Enterprise Sync Web Services functionality, then the primary screen that should be used will be available under the Setup menu of the Enterprise Portal.
If you are currently using the Account Sync Web Services functionality, then the primary screen that should be used will be available under the Setup menu of each Administration Portal account using the web services functionality.
The “Configuration Tab” houses the basic configuration data necessary to connect to the Web Services Platform. The HR Company ID, External Company ID, Vendor ID, and Web Services Password.
The “Active Sessions Tab” will display any active connections with the Web Services Platform.
The “Audit Tab” will display a history of Web Method calls made through the Web Services Platform, filtered by the selected date. This screen will also provide the ability to execute the Web Method call from within the screen to see the data collections that are being returned by the Web Method.
This screen is especially useful when a caller of the Web Method would like to view the actual data being returned in order to make decisions about mapping, data values, etc… as well as diagnose any issues that might be experienced when integrating other applications. To drill down on a specific Web Method select “Execute” next to the Method.
This Web Service Dashboard will either return All Employees if the GetEmployeesAll method was executed or Employees that had changes made to their record if the GetEmployeesByEffectiveDate method was executed.
To further drill down on a specific employee and the data collections being returned by the web service choose “Select”. A new table will display with the data collections being returned for the specified employee.
The “Error Tab” will display a history of errors that were encountered from within Web Services Platform. This screen will be especially useful when a caller of a Web Method is trying to determine why an operation within the platform is failing.
The “Exclusions Tab” allows you to choose which employees and data elements should be synchronized by the web service. The selected employees and data elements will NOT be returned from the web service.
- The “Employees” Tab allows you to select which employees listed will not be synchronized by the integration web service. This is helpful if you do not wish to sync test employees or employees that you want to manage primary from a third-party application.
- The “Data” tab allows you to choose which data elements are synchronized. The selected data elements will not be returned from the web service. The following items can be selected:
- Direct Deposit
- State Tax
- Federal Tax
The “Reports Tab” allows you to run reports around the Paystub upload process. Both reports are designed to audit paystubs that have been uploaded to HR system.
- Missing Pay Stubs by Pay Date Report – Enter the specified Pay Date in the “Pay Date” field and select either the PDF or Excel icon to run the report. The report will return a list of employees who do not have a pay stub on their employee record for the date entered.
- PDF Paystubs Uploaded by Pay Date – Enter the Date the Pay Stubs Were Uploaded for a particular pay date in the “Pay Date” field and select either the PDF or Excel icon to run the report. The report will return a list of employees who have a pay stub uploaded for the specified date.