XOG: User

ccppmop1571
Use the user XOG object to view inbound and outbound user object instance attributes.
Schema Name
nikuxog_user.xsd
Read and Write XML Files
The following XML files are included:
  • cmn_users_read.xml. Use this file to export users from 
    Clarity PPM
    .
  • cmn_users_write.xml. Use this file to import users that were previously exported from 
    Clarity PPM
    .
Business Rules and Processing
Users are defined for both inbound (write) and outbound (read) processing. Password and Password_Confirm, used to validate the user, are not exposed but are populated with default values (2000). When a user first logs in, they are prompted to reset this default password.
  • Resource
    A labor resource is automatically created for every user who is imported through XOG.
  • Company ID
    A browse field that is used to associate a user with a company is run against SRM_COMPANIES. If the company does not exist, the user is posted without a company and a warning message is posted to the Success and Error file. If the company_id exists, the field is populated with that value.
  • Lookup values
    The schema requires lookup codes that are validated against CMN_LOOKUPS.
  • User type
    If not provided, this entry defaults to internal. There is no admin type.
  • OBS association
    With the new OBS Security, a Security OBS is required and any OBS can be associated with a user. To accommodate this situation, there is an OBS Associations portlet. The OBS association fields can be used for import and export.
Read Filters
This XOG allows for outbound (read) processing of users who are based on the following two fields: User Status and User Type. And and Or processing is supported between these two fields and for processing within Type. The following combinations are supported:
  • User Status = x
    where x = Active, Inactive, or LOCK
  • User Type = x
    where x = Internal, External
  • User Status = x AND User Type = y
    where x = Active, Inactive, or LOCK where y = one of many User Types
Error Handling
If an error occurs for a user transaction, the following information is written to the Success and Error file:
  • externalId
  • ExternalSource
Schema Mappings
The following schema mappings are described.
Personal Information (CMN_SENC_USERS) Schema Tag
This tag is part schema mapping for the user XOG object and has the following attributes:
  • firstName
    Required.
    Table and Column:
    CMN_SEC_USERS.First Name
    Type:
    String
  • lastName
    Required.
    Table and Column:
    CMN_SEC_USERS.Last Name
    Type:
    String
  • userName
    Required. A unique primary key.
    Table and Column:
    CMN_SEC_USERS.User_Name
    Type:
    String
  • userType
    Optional.
    Values:
    Internal and External
    Default:
    Internal
    Table and Column:
    CMN_SEC_USERS.User_Type_Id
    Type:
    String
  • userStatus
    Required.
    Values:
    Active, Inactive, and LOCK
    Default:
    Active
    Table and Column:
    CMN_SEC_USERS.User_Status_ID
    Type:
    String
  • emailAddress
    Required.
    Table and Column:
    CMN_SEC_USERS.Email Address
    Type:
    String
  • userLocale
    Optional. The Java Locale format, for example, en_US.
    Table and Column:
    CMN_SEC_USERS.locale
    Type:
    String
  • userTimezone
    Optional. The Java TimeZone format, for example, Europe/London, PST.
    Table and Column:
    CMN_SEC_USERS.timezone
    Type:
    String
  • userLanguage
    Required. Defines the language that is displayed when the user first logs in.
    Values:
    English, German, Spanish, and French
    Default:
    English
    Table and Column:
    CMN_SEC_USERS.Language
    Type:
    String
  • resource
    Optional. A browse field with a one-to-one relationship between users and resources.
    Table and Column:
    CMN_SEC_USERS.Resource
    Type:
    String
  • companyId
    Optional. Browse field. The company association with the user.
    Table and Column:
    CMN_SEC_USERS.Company_ID
    Type:
    String
  • externalSource
    Required by the schema. A lookup value that is the originating system ID (for example, Oracle).
    Table and Column:
    CMN_SEC_USERS.External_Source_ID
    Type:
    String (in the schema) and Number (in the application)
  • externalId
    Required by the XML schema. The originating unique identifier.
    Table and Column:
    CMN_SEC_USERS.External_ID
    Type:
    String
OBS Associations (OBSAssocs) Schema Tag
This tag is a part of the schema mapping for the user 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 OBSAssocs tag contains the following element, plus zero or more OBSAssoc subelements.
  • 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 new OBS units or updates any existing ones.
    Complete
    replaces deprecated forms 
    completed
    and
    IsComplete
    .
    Default:
    False
    Table and Column:
    None
    Type:
    Boolean
