Evidence Punch Attestation

• Comment: Configure a comment to which the integration adds evidence punch data. The punches category must be selected during configuration.

  See the Comments topic.

Example: Evidence Punch Data

Paycode: Configure a hidden standard hour paycode that must be used exclusively by the Evidence Punch Import integration. See the Paycode definition topic.

Example: Evidence Punch

Get the URL, User, and Password for the APIGatewayServer.

1. Open the Integration Template Designer: Select Main Menu Administration > Application Setup > Integrations Setup > Design Integration Templates.

   Note: If prompted, enter your Username and Password. Click Tap Log in.

2. Make sure that the Account is correct. If not, select the right account.

3. Select the Deploy tab > Integration Packs.
4. From the list in the left column, search for and select the Pro WFM Evidence Punch Attestation Extension integration.
   Note: If the integration does not display, select Browse Integration Packs to search for and select the iPack.

5. Click Tap Install.

6. From Unattached Environments, select the environment in which to deploy the integration process for the selected integration. Click Tap the double-left arrows button
   
   .

1. Select the environment
   1. Select the Manage tab > Atom Management.
   2. Select your environment.
2. Select environment extensions
   1. In Administration, click tap Environment Extensions.
   2. In Process Filter, click tap the magnifying glass
      
      . It can take several seconds before the button becomes active.
   3. Scroll to and select the integration pack: Evidence Punch Import > EvidencePunchImport_iPack_v3.

1. Select Connection Settings.

2. From the Connection dropdown list, select and configure the following:

   Connection Settings

   Connection Settings for the integration

   Setting	Required	Actions
   EvidencePunchImport_iPack_v3_APIGatewayServer	Required	To change the default API gateway server: Clear Use Default. Enter the URL to the server. Example: <tenantURL>/api
   EvidencePunchImport_iPack_v3_SFTPServer	Required	The SFTP server setting defines the connection to the file that contains the records. Integrations access only the internal SFTP account. To change the default SFTP server parameters: For each field, clear Use Default. Enter the following values: Enter the name of the internal Host. Enter the number of the Port for the internal SFTP account. In User, enter the username for the internal SFTP account. In Password, select <Encrypted>. Enter the new password for the internal SFTP account. Click Tap Apply.
   EvidencePunchImport_iPack_v3_Locale	Required	Enable Override.

1. Select Process Properties.
   Caution: Do not edit the default values of the AuthenticationProperties. By default, cookies are enabled and set the values for authentication properties.

2. Select EvidencePunchImport_iPack_v3_CRTConfig to set process properties that must be configured before the integration can run. This main process starts the integration process and handles errors.

Cross-reference tables (CRT) are the look-up tables that the integrations use to translate parameter values. One or more data values from the source system can be used to assign one or more parameters in the destination system.

1. Select Cross Reference.

2. From the Cross Reference dropdown list, select the EvidencePunchImport_iPack_v3 table.

3. Select Override, which allows you to:

   • Download the tables when you run the integration
   • Edit the table cells in Extensions
4. When you finish, click tap OK.

EvidencePunchImport_iPack_v3_Locale_CRT: Allows translation of messages and labels into different languages.

(Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.

Email Notifications

(Optional)

1. Select Yes to send email and control center notifications for integration runs.
2. Enter the email addresses of the recipients for the following types of run status. For multiple recipients, separate the addresses by a comma, but no spaces:

   In Progress — The integration run started and has not finished.

   Completed — The integration ran successfully without errors.

   Failed — The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.

   Completed with Errors — The integration run has errors or could not run.

1. In Integration Template, select EvidencePunchImport_iPack_v3.
2. Click Tap Assign .
3. In Integration Parameters, you can override default settings.
4. Complete the configuration for each integration control parameter value.

5. Click Tap Save.

   Repeat this step for each integration control parameter that supports the Evidence Punch Import process.

   Integration Parameters

   Integration Parameters

   Parameter name	Description / User prompt / Mandatory	Template parameter	Parameter type
   Date Format	Default Date format used for date of the evidence punch, such as: yyyy-MM-dd(default) dd-MM-yyyy MM-dd-yyyy User prompt = No Mandatory = Yes	DateFormat	Text
   Evidence Punch Comment	Comment to hold Evidence Punch Data. User prompt = No Mandatory = Yes	EvidencePunchComment	Text
   Evidence Punch Comment Note	Note added to the evidence punch hidden paycode. #InPunch# and #OutPunch# are mandatory. Default = Evidence Punch In Time: #Inpunch# Evidence Punch Out Time: #Outpunch# User prompt = No Mandatory = Yes	EvidencePunchCommentNote	Text
   Evidence Punch Paycode	Hidden paycode used as a container for the evidence punches. User prompt = No Mandatory = Yes	EvidencePunchPaycode	Text
   Hyperfind	Employees for whom this integration will run. Both Hyperfind and Location can be selected by user. Only active employees are included for the selected time period. Default = All Home User prompt = Yes Mandatory = Yes	HyperfindAndLocation	Hyperfind
   Employee IDs	A comma-separated list of specific employees for whom the integration is run. When no value is entered, the integration defaults to the Hyperfind parameter. To process the integration for only a limited group of employees, enter the person numbers as defined in the source system, each separated by a comma (,) but not spaces. User prompt = Yes Mandatory = Yes	EmployeeID	Text
   Locale	Locale for CRT lookup. If not provided, tenant locale is used. User prompt = No Mandatory = No	Locale	Text
   Source Filename	Source File name. Supports wildcarding for cases such as: new data is appended to a file using a datetime stamp. a file is archived after import. It is recommended that a datetime stamp, formatted as yyyymmddHHmm, be appended as a suffix to the Source Filename. EvidencePunchImport* supports cases when a new file is created each time that new evidence punch data is added to the SFTP location. User prompt = Yes Mandatory = Yes	SourceFilename	Text
   SourceDirectory	SFTP directory where the source file is stored. Default = /Inbound User prompt = No Mandatory = Yes	SourceDirectory	Text
   Time Format	Default time format used for punch times in the source file, such as hh:mma HH:mm(default) User prompt = No Mandatory = Yes	TimeFormat	Text
   Archive Directory	Directory name for archive files. Default = /Inbound/Archive User prompt = No Mandatory = Optional, when Archive File After Processing is set to false.	ArchiveDirectory	Text
   Archive File After Processing	Determines whether the source file is moved to the archive directory after import. Default = false User prompt = No Mandatory = Yes	ArchiveFileAfterProcessing	Text
   Archive Filename	Name given to the import file after archive; appended with date timestamp. User prompt = No Mandatory = Optional, when Archive File After Processing is set to false.	ArchiveFilename	Text

See Configure Access to Integrations .

1. Log in to the appropriate tenant.

2. Go to Main Menu > Administration > Setup Data Manager.

3. Select the Source tenant where the Process Model resides, and select the template to copy. It is a .zip file. A message appears in the Source column: Source: Import from <filename>.zip.

4. Click Tap Review and Publish. The Publish Summary panel appears.

5. Review the Publish Summary panel. It lists the items that were extracted from the migration file. If you approve, click tap Publish with Comment or just Publish.

6. Click Tap Go to Publish History at the bottom of the panel to view the status of the data transfer. The Publish History page contains a table that lists the items you have published. If there were errors during the transfer, the button under the Errors column for that row is black.

7. To view details, click tap the appropriate row and click tap View Selected.

8. On the History for publish run page, click tap Show all to view the setup data that you published, and the errors that occurred, if any, listed by item type and name.

1. Go to Main Menu > Administration > Application Setup > Business Process setup > Process Models.

2. Select the EvidencePunchAttestation_v1.1 process and click tap Edit. The process model enters edit mode.

3. Select the Decision Tables tab.

4. Click Tap Everyone's, and then select the decision table to edit.

5. Click Tap Decision Table Editor to add or update the rows in the table.

6. Click Tap Save and close.

7. Edit the following decision tables:
   Caution:

   • Values entered in the decision tables are case-sensitive, and must match configured values in the application.

   • Do not remove variables, variable names, or variable types from any decision table.

   • EvidencePunchAttestation_Variables_v1_1— Controls the Evidence Punch Attestation process.

     Evidence Punch Attestation Variables - decision table

     Evidence Punch Attestation Variables - decision table

     Variable name	Description
     EvidencePunchComment	Comment to hold Evidence Punch Data.
     EvidencePunchCommentNote	Note that integration adds to a comment during punch import processing. Default = Evidence Punch In Time: #Inpunch# Evidence Punch Out Time: #Outpunch#
     ThresholdInPunch	Amount of time beyond which an In punch is considered as an exception. Format hh:mm.
     ThresholdOutPunch	Amount of time beyond which an Out punch is considered as an exception. Format hh:mm.
     JustificationComment	Comments to be used by employees to justify punch exception. Comma-separated values without spaces. Warning: Comment names must not contain commas.
     Locale	Locale used to display form values and error messages.
     DateFormat	Display date format on exception form, such as: yyyy-MM-dd(default) dd-MM-yyyy MM-dd-yyyy
     TimeFormat	Display time format on exception form, such as: hh:mma HH:mm(default)
     EvidencePunchPaycode	Hidden paycode used as a container for the evidence punch data.
     WorkflowNotification	Notification which is initiated on error.
     Admin	Internal user; do not change. Default value = SERVICES-LEVEL3

8. EvidencePunchAttestation_Locale_v1_1— Allows customization of the text in the workflow form and notifications for different locales.

   Evidence Punch Attestation Locale - decision table structure

   Evidence Punch Attestation Locale - decision table structure

   Variable name	Variable type	Description
   Key	Text	Internal field label; do not change.
   Locale Policy	Text	Name of the locale policy for which the text applies. When the text applies to all locales, retain the empty value.
   Message	Text	Text displayed in the workflow form or notification.
   Description	Text	(Optional) Additional information.

   Note:

   • Localization of business process workflows remains optional, but is supported.

   • The decision table holds all messages represented with standard English labels; these apply to all locales when the Locale is set to a wildcard (*).

   • Some or all messages can be translated by adding lines to the table in their preferred translation for specific locales. Messages for the most commonly used Locale Policy should be defined at the top of the decision table. Text within tags ("<>") must not be changed.

   • Names of the parameters in the decision table column Parameter Name must be used as is. If any parameter value needs to be localized for a different Locale Policy, copy the Parameter Name with the * Locale Policy, add a new row to the decision table with the appropriate Locale Policy, and then add the localized values in the Message column.

   Locale decision table - Sample content

   Locale decision table - Sample content

   Variable	Locale	Value	Description
   _Message1	!=empty	Contact the system administrator.	Message1 error notification.
   _Message2	!=empty	Error listed below:	Message2 error notification.
   _MessageBlankAdmin	!=empty	Admin must be configured.	Null value passed in Admin.
   _MessageBlankDateFormat	!=empty	DateFormat must be configured.	Null value passed in DateFormat.
   _MessageBlankEvidencePunchComment	!=empty	EvidencePunchComment must be configured.	Null value passed in EvidencePunchComment.
   _MessageBlankEvidencePunchCommentNote	!=empty	EvidencePunchCommentNote must be configured.	Null value passed in EvidencePunchCommentNote.
   _MessageBlankEvidencePunchPaycode	!=empty	EvidencePunchPaycode must be configured.	Null value passed in EvidencePunchPaycode.
   _MessageBlankJustificationComment	!=empty	JustificationComment must be configured.	Null value passed in JustificationComment.
   _MessageBlankTimeFormat	!=empty	TimeFormat must be configured.	Null value passed in TimeFormat.
   _MessageErrorFormHeader	!=empty	Error	Form header text displayed on the error form.
   _MessageExceptionInPunch	!=empty	<punchDate> - <evidencePunch> In	In punch exception string displayed on the exception form.
   _MessageExceptionOutPunch	!=empty	<punchDate> - <evidencePunch> Out	Out punch exception string displayed on the exception form.
   _MessageInvalidThresholdInPunch	!=empty	Enter ThresholdInPunch using hh:mm format.	ThresholdInPunch not in hh:mm format.
   _MessageInvalidThresholdOutPunch	!=empty	Enter ThresholdOutPunch using hh:mm format.	ThresholdOutPunch not in hh:mm format.
   _MessagePunchCheckboxHeader	!=empty	Evidence punches found.	Exception check box header text displayed on the exception form.
   _MessagePunchDropdownHeader	!=empty	Justify the difference.	Justification drop down header text displayed on the exception form.
   _MessageScriptError	!=empty	Script failure in #error_component# script task. Error message: #error_message#	Error occurred in script.

Process models must be redeployed every time changes are made to an existing model. Re-deployment is not required for decision table changes.

Follow these steps to deploy the process model. For detailed information, see the online help topic Deploy Business Process Models .

1. Go to Main Menu > Administration > Application Setup > Business Process Setup > Process Models.

2. Select the EvidencePunchAttestation_v1.1 model.

3. Click Tap Edit, and then configure the deployment dates, and required parameters, such as Hide from the Action List, Tile List, and GoTo List. Select Attestation from the Template Categories list.

4. Click Tap Save, and then select Return to deploy.

Configure Access to Integrations.

• Function Access Profile (FAP): The administrator who runs the integration must be assigned a FAP which has been configured with the Retrieve Hidden Pay Code Edits via API access control point set as Allowed. See the Function Access Profiles topic.

Get the URL, User, and Password for the APIGatewayServer.

1. Open the Integration Template Designer: Select Main Menu Administration > Application Setup > Integrations Setup > Design Integration Templates.

   Note: If prompted, enter your Username and Password. Click Tap Log in.

2. Make sure that the Account is correct. If not, select the right account.

3. Select the Deploy tab > Integration Packs.
4. From the list in the left column, search for and select the Pro WFM Evidence Punch Attestation Extension integration.
   Note: If the integration does not display, select Browse Integration Packs to search for and select the iPack.

5. Click Tap Install.

6. From Unattached Environments, select the environment in which to deploy the integration process for the selected integration. Click Tap the double-left arrows button
   
   .

1. Select the environment
   1. Select the Manage tab > Atom Management.
   2. Select your environment.
2. Select environment extensions
   1. In Administration, click tap Environment Extensions.
   2. In Process Filter, click tap the magnifying glass
      
      . It can take several seconds before the button becomes active.
   3. Scroll to and select the integration pack: Evidence Punch Attestation Report > EvidencePunchAttestationReport_iPack_v3.

1. Select Connection Settings.

2. From the Connection dropdown list, select and configure the following:

   Connection Settings

   Connection Settings for the integration

   Setting	Required	Actions
   EvidencePunchAttestationReport_iPack_v3_APIGatewayServer	Required	To change the default API gateway server: Clear Use Default. Enter the URL to the server. Example: <tenantURL>/api
   EvidencePunchAttestationReport_iPack_v3_SFTPServer	Required	The SFTP server setting defines the connection to the file that contains the records. Integrations access only the internal SFTP account. To change the default SFTP server parameters: For each field, clear Use Default. Enter the following values: Enter the name of the internal Host. Enter the number of the Port for the internal SFTP account. In User, enter the username for the internal SFTP account. In Password, select <Encrypted>. Enter the new password for the internal SFTP account. Click Tap Apply.
   EvidencePunchAttestationReport_iPack_v3_Locale	Required	Enable Override.

1. Select Process Properties.
   Caution: Do not edit the default values of the AuthenticationProperties. By default, cookies are enabled and set the values for authentication properties.

2. Select EvidencePunchAttestationReport_iPack_v3_CRTConfig to set process properties that must be configured before the integration can run. This main process starts the integration process and handles errors.

Cross-reference tables (CRT) are the look-up tables that the integrations use to translate parameter values. One or more data values from the source system can be used to assign one or more parameters in the destination system.

1. Select Cross Reference.

2. From the Cross Reference dropdown list, select the EvidencePunchAttestationReport_iPack_v3 table.

3. Select Override, which allows you to:

   • Download the tables when you run the integration
   • Edit the table cells in Extensions
4. When you finish, click tap OK.

EvidencePunchAttestationReport_iPack_v3_Locale_CRT: Allows translation of messages and labels into different languages.

(Optional) Select Re-Run to allow repeated runs of the integration with the same parameter values as the previous run.

Email Notifications

(Optional)

1. Select Yes to send email and control center notifications for integration runs.
2. Enter the email addresses of the recipients for the following types of run status. For multiple recipients, separate the addresses by a comma, but no spaces:

   In Progress — The integration run started and has not finished.

   Completed — The integration ran successfully without errors.

   Failed — The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.

   Completed with Errors — The integration run has errors or could not run.

1. In Integration Template, select EvidencePunchAttestationReport_v2.
2. Click Tap Assign .
3. In Integration Parameters, you can override default settings. Click Tap Create.
4. Complete the configuration for each integration control parameter value.

5. Click Tap Save.

   Repeat this step for each integration parameter that supports the Evidence Punch Attestation Report process.

   Integration Parameters

   Integration Parameters

   Parameter name	Description / User prompt / Mandatory	Template parameter	Parameter type
   Date Format	Default Date format used for date of the evidence punch, such as: yyyy-MM-dd(default) dd-MM-yyyy MM-dd-yyyy User prompt = No Mandatory = Yes	DateFormat	Text
   Evidence Punch Comment	Comment to hold Evidence Punch Data. User prompt = No Mandatory = Yes	EvidencePunchComment	Text
   Evidence Punch Comment Note	Note added to the evidence punch hidden paycode. #InPunch# and #OutPunch# are mandatory. Default = Evidence Punch In Time: #Inpunch# Evidence Punch Out Time: #Outpunch# User prompt = No Mandatory = Yes	EvidencePunchCommentNote	Text
   Evidence Punch Paycode	Hidden paycode used as a container for the evidence punches. User prompt = No Mandatory = Yes	EvidencePunchPaycode	Text
   Export Only Exceptions	true: Export data for all dates during the selected period. false(default): Export data only for dates with a justification comment during the selected period. User prompt = No Mandatory = Yes	ExportOnlyExceptions	Boolean
   Hyperfind	Employees for whom this integration is run. Both Hyperfind and Location can be selected by user. Only active employees are included for the selected time period. Default = All Home User prompt = Yes Mandatory = Yes	HyperfindAndLocation	Hyperfind
   Employee IDs	A comma-separated list of specific employees for whom the integration is run. When no value is entered, the integration defaults to the Hyperfind parameter. To process the integration for only a limited group of employees, enter the person numbers as defined in the source system, each separated by a comma (,) but not spaces. User prompt = Yes Mandatory = Yes	EmployeeIDs	Text
   Justification Comment	Comments to be used by employees to justify punch exception. Comma-separated values without spaces. User prompt = No Mandatory = Yes Warning: Comment names must not contain commas.	JustificationComment	Text
   Locale	Locale for CRT lookup. If not provided, tenant locale is used. User prompt = No Mandatory = No	Locale	Text
   Output File Action	Determines whether output file is written as new, appended, or overwritten. Default = Overwrite User prompt = No Mandatory = No	OutputFileAction	Text
   Output Filename	Output file name. User prompt = No Mandatory = Yes	OutputFilename	Text
   OutputDirectory	SFTP directory where the report file is stored. Default = /Outbound User prompt = No Mandatory = Yes	OutputDirectory	Text
   Time Format	Default time format to be used for time in Input file, such as hh:mma HH:mm(default) User prompt = No Mandatory = Yes	TimeFormat	Text
   Timeperiod	Time period for which to export data. User prompt = Yes Mandatory = Yes	Timeperiod	Timeperiod

1. Select the integration:
   1. Select Main Menu Maintenance > Integrations.
   2. Click Tap Run an Integration .
   3. Select the EvidencePunchAttestationReport_iPack_v3 integration from the list. Click Tap Select.
   4. (Optional) Enter a unique Integration Run Name to make it easier to identify the run of the integration. Otherwise, the system assigns a default name, which ends with a date and time stamp.
2. Set parameters as follows:
   • Hyperfind: Select a Hyperfind query of employees.
   • Employee ID: To process data for only a limited group of employees, enter the person numbers, as defined in the source system, each separated by a comma (,) but no spaces.

     For 3 employees: 13997,15556,20012

   • Timeperiod: Specify the time period for which to export the Evidence Punch Attestation Report data.
3. Select the following:

   • Run Integration : If this is the first time this integration is being run.
   • Re-Run: If this integration has been run before, and the status is not In-Progress, you can run the integration again without entering the parameter values again. Click Tap Yes to continue, or No to not run the integration and to return to the parameter settings.
4. Wait for the confirmation that the integration completed or failed. Close the panel.
5. Click Tap Refresh .
6. To see details, select the integration run. Select Run Summary.

Status indicators

• In-Progress: The run of this integration has not yet completed.
• Completed: The integration ran successfully without errors.
• Scheduled: This integration is scheduled to run later or repeatedly.
• (Grayed out) Scheduled but Deleted: This integration is scheduled to run, but the integration template has been deleted. When it runs, it will generate an error. To prevent this error, delete the scheduled integration run.
• Completed with Errors: The integration ran successfully, but one or more records have errors. The integration run is treated as failed. If Abort on Failure is configured in an integration set, the integration set stops.
• Failed: The integration run has errors or could not run.
• To troubleshoot and resolve errors, do the following:

  Check the Run Summary for details.

  • To troubleshoot all types of errors, or if the Run Summary shows a large number of errors, click tap Go to Additional Details (if available), or click tap the Source File to open and examine the input source file.
  • (Only for import integrations) To troubleshoot and resubmit integrations that have transactional or data errors, click tap Go to Transaction Assistant.

To check the results in more detail:

1. Click Tap the tile for the integration run.
2. Click Tap Run Summary to see the results of the integration run.

   Example Run Summary details

   Note: The available details vary by integration and configuration.

   • Integration Run Name: Name of this run of the integration.
   • Process Name: Name of any integration set that includes this integration.
   • Integration Name: Name of the installed integration.
   • Integration Reference ID: Unique identifier for this integration run (to help in troubleshooting errors).
   • User: The person or user account that ran the integration.
   • Integration Type: Import, Export, or None
   • Start Date: Date and time when the integration run started.
   • End Date: Date and time when the integration run finished.
   • Status: In-Progress, Completed, Completed with Errors, or Failed.
   • Records Processed: Number of records that were processed.
   • Records Created: Number of records that were created.
   • Errors: Number of records that failed.
   • Source Files, Output File, and Error Files: For file-based import integrations, use Manage SFTP to access the source and output files on the inbound (source) and outbound (destination) SFTP folders. See the Manage SFTP topic.
3. Log in to the destination system and ensure that the data has been correctly updated.