Table of Contents

Systems.External.PublicUsers Entity

Namespace: Systems.External

/Users of the publicly offered services. This includes Internet, external and employee users. Entity: Ext_Public_Users (Obsoleted in version 22.1.6.73)

Note

OBSOLETE! Do not use!

Default Visualization

Default Display Text Format:
{CompanyName}
Default Search Members:
PhoneNumber; CompanyName
Code Data Member:
PhoneNumber
Name Data Member:
CompanyName
Category: Definitions
Show in UI: ShownByDefault

Track Changes

Min level: 0 - Do not track changes
Max level: 4 - Track object attribute and blob changes

Aggregate

An aggregate is a cluster of domain objects that can be treated as a single unit.

Aggregate Tree

Attributes

Name Type Description
AboutMeText string (1024) nullable About me text, written by the user.
Address string (128) nullable The primary address of the user. Can be specified with latin or local characters. Filter(like)
AlternateEmail string (64) nullable Alternate email of the user. Can be used for backup email for password restore. Filter(like)
City string (64) nullable The state of residence of the user. Can be specified with latin or local letters. Filter(like)
CompanyName string (64) nullable The name of the company, for which the user works, as specified by the user. Filter(like)
Country string (64) nullable The country of residence of the user, with latin letters. Filter(like)
CreatedOn datetime nullable The date and time when the user was created. Default(Now) Filter(ge;le)
DisplayText string Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.
Email string (64) The primary email of the user. Used for notifications and password restore. Required Filter(like)
FirstName string (64) First name of the user. Required Filter(like)
Id guid
IsActive boolean Specifies whether the user account is active and access should be allowed. Required Default(true) Filter(eq)
LastName string (64) Last name of the user. Required Filter(like)
Notes string (max) nullable Notes for this PublicUser.
ObjectVersion int32 The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.
PasswordAlgorithm string (16) Uniquely specifies the password storage algorithm among some system recognized algorithms. Usually specifies the hashing and the stretching functions. For example, 'PBKDF2-SHA1'. Required Filter(like)
PasswordHash string (128) Actual password storage. The format of the contents is determined by Password Algorithm. Required Filter(like)
PasswordRecoveryCode guid nullable Automatically generated unique code for the last password recovery attempt. Filter(multi eq) ReadOnly
PasswordRecovery
CreationTime		 datetime nullable Date and time when the last password recovery code was created. Filter(ge;le) ReadOnly
PhoneNumber string (16) nullable The primary phone number of the user. Filter(like)
PostalCode string (16) nullable The postal code of the default address of the user. Filter(like)
ProfilePicture byte[] nullable Profile picture of the user.
State string (64) nullable The state of residence of the user within the country. Can be specified with latin or local characters. Filter(like)

References

Name Type Description
Company Companies (nullable) Link to an internal company record, specified by internal employee. Filter(multi eq)
Person Persons (nullable) Link to an internal person record. Usually specified by internal employee, but can also be an automated process. Filter(multi eq)
PublicUserList PublicUserLists OBSOLETE! Do not use! The list in which the user account is saved. Obsolete Required Filter(multi eq) Obsoleted in version 25.1.1.47 Obsolete

Attribute Details

AboutMeText

About me text, written by the user.

Type: string (1024) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 1024
Show in UI: ShownByDefault

Address

The primary address of the user. Can be specified with latin or local characters. Filter(like)

Type: string (128) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 128
Show in UI: ShownByDefault

AlternateEmail

Alternate email of the user. Can be used for backup email for password restore. Filter(like)

Type: string (64) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

City

The state of residence of the user. Can be specified with latin or local letters. Filter(like)

Type: string (64) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

CompanyName

The name of the company, for which the user works, as specified by the user. Filter(like)

Type: string (64) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

Country

The country of residence of the user, with latin letters. Filter(like)

Type: string (64) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

CreatedOn

The date and time when the user was created. Default(Now) Filter(ge;le)

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Default Value: CurrentDateTime
Show in UI: ShownByDefault

DisplayText

Uses the repository DisplayTextFormat to build the display text from the attributes and references of current object.

Type: string
Category: Calculated Attributes
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

Email

The primary email of the user. Used for notifications and password restore. Required Filter(like)

Type: string (64)
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

FirstName

First name of the user. Required Filter(like)

Type: string (64)
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

Id

Type: guid
Indexed: True
Category: System
Supported Filters: Equals, EqualsIn
Default Value: NewGuid
Show in UI: CannotBeShown

IsActive

Specifies whether the user account is active and access should be allowed. Required Default(true) Filter(eq)

