{"type":"doc","content":[{"type":"paragraph","content":[{"text":"The reason why a new web service module was created is that the old one is tightly connected with Camel routes. This was sufficient in past. But now, when dealing with a larger number of operations, it is very hard to maintain. The aim of this new module is to implement step-by-step all operations which are available in the ","type":"text"},{"text":"pfx-api","type":"text","marks":[{"type":"link","attrs":{"href":"https://pricefx.atlassian.net/wiki/spaces/IM/pages/5867406596"}}]},{"text":" component.","type":"text"}]},{"type":"paragraph","content":[{"type":"emoji","attrs":{"id":"atlassian-warning","text":":warning:","shortName":":warning:"}},{"text":" Not all functionality of the old Web Services module is available.","type":"text"}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Operations","type":"text"}]},{"type":"paragraph","content":[{"text":"Supported operations:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"delete","type":"text"}]}]}]},{"type":"heading","attrs":{"level":1},"content":[{"text":"Configuration","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Enable Web Services","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"f35cf210-f158-4bd7-99f7-ef71911363bc"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Property","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Value","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"integration.webservices.enabled","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"true","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Server Setup","type":"text"}]},{"type":"paragraph","content":[{"text":"The web services run on the same port as the IntegrationManager application. The port can be changed:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"c9cb4bbb-8119-4611-9b43-3ed26112ed2f"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Property","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Value","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"integration.server.port","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"8080","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"It is not advised to change the port since other functionality might rely on it.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Authentication","type":"text"}]},{"type":"paragraph","content":[{"text":"Authentication is the same as in REST API. Properties:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"69f63c69-0872-4e92-9ba6-02821c2aeff6"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Property","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"Value","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"integration.webservices.username","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"xx","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"integration.webservices.password","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1},"content":[{"type":"paragraph","content":[{"text":"xx","type":"text"}]}]}]}]},{"type":"paragraph","content":[{"text":"Setting the properties will result in a stateless ","type":"text"},{"text":"Basic","type":"text","marks":[{"type":"code"}]},{"text":" authentication scheme.","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Properties","type":"text"}]},{"type":"paragraph","content":[{"text":"Other properties which can be set:","type":"text"}]},{"type":"table","attrs":{"layout":"default","localId":"3d5bad70-6a10-47a3-a0c5-49e962de3b05"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[414.0]},"content":[{"type":"paragraph","content":[{"text":"Property","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[487.0]},"content":[{"type":"paragraph","content":[{"text":"Value","type":"text"}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[542.0]},"content":[{"type":"paragraph","content":[{"text":"Description","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[414.0]},"content":[{"type":"paragraph","content":[{"text":"integration.webservices.publishedEndpointUrlPrefix","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[487.0]},"content":[{"type":"paragraph","content":[{"type":"hardBreak"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[542.0]},"content":[{"type":"paragraph","content":[{"text":"When set, the web service will be available at a given URL. E.g. setting the value ","type":"text"},{"text":"https://my.webservice.com","type":"text","marks":[{"type":"link","attrs":{"href":"https://my.webservice.com"}}]},{"text":" will result in the web service available at ","type":"text"},{"text":"https://my.webservice.com/ws","type":"text","marks":[{"type":"link","attrs":{"href":"https://my.webservice.com/ws"}}]},{"text":" instead of ","type":"text"},{"text":"https://0.0.0.0/ws","type":"text","marks":[{"type":"link","attrs":{"href":"https://0.0.0.0/ws"}}]},{"text":".","type":"text"}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[414.0]},"content":[{"type":"paragraph","content":[{"text":"integration.webservices.payloadBackupDirectory","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[487.0]},"content":[{"type":"paragraph","content":[{"text":"Default value is /var/pricefx/data/im-name/webservices, respectively ","type":"text"},{"text":"${integration.data}/webservices","type":"text","marks":[{"type":"code"}]},{"text":" where ","type":"text"},{"text":"integration.data","type":"text","marks":[{"type":"code"}]},{"text":" is a property","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[542.0]},"content":[{"type":"paragraph","content":[{"text":"When set, payloads will be stored to a specified directory.","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"WSDL","type":"text"}]},{"type":"paragraph","content":[{"text":"After IntegrationManager starts, the web services are available at:","type":"text"}]},{"type":"table","attrs":{"layout":"wide","localId":"b97f4f74-05c6-4474-a5bc-fa33eafde99b"},"content":[{"type":"tableRow","content":[{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[168.0]},"content":[{"type":"paragraph","content":[{"text":"Web services","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.0]},"content":[{"type":"paragraph","content":[{"text":"WSDL from internal network","type":"text","marks":[{"type":"strong"}]}]}]},{"type":"tableHeader","attrs":{"colspan":1,"rowspan":1,"colwidth":[524.0]},"content":[{"type":"paragraph","content":[{"text":"WSDL for customers","type":"text","marks":[{"type":"strong"}]}]}]}]},{"type":"tableRow","content":[{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[168.0]},"content":[{"type":"paragraph","content":[{"text":"PfxApiDelete","type":"text","marks":[{"type":"code"}]}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[268.0]},"content":[{"type":"paragraph","content":[{"text":"https://0.0.0.0:8080/ws/pfxApiDelete.wsdl","type":"text"}]}]},{"type":"tableCell","attrs":{"colspan":1,"rowspan":1,"colwidth":[524.0]},"content":[{"type":"paragraph","content":[{"text":"https://servername.pricefx.eu/ws/pfxApiDelete.wsdl","type":"text"}]}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Storing Payloads","type":"text"}]},{"type":"paragraph","content":[{"text":"When the property ","type":"text"},{"text":"integration.webservices.payloadBackupDirectory","type":"text","marks":[{"type":"code"}]},{"text":" is set, payloads (request, response) will be stored to a directory. If the directory does not exist, IntegrationManager will try to create it. If the process fails, the startup of the application will also fail.","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Format","type":"text"}]},{"type":"paragraph","content":[{"text":"The payloads are stored in following format:","type":"text"}]},{"type":"codeBlock","content":[{"text":"hash_timestamp_type.txt","type":"text"}]},{"type":"paragraph","content":[{"text":"where:","type":"text"}]},{"type":"bulletList","content":[{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"hash","type":"text","marks":[{"type":"code"}]},{"text":" – Hash of the request. For both request and response, the hash is the same (as the request is same). Thus request/response are coupled together and you can immediately see if the response is missing.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"timestamp","type":"text","marks":[{"type":"code"}]},{"text":" – Timestamp of the payload storage in ISO format.","type":"text"}]}]},{"type":"listItem","content":[{"type":"paragraph","content":[{"text":"type","type":"text","marks":[{"type":"code"}]},{"text":" – Determines whether the payload is ","type":"text"},{"text":"request","type":"text","marks":[{"type":"code"}]},{"text":" or response.","type":"text"}]}]}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Debug","type":"text"}]},{"type":"paragraph","content":[{"text":"You can enable the debug mode of the web services module to trace requests and responses in logs. You must set the following class to the ","type":"text"},{"text":"DEBUG","type":"text","marks":[{"type":"code"}]},{"text":" log level in the logger setup:","type":"text"}]},{"type":"codeBlock","content":[{"text":"net.pricefx.integration.autoconfigure.webservicesspring.LogRequestInterceptor","type":"text"}]},{"type":"paragraph","content":[{"text":"You can also do that by setting the property:","type":"text"}]},{"type":"codeBlock","content":[{"text":"logging.level.net.pricefx.integration.autoconfigure.webservicesspring.LogRequestInterceptor=DEBUG","type":"text"}]},{"type":"heading","attrs":{"level":2},"content":[{"text":"Examples","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Delete","type":"text"}]},{"type":"paragraph","content":[{"text":"POST https://0.0.0.0:8080/ws","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete request","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n PX\n\t\tpricefx\n\t\tmyFilter\n \n \n \n","type":"text"}]},{"type":"paragraph","content":[{"text":"Response:","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete response","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n \n \n \n 0\n [0]\n \n \n \n \n","type":"text"}]},{"type":"heading","attrs":{"level":3},"content":[{"text":"Delete with Filter Definition","type":"text"}]},{"type":"paragraph","content":[{"text":"You may also define the filter within a web service call.","type":"text"}]},{"type":"paragraph","content":[{"text":"POST https://0.0.0.0:8080/ws","type":"text"}]},{"type":"heading","attrs":{"level":5},"content":[{"text":"Delete request with filterDef","type":"text","marks":[{"type":"strong"}]}]},{"type":"codeBlock","attrs":{"language":"xml"},"content":[{"text":"\n \n \n\t\t\n \n PX\n pricefx2\n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n \n","type":"text"}]}],"version":1}

Browser not supported