Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 34 Next »

Overview


This represents all the fields that make up a user defined field. User Defined Fields (UDFs) allow you to track custom attributes of clients, engagements, projects, and resources that are specific to your business and that Projector was not originally designed to track. 

Format


PwsUserDefinedFieldDetail
  • PwsUserDefinedFieldDetail
    • UdfId: Int32
    • UdfName: String
    • UdfUid: Int64
    • BooleanValue: Boolean
    • DataType: String
    • DateValue: DateTime
    • IntegerValue: Int32 ** deprecated **
    • ResourceIdentityValue: PwsResourceRef
    • TextValue: String
    • UdfTreatment: String
    • StoplightValues: PwsStoplightValue
    • NumericValue: Double
    • RelationValue: PwsRelationValue

Elements


Element

Data Type

Required?

Default

Description

Sample Data

UdfId

Int32

On Insert: No

On Update: No


The user defined field Id is a unique identifier for a user defined field. For internal use only.


UdfName

String

On Insert: Yes

On Update: Yes (if UdfUid is not supplied)


The user defined field name is a unique identifier for a user defined field

Client's Sign On Date

UdfUid

Int64

On Insert: No

On Update: Yes (if UdfName is not supplied)


The user defined field Uid is a unique and immutable identifier for a user defined field

1152921504606856792

BooleanValue

Boolean

On Insert: No

On Update: No


The value of a boolean type user defined field. Applicable only when the DataType is "Y".

Y/N

DataType

String

On Insert: Yes

On Update: No


The user defined field data type

"D" for date

"I" for integer

"L" for text list

"R" for resource

"T" for text

"Y" for boolean

"P" for relationship type

"S" for stoplight

D

DateValue

DateTime

On Insert: No

On Update: No


The value of a date type user defined field (in midnight UTC). Applicable only when the DataType is "D".

2017-12-19T00:00:00Z

IntegerValue

Int32

deprecated


** This field has been deprecated in favor of "NumericValue" **

1

ResourceIdentityValue

PwsResourceRef

On Insert: No

On Update: No


The value of a resource type user defined field. Applicable only when the DataType is "R". Click here for more information.


TextValue

String

On Insert: No

On Update: No


The value of a text type user defined field. Applicable only when the DataType is "T".

Test

UdfTreatment

String

On Insert: Yes

On Update: No


This field determines how the UDF whether the UDF will be treated as "not available", "available" or "required

"N" for not available

"A" for available

"R" for required

N

StoplightValues

PwsStoplightValue

On Insert: No

On Update: No


The value(s) of a stoplight type user defined field. Applicable only when the DataType is "S". Click here for more information.


NumericValue

Double

On Insert: No

On Update: No


The value of an integer type user defined field. Applicable only when the DataType is "I".

8

RelationValue

PwsRelationValue

On Insert: No

On Update: No


The value of a relationship type user defined field. Applicable only when the DataType is "R". Click here for more information.


Usage Example(s)


Example 01 
                       <b:PwsUserDefinedFieldDetail>
                           <b:UdfId i:nil="true"/>
                           <b:UdfName>EN-Date</b:UdfName>
                           <b:UdfUid>1152921504606856799</b:UdfUid>
                           <b:BooleanValue i:nil="true"/>
                           <b:DataType>D</b:DataType>
                           <b:DateValue>2018-01-17T00:00:00Z</b:DateValue>
                           <b:IntegerValue i:nil="true"/>
                           <b:ResourceIdentityValue i:nil="true"/>
                           <b:TextValue i:nil="true"/>
                           <b:UdfTreatment>A</b:UdfTreatment>
                           <b:StoplightValues/>
                           <b:NumericValue i:nil="true"/>
                           <b:RelationValue i:nil="true"/>
                        </b:PwsUserDefinedFieldDetail>
  • No labels