Type: boolean
Category: System
Supported Filters: Equals
Supports Order By: False
Default Value: True
Show in UI: ShownByDefault

LastName

Last name of the user. Required Filter(like)

Type: string (64)
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

Notes

Notes for this PublicUser.

Type: string (max) nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Maximum Length: 2147483647
Show in UI: ShownByDefault

ObjectVersion

The latest version of the extensible data object for the aggregate root for the time the object is loaded from the database. Can be used for optimistic locking.

Type: int32
Category: Extensible Data Object
Supported Filters: NotFilterable
Supports Order By: ****
Show in UI: HiddenByDefault

PasswordAlgorithm

Uniquely specifies the password storage algorithm among some system recognized algorithms. Usually specifies the hashing and the stretching functions. For example, 'PBKDF2-SHA1'. Required Filter(like)

Type: string (16)
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 16
Show in UI: ShownByDefault

PasswordHash

Actual password storage. The format of the contents is determined by Password Algorithm. Required Filter(like)

Type: string (128)
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 128
Show in UI: ShownByDefault

PasswordRecoveryCode

Automatically generated unique code for the last password recovery attempt. Filter(multi eq) ReadOnly

Type: guid nullable
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

PasswordRecoveryCreationTime

Date and time when the last password recovery code was created. Filter(ge;le) ReadOnly

Type: datetime nullable
Category: System
Supported Filters: GreaterThanOrLessThan
Supports Order By: False
Show in UI: ShownByDefault

PhoneNumber

The primary phone number of the user. Filter(like)

Type: string (16) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 16
Show in UI: ShownByDefault

PostalCode

The postal code of the default address of the user. Filter(like)

Type: string (16) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 16
Show in UI: ShownByDefault

ProfilePicture

Profile picture of the user.

Type: byte[] nullable
Category: System
Supported Filters: NotFilterable
Supports Order By: False
Show in UI: ShownByDefault

State

The state of residence of the user within the country. Can be specified with latin or local characters. Filter(like)

Type: string (64) nullable
Category: System
Supported Filters: Like
Supports Order By: False
Maximum Length: 64
Show in UI: ShownByDefault

Reference Details

Company

Link to an internal company record, specified by internal employee. Filter(multi eq)

Type: Companies (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

Person

Link to an internal person record. Usually specified by internal employee, but can also be an automated process. Filter(multi eq)

Type: Persons (nullable)
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

PublicUserList

OBSOLETE! Do not use! The list in which the user account is saved. Obsolete Required Filter(multi eq) Obsoleted in version 25.1.1.47 Obsolete

Type: PublicUserLists
Category: System
Supported Filters: Equals, EqualsIn
Show in UI: ShownByDefault

API Methods

Methods that can be invoked in public APIs.

GetAllowedCustomPropertyValues

Gets the allowed values for the specified custom property for this entity object. If supported the result is ordered by property value. Some property value sources do not support ordering - in that case the result is not ordered.
Return Type: Collection Of CustomPropertyValue
Declaring Type: EntityObject
Domain API Request: GET

Parameters

  • customPropertyCode
    The code of the custom property
    Type: string

  • search
    The search text - searches by value or description. Can contain wildcard character %.
    Type: string
    Optional: True
    Default Value: null

  • exactMatch
    If true the search text should be equal to the property value
    Type: boolean
    Optional: True
    Default Value: False

  • orderByDescription
    If true the result is ordered by Description instead of Value. Note that ordering is not always possible.
    Type: boolean
    Optional: True
    Default Value: False

  • top
    The top clause - default is 10
    Type: int32
    Optional: True
    Default Value: 10

  • skip
    The skip clause - default is 0
    Type: int32
    Optional: True
    Default Value: 0

CreateNotification

Create a notification immediately in a separate transaction, and send a real-time event to the user.
Return Type: void
Declaring Type: EntityObject
Domain API Request: POST

Parameters

  • user
    The user.
    Type: Users

  • notificationClass
    The notification class.
    Type: string

  • subject
    The notification subject.
    Type: string

CreateCopy

Duplicates the object and its child objects belonging to the same aggregate. The duplicated objects are not saved to the data source but remain in the same transaction as the original object.
Return Type: EntityObject
Declaring Type: EntityObject
Domain API Request: POST

Business Rules

None

Front-End Business Rules

None

API

Domain API Query: https://demodb.my.erp.net/api/domain/odata/Systems_External_PublicUsers?$top=10

Domain API Query Builder: https://demodb.my.erp.net/api/domain/querybuilder#Systems_External_PublicUsers?$top=10

Suggest improvement to this page