Properties
The sedex Client’s configuration is done primarily via a single configuration file:
<sedex_home>/conf/sedex-client-configuration.properties
If required, this file can be opened in a text editor and the values adjusted as required. The new values usually only apply after a restart of the sedex Client.
The table below lists the sedex Client’s configuration properties as well as their description and default values.
| Configuration Property (Key) | Description and Default Value |
|---|---|
| General configuration | |
| sedex.id | The sedex participant ID. (Example: 1-123-1) |
| Messaging configuration | |
| messaging.folder.path.inbox | Interface folder for received messages. Default: <sedex_home>/interface/inbox |
| messaging.folder.path.outbox | Interface folder for messages to be sent. Default: <sedex_home>/interface/outbox |
| messaging.folder.path.processed | Interface folder for processed messages (either successfully sent or rejected with error receipt). Default: <sedex_home>/interface/processed |
| messaging.folder.path.receipts | Interface folder with receipts for sent messages. Default: <sedex_home>/interface/receipts |
| messaging.folder.path.working | Internal technical folder with messages that are currently being sent by the sedex Client. Warning: Because it contains the messages being sent, it must never be deleted on an active system. Note: This folder must be in the same parent folder as the outbox. Default: <sedex_home>/interface/working |
| messaging.processed-messages.delete-after-x-days | Defines whether and after how many days a message should be automatically deleted from the processed folder. The value -1 deactivates the automatic deletion. Default: -1 (→ automatic deletion deactivated) |
| Messaging REST API configuration | |
| messaging.interface.rest-api.enabled | Determines whether messages can be sent and received via the sedex Messaging REST API. Default: false |
| messaging.interface.selector.rule.default | Defines whether the incoming messages should be delivered to the file-system interface or REST interface. Note: This property is only used if messaging.interface.rest-api.enabled is set to true Valid values are file-system and rest-api Default: file-system |
| sedex Web Service Proxy configuration | |
| wsproxy.start | Defines whether the sedex Web Service Proxy should be started. This additional component of the sedex Client is only required if business applications need to access defined synchronous Web services (SOAP, REST) via sedex. Default: true |
| wsproxy.http.port | The sedex Web Service Proxy’s HTTP port. Business applications can call defined Web services via this port. However, the HTTP connection between the business application and the sedex Web Service Proxy is unprotected. It would be safer to use the HTTPS connection to the sedex Web Service Proxy (see next property). Default: 8080 |
| wsproxy.http.disabled | Disables the unprotected HTTP port. Note: Only disable HTTP if all applications are accessing Web Service Proxy via HTTPS. Default: false |
| wsproxy.https.port | The sedex Web Service Proxy’s HTTPS port. Business applications can call defined Web services via this port. The HTTPS connection between the business application and the sedex Web Service Proxy is secured and should be preferred to an unprotected HTTP connection. Default: 8443 |
| wsproxy.https.key-store-file | Path to the key store file that contains the private key and the SSL/TLS certificate for the HTTPS connection with the business applications. The key store is a file of type PKCS#12 (file extension .P12). Default: Path to a self-signed SSL/TLS-certificate generated at the first start of the sedex Web Service Proxy. |
| wsproxy.https.key-store-password | Password for the key store file with the private key and the SSL/TLS certificate. Default: Generated random password for the generated SSL/TLS-certificate. |
| wsproxy.https.key-password | Password for the private key entry within the key store file. If the wsproxy.https.key-store-password and wsproxy.https.key-password are identical, this property is optional. This is normally the case. |
| wsproxy.https.key-alias | Alias (name) of the private key within the key store file to use. If there is only one key in the key store, the alias does not have to be configured. This is normally the case. |
| wsproxy.users.allow-anonymous | Enables anonymous access (no username and password) to unrestricted Web services. Default: true |
| Outgoing Web Proxy configuration Note: These values must only be set if access to Internet addresses must be made via a proxy server. Otherwise, the values of the properties can be empty. |
|
| outgoing-web-proxy.host | Proxy host for outgoing connections to the internet. Leave blank to not use an outgoing proxy. Note: Do not include http:// in this value. The proxy host entry must look like: myproxy.server.chDefault: <empty> |
| outgoing-web-proxy.port | Proxy port for outgoing connections to the internet, e.g. 8080. Leave blank to not use an outgoing proxy. Default: <empty> |
| outgoing-web-proxy.user | Username on the proxy. Leave blank to not use an outgoing proxy or if the proxy does not require authentication. Default: <empty> |
| outgoing-web-proxy.password | Password on the proxy. Leave blank to not use an outgoing proxy or if the proxy does not require authentication. Default: <empty> |
| Monitoring configuration | |
| monitoring.port | The port used to access the sedex Client’s monitoring page using HTTP. Default: 8000 |
| monitoring.file | The path to the sedex Client’s monitoring page in the file system. Default: <sedex_home>/monitoring/monitoring.txt |