Custom Employee Payment Request Form

XML Forms Guide

Version
R2024.1.1
Custom Employee Payment Request Form

You can use the Employee Payment Request form to implement one or more workflows for an employee who submits a one-time payment request. These requests generate quick entries in Payroll upon final approval. These quick entries are added to the next scheduled open pay run, based on the request date entered in the form. Unlike the Quick Entry Payment form, the Employee Payment Request form are designed for a single payment request based on a single earning.

The Employee Payment Request system form is available in Workflow Administration > Form Builder. This form serves as a template for you to copy and create one or more customized versions of the form. You must configure the following items in the custom form:

  • Form name.
  • Options that the user selects in the Earning field.

You can also configure the type of supporting documents that the employee can attach to the request. However, this feature can be removed from the form as needed.

Earning

The following code example shows how to add an option to the form's Earning field. The following code is for a single earning, such as Commission:

Copy
<Filter>
    <FieldName>XRefCode</FieldName>
    <FieldValue>Commission</FieldValue>
</Filter>

You can also add a list of options to the form's Earning field for multiple earnings, such as Gift, Severance, and Bonus:

Copy
<Filter>
    <FieldName>XRefCode</FieldName>
    <FieldValue>Gift;Severance;Bonus</FieldValue>
</Filter>

Optionally, you could configure the Earning field to show a specific earning option by default. A default earning option is useful when that earning is a popular option, or if you want that option to be the only one selected in the form. In these cases, you should configure the IsReadOnly, Visible and InitialValue XML tags. Here are some suggested configurations:

  • Set IsReadOnly to False to make the field read-only.
  • Set Visible to False to hide the field. For example, you could set the field for a specific earning and then hide the field so the user doesn't have to select it in the form.
  • Enter an earning's reference code in InitialValue to set a specific earning option by default.

For more information about these XML tags, see Appendix: Supported XML Tags.

In the following code example, the Earning field is configured to be editable and visible. Commission is the default earning option.

Copy
<Field>
    <Style>IVComboBox</Style>
    <Block>1</Block>
    <Row>4</Row>
    <Column>0</Column>
    <BindingProperty>List_EmployeeEarning.PREarningXrefCode</BindingProperty>
    <DataProvider>PREarnings</DataProvider>
    <DisplayMemberPath>ShortName</DisplayMemberPath>
    <SelectedValuePath>XRefCode</SelectedValuePath>
    <IsReadOnly>False</IsReadOnly>
    <Visible>True</Visible>
    <IsRequired>True</IsRequired>
    <InitialValue>Commission</InitialValue>
    <Filter>
        <FieldName>XRefCode</FieldName>
        <FieldValue>Commission</FieldValue>
    </Filter>
</Field>

Supporting Documents

Users can include supporting documents in the Supporting Documents section of the form. You can restrict the type of document that can be attached to the payment request. When you want the form to support more than one document type, separate each item with a semicolon within the XML tag.

In the following code example, the form is set up to support the QEPayReq and the Receipts document types.

Copy
<UploadDownload>
    <DocMgmtTypeXRefCodes>
        <DocMgmtTypeXRefCode>QEPayReq;Receipts</DocMgmtTypeXrefCode>
    </DocMgmtTypeXRefCodes>
    <Block>1</Block>
    <Row>12</Row>
    <RowSpan>6</RowSpan>
    <Column>0</Column>
    <ColumnSpan>3</ColumnSpan>
    <ItemSource>List_DocMgmtFileStore</ItemSource>
</UploadDownload>