XOG: Subscription

ccppmop1561
Use the subscription XOG object to view inbound and outbound department subscription attributes.
Schema Name
nikuxog_subscription.xsd
Read and Write XML Files
The following XML files are included:
  • subscription_read.xml. Use this file to export department subscription attributes from 
    Clarity PPM
    .
  • subscription_write.xml. Use this file to import department subscription attributes that were previously exported from 
    Clarity PPM
    . Entity, department, and service must exist in 
    Clarity PPM
    .
Read Filters
The following explicit read filters are used:
  • departmentId
    The code of the department for which the subscriptions should be read out.
Error Handling
The errors are thrown based on the following checks:
  • Required fields. Ensures that all required fields have values.
  • Entity. Checks if the entity is valid and exists.
  • Department. Checks if the department is valid and exists.
  • Service. Checks if the service is valid and exists.
Subscription Schema Tag
The subscription tag is part of the schema mapping for the subscription XOG object. This is a placeholder tag for multiple subscriptions.
Subscription element
There can be zero or more subscription elements, with each having an optional keymetrics element. Here are the attributes of a subscription element:
  • sla_violations
    Defines the number of SLA violations.
    Table and Column:
    DPT_SUBSCRIPTIONS.sla_violations
    Type:
    Integer
  • sla_violations_th
    Defines the threshold for SLA violations.
    Table and Column:
    DPT_SUBSCRIPTIONS.sla_violations_threshold
    Type:
    Integer
  • incidents
    Defines the number of incidents.
    Table and Column:
    DPT_SUBSCRIPTIONS.incidents
    Type:
    Integer
  • incidents_threshold
    Defines the threshold for incidents.
    Table and Column:
    DPT_SUBSCRIPTIONS.incidents_threshold
    Type:
    Integer
  • change_orders
    Defines the number of change orders.
    Table and Column:
    DPT_SUBSCRIPTIONS.change_orders
    Type:
    Integer
  • charges
    Defines the total charges (from chargebacks) against the investment (service) for this subscription.
    Table and Column:
    DPT_SUBSCRIPTIONS.charges
    Type:
    Integer
  • cust_satisfaction
    Defines the customer satisfaction rating for this subscription.
    Table and Column:
    DPT_SUBSCRIPTIONS.customer_satisfaction
    Type:
    Integer
  • total_users
    Defines the total number of users utilizing this subscription.
    Table and Column:
    DPT_SUBSCRIPTIONS.total_users
    Type:
    Integer
  • active_users
    Defines the number of active users utilizing this subscript.
    Table and Column:
    DPT_SUBSCRIPTIONS.active_users
    Type:
    Integer
  • page_hits
    Defines the page hits as captured for this subscription if applicable.
    Table and Column:
    DPT_SUBSCRIPTIONS.page_hits
    Type:
    Integer
  • entityId
    Required. Defines the entity to which the service belongs.
    Table and Column:
    Derived attribute.
    Type:
    String
  • departmentId
    Required. Identifies the subscribing department.
    Table and Column:
    DPT_SUBSCRIPTIONS.department_id
    Type:
    String
  • serviceId
    Required. Defines the identifier that makes it unique in combination with the table_name column.
    Table and Column:
    pk_id
    Type:
    String
keymetrics Tag
The keymetrics element consists of zero or more keymetric elements. This element contains an optional targetCurve and an actualCurve and may have zero or more CustomInformation elements. This tag has the following attributes:
  • metrics_code
    Required. Code of the metric.
    Table and Column:
    DPT_KEYMETRICS.METRIC_CODE
    Type:
    String
  • metrics_code
    Optional.
    Table and Column:
    DPT_KEYMETRICS.NAME
    Type:
    String
targetCurve and actualCurve Schema Tag
The curve elements contain segment objects which specify target metrics and actual metrics over a period of time.