Custom Attribute Value (PPL6130) API
This API allows the programmer to set or get Custom Attribute Values attached to entities in the system. It will execute only on the Management System. The program is contained in the Central Administration library PTPLLIB.
Required Parameter Group
| 1. | Function | Input | Char(1) |
| 2. | EntityID | Input | Char(16) |
| 3. | EntityClass | Input | Char(4) |
| 4. | AttributeName | Input | Char(20) |
| 5. | Value | I/O | Char(*) |
| 6. | Length | I/O | Unsigned Binary(4) |
Optional parameter group 1:
| 7. | MaxLength | Input | Unsigned Binary(4) |
Required parameter group:
Function
INPUT; CHAR(1)
Determines the function of the API, either getting a value or putting a value. G=Get Value, S=Set Value.
EntityID
INPUT; CHAR(16)
Specifies the internal ID of the entity that owns the value.
EntityClass
INPUT; CHAR(4)
Specifies the class of entity that owns the value. Some typical entity classes include:
| Entity Class | Entity | Provider |
|---|---|---|
| PLTT | Template | Central Administration |
| PLTA | Template System Allowance | Central Administration |
| PMPR | Person | Identity Manager |
| PMCM | Company | Identity Manager |
| PMDP | Department | Identity Manager |
| PMPO | Position | Identity Manager |
AttributeName
INPUT; CHAR(20)
The name of the Custom Attribute whose value you want to get or set.
Value
I/O; CHAR(*)
The maximum size of a Custom Attribute value is 512 bytes. You can pass a shorter variable as long as you specify the length parameters correctly.
SET: Provides the value to be stored.
GET: The buffer into which the retrieved value is placed. The output variable will always be filled with blanks (the number of which is specified by MaxLength) before the fetched value is inserted into the variable.
Length
I/O; UNSIGNED BINARY(4)
SET: The length of the significant data in the Value parameter, measured in bytes.
GET: The number of bytes placed into the Value buffer is returned to you in this parameter.
Optional parameter group 1
MaxLength
INPUT; UNSIGNED BINARY(4)
GET: Indicate the maximum size of your variable in bytes. If you do not pass this length, your variable is assumed to be 512 bytes. Unpredictable results may occur if you specify a larger number of bytes than your variable can contain.
Error Messages
| Message ID | Error Message Text |
|---|---|
| T613001 | Function is invalid. |
| T613002 | Entity ID is invalid. |
| T613003 | Entity Class is invalid. |
| T613004 | Custom Attribute Name is invalid. |
| T613006 | Values cannot be set for the specified Entity Class. |
| T613007 | Custom Attribute Value not saved. |
| T613008 | Value length &1 exceeds the size of your output buffer. |