Helper pages - Symmetry Docs

Helper Pages allow clients to get up and running with SPF quickly, by offering an out-of-the-box solution that prompts employees to enter in the necessary information themselves in order for SPF to supply the suggested onboarding forms for them to complete. Helper Pages can be accessed directly, or can be prepopulated with SPF Registration JSON data that can be edited by the employee. To access the blank Helper Pages, navigate to the following URLs:

Hosted: https://spf.symmetry.com/spf/get-started?profile=[yourprofilehash]
On-Premise: https://[yourservername]:[yourserverport]/spf/get-started

Employee Unique Identifier for Hosted ClientsSPF Hosted allows clients to pass in a specific value for the unique identifier (uniqueIdentifier) element that is used in the SPF Registration JSON generated by the Helper Pages. To pass in a specific uniqueIdentifier, clients need to generate the value within their own system and direct to employee to the Helper Pages using the following URL format:https://spf.symmetry.com/spf/get-started?profile=[yourprofilehash]&uniqueIdentifier=[yourdesireduniqueidentifier].If the uniqueIdentifier is not set by the client, the Helper Page will generate its own generic uniqueIdentifier as it is a required element.

There are three sections within Helper Pages (across 4 pages) that guide an employee through the process of entering the pertinent information needed for generating SPF Registration JSON. Below are the four pages and information collected. Personal Information: Employee Information The Personal Information collected from employees is split between two pages: Employee Information and Resident Address. The Employee Information page is where employees enter their personal information needed on certain forms. Below are the input fields.

Element	Type and Enforcement	Description
First Name	Required.	Employee’s first name. Used to populate withholding forms.
Middle Initial	Optional.	Employee’s middle initial. Used to populate withholding forms.
Last Name	Required.	Employee’s last name. Used to populate withholding forms.
Social Security Number	Required.	Employee’s social security number. Used to populate withholding forms.
Primary Country of Residence	Optional.	Employee’s country of residence. Value defaults to the United States.

Personal Information: Resident Address The Personal Information collected from employees is split between two pages: Employee Information and Resident Address. The Resident Address page is where employees enter their physical resident address, which is used by SPF to determine which withholding forms to display. Below are the input fields.

Element	Type and Enforcement	Description
Street Address 1	Required.	Civic number and street name of employee’s physical home address.
Street Address 2	Optional.	Apartment, floor, unit number, or other address designation that is part of the employee’s physical home address.
City	Required.	City of the employee’s physical resident address.
State	Required.	State of the employee’s physical resident address.
ZIP Code	Required.	ZIP code of the employee’s physical resident address

Work Address Information The Work Address Information section is where the employee will enter their physical work address. Below are the input fields.

Unknown Work LocationIn certain situations, an employer or employee may not know the Work Address at the time an employee is to complete their forms. The "presentation.helperPagesAllowResidentAddrCopy" setting allows the Resident Address to be copied and used as the Work Address if no work address was supplied. Symmetry does not recommend using this setting, but it is available. Best practice is to use the actual physical address at which the employee will be performing work as this determines which forms are needed to be completed to remain compliant.

Element	Type and Enforcement	Description
Street Address 1	Required.	Civic number and street name of employee’s physical work address.
Street Address 2	Optional.	Suite, floor, unit number, or other address designation that is part of the employee’s physical work address.
City	Required.	City of the employee’s physical work address.
State	Required.	State of the employee’s physical work address.
ZIP Code	Required.	ZIP code of the employee’s physical work address

Review Information The Review Information page is where the employee will review the data that they have submitted for completeness and accuracy. If any changes need to be made, the employee can go back and edit the information before proceeding to the withholding forms process.

Preview Helper Pages Using Settings BuilderClients can also access Helper Pages within Settings Builder, a tool used for testing. Read more about how to access Helper Pages within Settings Builder here.