Skip Headers
Oracle® Communications Network Integrity UIM Integration Cartridge Guide
Release 7.2.2

Part Number E35810-01
Go to Documentation Home
Home
Go to Book List
Book List
Go to Table of Contents
Contents
Go to Feedback page
Contact Us

Go to previous page
Previous
Go to next page
Next
PDF · Mobi · ePub

7 UIM Sample Web Service Operations

This chapter provides information about Web service operations for the Oracle Communications Unified Inventory Management (UIM) Sample Web service provided in the ora_ni_uim_webservice project.

The Web service assumes that all specifications comply with the Oracle Communications Information Model. The Web service assumes that all specifications in UIM that the Web service interacts with contain the characteristics listed in Table 7-1.

Table 7-1 UIM Sample Web Services Entity Characteristics Requirements

Entity Characteristics

PhysicalDevice

nativeEMSName

Equipment

physicalLocation

nativeEMSName

EquipmentHolder

nativeEMSName

physicalLocation

PhysicalPort

nativeEmsName

physicalLocation

physicalAddress

serialNumber

LogicalDevice

nativeEMSName

nativeEMSAdminServiceState

nativeEMSServiceState

physicalLocation

DeviceInterface

nativeEMSName

nativeEMSAdminServiceState

nativeEMSServiceState

physicalLocation

ifType

minSpeed

maxSpeed

nominalSpeed

MediaInterface

nativeEMSName

nativeEMSAdminServiceState

nativeEMSServiceState

physicalLocation

ifType

minSpeed

maxSpeed

nominalSpeed

mtuCurrent

mtuSupported

nativeEMSConnectorPresent

physicalAddress


Installing the UIM Sample Web Service

Before you install the UIM Sample Web service, ensure that the following are installed:

To install the UIM Sample Web service on UIM:

  1. Rename the etc\COMPUTERNAME.properties file to host.properties, where host is the environment name of the computer.

    Note:

    Obtain the environment name for the computer by entering the hostname command at the prompt. The output from this command is the computer environment name.

    This enables the loaded Java project to reflect the environment.

  2. Open the host.properties file and set the property fields to reference your WebLogic domain and UIM instance.

  3. Save and close the file.

  4. (Optional) If you wish to develop the Web service in Design Studio, set the following Java Build Path Variables:

    • UIM_LIB: Example C:/wls1036/user_projects/domains/UIM/UIM/lib

    • POMS_LIB: Example C:/OracleCommunications/commsplatform/ws

    • POMS_PLIB: Example C:/OracleCommunications/POMSClient/lib

    • FMW_LIB: Example C:/wls1036/modules

  5. In the build.xml file, run the following ANT targets to get the Web service ready to build and deploy:

    • clean

    • extract.ear

  6. Edit the META-INF\application.xml file and add the following code fragment:

    <module> 
      <web> 
        <web-uri>NI_Uim.war</web-uri> 
        <context-root>NI_Uim</context-root> 
      </web> 
    </module>
    
  7. In the build.xml file, run the following ANT targets to build the Web service and update the EAR file:

    • generate-from wsdl

    • build-service

    • update.ear

  8. Redeploy custom.ear using the WebLogic console.

  9. (Optional) If you are installing the Network Integrity UIM Sample Web service on a UIM instance that is not located on the same server as Design Studio, do not run update.ear. For information about installing UIM on a remote server, see UIM Developer's Guide.

Configuring the Network Integrity GUI for the UIM Sample Web Service

To configure the Network Integrity GUI for the UIM Sample Web service:

  1. Log in to the Network Integrity GUI.

  2. Click Manage Import System. The Import System Details page is displayed.

  3. In the Name field, enter the name of the import system.

  4. In the Address field, enter the following address:

    http://UIM_IPAddress:UIM_Port/NI_Uim/NI_UimHTTP
    

    If UIM is installed with SSL enabled, the UIM URL requires HTTPS.

  5. In the User Name field, enter the UIM user name.

  6. In the Password field, enter the password of UIM.

Note:

You must configure the WebLogic domain to accept UIM Sample Web service connections using HTTPS. See UIM Installation Guide and UIM System Administrator's Guide for more information.

About CRUD Operations

The UIM Sample Web service provides Create, Read, Update, and Delete (CRUD) operations on the following entities:

The UIM Sample Web service provides create-association operations between peer entities using:

The UIM Sample Web service provides create-parent-and-child associations between entities using link.

