XOG: Company and Company Class

Use the Company Class XOG object to view inbound and outbound Company Class instances. Use the company XOG object to view inbound and outbound company attributes.
ccppmop144
Use the Company Class XOG object to view inbound and outbound Company Class instances. Use the company XOG object to view inbound and outbound company attributes.
2
Company Class
Schema Name
nikuxog_companyclass.xsd
Read and Write XML Files
The following XML files are included:
  • companyClass_read.xml. Use this file to export Company Class instances from 
    Clarity Project and Portfolio Management (PPM)
    .
  • companyClass_write.xml. Use this file to import Company Class instances that were previously exported from 
    Clarity Project and Portfolio Management (PPM)
    .
Prerequisites
None.
Read Filters
The following explicit read filters are used:
  • companyclass
    Defines the company class name.
  • description
    Defines the description for the Company Class.
  • shortdesc
    Defines the short description for the Company Class.
Error Handling
The following errors can be thrown:
  • Could not xog-in item because size of some attributes [description] is not within valid range.
Schema Mapping
Mappings for the following schema tag name are provided.
Company Class Schema Tag
The Company Class tag is part of the schema mapping for the Company Class XOG object. It has the following attributes:
  • companyclass
    Required. Defines the unique company class name.
    Table and Column
    : CLNTCLASS
    Type
    : String
  • description
    Required. Defines the description of the company class.
    Table and Column
    : DESCRIPTION
    Type
    : String
  • shortdesc
    Required. Defines the summary of the company class description.
    Table and Column
    : SHORTDESC
    Type
    : String
Company
Use the company XOG object to view inbound and outbound company attributes. Companies are defined for inbound (write) and outbound (read) processing.
Schema Name
nikuxog_company.xsd
Read and Write XML Files
The following XML files are included:
  • biz_companies_read.xml. Use this file to export companies from 
    Clarity Project and Portfolio Management (PPM)
    .
  • biz_companies_write.xml. Use this file to import companies that were previously exported from 
    Clarity Project and Portfolio Management (PPM)
    .
Terms
The following terms are used with Company XOG object:
  • Parent and Affiliate Company
    These browse fields are used to associate a company with a parent or affiliate company and are used to perform validation against SRM_COMPANIES table.
    If the company does not exist, no information is posted to the company supplemental fields and a warning is written to the Success and Error file. If the company exists, the field is populated.
  • Account Manager
    This browse field is used to associate a company with a project manager and to perform validation with uniqueName in the SRM_RESOURCES table.
    If the resource does not exist, no information is posted to the company supplemental fields and a warning is posted to the Success and Error file. If the resource uniqueName is contained in 
    Clarity Project and Portfolio Management (PPM)
    , the field is populated.
  • Internal Contact
    This browse field is used to associate an internal contact with a company and perform validation on Last_Name in SRM_RESOURCES.
    If the resource does not exist, a blank field is posted to company custom-defined fields and a warning is written to the Success and Error file. If the resource last_name exists, the field is populated.
  • Billing Address
    The billing address of the company. A company can have more than one billing address. If more than one billing address exists, each is associated with the same company.
  • Custom Fields
    Use these to import custom-defined fields. First generate the custom-defined fields with XDM. The XOG allows for an unlimited number of custom-defined fields if you map the generated field to the XML schema. Within the schema for custom-defined fields, you must provide the Column Name, Attribute Name, and Value.
  • Financial Properties
    Prior to importing companies, the following financial properties must be set up in the Financial Administration module. The Default Values must be populated in the Administration Tool's Application Administration/Financial Management/Defaults section. The Location, Department, WIP Class, Project Class, and Company Class values are not required in the XML schema but are required within 
    Clarity Project and Portfolio Management (PPM)
    .
  • Lookup values
    The XML schema requires lookup codes that are provided later. These are validated against the values in CMN_LOOKUPS.
  • OBS association
    There is an OBS Associations portlet that contains the OBS unit that is associated with the company, if any. The OBS association fields can be used for import and export.
Read Filters
The XOG supports outbound processing of companies that are based on the following fields:
  • Company Status
  • Company Type