The OBSAssoc element contains the following attributes:
  • id
    Required.
    Table and Column:
    PRJ_OBS_TYPES.UNIQUE_NAME
    Type:
    String
  • name
    Optional.
    Table and Column:
    PRJ_OBS_TYPES.PRJ_OBS_TYPES.NAME
    Type:
    String
  • unitPath
    Required. Slash-delimited list of unit names leading up to the unit to which the object is associated.
    Table and Column:
    PRJ_OBS_TYPES.PRJ_OBS_UNITS.NAME
    Type:
    String
    Example:
    CAN/BC/VAN
Group Assignments Schema Tag
This tag is part of the schema mapping for the
user
XOG object. The Group Assignments schema tag is not mapped to any table and is a wrapper for the Group elements. This tag has the following attribute:
  • complete
    Optional. If complete and set to
    true
    , any existing Group assignments that are not listed in the import are deleted.
    Complete
    replaces deprecated forms 
    completed
    and
    IsComplete
    .
    Default:
    False
    Table and Column:
    none
    Type:
    String
The Group Assignments element has the following attribute:
  • id
    Required.
    Table and Column:
    CMN_SEC_GROUPS.GROUP_CODE
    Type:
    String
Global Access Right Assignments (GlobalRights) Schema Tag
This tag is part of the schema mapping for the
user
XOG object. This tag is a wrapper element for one or more Right elements. The Global Access Right Assignments schema tag is not mapped to any table and has the following attribute:
  • complete
    Optional. When this value is
    true
    , any existing Right assignments that are not listed in the import are deleted.
    Complete
    replaces deprecated forms 
    completed
    and
    IsComplete
    .
    Default:
    False
    Table and Column:
    None
    Type:
    String
Right Assignment (Right) Element
  • id
    Required.
    Table and Column:
    CMN_SEC_GROUPS.GROUP_CODE
    Type:
    String
Instance Access Right Assignments (InstanceRights) Schema Tag
This tag is part of the schema mapping for the user XOG object. It is a wrapper element for one or more Right elements. The Instance Access Right Assignments schema tag is not mapped to any table and has the following attribute:
  • complete
    Optional. When this value is
    true
    , any existing Right assignments that are not listed in the import are deleted.
    Complete
    replaces deprecated forms 
    completed
    and
    IsComplete
    .
    Default:
    False
    Table and Column:
    None
    Type:
    String
Right Assignment (Right) Element
  • id
    Required.
    Table and Column:
    CMN_SEC_GROUPS.GROUP_CODE
    Type:
    String
Instance OBS Access Right Assignments (InstanceOBSRights) Schema Tag
This tag is part of the schema mapping for the
user
XOG object and is a wrapper element for the Right elements. The Instance OBS Access Right Assignments schema tag is not mapped to any table and has the following attribute:
  • complete
    Optional. If complete and set to
    true
    , any existing Right assignments that are not listed in the import are deleted.
    Complete
    replaces deprecated forms 
    completed
    and
    IsComplete
    .
    Default:
    False
    Table and Column:
    None
    Type:
    String
Right Assignment (Right) Element
  • id
    Required.
    Table and Column:
    CMN_SEC_GROUPS.GROUP_CODE
    Type:
    String
Instance Object (InstanceObject) Schema Tag
This tag is part schema mapping for the user XOG object. This tag has the following attributes that are mapped to any of the following tables, unless otherwise noted:
  • SRM_RESOURCES
  • SRM_PROJECTS
  • BPM_DEF_PROCESSES
  • CMN_PAGES
  • CMN_PORTLETS
  • CMN_SCH_JOB_DEFINITIONS
  • INV_APPLICATION
  • INV_ASSET
  • INV_OTHER
  • INV_PRODUCT
  • SCENARIO
  • id
    Required. The unique code from one of the listed tables.
    Type:
    String
  • name
    Optional. The name from one of the listed tables.
    Type:
    String
  • type
    Required. The key to determine which table is mapped. This attribute is not mapped to any table.
    Type:
    String
Language Support (nls) Schema Tag
This tag is part schema mapping for the user XOG object and has the following attributes:
  • name
    Optional.
    Table and Column:
    CMN_CAPTIONS_NLS.NAME
    Type:
    String
  • description
    Optional.
    Table and Column:
    CMN_CAPTIONS_NLS.DESCRIPTION
    Type:
    String
  • languageCode
    Optional.
    Table and Column:
    CMN_CAPTIONS_NLS.LANGUAGE_CODE
    Type:
    String