Versions Compared

Old Version 41

changes.mady.by.user Bettina Borces

Saved on

compared with

New Version 42

changes.mady.by.user Luke Wright

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview


This represents all the fields that make up a user defined field value. 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. . Each user defined field has a designated data type, and the format of the UDF value depends upon the UDF's data type.

Format


Panel
titlePwsUserDefinedFieldDetail
  • 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

...

Element

Data Type

Required?

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

One of UdfName or UdfUid is required

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

EN-Date

UdfUid

Int64

See UdfName

A unique and immutable identifier for a user defined field.

1152921504606856799

BooleanValue

Boolean

On Insert: No

On Update: No

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


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 (in midnight UTC)

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".

2018-01-17T00:00:00Z

IntegerValue

Int32

deprecated

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


ResourceIdentityValue

PwsResourceRef

On Insert: No

On Update: No

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


TextValue

String

On Insert: No

On Update: No

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


UdfTreatment

String

On Insert: Yes

On Update: NoN/A

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

"N" for not available. Generally speaking, the UDF is not displayed, unless there is already a value set for it. When there is a value, the user is typically allowed to clear the value, but not change it.

"A" for available. The UDF is displayed and editable (so long as user has appropriate permissions).

"R" for required. The UDF is displayed, editable and required. The UI would insist on a non-empty value.

This is populated when fetching UDF values from the database, but ignore on insert or update.

A

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".


NumericValue

Double

On Insert: No

On Update: No

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


RelationValue

PwsRelationValue

On Insert: No

On Update: No

The value of a relationship type user defined field. Relationship type user defined fields are designed to integrate with another system (i.e. Zendesk or Jira) and are only applicable to time cards and cost cards. Applicable only when the DataType is "P".


...