GL Interfaces
Where payroll goes in the general ledger that receives it: the target system profile (Yardi Voyager journal ETL, or a generic CSV / JSON journal), its codes, the schedule and the transport. A new interface sends TEST files until Go live.
Where to find it
- Module: HRMS
- Group: Payroll
- Section: Labor Distribution & GL Interface
- Screen: GL Interfaces
Address in the console: /hrms/gl-interfaces
List · 9 columns · 29 fields on its form · 3 of them required · 5 actions
What the list shows
These are the columns of the list, in the order they are drawn. Any of them can be sorted on, filtered on, hidden, or exported.
| Column | Kind | Field name |
|---|---|---|
| Code | Code | code |
| Name | Text | name |
| Profile | Status | profile |
| Mode | Status | mode |
| Transport | Status | transport |
| Schedule | Status | schedule |
| Mappings | Number | mapping_count |
| Open exceptions | Number | open_exceptions |
| Active | Yes or no | is_active |
The form
What is asked for when a record is created here. Required fields are marked; a choice drawn from a configuration list is one an administrator can extend without a release.
| Field | Type | Choices | Notes |
|---|---|---|---|
| Code required | Text | ||
| Name required | Text | ||
| Target system profile required | Choice | Yardi Voyager -- journal ETL (CSV), Generic journal (CSV), Generic journal (JSON) | |
| Detail | Choice | By account and dimension, By employee as well | |
| Liabilities | Choice | Split like the cost (each property balances), At company level (default property) | |
| Dimensions carried | Text | Comma separated: property, department, program, fund, grant, cost_center, job. | |
| Default property / entity code | Text | The target code for amounts with no property of their own. | |
| Entity code | Text | ||
| Book | Text | Yardi: Accrual or Cash, as the receiving database names them. | |
| Person code | Text | ||
| Column headings | Text | Rename any heading to match the receiving ETL template, such as {"AMOUNT":"Amount"}. | |
| Account code pattern | Text | A regular expression every target account must match. | |
| Property code pattern | Text | ||
| Codes must be on the valid-code list | Yes or no | ||
| Schedule | Choice | After each payroll is posted (and caught up daily), Manual | |
| Transport | Choice | Download, SFTP, HTTPS API | |
| SFTP host | Text | ||
| SFTP port | Number | ||
| SFTP user | Text | ||
| SFTP sign-in | Choice | Private key, Password | The key or password itself is set with Set credentials, sealed, and never shown again. |
| Pinned host key (SHA256) | Text | Use Fetch host key, compare it with what the receiving side publishes, then pin it. | |
| Folder (live) | Text | ||
| Folder (test) | Text | ||
| HTTPS URL (live) | Text | ||
| HTTPS URL (test) | Text | ||
| Token header | Text | ||
| File name | Text | {code}, {run_no}, {version}, {test}, {mode}, {pay_date}, {ext}. | |
| Active | Yes or no | ||
| Notes | Long text |
What you can do here
Set credentials
Sealed when saved and never shown again. Leave a box empty to keep what is there.
Asks for: SFTP password SFTP private key (PEM / OpenSSH) Key passphrase HTTPS token (for the token header)
Fetch host key
Reads the server's host key fingerprint. Nothing is pinned or sent.
Pin host key
Asks for: Fingerprint you confirmed*
Go live primary
From a TEST file that was sent, passed its control totals and was accepted by the receiving system.
Asks for: Who accepted the TEST file, and how*
Send what is due
Every posted payroll an after-post interface has not been sent yet.
* required
The rules that apply here
Everything on this screen obeys the platform rules rather than rules of its own. The ones worth knowing before you use it:
- Narrowing a list — search, conditions, sort, totals, export and saved views.
- What may be changed — the five grounds a record may not be edited on.
- Companies and business units — what the switcher above this list is doing to it.
- Creating a record — required fields, where choices come from, and how the number is allocated.
- Importing a spreadsheet — this screen accepts one, and it runs through the same rules as typing.