Data Refresh Job
Note a valid User Access Token must exist on the Scheduling page for the Data Refresh Job to run. See Create Token for details
Selecting the Data Refresh Job from the Jobs screen will open the job
Once open the Data Refresh job will present a number of options which may be edited by selecting any of the edit icons to open the relevant page
- Data Refresh Job Version
- Parameters
- Scheduling
- Permissions
- SFTP
- Encryption
- Last Run : Results of job for last run (non amendable)
- Add To Queue
Data Refresh Job Version
This details which version of the Data Refresh 2.0 job is loaded
Important The version number for the Data Refresh Job must match that of the Hub Release Number
If the Data Refresh Job version number does not match contact support@orgvue.com , or your Client Success Manager for assistance
Parameters
These job parameters will have been set during implementation and will not normally need to be changed unless instructed
Debug Logging
and Verbose Logging
are used to provide detailed logs for debugging
Scheduling
Scheduling may be enabled by setting the Enabled switch to Yes
- Frequency: Choice of
Daily
,Weekly
orMonthly
- Time of Day: Select HH:MM (UTC Time)
- Day of Week: Applicable for
Weekly
frequency - Day of Month: Applicable for
Monthly
frequency - Token Expiry: Expiry for current token with option to
Create Token
Important Note: A current valid User Access Token must be present for the Data Refresh Job to run even if scheduling is not enabled. See Create Token for details
Permissions
Permissions define the user roles that may View, Edit or Execute the job
Default set to admin
for all three but may be amended if required
SFTP
If the File Location
on the File Configuration screen is set to orgvue file storage
then the SFTP Enabled
switch should be set to No
If it is set to SFTP
then the SFTP Enabled
switch should be set to Yes
and the following details entered
Setting | Description | Possible values | Example |
---|---|---|---|
URI | Hostname URI prefixed SFTP:// |
Hostname or IP address of the server |
sftp://192.0.2.1 sftp://somefileserver.com |
Host Username | The SSH username which client uses to connect to the server | A valid username defined for SFTP server | The username that you have set |
Orgvue Private Key | The SSH private key generated by orgvue is used to authenticate connection to SFTP server. See PGP for more details | Select the required private key from dropdown | Key name(Expiry DD/MM/YYYY) |
Orgvue Public Key | The corresponding public key is uploaded and registered on the SFTP server and is used to secure the connection. See PGP for more details | Automatically generated by orgvue |
Encryption
Files may be encrypted using PGP encryption This may be useful if the source HR system exports files using PGP encryption
See PGP for more details on PGP encryption
To enable encryption:
- Enter the load file name (do not include file extension in file name)
- Select
Add Row
- File will be displayed
- Generate a new PGP key if required
- Select generated key from dropdown list
- Copy corresponding
Public Key
to encrypt file
Create Token
A valid User Access Token must exist for the Data Refresh Job to run
In addition the User account will require the property TokenAccess
to be set to TRUE
in Setting User List
To create a new token on the Scheduling page:
- Select
Create Token
- Select the
Token Expiry Date
window to open the date picker - Select the expiry date from the token which my be set for up to 1 year
- Select
Create Token
- Select
Save
Run Data Refresh Job
Once scheduled the Data Fresh Job will run automatically as per the Schedule however if an ad-hoc or manual run is required:
- Set the Scheduling enabled switch to
No
- Select the
Add to queue
button