OpaccERP logo

TechNotes

Konfiguration

Die WebService-Schnittstelle wird über Einstellungen des WebService-Plugin konfiguriert.

Bemerkung
Bemerkung
Neben den Einstellungen des WebService-Plugin haben natürlich auch die Einstellungen auf Stufe Cluster, Node und Instance einen Einfluss.

OpaccOneInstallation.xml (Berechtigungen)

Wichtig
Wichtig
Für einen WebService ServiceBus-Cluster empfehlen wir, Zugriffe via TCP/COM zu verweigern.
Erfassen Sie hierfür bei der entsprechenden ServiceBusInstance folgende Zugriffsregel:
<DeniedClientIpAdressRule>0.0.0.0/0.0.0.0</DeniedClientIpAdressRule>

WebService-Plugin

Element Beschreibung Bemerkung
Name
Opacc.ServiceBus.Interface.Ws.Plugin
Der Name ist fix und darf nicht geändert werden.
Activated
Plugin aktiv oder passiv.
Mögliche Werte: true/false. Default: true.
Autostart
Autostart des Plugin aktiv oder passiv.
Mögliche Werte: true/false. Default: true.
ServiceBusPluginSetting
Name
WsPort
Der Name ist fix und darf nicht geändert werden.
Value
TCP-Port über welchen die Kommunikation läuft.
Default: 9955
ServiceBusPluginSetting
Name
WsEnabled
Der Name ist fix und darf nicht geändert werden.
Value
WebService-Endpoint aktiv oder passiv.
Mögliche Werte: true/false
ServiceBusPluginSetting
Name
AllowPlainPasswords
Der Name ist fix und darf nicht geändert werden.
Value
Passwörter in Klartext erlaubt oder nicht.
Mögliche Werte: true/false
Empfehlung: Immer mit false arbeiten.
Das Verschlüsseln der Passwörter erfolgt mit der Operation EncryptPassword.
ServiceBusPluginSetting
Name
CompressedEndpointEnabled
Der Name ist fix und darf nicht geändert werden.
Value
CompressedEndpoint aktiv oder passiv.
Komprimierte Kommunikation via http. Dieser Endpunkt wird von unseren mobilen Anwendungen (z.B. MobileService) verwendet.
Mögliche Werte: true/false
ServiceBusPluginSetting
Name
SecureCompressedEndpointEnabled
Der Name ist fix und darf nicht geändert werden.
Value
SecureCompressedEndpoint aktiv oder passiv.
Komprimierte Kommunikation via https. Dieser Endpunkt wird von unseren mobilen Anwendungen (z.B. MobileService) verwendet.
Mögliche Werte: true/false
ServiceBusPluginSetting
Name
WsdlMetaInfoEnabled
Der Name ist fix und darf nicht geändert werden.
Value
Wsdl Meta-Info aktiv oder passiv.
MetaInformationen des WebService. Werden benötigt, wenn ein eigener Client implementiert wird.
Mögliche Werte: true/false
ServiceBusPluginSetting
Name
NullToEmptyStringInFlatResponses
Der Name ist fix und darf nicht geändert werden.
Value
Nullwerte gegen aussen in Leerstrings umwandeln.
Das kann notwendig sein, wenn 3rd-Party-Clients nicht mit XML-Nullwerten nil=true umgehen können.
Mögliche Werte: true/false
ServiceBusPluginSetting
Name
WebSocketEndpointEnabled
Der Name ist fix und darf nicht geändert werden.
Value
WebSocketEndpoint aktiv oder passiv.
Mögliche Werte: true/false
ServiceBusPluginSetting
Name
SecureWebSocketEndpointEnabled
Der Name ist fix und darf nicht geändert werden.
Value
SecureWebSocketEndpoint aktiv oder passiv.
Mögliche Werte: true/false
ServiceBusPluginSetting
Name
WebSocketSessionTimeoutInMinutes
Der Name ist fix und darf nicht geändert werden.
Value
WebSocketSessionTimeout in Minuten.
Default = 1440 (Entspricht einem Tag.)
0 = unendlich
ServiceBusPluginSetting
Name
IncludeExceptionDetailsInFaults
Der Name ist fix und darf nicht geändert werden.
Value
Fehler (Details) auf Stufe des Kommunikations-Protokolls zum Client weiterleiten.
Mögliche Werte: true/false. Default: false.

Beispiel

<!-- WebService -->
<ServiceBusPlugin>
  <Name>Opacc.ServiceBus.Interface.Ws.Plugin</Name>
  <Activated>true</Activated>
  <Autostart>true</Autostart>
  <ServiceBusPluginSetting>
    <Name>WsPort</Name>
    <Value>9955</Value>
  </ServiceBusPluginSetting>
  <ServiceBusPluginSetting>
    <Name>WsEnabled</Name>
    <Value>true</Value>
  </ServiceBusPluginSetting>
  <ServiceBusPluginSetting>
    <Name>AllowPlainPasswords</Name>
    <Value>false</Value>
  </ServiceBusPluginSetting>
  <ServiceBusPluginSetting>
    <Name>CompressedEndpointEnabled</Name>
    <Value>true</Value>
  </ServiceBusPluginSetting>
  <ServiceBusPluginSetting>
    <Name>SecureCompressedEndpointEnabled</Name>
    <Value>false</Value>
  </ServiceBusPluginSetting>
  <ServiceBusPluginSetting>
    <Name>WsdlMetaInfoEnabled</Name>
    <Value>false</Value>
  </ServiceBusPluginSetting>
  <ServiceBusPluginSetting>
    <Name>NullToEmptyStringInFlatResponses</Name>
    <Value>true</Value>
  </ServiceBusPluginSetting>
</ServiceBusPlugin>