And and Or processing is supported between these two fields (listed above) and for processing within Company Type. The following combinations are supported:
Company Status = x
where x = Active or Inactive
Company Type = x
where x = Prospect, Other, Competitor, Customer, Department, Marketplace Buyer, Marketplace Supplier, Resource Partner, Project Partner, Trust Client, Vendor
Company Status = x AND Company Type = y
where x = Active or Inactive where y = one of many Company Types
Error Handling
The following fields are written to the Success and Error file when the XOG process generates an error or warning:
  • companyId
  • companyName
  • externalId
  • externalSource
The Company XOG object handles errors and warnings. If an error occurs, the table is not updated. You must fix the error and must run the XOG again. If a warning occurs, the record is posted but the non-required fields are defaulted because of inconsistencies in the data.
The following errors are validated against Company:
  • companyId
    The unique identifier for the company.
    The company ID is validated against the companyId field. If the company ID is not unique, the company is not imported and an error is posted to the Success and Error file.
  • parentCompany
    The name of the parent company associated with the company.
    The parent company name is validated against the parentCompany field. If the parent company does not exist, the company is imported without any association to a parent company.
  • affiliateCompany
    The name of the affiliate company associated with the company.
    The affiliate company is validated against the affiliateCompany field. If the affiliate company does not exist, the company is imported without any association to an affiliate company.
Schema Mappings
The following schema mappings are provided for the company XOG.
3
3
Company Schema Tag
The Company tag is part of the schema mapping for the Company XOG object. It has the following attributes:
  • companyId
    Required. Defines the unique, primary key for the company.
    Table and Column:
    SRM_COMPANIES.Company_ID
    Type:
    String
  • name
    Required. Defines the company name.
    Table and Column:
    SRM_COMPANIES.Company_Name
    Type:
    String
  • type
    Required. Defines the company type.
    Values:
    Prospect, Other, Competitor, Customer, Department, Marketplace Buyer, Marketplace Supplier, Resource Partner, Project Partner, Trusted Client, Vendor
    Table and Column:
    SRM_COMPANIES.Type
    Type:
    String
  • status
    Required. Defines the status for the company.
    Values:
    Active and Inactive
    Default:
    Active
    Table and Column:
    SRM_COMPANIES.Status
    Type:
    String
  • externalSource
    Required by the schema. The lookup value specifies the originating system ID. For example, Oracle.
    Table and Column:
    SRM_COMPANIES.External_Source_ID
    Type:
    String (in schema) and Number (in 
    Clarity Project and Portfolio Management (PPM)
    )
  • externalId
    Required. Defines the originating unique identifier that is required by the XML schema.
    Table and Column:
    SRM_COMPANIES.External_ID
    Type:
    String
Contact Information Schema Tag
The Contact Information tag is part of the schema mapping for the Company XOG object. Contact information includes phone and fax numbers and mail and email addresses.
This schema tag has the following attributes:
  • address1
    Defines the first line of the address.
    Table and Column:
    SRM_CONTACTS.Address1
    Type:
    String
  • address2
    Defines the second line of the address.
    Table and Column:
    SRM_CONTACTS.Address2
    Type:
    String
  • city
    Defines the city.
    Table and Column:
    SRM_CONTACTS.City
    Type:
    String
  • county
    Defines the county.
    Table and Column:
    SRM_CONTACTS.County
    Type:
    String
  • state
    Defines the state.
    Table and Column:
    SRM_CONTACTS.State_Province
    Type:
    String
  • postalCode
    Defines the postal code.
    Table and Column:
    SRM_CONTACTS.Postal _Code
    Type:
    String
  • country
    Defines the country.
    Table and Column:
    SRM_CONTACTS.Country_ID
    Type:
    Number
  • workPhone
    Defines the work phone number.
    Table and Column:
    SRM_CONTACTS.Phone_Work
    Type:
    String
  • fax
    Defines the fax number.
    Table and Column:
    SRM_CONTACTS.Phone_Fax
    Type:
    String
  • webAddress
    Defines the Web address.
    Table and Column:
    SRM_CONTACTS.URL
    Type:
    String
