1. Web Services Developer's Guide
  2. Preface

Preface

This guide describes the Oracle Communications Unified Inventory Management (UIM) Web Services. The information provided in this guide includes the UIM Web Service framework that supports web services, the various UIM Web Services that are available, and how to create custom web services.

When creating custom web services, you can use Oracle Communications Design Studio, which is an Eclipse-based integrated development environment. This guide includes references to both Design Studio and UIM, and often directs the reader to see the Design Studio Help and the UIM Help for instructions on how to perform specific tasks.

This guide includes examples used in given situations. The guidelines and examples may not be applicable in every situation.

Audience

This guide is intended for developers who have a working knowledge of web services in general, and who understand XML, Ant and Java development, including JPA, standard Java practices, and J2EE principles.

You should read UIM Concepts before reading this guide.

Documentation Accessibility

For information about Oracle's commitment to accessibility, visit the Oracle Accessibility Program website at http://www.oracle.com/pls/topic/lookup?ctx=acc&id=docacc.

Access to Oracle Support

Oracle customers that have purchased support have access to electronic support through My Oracle Support. For information, visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=info or visit http://www.oracle.com/pls/topic/lookup?ctx=acc&id=trs if you are hearing impaired.

Oracle is fully committed to diversity and inclusion. Oracle respects and values having a diverse workforce that increases thought leadership and innovation. As part of our initiative to build a more inclusive culture that positively impacts our employees, customers, and partners, we are working to remove insensitive terms from our products and documentation. We are also mindful of the necessity to maintain compatibility with our customers' existing technologies and the need to ensure continuity of service as Oracle's offerings and industry standards evolve. Because of these technical constraints, our effort to remove insensitive terms is ongoing and will take time and external cooperation.

Related Documentation

For more information, see the following documents in the Oracle Communications Unified Inventory Management documentation set:

  • UIM Installation Guide: Describes the requirements for installing UIM, installation procedures, and post-installation tasks.

  • UIM System Administrator's Guide: Describes administrative tasks such as working with cartridges and cartridge packs, maintaining security, managing the database, configuring Oracle Map Viewer, and troubleshooting.

  • UIM Security Guide: Provides guidelines and recommendations for setting up UIM in a secure configuration.

  • UIM Concepts: Provides an overview of important concepts and an introduction to using both UIM and Design Studio.

  • UIM Developer's Guide: Explains how to customize and extend many aspects of UIM, including the data model, life-cycle management, topology, security, rulesets, user interface, and localization.

  • UIM API Overview: Provides detailed information and code examples of numerous APIs presented within the context of a generic service fulfillment scenario, and within the context of a channelized connectivity enablement scenario.

  • UIM Information Model Reference: Describes the UIM information model entities and data attributes, and explains patterns that are common across all entities. This is available on the Oracle Software Delivery Cloud under “Oracle Communications Unified Inventory Management Developer Documentation."

  • Oracle Communications Information Model Reference: Describes the Oracle Communications information model entities and data attributes, and explains patterns that are common across all entities. The information described in this reference is common across all Oracle Communications products. This is available on the Oracle Software Delivery Cloud under “Oracle Communications Unified Inventory Management Developer Documentation."

  • UIM Cartridge Guide: Provides information about how you use cartridges and cartridge packs with UIM. Describes the content of the base cartridges.

  • UIM NFV Orchestration Implementation Guide: Provides information about how you use NFV Orchestration components and the NFV Orchestration RESTful API resources.

For step-by-step instructions for performing tasks, log into each application to see the following:

  • Design Studio Help: Provides step-by-step instructions for tasks you perform in Design Studio.

  • UIM Help: Provides step-by-step instructions for tasks you perform in UIM.