Difference between revisions of "OS4X plugin os4xplugin DTNA upload"

From OS4X
Jump to navigation Jump to search
Line 14: Line 14:
 
== Behaviour ==
 
== Behaviour ==
 
The plugin uploads the file(s) of the job to the target URL via REST webservice, using the configured client certificate. The content of the file must be of the type as documented in "IF72 Supplier ASN Webservice". The upload results into a response from the web service, which is then interpreted. If any of the output indicates an error, the plugin aborts the job by exiting with a non-zero return code.
 
The plugin uploads the file(s) of the job to the target URL via REST webservice, using the configured client certificate. The content of the file must be of the type as documented in "IF72 Supplier ASN Webservice". The upload results into a response from the web service, which is then interpreted. If any of the output indicates an error, the plugin aborts the job by exiting with a non-zero return code.
 +
 +
== Issues during upload of certificate file ==
 +
You must upload a file containing your certificate and private key as PEM formatted file. This can be accomplished by tasks described in [[OS4X Core - handle PFX/PKCS#12 file|this documentation]].
  
 
[[Category:Plugins]]
 
[[Category:Plugins]]

Revision as of 12:40, 8 December 2020

Purpose

Upload all files of a job (typically: one) to the DTNA REST webservice, provided by

Configuration

The plugin must be configured on per-partner level and has no global configuration.

Configuration parameters are:

  • Target URL: The destination URL incl. protocol. Typical values are:
  • Client certificate: a selectable certificate from the panel "Certificates" -> "CSR", where you have to upload your own certificate incl. private key to the CSR panel.
  • Debug output: Print out more information for debugging purposes

Behaviour

The plugin uploads the file(s) of the job to the target URL via REST webservice, using the configured client certificate. The content of the file must be of the type as documented in "IF72 Supplier ASN Webservice". The upload results into a response from the web service, which is then interpreted. If any of the output indicates an error, the plugin aborts the job by exiting with a non-zero return code.

Issues during upload of certificate file

You must upload a file containing your certificate and private key as PEM formatted file. This can be accomplished by tasks described in this documentation.