Cisco Prime Collaboration Provisioning Guide - Standard and Advanced, 10.0
Managing Inventory
Downloads: This chapterpdf (PDF - 1.29MB) The complete bookPDF (PDF - 6.23MB) | Feedback

Managing Inventory

Managing Inventory

You can add, update, or remove endpoints using the endpoint inventory. You can add and update directory numbers, reserve them for specific users, and clear directory numbers whose designated length of time in the Reserved state has been exceeded.

Provisioning tracks the information about all services and users in an internal asset management inventory system. This information can be viewed by an administrator, who can create and save advanced searches that permit producing report templates in HTML or Microsoft Excel format.

Managing Endpoint Inventory

You can view the endpoint inventory report based on the Domain. The following details are displayed in the Endpoint Inventory page:

Table 1 Endpoint Inventory Management Page Field Descriptions
Field Description

Endpoint

You can add a new endpoint by specifying the domain, model, MAC address, and status. You can also click the Chooser icon to view the list of existing endpoints.

Domains

List of managed Domains.

Model

List of endpoint types.

MAC Address

Hexadecimal value that identifies the endpoint. The MAC address must be 12 characters in length. Valid values are alphanumeric characters (A-Z, a-z, 0-9), for example, 201B79989002.

Status

The status of the endpoint. Possible values are the following:
  • In-use—The endpoint is being used by a user.
  • Reserved—The endpoint is booked for a specific user.
  • Available—The endpoint is available, and can be manually or automatically assigned to a user.
  • Returned—The endpoint is returned to inventory, but its arrival is not confirmed.
  • Provisioning—The endpoint is currently being provisioned.

Reserved For (optional)

Specific user that the endpoint is reserved for.

Reserved On (optional)

Date that the endpoint was reserved on. It automatically appears after the endpoint information has been added or updated.

Reservation Timeout (optional)

Period of time, in days, that an endpoint will stay reserved in the system. Provisioning administrator sets the reservation timeout, therefore this field is non editable.

The endpointReservationTimeout rule determines the endpoint reservation timeout for a Domain (see Overview of Business Rules).


Note


Self-Care option is available for users to set up lines, manage services, and configure endpoint options quickly and easily. For more information, see Customizing Your Personal Settings.


If you are assigned the Ordering authorization role, you can perform the following tasks to manage the endpoint inventory:

Task Description Procedure

Add

You can add endpoints that are available to all users, or you can designate endpoints for specific users.

  1. Choose Deploy > Provisioning Inventory > Manage Endpoints.
  2. Enter the value in the Endpoint Inventory Management page and click Add. See Managing Endpoint Inventory for details on endpoint inventory.
Note   

Third party devices must be added as SIP devices in Prime Collaboration Provisioning. See Supported Devices for Prime Collaboration Provisioning for more information.

Update endpoint information

You can change endpoint information.

  1. Choose Deploy > Provisioning Inventory > Manage Endpoints.
  2. In the Endpoint field, click the Chooser icon.
    Note   

    You can search for the endpoint based on a complete or partial MAC address. You can use an asterisk (*) as a wildcard character at the beginning and/or end of the MAC address, but not in the middle. Do not specify SEP in the search criteria.

  3. In the Choose a Endpoint dialog box, select the endpoint that you require.
  4. Update the endpoint information as required and click Update. See Managing Endpoint Inventory for more information.
    Note   

    You cannot update an endpoint that is in In-use state).

Delete endpoints

You can delete endpoints from the inventory list.

In the Endpoint Inventory Management page, click the Chooser icon. In the Choose an Endpoint dialog box, select the desired endpoint, and click Remove.

You cannot delete an endpoint that is in In-use state.

The endpoints that are not associated to any users are called as orphan endpoints. You can identify these endpoints and delete them if not required. To identify orphan endpoints, in the Endpoint Inventory Management page, click Search Endpoints Without Associated User. To delete orphan endpoints, select one or multiple endpoints from the list, and click Delete Selected Endpoints.

Clear expired reservations

If required, you can clear all endpoints whose reservation time has expired, from the inventory.

You can clear expired reservations for endpoints to change the status of the endpoints from Reserved to Available.

In the Endpoint Inventory Management page, select the appropriate domain and then click Clear Expired Reservations.

Managing Directory Number

In most cases, Service Area Directory Number Blocks (DNBs) are used to allocate directory numbers. However, you can explicitly track (store and manage) directory numbers that are associated with each Service Area in the Provisioning inventory.

You can add and update directory numbers, reserve them for specific users, and clear directory numbers whose designated length of time in the Reserved state has been exceeded.


Note


