> For the complete documentation index, see [llms.txt](https://prosbcdocs.telcobridges.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://prosbcdocs.telcobridges.com/telecom-references/apis-and-integration/web-oam-and-p.md).

# Web OAM\&P

A tool is provided to configure/monitor the framework. Using this tool it is possible to:

* Manage users
* Manage configurations
* Configure/monitor Hardware
  * IP Interfaces
  * TDM Interfaces
  * ISDN stacks
  * SIP service access points
* Configure network access points

When used with the gateway application it is also possible to:

* Monitor call activity
* Configure dial plans

There are three terms that are often used in the framework when referring to this tool:

* \*\*Configuration \*\*: An element’s configuration can always be viewed but can only be changed on non active configurations
* \*\*States \*\*: An element’s state can only be viewed/changed on active configurations
* \*\*Status \*\*: An element’s state can only be viewed on active configurations. It may never be changed

**Database** The web application queries and updates the framework database that acts as an interface to configure the underlying framework. The database is the only required part of the configuring tool. This means clients can build their own configuration GUI as long as it uses the database correctly. For more information see the [Framework database](https://github.com/telcobridges-main/tmedia-wiki/tree/main/reference/api/framework-database/README.md). Note that the naming convention is one that is used widely and easy to understand. This is also the naming convention used by the Ruby on rails framework.

**Web application** The web application is a full working example (also optional) of how to integrate with the framework’s database:

* Written in Ruby using the Ruby on Rails framework. The framework is easy to learn and use; it simplifies traditional web design by a great factor. Since the framework is based on the MVC pattern, it is very easy to add new pages without risking to break the rest of the application.
* Implements all of the database tables
* Uses cascading stylesheets extensively to allow for "look and feel" customization
* When it makes sense, Ajax is used to provide better responsiveness
* Supports at least the following browsers: IE, Mozilla, Opera and Safari
* Can run on the following web servers: Apache, lighttpd, or nginx proxying to Mongrel (or using FastCGI)

### Usage

Usage depends on the server used to run the web application and the database. In any case there is some configuration that must be modified in the web application. The "database.yml" file must be changed to point to the client’s framework database. Starting the web server (using Webrick or Mongrel) can then be done as follows from the web application’s directory:

```
ruby script/server
```

### Caveats

The framework database must be one supported by Ruby On Rails to use the supplied web application.

***

Return to the Toolpack [User Guide](https://github.com/telcobridges-main/tmedia-wiki/tree/main/tmedia/configuration/user-guide/README.md)


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://prosbcdocs.telcobridges.com/telecom-references/apis-and-integration/web-oam-and-p.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
