OS4X Enterprise job archive restore
Requirements
If you have an archive system which is capable to inform OS4X that an OS4X Enterprise job is archived, you can update the database of OS4X. After the information is available that the job is archived, the administrative web interface offers a restore functionality. The ID of the archiving must be numerical.
Your job restore mechanism must support JSONP requests. There are several ways to achieve this, please consult your archiving provider how to implement such a functionality.
If you want to use single-sign on for this web request, the domain of the OS4X administrative web interface must be the same as the JSONP service URL, example:
- OS4X Administrative interface: https://os4x.mydomain.tld/os4x
- JSONP restore service URL: https://archive-server.mydomain.tld/service/url
This functionality was introduces with OS4X release 2017-08-22.
Task to be done when archiving a job
You have to update the job record in OS4X's database:
- Table:
[tableprefix_]jobs, default:os4x_jobs - Column:
archive_id
The default of the value for this column is NULL, so if you want to reset the archive value, please update it to NULL value.
Configuring job restore
In the OS4X's administrative web interface, navigate to "Configuration" -> "OS4X Enterprise" -> "Basic". In the section "Job restore mechanism" there exist some parameters to be defined:
- Absolute AJAX URL for job restore processes: This is the absolute URL of the service call
- Name of parameter for restore AJAX call: the parameter name of the archive ID must be configured here
- (optional) Name of JSONP callback parameter: the callback function name parameter
Due to the nature of JSONP, your service must be able to interpret the "callback" parameter and reply with a valid JSON answer, encapsulated by the callback function name. Example:
- Service URL call: http://192.168.20.60/archiving/restoreJob?inArchiveJobId=4711&callback=Ext.my.callbackfn123
- Expected answer:
Ext.my.callbackfn123({ whatever: true })