Release 2.x‎ > ‎Install - Reference‎ > ‎Config Ref Guide‎ > ‎Definitions‎ > ‎Definition‎ > ‎Attributes‎ > ‎

Attribute

An Attribute is related to a Definition.

Syntax

<Attribute id="fullname" required="true"> 
   <Functions> 
      <Function id="OutConcat"> 
      </Function> 
      ... 
   </Functions> 
</Attribute>


Arguments

NameRequiredDescriptionExample
idYesThe unique identifier for the Attributeid="firstname"
requiredNoFlags the Attribute as being required. Valid settings are true or false. The default value is false. If the setting is true, then one of two things could happen. If there is a Function then it will be used to automatically generate a value for the Attribute. If there is not a Function then an error is returned to the Consumer Tier application.true
virtualNoUsed to indicate that the Attribute only exists in the OpenPTK Framework. There is no "real" attribute in the Service/Operation back-end user repository. The default value is falsevirtual="true"
typeNoDefines the data type for the Attribute. Valid settings are: String,Integer,Boolean,Object. If not set, the default value is StringString
encryptedNoIndicates that the data within the Attribute is encrypted. Valid settings are true and false. The default setting is falseNote: This flag is currently not being used.encrypted="true" 
multivalued NoDetermines if an Attribute supports multi-values. The default value is falsefalse
accessNoDefines what parts of the Framework should have "access" to the Attribute. Valid settings are public and private. The default setting is public. When set to public the Attribute is available to the internal Framework and to the Consumer Tier applications. When set to private the Attribute is only available to the internal Framework. private Attributes are typically used for Functions where they are used only for internal operations but should not be made available to the Consumer Tier applications (such as a users password). Note: This flag is currently not being used.access="private" 


Properties

None