XOG: Location

Use the location XOG object to view inbound and outbound location attributes.
ccppmop144
Use the location XOG object to view inbound and outbound location attributes.
Schema Name
nikuxog_location.xsd
Read and Write XML Files
The following XML files are included:
  • locations_read.xml. Use this file to export locations from 
    Clarity Project and Portfolio Management (PPM)
    .
  • locations_write.xml. Use this file to import locations that were previously exported from 
    Clarity Project and Portfolio Management (PPM)
    .
Prerequisites
An entity must exist in 
Clarity Project and Portfolio Management (PPM)
.
Business Rules and Processing
When a location is created, a corresponding OBS unit is created in the location OBS referred to by the location's entity.
Read Filters
The following explicit read filter is used:
  • Entity
    The unique entity code for which the locations should be read out.
Error Handling
The following attribute values are validated against 
Clarity Project and Portfolio Management (PPM)
. If the values do not exist, XOG displays an error message and does not import or update the record.
  • Entity
    Checks if the entity is valid and exists in the system.
  • Required fields
    Verifies that all required fields have values.
  • Department associations
    Verifies that departments belong to the same entity. In addition, if the department does not exist, a warning is output.
Schema Mappings
The following schema mappings are provided for locations.
Locations Schema Tag
The Locations tag is part of the schema mapping for the Location XOG object.
A placeholder element for multiple locations. This schema tag has the following elements:
  • Location
  • Description Schema Tag
  • DepartmentAssociations Schema Tag
Location Element
The Location element is the actual Location object. This element has the following attributes.
  • locationCode
    Required. The unique code for location.
    Table and Column:
    locations.locationid
    Type:
    String
  • entity
    Required. The entity to which the location belongs.
    Table and Column:
    locations.entity
    Type:
    String
  • description
    Required.
    Table and Column:
    locations.locationdescription
    Type:
    String
  • shortdescription
    Required.
    Table and Column:
    locations.shortdesc
    Type:
    String
  • address1
    Optional.
    Table and Column:
    locations.address1
    Type:
    String
  • address2
    Optional.
    Table and Column:
    locations.address2
    Type:
    String
  • address3
    Optional.
    Table and Column:
    locations.address3
    Type:
    String
  • city
    Optional.
    Table and Column:
    locations.city
    Type:
    String
  • zip
    Optional.
    Table and Column:
    locations.zip
    Type:
    String
  • countryid
    Optional.
    Table and Column:
    locations.countryid
    Type:
    String
  • phone
    Optional.
    Table and Column:
    locations.phone
    Type:
    String
  • fax
    Optional.
    Table and Column:
    locations.fax
    Type:
    String
  • managerResourceCode
    Optional. The manager for location department associations.
    Table and Column:
    locations.manager_resource_code
    Type:
    String
  • name
    Required. The name of the location.
    Table and Column:
    locations.shortdesc
    Type:
    String
  • locationManagerCode
    Optional. The resource code for location manager.
    Table and Column:
    locations.location_manager_id
    Type:
    String
  • stateprov
    Optional.
    Table and Column:
    locations.stateprov
    Type:
    String
Description Schema Tag
The Description schema tag contains the attribute for the location description.
  • Description
    Required. The description of the location.
    Table and Column:
    description
    Type:
    String
DepartmentAssociations Schema Tag
The placeholder element for multiple department associations. This tag has the following attribute.
  • DepartmentAssociation
    Represents the department that is associated to the location. This element has the following attribute:
    • departmentCode
      Required. The association to department code. The department must belong to the same entity as the location.
      Table and Column:
      LocationDept.dept_id
      Type:
      String
Child Location Schema Tag
A child location. This element contains all the elements and attributes that the enclosing location has.