Home‎ > ‎Support‎ > ‎

Administrator's Guide: Web Services for Glovia ERP

Administrator's Guide 



Conventions

Throughout this document, < > type parentheses represent values that are specific to your own implementaion. 
E.g.<host> or <port> represent the host or port that you have in your particular install.

<HOST> is the server on which the Glovia ERP product is installed. This is usually the same server as the web services.

<PORT> is the HTTP Connector port. See Tomcat section for more details.

<CATALINA_HOME> is the install directory of Apache Tomcat on your server.

<COMPANY> is your company name or designation as used by Fix-a-Job to represent you, the customer.

Ensure you are in the CORRECT environment before making any changes!!!

Overview 

The Fix-a-Job web services for Glovia ERP use Apache Axis2 under the Tomcat Servlet Engine. 
Tomcat; Axis2 and the SOAP Monitor are all freely available for download under the Apache License 2.0
You may download the from Apache.org by clicking here.

For the Web Services themselves, please contact us here for a quote.


Apache Tomcat Servlet Engine 


Typically, a Fix-a-Job web service install will consist of two separate installations, one for development/testing purposes and one for Production.
By default, the HTTP Connector port number for Production is 8080. Development/Test will be 8090. 

The shutdown port for Tomcat by default is 8005. This is the port used for Production. Development/Test are typically set to 8092.
To find the specifics on your own installation, check the configuration file at:

<CATALINA_HOME>/conf/server.xml

You will need appropriate permissions to view and edit this file.



Further reading on Tomcat can be found from the Apache Software Foundation here.

Apache Axis2 Web Services

Axis2 has its own web page for administration management.
To access this page, enter the following into your browser.

http://<host>:<port>/axis2/

e.g.

If you see the administration page, axis is probably deployed correctly. 

You will be presented with various options on this screen.
  • Choose the Validate option to further validate the Axis2 install and configuration.
  • The Services option will show currently deployed web services running under Axis2 and will indicate and errors with their deployment. They should normally all be set as "Active".
  • The administration option with take you to the web service administration module. This area is password protected and you will need to use the username/password created during your install. The default username : password is admin : axis2.
    • Upload Services will allow you to deploy a new or existing web service in the form of a .aar file.
Note: If the new .aar file is brand new, i.e. has never been deployed before, Axis2 will deploy the web service immediately. This concept is known as "Hot Deployment". As per Apache recommendations, Hot Deployment for changed services is NOT enabled in production environments. You may still upload the changed .aar file, but axis2 will need to be restarted (tomcat) for the new version of the web service to be enabled. This only applies to production environments. Test/Development environments are configured to allow Hot Deployment for existing services and therefore do not need a restart of Axis2.





Further reading on Axis2 can be found from the Apache Software Foundation here.

SOAP Monitor

As an aid to debugging the web services, the SOAP Monitor tool has been installed on both production and test systems. The SOAP Monitor is a web based tool that can be accessed as follows...

http://<host>:<port>/axis2/SOAPMonitor

e.g.


The SOAP Monitor allows the user to physically see messages flowing from the clients into Axis2 (the Request) and the reply from the web service (the Response). The message at the top is always the current request. You will probably want to set the Format XML check box to allow you to see the XML request and XML response more clearly. This is a real time tool. To use it, it must be running on before the messages are sent to the web server.

Note: There is no history saved for these request/responses, aside from the usual logging. You must have the SOAP Monitor up and running in a browser to capture the requests and their corresponding responses. You cannot use the SOAP Monitor to view this information on requests sent previous to your launching of the SOAP Monitor. To debug these, you will need to use the Java logs.

The SOAP Monitor configuration requires a port number defined unique to each installed environment. The default port is 5001. This is usually used for the Production environment. The Development/Test environment requires its own port assignment which is typically set as 8092.

To check the configuration of your own specific installation, review the configuration file:

<CATALINA_HOME>/webapps/axis2/WEB-INF/web.xml

You will need appropriate permissions to view and edit this file.
A restart of Axis will be required for any changes to this file to take effect.



For further reading: 


Logging

Log4j is the logging system used by both Tomcat and Axis2.

Log levels in Production are usually set to ERROR. Development/Test will usually be set to DEBUG.

There are three logs of interest.
  • catalina.out is the Tomcat log
  • axis2.log is the Axis2 log
  • <Company>.log is web services log. This is the one developers will typically need to review to ensure a particular web service is working correctly or to debug a newly deployed web service.

For further reading on Log4j:


Fix-a-Job Web Services

All Fix-a-Job web services share a single configuration to make administration and maintenance tasks easier. These guidelines apply to all web services deployed since the beginning of 2010. These configurations are environment and customer specific. Please review your own specific install for the exact configuration used.

You will need to have sufficient user privileges to view or edit these files.

axis2.xml

<CATALINA_HOME>/conf/Catalina/localhost/axis2.xml

Contains configuration information for Oracle (SID/Usernames etc) and the ProIV Bus Daemon.

oraclejdbcXXXX.jar

<CATALINA_HOME>/common/lib/oraclejdbc<XXXX>.jar

Where <XXXX> is related to the Oracle version your Glovia ERP instance is using.

The Oracle JDBC driver. Available for download from here.


<COMPANY>beans.jar

<CATALINA_HOME>/shared/lib/<COMPANY>beans.jar

Contains the Fix-a-Job web services common components. Supplied by Fix-a-Job.

gloviabus.jar

<CATALINA_HOME>/shared/lib/gloviabus.jar
The ProIV Bus Daemon API Connection - (c) Glovia / Fujitsu. Contact Glovia for availability and licensing. If you are currently licensed for the ProIV / Glovia Bus this file will be part of your current glovia install, typically within pro4bin.


Log4j.properties

<CATALINA_HOME>
See Logging Section for more details.


<COMPANY>Services.aar

<CATALINA_HOME>/webapps/axis2/services/<COMPANY>Services.aar

This is the actual web service code containing methods for each of the web services that you have purchased from Fix-a-Job. See Axis2 section for information on how to deploy this file.

Comments