|API Support||Since PageSeeder||Last updated||Documentation Date|
|obsolete||4.7000||5.7900||12 August 2015|
This item is obsolete!This servlet has been removed in version 5.9.
Handles Publishing user interface.
This servlet handles the connections with the Publish Engine and the display of Publish log files.
The connection to the Publish Engine is realized using the property
publishEngineUrl from the configuration file Global Properties.
The log files are stored under the following location:
HTTP Method: GET
Runs an action on the publishing framework.
|action||The action to run on the publish interface||yes||enum|
|date||The date of the log file to display (format is yyyy-MM-dd, required when action is 'showlog')||maybe||date|
|jobid||The id of the Publish job to cancel (required when action is 'canceljob')||maybe||long|
|name||The name of the publish process (used when action is 'query', 'check', 'publish' or 'cancel')||no||String|
|uri||The id of the URI to publish (required when action is 'query', 'check', 'publish' or 'cancel')||maybe||long|
|group||The id of the group where the URI is published (required when action is 'query', 'check', 'publish' or 'cancel')||maybe||long|
|type||The name of the publish script (required when action is 'query', 'check', 'publish' or 'cancel')||maybe||string|
|script||The type of the publish script, the only value currently supported is 'ant' (required when action is 'query', 'check', 'publish' or 'cancel')||maybe||string|
|input-message-[nb]||The message(s) of input parameter(s) for the publish script (used when action is 'publish')||no||string|
|input-value-[nb]||The value(s) of input parameter(s) for the publish script (used when action is 'publish')||no||string|
|target-[nb]||The name(s) of target(s) to run (at least one is required when action is 'publish')||maybe||string|
The supported actions are:
query: load a publish script.
check: check the status of a publish job.
checkall: check the status of all the publish jobs currently running.
publish: launch a new publish job.
showlog: show a particular log file.
cancel: cancel a publish job.
canceljob: cancel a publish job.
PageSeeder Return Status
|error||Group ID missing|
|error||Document Creation Not Allowed|
HTTP Method: POST
Does the same as
Created on , last edited on