[Fix Pack 29 or later]

IdMgrDataModel command group for the AdminTask object

You can use the Jython or Jacl scripting language to manage the federated repository schema using the wsadmin tool. Use the commands and parameters in the IdMgrDataModel group to manage the property extension repository. The commands are available in connected or local mode using the –conntype NONE option.

The IdMgrDataModel command group for the AdminTask object includes the following commands:

addIdMgrPropertyToEntityTypes

Use the addIdMgrPropertyToEntityTypes command to add a new property to one or more existing entity types with specified parameters.

Target Object

None.

Required parameters

-name
Use this parameter to specify the name of the new property that is added to one or more existing entity types.

(String, required)

-dataType
Use this parameter to specify the data type of the property. The default supported data types are: [Updated in August 2011]
  • String
  • Int
  • Boolean
  • Long
  • Double
  • Base64binary
  • AnySimpleType
  • AnyURI
  • Byte
  • DateTime
  • Date
  • Short
  • Token
  • IdentifierType
[Updated in August 2011]
aug2011

(String, required)

-entityTypeNames
Use this parameter to specify the name of one or more existing entity types to which the new property is added. Use a semicolon (;) as the delimiter to specify multiple entity types.

You can use a valid namespace prefix (nsPrefix) to refer to the entity type names in a specific namespace. The default namespace prefix is wim. Use a colon (:) to specify the namespace prefix. For example, you can use: your_ext:Person_Account

  • your_ext is the namespace prefix, which is mapped to the http://www.yourco.com/yourext namespace URI.
  • Person_Account is the entity type name.

(String, required)

Optional parameters

-nsURI
Use this parameter to specify the namespace to which the new property is added.

You must map each namespace URI (nsURI) value to a unique namespace prefix (nsPrefix) value the first time that you use the namespace URI. The new property is added to the default namespace if you do not specify a nsURI value. The default namespace is http://www.ibm.com/websphere/wim, which is mapped, by default, to the wim nsPrefix value.

(String, optional)

-nsPrefix
Use this parameter to specify the prefix for the namespace.

You must specify a namespace prefix (nsPrefix) value, if you specify a new namespace URI (nsURI) value, so that the new nsURI value is mapped to this nsPrefix value. The default nsPrefix value is wim, which is mapped, by default, to the http://www.ibm.com/websphere/wim nsURI value.

(String, optional)

-isMultiValued
Use this parameter to specify whether the new property accepts more than one value. The default value is false.

(Boolean, optional)

-repositoryIds
Use this parameter to specify the repository or repositories to which the new property is added.

Use a semicolon (;) as the delimiter to specify multiple repository identities. All of the configured repositories are included, if this parameter is not specified.

To add the new property into the property extension repository, specify LA as the value of this parameter.

To add the new property to the entity types for all the specified repositories, specify a list of repository identities and do not include LA in the list.

To extend the property to the property extension repository for particular Lightweight Directory Access Protocol (LDAP) repositories, specify a list that includes LA. The new extended property is then marked as not supported for the other LDAP repositories that are included in this list.

(String, optional)

-requiredEntityTypeNames
Use this parameter to specify one or more entity types for which the new property is required.

Use a semicolon (;) as the delimiter to specify multiple entity types.

You can use a valid namespace prefix (nsPrefix) to refer to the entity type names in a specific namespace. The default namespace prefix is wim. Use a colon (:) to specify the namespace prefix. For example, you can use: your_ext:Person_Account

Where:
  • your_ext is the namespace prefix, which is mapped to the http://www.yourco.com/yourext namespace URI.
  • Person_Account is the entity type name.
For example, if you are adding the contactNumber property to the PersonAccount and Group entity types and you require that all PersonAccount entity types have a contactNumber value, then specify:
{-name contactNumber -entityTypeNames PersonAccount;Group  -requiredEntityTypeNames PersonAccount}

(String, optional)

-applicationId
Use this parameter to indicate the ID of the application for which the property is extended.

You can use the listIdMgrPropertyExtensions command to retrieve the extended properties for a specific application ID, if you specify a value for the applicationId parameter.

(String, optional)

Examples

Batch mode example usage:

Interactive mode example usage:

listIdMgrPropertyExtensions

Use the listIdMgrPropertyExtensions command to list the properties extended for entity types.

Target Object

None.

Required parameters

None.

Optional parameters

-applicationId
Use this parameter to indicate the ID of the application for which the extended properties are listed.

If you do not specify this parameter, all the extended properties are listed.

(String, optional)

Return value

This parameter returns a hash map that contains the property name as the key. The value of each key is another hash map, which contains the same keys as the input parameters of the addIdMgrPropertyToEntityTypes command. For multivalued parameters, the value of the key is a List object.

Examples

Batch mode example usage:

Interactive mode example usage:

Supported configurations Supported configurations: This command lists the extended properties that are present in the wimxmlextension.xml file only.sptcfg



Related tasks
Using the AdminTask object for scripted administration
Related reference
Commands for the AdminTask object
IdMgrDBSetup command group for the AdminTask object
Reference topic Reference topic    

Terms and conditions for information centers | Feedback

Last updatedLast updated: Aug 30, 2013 6:03:36 PM CDT
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=pix&product=was-base-iseries&topic=rxml_atidmgrDataModel
File name: rxml_atidmgrDataModel.html