Supplemental Information Schema Tag
This tag is part of the schema mapping for the Company XOG object. It has the following attributes:
  • description
    Describes the company.
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Description
    Type:
    String
  • rating
    Lookup values include:
    • High
    • Medium
    • Low
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Rating
    Type:
    String
  • sicCode
    Lookup values include:
    • SIC Code 1
    • SIC Code 2
    • SIC Code 3
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.SIC_Code
    Type:
    String
  • parentCompany
    Browse this field to specify the parent with which the company is associated.
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Parent_Company
    Type:
    String
  • affiliate Company
    Browse this field to specify the affiliate with which the company is associated.
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Affiliate_Company
    Type:
    String
  • division
    Defines the company division.
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Division
    Type:
    String
  • category
    Defines the company category.
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Category
    Type:
    String
  • industry
    Defines the industry in which the company operates.
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Industry
    Type:
    String
  • numberOfEmployees
    Defines the number of employees in the company.
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Number_of_Employees
    Type:
    Number
  • ownership
    The Lookup value is "Corporation".
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.OwnerShip
    Type:
    String
  • tickerSymbol
    Defines the ticker symbol of the company
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Ticker_Symbol
    Type:
    String
  • referralSource
    Defines the referral source.
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Referral_Source
    Type:
    String
  • accountManager
    Browse this field to identify the account manager who is associated with the company.
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Account_Manager
    Type:
    String
  • primaryContactName
    Defines the primary contact in the company.
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Primary_Contact_Name
    Type:
    String
  • primaryContact Email
    Defines the email address of the company's primary contact.
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Primary_Contact_Email
    Type:
    String
  • primaryContact Phone
    Defines the phone number of the company's primary contact.
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Primary_Contact_Phone
    Type:
    String
  • notes
    Defines any company notes.
    Table and Column:
    BIZ_COM_SUP_PROPERTIES.Notes
    Type:
    String
Custom Information Schema Tag
The Custom Information tag is part of the schema mapping for the Company XOG object. This tag stores custom-defined fields (CDF). You must allow several CDFs for each company.
This schema tag has the following attributes:
  • ceoName
    Defines the name of the company's Chief Executive Officer.
    Table and Column:
    XDM_CDF_SRM_COMPANIES.XDM_CEO_NAME
    Type:
    String
  • defaultWebSite
    Defines the company's default Web address.
    Table and Column:
    XDM_CDF_SRM_COMPANIES.XDM_DEFALUTWEBSITE
    Type:
    String
  • numberOfEmployees
    Defines the number of employees in the company.
    Table and Column:
    XDM_CDF_SRM_COMPANIES.XDM_NUM_OF_EMPLOYEES
    Type:
    Number
  • opportunity
    Defines the opportunity for the company.
    Table and Column:
    XDM_CDF_SRM_COMPANIES.XDM_OPPORTUNITY
    Type:
    Boolean
    Default:
    False
  • internalContact
    Defines the name of the internal contact for the company. This is a browse field.
    Table and Column:
    XDM_CDF_SRM_COMPANIES.XDM_PRIM_INTERNAL_CONTACT
    Type:
    String
  • agreementStartDate
    Defines the agreement start date for the company.
    Table and Column:
    XDM_CDF_SRM_COMPANIES.XDM_AGREEMENT_START_DATE
    Type:
    Date
  • industry
    Defines the industry type for the company. This is a lookup value.
    Table and Column:
    XDM_CDF_SRM_COMPANIES.XDM_INDUSTRY
    Type:
    String
