Web Based Monitoring and Management: WBMM> New TargetObjects

WBMM> New TargetObjects parameter for Get/SetElements

From: McDonald, Ira (imcdonald@sharplabs.com)
Date: Sat Jul 17 2004 - 15:07:09 EDT

  • Next message: Wagner,William: "RE: WBMM> Edits for wd-wims10-20040628.pdf"

    Hi Harry, Saturday (17 July 2004)

    I think we should add one new 'ActionTargetObjects' parameter to both
    the GetElements and SetElements actions (see below).

    Comments?

    Cheers,
    - Ira

    Ira McDonald (Musician / Software Architect)
    Blue Roof Music / High North Inc
    PO Box 221 Grand Marais, MI 49839
    phone: +1-906-494-2434
    email: imcdonald@sharplabs.com

    PS - I think we should also add the new 'ActionTargetObjects' parameter
    to every other action, for the required granularity. I suggest I do
    that in the revised Schedule schema I'll post this weekend, if Harry
    approves of the bug fix in this note.

    [Background - A WIMS Agent object (when defined) should contain one or
    more Schedule objects and may contain one or more Resource objects.
    But otherwise a WIMS Agent object should only contain _references_ to
    other managed entities (service, printer, etc.). Those referenced
    managed entities should contain further subordinate objects (job,
    document, etc.) that may be actual targets of Get or Set actions.]

    ----------------------------------------

    <xsd:element name="ActionGetElements">
      <!-- read elements of legacy or WIMS agent, which MUST -->
      <!-- send a SendReport to the source manager URI -->
      <!-- see WIMS Monitoring Actions - section 5 [WIMS-PRO] -->
      <!-- see Get-Printer-Attributes - section 3.2.5 [RFC2911] -->
      <xsd:complexType>
        <xsd:sequence>
          <xsd:element ref="ActionTargetURIs"
            minOccurs="0" maxOccurs="1"/>
          <xsd:element ref="ActionTargetObjects"
            minOccurs="0" maxOccurs="1"/>
          <xsd:element ref="ActionRequestedElements"
            minOccurs="0" maxOccurs="1"/>
          <xsd:element ref="ActionParameters"
            minOccurs="0" maxOccurs="1"/>
        </xsd:sequence>
      </xsd:complexType>
    </xsd:element>

    <xsd:element name="ActionSetElements">
      <!-- write elements of legacy or WIMS agent, which MUST -->
      <!-- send a SendReport to the source manager URI -->
      <!-- see WIMS Management Actions - section 5 [WIMS-PRO] -->
      <!-- see Set-Printer-Attributes - section 4.1 [RFC3380] -->
      <xsd:complexType>
        <xsd:sequence>
          <xsd:element ref="ActionTargetURIs"
            minOccurs="0" maxOccurs="1"/>
          <xsd:element ref="ActionTargetObjects"
            minOccurs="0" maxOccurs="1"/>
          <xsd:element ref="ActionTargetElements"
            minOccurs="0" maxOccurs="1"/>
          <xsd:element ref="ActionMandatoryElements"
            minOccurs="0" maxOccurs="1"/>
          <xsd:element ref="ActionResetMode"
            minOccurs="0" maxOccurs="1"/>
          <xsd:element ref="ActionParameters"
            minOccurs="0" maxOccurs="1"/>
        </xsd:sequence>
      </xsd:complexType>
    </xsd:element>

    <xsd:element name="ActionTargetObjects">
      <!-- OPTIONAL - MUST be single-valued -->
      <!-- target object(s) scope for this action -->
      <!-- see schedVariable and schedValue - section 4 [RFC3231] -->
      <xsd:complexType>
        <xsd:sequence>
          <xsd:element ref="ActionManagedEntityType"
            minOccurs="0" maxOccurs="1"/>
          <xsd:element ref="ActionManagedEntityURI"
            minOccurs="0" maxOccurs="1"/>
          <xsd:element ref="ActionJobId"
            minOccurs="0" maxOccurs="1"/>
          <xsd:element ref="ActionDocumentNumber"
            minOccurs="0" maxOccurs="1"/>
        </xsd:sequence>
      </xsd:complexType>
    </xsd:element>

    <xsd:element name="ActionManagedEntityType" type="WIMSObjectType"/>
      <!-- OPTIONAL - MUST be single-valued -->
      <!-- top managed entity type of scope for action, for example, -->
      <!-- 'Agent' (WIMS Agent object) or 'Printer' (PWG Printer object) -->

    <xsd:element name="ActionManagedEntityURI" type="xsd:anyURI"/>
      <!-- OPTIONAL - MUST be single-valued -->
      <!-- top managed entity URI of scope for action, for example, -->
      <!-- 'pwg-wims://example.com' (WIMS Agent object) -->
      <!-- or 'ipp://example.com/prt1' (PWG Printer object) -->
      <!-- (a value of '*' is a wildcard and specifies all objects -->
      <!-- of the type specified by ActionManagedEntityType and -->
      <!-- within the scope specified by ActionTargetURIs, for example, -->
      <!-- to support configuration 'cloning' across Printers) -->
      <!-- see pwg-sm:Printer.PrinterDescription.PrinterUriSupported in -->
      <!-- PrinterDescription schema of PWG Semantic Model -->
      <!-- see printer-uri-supported - section 4.4.1 [RFC2911] -->
      <!-- see job-printer-uri - section 4.3.3 [RFC2911] -->

    <xsd:element name="ActionJobId">
      <!-- OPTIONAL - MUST be single-valued -->
      <!-- job identifier (key) of Job object scope for action -->
      <!-- (a value of zero is a wildcard and specifies all Jobs -->
      <!-- within the higher scope specified by ActionManagedEntityURI, -->
      <!-- similar to Get-Jobs in section 3.2.6 of IPP/1.1 [RFC2911]) -->
      <!-- see pwg-sm:Job.JobStatus.JobId in -->
      <!-- JobStatus schema of PWG Semantic Model -->
      <!-- see job-id - section 4.3.2 [RFC2911] -->
      <!-- see jmJobIndex in [RFC2707] -->
      <xsd:simpleType>
        <xsd:restriction base="xsd:int">
          <xsd:minInclusive value="0"/>
          <xsd:maxInclusive value="2147483647"/>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:element>

    <xsd:element name="ActionDocumentNumber">
      <!-- OPTIONAL - MUST be single-valued -->
      <!-- document number (key) of Document object scope for action -->
      <!-- (a value of zero is a wildcard and specifies all Documents -->
      <!-- within the higher scope specified by ActionJobId, -->
      <!-- similar to Get-Documents in section 3.3 of [PWG5100.5]) -->
      <!-- for this GetElements or SetElements action -->
      <!-- see pwg-sm:Document.DocumentStatus.DocumentNumber in -->
      <!-- DocumentStatus schema of PWG Semantic Model -->
      <!-- see document-number - section 9.1.23 [RFC5100.5] -->
      <!-- see sheetCompletedDocumentNumber in [RFC2707] -->
      <xsd:simpleType>
        <xsd:restriction base="xsd:int">
          <xsd:minInclusive value="0"/>
          <xsd:maxInclusive value="2147483647"/>
        </xsd:restriction>
      </xsd:simpleType>
    </xsd:element>



    This archive was generated by hypermail 2b29 : Sat Jul 17 2004 - 15:07:18 EDT