What's New in Stat Web Services API Calls?

Introduction:

Welcome and thanks for reading. This blog will look at the 5 W’s, Who, What, When, Where, and Why, of the Stat Web Services API calls currently available.
It will also highlight the latest Web Service calls revealed in the release of Stat 5.6.1.

The first section of the blog, entitled “The Setting”, deals with a potential scenario of who, what, when, where and why someone may want to use the Web Service calls to put them into context.
The second part of the blog, entitled “What Are They” deals more with the technical aspects of the calls and the calls available for use today.

The Setting:

Let’s say you are managing several applications. Let’s say the most widely used application is your corporate Help Desk system.
Next, you have Developers and Admins using Stat ACM for handling all changes to your PeopleSoft, Oracle eBusiness Suite, and Custom Applications.
You have another system for Application Performance Monitoring (APM). That APM application in use is… oh my, what should I {cherry} pick… Foglight!
And because you are a meticulous bunch, we’ll comply with the current ITIL Framework.

That gives us an Application Environment, or Application Stack, of:
1. Corporate Help Desk System
2. Stat ACM for PeopleSoft, Oracle eBusiness Suite & Custom Applications

3. Foglight Application Performance Monitoring

4. ITIL CMDB Database & Server

These four variables are enough to ensure chaos at one time or another wouldn’t you say?

The Chaos:

The Chaos we introduce isChange.

It’s that simple.

Change is the only thing required to ensure that sometime in the near future something will happen that you did not anticipate.
When that time comes you will need to know exactly what that change was, and if needed, roll it back to the previous state.
However, before we can do that; we need to know a few things.

The things we need to know about the change are: Who, What, Where, When and Why.

More importantly, we need a mechanism in place to share the change information across these applications.
We need to know that a change physically occurred.
We need to know when that change occurred.
With these two pieces of information shared amongst the application stack, it gives us the ability to be cautious of any discrepancies that could transpire.

The Solution:

The solution is in integrating our currently disparate systems into a more cohesive unit; with the intent of sharing information across our applications.
Using Web Service API calls, we can have these seemingly “Disparate Systems” become a little less disparate.
Let’s see how we do that.

Why Are They?

The Web Service API calls are available to provide direct interaction between Stat and another application needing data related to changes made in Stat.
These could be things like another Help Desk, Auditing Applications, ITIL related CMDB, or other reporting/tracking type of tools.

What Are They?

Stat provides programmatic access to CSR information via a Web Service API. The Stat Web Services are delivered with both the Standalone and the WebLogic
versions of the Stat Central Agent and are available for use when the Stat Central Agent is running, or is alive and responding.

The currently available Web Service API calls represent specific operations that your application(s) can use to retrieve or update data from/to Stat, such as:

Query information about a Service Domain residing in your Stat Repository
• Create, Retrieve, or Update a Change Service Request (CSR)
• Create, Retrieve, or Delete Attachments to/from a CSR
• Create, Retrieve, or Update a Detail Log
• Create, Retrieve, or Update a CSR’s Approval Status

Stat Web Service calls are implemented via JAX-WS 2.0 technology available in JBoss and WebLogic 10 application servers.
The current approved development approach is to follow the Top-Down approach, or “WSDL First” approach.
The Stat Web Service WSDL’s are fashioned on the “Literal Wrapped” or Document Approach.

There are currently 40 Web Service Calls available in the latest release of Stat.
Below is a list of the available calls broken out by WSDL, and then divided by primary purpose:

  1. WSLoginService.wsdl:
    Description: Stat Web Service Connect/Disconnect required for any of the below calls to be executed
    Stat ACM Domain Related:

    - connect
    - disconnect
  2. WSCsrService.wsdl:
    Description: Stat Service Domain Related Calls and CSR Related Calls
    Service Domain Related:
    - getServiceDomainList
    - getServiceDomainForUserList
    - getCustomerList
    - getProjectList
    - getOpenedByList
    - getCustomerPriorityList
    - getApplicationList
    - getEnvironmentList
    - getCSRTypeList
    - getAssignedToList
    - getPriorityList
    - getWorkflowList
    - getStatusList
    - getQueueList

    CSR Template Related:
    - getCSRTemplateValues
    - getApplicationDescriptionTemplate
    - getApplicationResolutionTemplate
    - getCSRTypeDescriptionTemplate
    - getCSRTypeResolutionTemplate

    CSR Entity Related:
    - saveNewCSR
    - retrieveCSR
    - updateCSR

    CSR
    Attachment Related:

    - retrieveCSRAttachments
    - addCSRAttachments
    - deleteCSRAttachments

    CSR
    Detail Log Related: (Newly opened in Stat 5.6.x)
    - retrieveCSRDetailLogs
    - updateCSRDetailLogs
    - retrieveDetailLogTopicList

  3. WSApprovalService.wsdl:
    Description: Stat CSR Transfer, Migration and Patch Approval Related Calls.
    Workflow Status Transfer Approval Related:

    - getTransferApprovalList
    - getTransferApprovalForCsrList
    - getTransferApprovalForCsrByStatusList
    - submitTransferApproval

    Migration Approval Related:

    - getMigrationApprovalList
    - getMigrationApprovalForCsrList
    - submitMigrationApproval

    Patch Approval Related:
    - getPatchApprovalList
    - getPatchApprovalForCsrList
    - submitPatchApproval

Where Are They?

Documentation for the Web Service API calls are located in the “web_services_sample” directory on the Stat ACM installation media.
You can find additional information on understanding and using these calls in Appendix G of the Stat Administrators Guide.

Please see the below section entitled “Additional Resources” for more information.

What’s Next?

It would be reasonable to assume that as time goes on, more of the Stat functionality will be released for additional Web Service Calls.

Thanks for taking the time to read this post. If you would like additional information or sample code on using the Stat Web Services API, please do let us know.

Respectfully,

William R. Hart

Solutions Architect

Dell | Pre-Sales, Quest Software, Inc

Mobile +1 727 808 1858, Office +1 727 787 7374

William.Hart@quest.com


Quest Software is now a part of Dell.

Additional Resources:

Java Sample code for Stat Web Services APIs is available on the Stat installation media under the folder web_services_sample. In addition, Microsoft ASP.NET/VB.NET Sample Code is also available upon request.

Also be sure to check out the following documents:

· Stat 5.6.x Patch App Instructions.pdf

· Stat Administrators Guide.pdf

· Stat 5.6.x Release Notes.htm

About the Author
William.Hart
Promoting a positive Stat User Community and enriching the value of the Stat investment. William has worked with the Stat application for over twelve years. He specializes in the areas of PeopleSoft and...