How to Use the Web Service SOAP APIs

After installing EnterWorks, the Enable Web Services server is pre-registered and ready to be utilized. After starting the Enable Windows Services, you can use the guidelines below to access the Web Service.

Setting up the Environment

Web Services provides a standardized way of integrating Web-based applications using XML, SOAP, and WSDL to support interoperable machine-to-machine interaction over the network.

In order to properly utilize the Web Service, make sure your EnterWorks install contains the following ,jar files:

  • axis.jar

  • commons-discovery.jar

  • jaxrpc.jar

  • saaj.jar

  • sharedcm.jar

  • wsdl4j.jar

These jar files are needed in the Web Services client environment in order to access the server for EnterWorks Web Services. These jar files can be simply added onto the classpath if they are located on the same machine or copied to the client machine.

These files are located in the following directory: 

<drive>:\Enterworks\EnableServer\tomcat\webapps\webcm\WEB-INF\lib\

During install, EnterWorks automatically creates and deploys web services, which makes the EnterWorks Web Services ready after EnterWorks is installed and the services are restarted. However, one can still deploy or undeploy the web service manually by navigating to <Install Directory>:\EnableServer\tomcat\bin, and then double-clicking deploy_pimws.bat to deploy the current EnterWorks web service, or double-clicking on undeploy_pimws.bat to undeploy the web service. Make sure that the tomcat service is running.

A complete list of the Web services Java classes in EnterWorks is displayed including the following:

  • AttrCodeSetMapping

  • AttrData

  • Attribute

  • CodeSet

  • CodeSetDetail

  • EJBServer

  • EnableTreeNode

  • Group

  • Item

  • ItemHistory

  • ItemHistoryDiff

  • ItemList

  • ItemState

  • KeyValuePair

  • Repository

  • RepositoryGroup

  • RepositoryViewMapping

  • SearchCondition

  • Server

  • ServerSoapBindingImpl

  • Session

  • TextSearchConfig

  • TextSearchConfigAttr

  • TradingPartner

  • TransactionStatus

  • UserPreference

Server URL

The Web Services server can be accessed using the URL below: 

http://<hostname>:<tomcat_http_port>/webcm/services/server

Session

The EnterWorks Web Services is session-based. A typical Web Services working session has the following sequence of events:

  1. Bind to the service.
  2. Log in to obtain a Web Services session.
  3. Perform a function or a series of functions.
  4. Log out.

Concurrency is allowed within a session or cross-sessions.