To change the length of time that a directory number can remain in the Reserved state, you can modify the DNReservationTimeout rule. For more information, see Overview of Business Rules.


Directory numbers can be in these states: In-use, Reserved, or Available.

When a line is added, Provisioning allocates directory numbers using the following process:

  1. Checks if a directory has been reserved for the user.
  2. Checks for a directory number in the Available state.
  3. Checks the Service Area DNB for next available directory number.

In the Service Area component of the Domain, you can create DNBs, not individual directory numbers. After a directory number has been allocated to a user, Provisioning tracks the individual directory number.

The following details are displayed in the Directory Number Inventory page.

Table 2 Directory Number Inventory Management Page Fields
Field Description

Directory Number

Specify the Directory Number that you want to add or update.

Call Processor/Route Partition

The Call Processor and route partition that the directory number is added to.

Note   

The directory number is not added at this time. It is reserved for adding to the Call Processor once an order that requires one is received.

Status

The status of the number. Possible values are:

  • In-use—The directory number is currently being used by a user.
  • Reserved—The directory number is booked for a specific user for a specific period of time.
  • Available—The directory number is available, and can be assigned to any user.

Reserved For (Optional)

Specific user that the directory number is reserved for.

Reserved On (Optional)

Date that the directory number was reserved on. It appears automatically after the endpoint information has been added or updated.

You can perform the following tasks to manage the directory numbers in the inventory:

Task Description Procedure

Add

When you add a directory number, you can specify a status for it and/or reserve it for a particular user.

The same directory number can exist in different Call Processors. When you add a directory number, you must specify both the Call Processor and route partition.

  1. Choose Deploy > Provisioning Inventory > Manage Directory Numbers.
  2. In the Directory Number Inventory Management page, click Add New Directory Number. The fields in the right pane become editable.
  3. Complete the fields as required (see Directory Number Inventory Management Page Fields), and click Save.

Update directory number

You can search for and select a directory number to update.

Note   

You cannot update the status of a directory number that is in In-use state.

  1. Choose Deploy > Provisioning Inventory > Manage Directory Numbers.
  2. In the Directory Number field, do one of the following:
    • If you know the directory number, enter it and then click Search.
    • Search for the directory number, using an asterisk (*) as a wildcard. From the Choose a Directory Number dialog box, click the required directory number.
  3. Click Update Current Directory Number. The fields in the right pane become editable.
  4. Complete the fields as required (see Directory Number Inventory Management Page Fields), and click Save.

Clear expired reservations

You can clear expired reservations for directory numbers to place the directory numbers back into the available pool.

In the Directory Number Inventory Management page, click Clear Expired Reservations

To set the number of days that the directory number is reserved for, see Overview of Business Rules.

Delete directory number

You cannot delete a directory number that is in use.

In the Directory Number Inventory Management page, select the directory number and click Delete.

Searching Inventory

If you are assigned the Administration authorization role, you can browse and search the Provisioning inventory using the Instance Browser. The following objects appear in the instance selector:
Objects Description
Global Resources Lists infrastructure data such as, Route Partition, Call Search Space, Call Pickup Group, and so on.
Product Catalog Do not edit the information listed. If you want to see a list of products, refer to the external version of the product catalog which is included in the Provisioning NBI SDK. The schema of this data is located in the SDK subdirectory productcatalog\schema. The product definitions are located in the SDK subdirectory productcatalog\metadata. There is one XML file for each product, defining all required and optional attributes.
Users List all users and their locations in Provisioning.
Domain Specific directory numbers, endpoints, rules and Services Areas.

You can search for inventory objects using basic or advanced searches. You use basic searches to find instances of an object based on its properties. Advanced searches are used to specify more detailed search criteria.

You can include multiple constraints, such as customers, properties, associations, and namespaces, to limit the search results. You can also specify what properties you want the search to return. You can save advanced searches as reports, and organize them into categories. Reports can be created only by administrators.

Performing Basic Searches

Using the Instance Browser, you can run a basic search for instances of a particular object. In a basic search, the search parameters are based on the properties of the class.

The first step to searching for an instance is specifying the class that it is based on. You can specify search criteria and how the results are displayed by:

  • Specifying a keyword or partial keyword. You can use asterisks (*) as wild cards.
  • Specifying whether the results are displayed according to the class name or label property.
  • Restricting the search to a particular Domain.
  • Including and/or excluding abstract, association, and interface classes.

After you have located the class that the instance is based on, you can narrow your search by specifying search criteria based on the class properties. The number of searchable properties varies from class to class.

