Presentation of Collector Web Services at StreamServe Customer Conference, 2009-11-04

1. Collector Web Services
presented by
Petrus Näslund
Solutions Architect
at StreamServe Customer Conference, 2009-11-04

2. Schedule
•Web Services - intro
• StreamServe - config
• Examples and demo
• Questions

3. Web Services Definition
[A Web service is a software system designed to support
interoperable machine-to-machine interaction over a
network. It has an interface described in a machine-
processable format (specifically WSDL). Other systems
interact with the Web service in a manner prescribed by
its description using SOAP messages, typically conveyed
using HTTP with an XML serialization in conjunction
with other Web-related standards.]
(http://www.w3.org/TR/ws-arch/)

4. SOA
• Service Oriented Architecture
• Use Web Services to create new
functionality

5. WSDL
• Web Services Description Language
• Interface
• Types
• Binding
• Address
(http://www.w3.org/TR/WSDL/)

6. SOAP
• Simple Object Access Protocol (<1.2)
• Service Oriented Architecture Protocol
• Lightweight protocol intended for
exchanging structured information in a
decentralized, distributed environment
• Current version 1.2 (2003)
(http://www.w3.org/TR/SOAP/)

7. REST
• Representational State Transfer
• Smaller footprint than SOAP
• Not supported by the WS in StreamServe
• With our archiveLink app it is (see this page)
(http://dret.net/netdret/docs/soa-rest-www2009/)

8. MTOM
• Message Transmission Optimization Mechanism
(http://www.w3.org/TR/soap12-mtom/)

9. XML
• Extensible Markup Language
(http://www.w3.org/TR/xml11/)

10. HTTP
• Hypertext Transfer Protocol

11. Web Services in Persuasion ≤ SP3
• strsJobService
• strsCorrespondenceManagementService
• strsRepositoryResourceService
• strsRepositoryDocumentService
[Strs Install]ApplicationsService Gateway1.3webservices

12. Web Services in Persuasion SP4
• (strsRepositoryDocumentService)*
• strsRepositoryArchiveService
* SP2/3 web services still possible to use in SP4 to allow for
easy upgrades from SP2/3 solutions to SP4
[Strs Install]ApplicationsService Gateway5.4.0webservices

13. Service Gateway
• Make sure you have one
• Make sure it is started
• Verify the port number (2718?)
• This will be the web services end point

14. Security
• From SP3 web services enabled by default
• Before SP3, enable in semper.xml
[Strs Install]ApplicationsService Gateway1.3binsemper.xml
• WS Security in the Application Domain Editor
• Block Service Gateway port in Firewall
• Not very well documented, ask Support

15. strsRepositoryDocumentService
• documentSearch
• getDocuments
• getDocumentDetails
• defineDocument
• defineDocumentMetaData
• createDocument
• createDocumentAnnotation
• setDocumentTransferReady
• deleteDocument

16. strsRepositoryDocumentService
• batchDeleteDocuments • getDocuments
• createAnnotation • getDocumentsB64
• createDocumentTypes • getDocumentsDetails
• deleteAnnotations • getInternalDocumentTypes
• deleteDocuments • getMetaDataForDocType
• documentSearch • reprocessDocument
• getAllDocumentTypes • updateDocumentMetaData
• getAnnotations
• getDocumentLxfData

17. Compression
• Not handled by Web Services
• Check header of byte stream for gzip
• Decompress if needed

18. SDK
• SDK on Download Center
• strsRepositoryDocumentService in SP3
• strsRepositoryArchiveService in SP4
• You get manual, wsdl (and xsd for SP4)

19. Frameworks
• .Net - WCF (http://msdn.microsoft.com/en-us/netframework/aa663324.aspx)
• Java - Axis2 (http://ws.apache.org/axis2/)
• PHP - WS02 (http://wso2.org/projects/wsf/php)
• Ruby - WS02 (http://wso2.com/products/wsfruby/)
• C++ - gSOAP (http://gsoap2.sourceforge.net/)
• SAP NetWeaver
webservices.epx)
(http://www.sap.com/platform/netweaver/standardssupport/
• ...

20. .Net
• Should use Visual Studio 2008
• 2005 might work, but must install WSE 3.0
to get MTOM working correctly

21. Monitor
• ServiceGateway log
• Start ServiceGateway with verbose flag
(logs all sql statements etc)
• TCPMon (soap request and responses)
(https://tcpmon.dev.java.net/)

22. Real Life
• Example of a real implementation
• Siemens

23. Code
• .Net project

24. archiveLink
• App developed by PubliSyst (ask us for demo)
• Drop app file in Tomcat* and you’re done
• Abstracts web services to simple http(s) get/post
• Handles guid and types in background
• Return result as XML, Json or XHTML
• Control XHTML through CSS and XSLT
• Security through ACL and authentication
* Also working on GlassFish, JBoss and WebSphere

25. Future
SP5

26. Questions

27. Thank You!
Petrus Näslund
petrus@publisyst.se
+46(0)707507829