Financial Information Schema Tag
The Financial Information tag is part of the schema mapping for the Company XOG object. The attribute values are unlike other lookup values. They require you to provide a text string instead of a lookup code.
This tag has the following attributes:
  • status
    Defines the company's status.
    Values:
    • Active
    • Inactive
    • No new business
    Default:
    Active
    Table and Column:
    CLNTSUPP.STATUS_TYPE
    Type:
    String
  • location
    Indicates the company location. This is a browse field.
    Table and Column:
    CLNTSUPP.LOCATIONID
    Type:
    String
  • department
    Indicates the department associated with the company. This is a browse field.
    Table and Column:
    CLNTSUPP.DEPARTCODE
    Type:
    String
  • wipClass
    Defines the WIP Class associated with the company. This is a browse field.
    Table and Column:
    CLNTSUPP.CLNTWIPCLASS
    Type:
    String
  • projectClass
    Defines the project class associated with the company. This is a browse field.
    Table and Column:
    CLNTSUPP.PROJCLASS
    Type:
    String
  • companyClass
    Defines the company class associated with the company. This is a browse field.
    Table and Column:
    CLNTSUPP.COMPCLASS
    Type:
    String
  • batchCycle
    (Optional) Defines the batch cycle associated with the company.
    Table and Column:
    CLNTSUPP.BILLCYCLE
    Type:
    String
  • dateOpened
    Defines the opened date for the company.
    Table and Column:
    CLNTSUPP.OPENEDDATE
    Type:
    Date
Billing Address Schema Tag
The Billing Address tag is part of the schema mapping for the company XOG object. This is the Billing Address header. Each company can have one or many billing addresses.
This schema tag has the following attributes:
  • billingCompanyName
    Required. Defines the Bill To company name.
    Table and Column:
    CLNTBILLTO.COMPANY_CODE
    Type:
    String
  • billingCode
    Required. Defines the billing code for the company.
    Table and Column:
    CLNTBILLTO.BILL_TO_COMPANY_CODE
    Type:
    String
Billing Address Detail Schema Tag
The Billing Address Detail tag is part of the schema mapping for the company XOG object. It has the following attributes:
  • address1
    Defines the first line of the billing address for the company.
    Table and Column:
    ARMASTER.ADDR1
    Type:
    String
  • address2
    Defines the second line of the billing address for the company.
    Table and Column:
    ARMASTER.ADDR2
    Type:
    String
  • address3
    Defines the third line of the billing address for the company.
    Table and Column:
    ARMASTER.ADDR3
    Type:
    String
  • address4
    Defines the fourth line of the billing address for the company.
    Table and Column:
    ARMASTER.ADDR4
    Type:
    String
  • address5
    Defines the fifth line of the billing address for the company.
    Table and Column:
    ARMASTER.ADDR5
    Type:
    String
  • attentionName
    Defines the name of the individual responsible for the company's billing.
    Table and Column:
    ARMASTER.ATTENTION_NAME
    Type:
    String
  • attentionPhone
    Defines the phone number for the individual responsible for the company's billing.
    Table and Column:
    ARMASTER.ATTENTION_PHONE
    Type:
    String
OBS Associations Schema Tag
The OBS Associations tag is part of the schema mapping for the Company XOG object. The OBS Associations tag is also a shared xsd type and a wrapper for the OBSAssoc elements.
Example:
<xs:complexType name="OBSAssocsType"> <xs:annotation> <xs:documentation xml:lang="en"> <... list of OBS Associations ...> <OBSAssocs complete="false"> </xs:documentation>
The OBS Associations tables include:
  • PRJ_OBS_ASSOCIATIONS
  • PRJ_OBS_TYPES
  • PRJ_OBS_UNIT
  • PRJ_OBS_UNITS_FLAT
Attributes:
  • complete
    Defines whether the OBS associations are complete. This field is optional. When complete is
    true
    , existing OBS associations that are not listed in the import are deleted. When the value is
    false
    , the operation inserts and/or updates any existing OBS associations.
    Complete
    replaces deprecated forms 
    completed
    and
    IsComplete
    .
    Table and Column:
    Not applicable
    Type:
    String
    Default:
    False
  • id
    Required. Defines the unique ID for the OBS type.
    Table and Column:
    PRJ_OBS_TYPES.UNIQUE_NAME
    Type:
    String
  • name
    Defines the name of the OBS type.
    Table and Column:
    PRJ_OBS_TYPES.NAME
    Type:
    String
  • unitPath
    Required. This is a slash-delimited list of unit names that lead to the unit with which the object is associated.
    Example:
    "CAN/BC/VAN".
    Table and Column:
    PRJ_OBS_UNITS.NAME
    Type:
    String