The W-2 form is what an employer must send to an employee and the Internal Revenue Service (IRS) at the end of the year. The W-2 form reports an employee's annual wages and the amount of taxes withheld from their paycheck.
Before configuring this document in the app, ensure that you have installed all mandatory Oracle legislative patches and have performed all required configurations to generate and view this document on standard Oracle pages.
In the app, this document is viewed in a Document block. The app shows a list of available W-2s together with the actual document for each.
To configure this document, choose a page where you would like the document block to be displayed. The block requires a Person Id context, so choose a page with a {PERSON_ID} object Id. The popular Object Id handler xxas_per_pkg.per_and_primary_asg_ctx includes this. If you don't have a page, you can create a new one. Please see Pages.
Once you have a page, create a Document block using the following block settings:
| Setting | Value |
|---|---|
| Block Type | Document |
| Security Type | Role and Data |
| Object | Applaud HR Person |
| REST Data Source | w2/{PERSON_ID} |
You will need to create at least two grants for employee access:
- Grant against your employee role using a suitable set of Object Ids, such as Applaud HR Person Restricted to Logged On Employee.
- You will also need to create a similar grant for your employee role against the Permission Set Applaud, W2 Reports Permission Set (XXAS_W2_PSET). This Permission Set is used to secure the REST API. You will need to create a grant for this Permission Set using Functional Administrator: Security: Grants. Again, ensure that you select the object Applaud HR Person and use the same Instance Set as you used in step 1.
If you wish to create proxy access for managers or HR professionals, you must repeat the above two grants but use alternative roles and Object Ids / Instance Sets as desired.