Procedure
    Step 1   Choose Deploy > Provisioning Inventory > Inventory Browser.
    Step 2   In the Instance Browser, click the Search icon, and then click the Object Class chooser icon.
    Step 3   In the Class Search screen, enter the search parameters, and click Search. The results appear in the Searchable Properties of pane.

    Performing Advanced Searches

    You can perform advanced searches to find inventory instances within a specified object class. An advanced search can be saved for future use.

    Procedure
      Step 1   Choose Deploy > Provisioning Inventory.
      Step 2   Do one of the following:
      • Click Inventory Browser, select a class using a basic search, then click Advanced.
      • Click Inventory Search, click Create Reports, and then select a class.
      Step 3   Add any applicable constraints. You can constrain searches using properties, associations, namespaces, or customers.
      Step 4   Create a list of properties to return in the search from a list of available properties.
      Step 5   Specify associated properties to return in the search, if applicable, by building the path to the properties.
      Step 6   Specify associated objects to return in the search, if applicable, by building the path to the objects.

      The search results will include only those instances with the selected objects.

      Step 7   Specify whether to include or exclude Namespaces and Object Classes in the search results.
      Step 8   Run the search.

      Constraints

      You can use the Add Constraint section to define the constraints for the search. The following constraints are available for advanced searches:
      Constraints Description
      Properties To restrict the results to objects that meet specified property criteria. You can set the properties constraint to be case sensitive or case insensitive. You can specify that either all or part of the value must be matched to return results.
      Associations To restrict the results to objects that are (or are not) associated with other objects using a specified association path. Association paths allow the relation between the source object and the queried objects to span multiple association classes.
      Namespaces To restrict the results to objects contained (or not contained) in specified namespaces.
      Customers To restrict the results to objects that are associated with specific customers.

      Defining Property Constraints

      You can define searches to select only the objects that meet specified property constraints. For example, you can define a constraint in which only instances that have a specific model number are included in the search results. In this case, the property constraint acts as a filter when searching for a specific object property.

      When defining property constraints, the following conditions are available:

      • Equals—To specify a value that is equivalent in value to the selected property..
      • Contains—To specify a value that is contained within the value of the selected property.
      • Not equal to—To specify a value that is not equivalent in value to the selected property.
      • Does not contain—To specify a value that is not contained within the value of the selected property
      • In range—To specify a value that has a Date property that is within the specified range. This operator can only be used when Date properties have been specified for an object, and where reportable=true is set in the class definition properties.

      After you select the operator, you can either specify a value, or leave the field blank. If you specify a value, it becomes the default value, although users who execute the search can change the value if required. Leaving the field blank allows a user who is executing the search at a later time to specify a value for that property constraint.

      To define property constraints:

      Procedure
        Step 1   In the Advanced Instance Search screen, select a property from the Add Constraint list.
        Step 2   Click Add. The available conditions appear in a list.
        Step 3   From the available conditions list, select the appropriate operator and click Add.
        Step 4   Select the appropriate property.
        Step 5   In the Value field, do one of the following:
        • Specify a default value for the constraint.
        • Leave the field blank so that users can specify their own constraints.
        Step 6   If you want the search to be case-insensitive, enable Ignore Case.
        Step 7   Click Add.
        Step 8   Repeat Steps 1 through 7 to add additional constraints.
        Step 9   If you have defined multiple constraints, specify the and or or operands as required in the Operand column.

        You can define searches to select objects that are, or are not, associated with other objects. For example, you can define a search for Lines that are associated with Voice Terminals of a certain type, excluding Voice Terminals of another type. Additionally, you can sort within a range; for example, you can search for all Endpoints with two to six Lines.

        When defining association constraints, the following conditions are available:

        • Associated with—Used to specify the object instance and association path associating the search class with another object instance.
        • Not associated with—Used to specify the object instance to not associate with for the search class.
        • Associated with range—Used to specify the range of object instances to associate with the search class. If you select this condition, you must complete the appropriate association, condition, and quantity information.

        After the operator is selected, you must select an object instance for the constraint. Each operator has a different procedure for selecting object instances to associate with.

        Defining Constraints using the Associated With Operator

        To define constraints using the associated with operator:

        Procedure
          Step 1   From the Add Constraint list, select Associations.
          Step 2   Click Add.
          Step 3   From the available conditions list, select Associated with, and click Add.
          Step 4   In the Add Constraint section, in the Instance field, click the Search icon.
          Step 5   In the To Class list, select the class that the object instance is associated with, and click Apply.
          Step 6   In the By Association list, select the appropriate association, and click Apply.
          Step 7   In the Participating As list, select the appropriate role for the class, and click Apply.
          Step 8   To specify another class in the To Class field, repeat Steps 5 through 7.
          Step 9   To restrict the constraint to a specific object instance, click the Search icon and search for that instance.

          By default, the constraint is not restricted to a particular instance.

          Step 10   Click Add to save your selections.
          Step 11   To add the constraint as defined, click Add.
          Step 12   If you have defined multiple constraints, select the and or or operands as required in the Operand column.

          Defining Constraints using the Associated With Range Operator

          To define constraints using the associated with range operator:

          Procedure
            Step 1   From the Add Constraint list, select Associations.
            Step 2   Click Add.
            Step 3   From the available conditions list, select the Associated with range condition, and click Add

            The constraint is added to the Add Constraint section.

            Step 4   From the Association list, select the association class that you want to search with.
            Step 5   From the Condition list, select the condition to satisfy in the search.
            Step 6   In the Quantity field, enter the number of instances the condition must meet, then click Add.

            The constraint is displayed in the Selected Constraints section.

            Step 7   Repeat Steps 1 through 6 to add additional constraints.
            Step 8   If you have defined multiple constraints, select the and or or operands as required in the Operand column.

            Defining Namespace Constraints

            Use namespace constraints to restrict the search to or exclude specific namespaces.

            Procedure
              Step 1   From the Add Constraint list, select a namespace, then click Add. Namespace appears in the Add Constraint section.
              Step 2   Do one of the following:
              • To specify a namespace to search in, select Equals.
              • To exclude a namespace from the search, select Not Equal To.
              Step 3   The Value list appears, displaying the available namespaces.
              Step 4   From the Value list, select the namespace, then click Add. The constraint appears in the Selected Constraints section.
              Step 5   Repeats Steps 1 through 4 to add additional constraints.
              Step 6   If you have defined multiple constraints, select the and or or operands as required in the Operand column.

              By default, the namespace, object class, and object values for each instance are displayed in the results of an advanced search. In addition to the default values, you can select other values for the advanced search to display

              The Properties to Return section lists the available properties of the object class being searched, and those properties that you want the search to return. Using the Properties to Return section, you can expand the search to display a list of property values

              Associated Properties to Return

              The Associated Properties to Return section identifies the associated object class properties that you want the search to return. Using the Associated Properties to Return section, you can extend the search to include a list of associated object property values.

              Procedure
                Step 1   In the Associated Properties section, click Add.
                Step 2   In the To Class list, select the object class.
                Step 3   Click Apply.
                Step 4   In the By Association list, select the appropriate association and click Apply.
                Step 5   Select the appropriate role for the class. Click Apply.
                Step 6   Do one of the following:
                • From the To Class list, select the object class. Click Apply. Repeat Steps 2 and 3 after you have added the classes that you require.
                • From the Select Property of list, select the properties of the class that you chose in Step 2. Click Apply
                Step 7   Click Add. The new associated property is displayed in the search screen


                Tip


                To remove a property, check the Remove check box, then click Remove.

                The Associated Objects to Return section identifies the associated object classes that you want the search to return. Using the Associated Objects to Return section, you can extend the search to include a list of associated objects of a specific class.

                Creating Search Reports

                You can save advanced searches (see Performing Advanced Searches) for future use. These are called Search Reports. Also, Provisioning provides you with sample search reports that you can use, or you can create your own. The sample search reports are not editable.

                Procedure
                  Step 1   Choose Deploy > Provisioning Inventory > Inventory Search.
                  Step 2   In the Search Reports page, click the New icon.
                  Step 3   In the Class Search dialog box, either enter a class in the search field or click one of the displayed classes.
                  Step 4   In the Instance Search page, enter the desired search criteria and click Save. For instructions on using the Instance Search page, see Performing Advanced Searches.
                  Step 5   Enter a name for the report and choose a category for it.
                  Step 6   Click Save. You are returned to the Advanced Search page, where you can initiate the search.

                  Running Search Reports

                  Once you have saved a search as a Search report, you can run it. Before running a Search report, you can choose to have the search results displayed in the current browser window or in a new window.

                  Procedure
                    Step 1   Choose Deploy > Provisioning Inventory > Inventory Search.
                    Step 2   In the Search Reports page, click the report that you want to run (either one of the sample search reports, or a search report that you created).
                    Step 3   Change the constraint values if required.
                    Step 4   To display the search results in a separate browser window, select Open results in a new window.
                    Step 5   Do one of the following:
                    • To execute the search and display the search results, click Search.
                    • To execute the search and write the search results to an Excel spreadsheet, click Excel.

                    To edit a search report, in the Search Reports page, click the Edit icon next to the Search report that you want to edit.

                    To delete search reports, in the Search Reports page, click the Edit icon next to the Search report that you want to delete. In the Search Options section, click Delete.