Overview
This structure contains the complete set of information about a user. A user is anyone who needs to log into Projector. This might be to enter time and expenses, to manage a project, or to administer Projector itself. There are different types of users in Projector like client users, proxy users, installation owners, and more. The structure is used both to retrieve detailed user information and to pass information about a user back to the server to get updated.
...
| Panel | ||
|---|---|---|
| ||
|
Elements
Element | Data Type | Required? | Default | Description | ||
|---|---|---|---|---|---|---|
UserDisplayName | String (30) | On Insert: Yes On Update: One of UserDisplayName, UserReferenceSystemId or UserUID is Required | The user's display name is a unique identifier for a user. | |||
UserId | Int32 | No | The user id is a unique identifier for a user. For internal use only. | |||
UserReferenceSystemId | String (20) | See UserDisplayName | The user's reference system id is a unique identifier for a user. | |||
UserUid | Int64 | See UserDisplayName | A unique and immutable Id for a user. | |||
EmailAddress | String (100) | On Insert: Yes On Update: No | The user's email address. | |||
FirstName | String (20) | On Insert: Yes On Update: No | The user's first name. | |||
LastName | String (20) | On Insert: Yes On Update: No | The user's last name | |||
MiddleName | String (20) | No | The user's middle name | |||
ClientIdentity | No | If the user is a client user, this is the client it is associated with. | ||||
PrimaryUserTypeCostCenter | Yes | The cost center of this user's primary user type | ||||
AdditionalUserTypes | No | The cost center(s) of this user's non-primary user type(s) | ||||
AdvancedAnalyticsPermissionSetting | String | No | set by user types | The advanced analytics permission setting: N – None (no access to advanced analytics) V – View (can view advanced analytics dashboards, etc) A – Administration (can administer advanced analytics dashboards) Note: The associated override flag, "OverrideAdvancedAnalyticsPermissionSettingFlag" must be set to true in order to specify this setting. | ||
AllowBookOwnTimeFlag | Boolean | No | If set to 'true', the user is allowed to request their own time on projects Note: The associated override flag, "OverrideAllowBookOwnTimeFlag" must be set to true in order to specify this setting. | |||
AllowRequestOwnTimeFlag | Boolean | No | If set to 'true', the user will be allowed to request their own time on projects Note: The associated override flag, "OverrideAllowRequestOwnTimeFlag" must be set to true in order to specify this setting. | |||
CultureIdentity | No | The culture associated with this user | ||||
DefaultTabGroupIdentity | No | set by user types | The user's default tab group. Note: The associated override flag, "OverrideDefaultPublicTabGroupFlag" must be set to true in order to specify this setting. | |||
EnableManagementPortalFlag | Boolean | No | set by user types | If set to ' true', the user has will have permission to access the Projector Management Portal. Note: The associated override flag, "OverrideEnableManagementPortalFlag" must be set to true in order to specify this setting. | ||
EndDate | DateTime | No | The StartDate and EndDate have to do with the users active/inactive status. In order to support scheduled inactivation or activation of users, an EndDate can be set to a date in the future (the user will remain as of this moment, active, but as of the specified date the user will automatically become inactive), or StartDate can be set to a date in the future (the user will be inactive as of this moment, but will become active on the specified date). The activation/deactivation is sensitive to the installation’s time zone (i.e. the user will become active or inactive on midnight of the specified date in the installation time zone). A user cannot have both a start date and an end date, they can only have one or neither. Please clear the unused date using EndDateClearFlag or StartDateClearFlag in PwsSaveUser. | |||
LimitedAccessFlag | Boolean | No | set by user types | If set to 'true', the user will be a limited access user. Click here for more information. Note: The associated override flag, "OverrideLimitedAccessFlag" must be set to true in order to specify this setting. | ||
LoginName | String (100) | This is only required if the user does not user his/her email address to log in | The user's login name | |||
MobilePhone | String (30) | No | The user's mobile phone number. | |||
OfficePhone | String (30) | No | The user's office phone number | |||
OtherContactInformation | String (1000) | No | Any other contact information associated with this user (i.e. email addresses, mailing addresses, etc...). | |||
OverrideAdvancedAnalyticsPermissionSettingFlag | Boolean | No | false | If set to 'true', the override flag for the Advanced Analytics permission is set to 'true'. | ||
OverrideAllowBookOwnTimeFlag | Boolean | No | false | If set to 'true', the override flag for the "Allow resource to book their own time" setting is set to 'true'. | ||
OverrideAllowRequestOwnTimeFlag | Boolean | No | false | If set to 'true', the override flag for the "Allow resource to request their own time" setting is set to 'true'. | ||
OverrideDefaultPublicTabGroupFlag | Boolean | No | false | If set to 'true', the override flag for the "Use default tab group" setting is set to 'true'. | ||
OverrideEnableManagementPortalFlag: Boolean ** deprecated - replaced with: OverrideEnabledComponentsFlag** | Boolean | No | false | If set to 'true', the override flag for the "Allow access to Management Portal" setting is set to 'true'.** deprecated - replaced with: OverrideEnabledComponentsFlag** | ** deprecated - replaced with: OverrideEnabledComponentsFlag** | ** deprecated - replaced with: OverrideEnabledComponentsFlag** |
OverrideLimitedAccessFlag | Boolean | No | false | If set to 'true', the override flag for the "Limit access to projects in time entry, expense entry, and project workspaces" setting is set to 'true'. | ||
OverrideProjectManagerFlag | Boolean | No | false | If set to 'true', the override flag for the Include in Project Manager List setting is set to 'true'. | ||
OverrideRequestTimeOffPermissionSettingFlag | Boolean | No | false | If set to 'true', the override flag for the request time off permission is set to 'true'. | ||
OverrideSkillPermissionSettingFlag | Boolean | No | false | If set to 'true', the override flag for the skills permission is set to 'true'. | ||
OverrideSsoSettingFlag | Boolean | No | false | If set to 'true', the override flag for the single sign on permission is set to 'true'. | ||
OverrideTimeZoneFlag | Boolean | No | false | If set to 'true', the override timezone flag permission is set to 'true'. | ||
OverrideUseDelegatedAuthenticationFlag | Boolean | No | false | If set to 'true', the override flag for the "Use delegated authentication" setting is set to 'true'. | ||
ProjectManagerFlag | Boolean | No | set by user types | If set to 'true', this user is included in the list of potential project managers wherever Projector requires entry of the name of a project manager. Note: The user must be associated with a resource that is in the engagement's cost center or in a child of the engagement cost center in order to be a project manager candidate for a given engagement. Note: The associated override flag, "OverrideProjectManagerFlag" must be set to true in order to specify this setting. | ||
RequestTimeOffPermissionSetting | String | No | set by user types | The request time off permission setting: N – Cannot Request (no ability to request time off) A – Request Pending Approval (can request time off but it needs to be approved) U – Update (can submit time off with no need for approval) Note: The associated override flag, "OverrideRequestTimeOffPermissionSettingFlag" must be set to true in order to specify this setting. | ||
SkillPermissionSetting | String | No | set by user types | The skill permission setting: N – None (no ability to view or maintain skills) V – View (can view skills but cannot maintain them) A – Update Pending Approval (can update skills, but changes need to be approved) U – Update (can update skills with no need for approval) Note: The associated override flag, "OverrideSkillPermissionSettingFlag" must be set to true in order to specify this setting. | ||
SsoSetting | String | No | set by user types | The single sign on setting: N – SSO Not Enabled A – SSO Enabled (user has option to sign in via SSO) R – SSO Required (user must sign in via SSO) Note: The associated override flag, "OverrideSsoSettingFlag" must be set to true in order to specify this setting. | ||
StartDate | DateTime | Yes | The StartDate and EndDate have to do with the users active/inactive status. In order to support scheduled inactivation or activation of users, an EndDate can be set to a date in the future (the user will remain as of this moment, active, but as of the specified date the user will automatically become inactive), or StartDate can be set to a date in the future (the user will be inactive as of this moment, but will become active on the specified date). The activation/deactivation is sensitive to the installation’s time zone (i.e. the user will become active or inactive on midnight of the specified date in the installation time zone). A user cannot have both a start date and an end date, they can only have one or neither. Please clear the unused date using EndDateClearFlag or StartDateClearFlag in PwsSaveUser. | |||
TimeZoneIdentity | No | set by Account Setting | The time zone associated with this user. Note: The associated override flag, "OverrideTimeZoneFlag" must be set to true in order to specify this setting. | |||
UseDelegatedAuthenticationFlag | Boolean | No | set by user types | If set to 'true', this user authenticates to Projector via delegated authentication. Delegated authentication allows a user to login to Projector using their company's own authentication servers. The account must be configured for delegated authentication to enable the user to be set up for it. Note: The associated override flag, "OverrideUseDelegatedAuthenticationFlag" must be set to true in order to specify this setting. | ||
ApproveExpenseAlertLevel | String | No | "A" - Show all alerts the user has permission to approve | This setting determines which expense alerts appear on a user's home page if the user has permission to approve expenses. "A" - Show all alerts the user has permission to approve "C" - Show alerts for all items in the user's cost center as well as for items sent directly to the user "N" - Only show alerts have been sent directly to the user | ||
ApproveTimeOffRequestAlertLevel | String | No | "A" - Show all alerts the user has permission to approve | This setting determines which expense alerts appear on a user's home page if the user has permission to approve expenses. "A" - Show all alerts the user has permission to approve "C" - Show alerts for all items in the user's cost center as well as for items sent directly to the user "N" - Only show alerts have been sent directly to the user | ||
FulfillSchedulingRequestAlertLevelflag, "OverrideUseDelegatedAuthenticationFlag" must be set to true in order to specify this setting. | ||||||
ApproveExpenseAlertLevel | String | No | "A" - Show all alerts the user has permission to approve | This setting determines which expense alerts appear on a user's home page if the user has permission to approve expenses. "A" - Show all alerts the user has permission to approve "C" - Show alerts for all items in the user's cost center as well as for items sent directly to the user "N" - Only show alerts have been sent directly to the user | ||
OverrideApproveExpenseAlertLevelFlagApproveTimeOffRequestAlertLevel | BooleanString | No | false | If set to true, the ApproveExpenseAlertLevelFlag can be set to a value other than the default | ||
OverrideApproveTimeOffRequestAlertLevelFlag | Boolean | No | false | If set to true, the ApproveTimeOffRequestAlertLevelFlag can be set to a value other than the default | ||
OverrideFulfillSchedulingRequestAlertLevelFlag | Boolean | No | false | If set to true, the FulfillSchedulingRequestAlertLevelFlag can be set to a value other than the default | ||
EnableWebApplicationsFlag | Boolean | No | On upgrade, all users get enableWebApplicationsFlag set to true and all users except for client users get enableWebServicesAndIntegrationsFlag set to true (client users get false). If a client currently overrides the R23 enable management portal flag, they will override the set of three flags. On create or update, the flags will be set to inherit from user types by default. If the user specifies the inherit flag (all three flags, management portal, web applications and web services/integrations are governed by a single override flag), if all of the three flags are null, it is an error; otherwise those flags that are null will be set according to values inherited from user types. | If set to true, the user will have permission to access web applications | ||
EnableWebServicesAndIntegrationsFlag | Boolean | No | On upgrade, all users get enableWebApplicationsFlag set to true and all users except for client users get enableWebServicesAndIntegrationsFlag set to true (client users get false). If a client currently overrides the R23 enable management portal flag, they will override the set of three flags. On create or update, the flags will be set to inherit from user types by default. If the user specifies the inherit flag (all three flags, management portal, web applications and web services/integrations are governed by a single override flag), if all of the three flags are null, it is an error; otherwise those flags that are null will be set according to values inherited from user types. | If set to true, the user will have permission to access web services and integrations | ||
OverrideEnabledComponentsFlag | Boolean | No | On upgrade, all users get enableWebApplicationsFlag set to true and all users except for client users get enableWebServicesAndIntegrationsFlag set to true (client users get false). If a client currently overrides the R23 enable management portal flag, they will override the set of three flags. On create or update, the flags will be set to inherit from user types by default. If the user specifies the inherit flag (all three flags, management portal, web applications and web services/integrations are governed by a single override flag), if all of the three flags are null, it is an error; otherwise those flags that are null will be set according to values inherited from user types."A" - Show all alerts the user has permission to approve | This setting determines which expense alerts appear on a user's home page if the user has permission to approve expenses. "A" - Show all alerts the user has permission to approve "C" - Show alerts for all items in the user's cost center as well as for items sent directly to the user "N" - Only show alerts have been sent directly to the user | ||
FulfillSchedulingRequestAlertLevel | String | No | "A" - Show all alerts the user has permission to approve | This setting determines which expense alerts appear on a user's home page if the user has permission to approve expenses. "A" - Show all alerts the user has permission to approve "C" - Show alerts for all items in the user's cost center as well as for items sent directly to the user "N" - Only show alerts have been sent directly to the user | ||
OverrideApproveExpenseAlertLevelFlag | Boolean | No | false | If set to true, the ApproveExpenseAlertLevelFlag can be set to a value other than the default | ||
OverrideApproveTimeOffRequestAlertLevelFlag | Boolean | No | false | If set to true, the ApproveTimeOffRequestAlertLevelFlag can be set to a value other than the default | ||
OverrideFulfillSchedulingRequestAlertLevelFlag | Boolean | No | false | If set to true, the FulfillSchedulingRequestAlertLevelFlag can be set to a value other than the default | ||
EnableWebApplicationsFlag | Boolean | No | set by user types | If set to true, the user will have permission to access web applications | ||
EnableWebServicesAndIntegrationsFlag | Boolean | No | set by user types | If set to true, the user will have permission to access web services and integrations | ||
OverrideEnabledComponentsFlag | Boolean | No | false | If set to true, the users settings for the flags EnableWebApplicationsFlag flags EnableManagementPortalFlag, EnableWebApplicationsFlag and EnableWebServicesAndIntegrationsFlag can be overridden | ||
| OverrideViewManagedResourceHomePageSettingFlag | Boolean | No | false | |||
| OverrideViewManagedResourceTimeSettingFlag | Boolean | No | false | |||
| ViewManagedResourceHomePageSetting | String(1) | No | "N" - Not view managed resource's home page | This setting determines which managed resource's home page a user can access. "N" - Not view managed resource's home page "D" - View directly managed resource's home page "A" - View all managed resource's home page | ||
| ViewManagedResourceTimeSetting | String(1) | No | "N" - Not view managed resource's time | This setting determines which managed resource's reported time (time cards) a user can access. "N" - Not view managed resource's time "D" - View directly managed resource's time "A" - View all managed resource's time |
- Note on attributes that come from user types: When inserting new users and not specifying the values for the various settings that are inherited from user types, default settings are determined by looking at the primary user type and all additional user types and generally adopting the cumulative value (for example, if any user type is marked as limited, the default for the user will be limited, etc.). The exception is the default tab group, which comes directly from the primary user type.
...