The UIM Sample Web service provides delete associations between parent and child entities and delete associations between peer entities. For these operations, the UIM Sample Web service uses unLink, which deletes vertical and horizontal associations.

The UIM Sample Web service provides operations to retrieve an entire device tree using:

About Find Qualifiers

The UIM Sample Web service defaults to the following attribute values for find-entity operations (see findLogicalDeviceRequest and findPhysicalDeviceRequest) if these qualifiers are not already set:

About the <specType> Entity

The <specType> element is commonly used throughout the UIM Sample Web service examples (see Example 7-1, "<specType> Element"). The <specType> element is used to identify the entity type. This stages the operations to be executed for a particular Oracle Communications Unified Inventory Management (UIM) API. Set the <name> element to the name of the specification you are using.

Example 7-1 <specType> Element

<specType>
      <name>?</name>
      <entityType>PHYSICALDEVICE</entityType>
</specType>

Supported Entity Types

The <entityType> element supports the following values:

Response Messages

The following response messages can appear:

Use the following code pattern to inspect a response and detect an operation FAILURE.

CreateLogicalDeviceRequestType createLogicalDeviceRequestType = new CreateLogicalDeviceRequestType();
 
createLogicalDeviceRequestType.setLogicalDevice(wsLogicalDevice);
 
UIMWebService.checkResponse(uimPort.createLogicalDevice(createLogicalDeviceRequestType));

UIM Sample Web Service Entity Operations

Table 7-2 describes the files included in the Web service project.

Table 7-2 Web Service Project Files

File Description

NI-Uim-soapui-project.xml

SoapUI project file that contains sample requests and responses.

WSDL-Documentation.html

Generated WSDL documentation that shows all the available operations. A short description of each operation is provided.


Table 7-3 shows how the UIM Sample Web service processes various entities.

Table 7-3 Entity Operation Coding Patterns

Entity Operations Signature Patterns

createLogicalDeviceRequest

createDeviceInterfaceRequest

createMediaInterfaceRequest

createPhysicalDeviceRequest

createEquipmentRequest

createEquipmentHolderRequest

createPhysicalPortRequest

Web service:

  • Passes in a fully specified entity

  • Returns the ID of each entity if successful

updateLogicalDeviceRequest

updateDeviceInterfaceRequest

updateMediaInterfaceRequest

updatePhysicalDeviceRequest

updateEquipmentRequest

updateEquipmentHolderRequest

updatePhysicalPortRequest

Web service:

  • Passes in a fully specified entity; however, all parameters must be specified, not just those parameters being updated

  • Returns the ID of each entity if successful

findLogicalDeviceRequest

findDeviceInterfaceRequest

findMediaInterfaceRequest

findPhysicalDeviceRequest

findEquipmentRequest

findEquipmentHolderRequest

findPhysicalPortRequest

Web service:

  • Passes in filters and filter qualifiers

  • Returns 0, 1, or n entity IDs

  • Checks for null ID elements when 0 entity IDs are returned

  • Returns ID. For finddevice operations, it may also return the IDs of related devices.

getLogicalDeviceRequest

getDeviceInterfaceRequest

getMediaInterfaceRequest

getPhysicalDeviceRequest

getEquipmentRequest

getEquipmentHolderRequest

getPhysicalPortRequest

Web service:

  • Passes in the ID of the entity to be retrieved

  • Returns the fully specified entity

link

Web service:

  • Passes in the parent and child ID

  • Returns the parent ID if successful

unlink

Web service:

  • Passes in the parent and child IDs

  • Assumes the parent ID is the logical entity and the child ID is the physical entity when used to delete associations between peer LogicalDevice to PhysicalDevice, and peer DeviceInterface to PhysicalPort

  • Returns the parent ID if successful

getPhysicalDeviceTree

getLogicalDeviceTree

Web service:

  • Passes in the ID

  • Returns the entire device tree. See the schemas to understand how this works with unlimited number of descendent child objects.


Note:

Oracle Communications Network Integrity does not support delete operations on the PhysicalDevice, LogicalDevice, and Equipment entities. Log in to UIM as administrator to delete these entities.

Enabling Debugging for the Web Service

To enable debugging for the Web service, which is displayed on the Oracle WebLogic Server console:

  1. Open the domain\UIM\config\loggingconfig.xml file.

  2. Add the following text to the file:

    <logger name="oracle.communications.inventory.webservice.adapter.ni" additivity="false">
          <level value="debug" />
          <appender-ref ref="stdout"/>
          <appender-ref ref="rollingFile"/>
    </logger>