There are three classes of users in the system: SPFLoginUser, SPFEmailOnlyUser, and SPFPaperUser. For more information about the differences in these types of users, see User and role assignment configuration.
Each of these user classes has its own primary interface as shown in the following diagram. The SPFEmailUser interface contains the common email properties and is realized by both the login user and email only user classes.
The general ISPFUser interface is realized by all three user classes and has the relationship to the organization objects.
Details of the properties and functionality exposed by these interfaces are given in the sections that follow.
ISPFLoginUser interface
ISPFLoginUser is the primary interface of the SPFLoginUser class and contains all the properties that control the user's profile. The following properties are found on this interface. Some are available only on the user create and update forms for the administrator to set, and others are available as user preferences.
|
Name |
Description |
Set on |
|---|---|---|
|
SPFDaysBetweenPasswordChange |
Days between password change |
New/Update User form |
|
SPFDisableUser |
Indicator to disable a user account |
New/Update User form |
|
SPFExpandToOption |
Expand to option (tree, new items or list view) |
User preferences |
|
SPFInboxRefresh |
To Do List refresh interval in minutes |
User preferences |
|
SPFLoginName |
Logon name |
New/Update User form |
|
SPFMaximumSQLLimit |
The Maximum number of items that can be returned |
User preferences |
|
SPFNestedReferenceFileLevel |
Nested reference file level |
User preferences |
|
SPFNotificationType |
Notification types (email or SmartPlant Foundation To Do List) |
New/Update User form |
|
SPFPassword |
SmartPlant Foundation password |
New/Update User form |
|
SPFShowHiddenFile |
Show/list files that are non-viewable and non-editable |
User preferences |
|
SPFSignOffTimeOut |
Time out duration for sign off |
New/Update User form |
|
SPFUserExclusiveClaim |
User-exclusive claim |
User preferences |
|
SPFUserExplicitClaim |
User-explicit claim |
User preferences |
|
SPFUserImplicitConfirmation |
User-implicit confirmation |
User preferences |
|
SPFUserMaintenance |
Allows user to alter other users' passwords |
|
|
SPFUserSchedulerRefresh |
User scheduler refresh |
User preferences |
|
SPFWarningDialogCount |
The maximum number of records that can be returned before a warning message appears |
User preferences |
Functionality configured on ISPFLoginUser
The GetToDoList method is configured on this interface.
Function CreateToDoListQueryCriteria (
ByVal pcolConfigUIDs
As List(Of String)) As ObjectCriteria
Function GetToDoList ( ByVal pblnConfigFiltering
As Boolean) As StructuredObjectCollection
The GetWorkFlowStepsAtStatus method is now deprecated.
Function GetWorkflowStepsAtStatus ( ByVal pstrStepStatus As String,
ByVal pblnConfigFiltering As Boolean,
ByVal pblnFilterOutOnHoldWorkflows As Boolean)
As StructuredObjectCollection
ISPFEmailUser interface
ISPFEmailUser is realized by the SPFLoginUser and SPFEmailOnlyUser classes and contains all the properties that control the user's profile. The following properties are found on this interface. Some are available only on the user create and update forms for the administrator to set, and others are available as user preferences.
|
Name |
Description |
Set on |
|---|---|---|
|
SPFEmailAddress |
Email address |
New/Update User form |
|
SPFEmailConfigGroupInd |
Email configuration group indicator |
User preferences |
|
SPFUsersEmailDigestDuration |
User's email digest duration |
User preferences |
|
SPFUsersEmailFormat |
User's email format (HTML or text) |
User preferences |
Functionality Configured on ISPFEmailUser
There are no methods configured on this interface.
ISPFPaperUser interface
ISPFPaperUser is the primary interface of the SPFPaperUser class.
Functionality configured on ISPFPaperUser
There are no methods configured on this interface.
ISPFUser interface
ISPFUser is realized by the SPFLoginUser, SPFEmailOnlyUser, and SPFPaperUser classes.
Functionality configured on ISPFUser
Basic commands such as Terminate, Copy, Update, and Edit Relationships are configured on this interface.
ISPFOrganization interface
ISPFOrganization is realized by the SPFCompany, SPFDepartment, and SPFSupplier classes. This interface is also the starting point for relationships to the file server host and the printer group as described in more detail in the Infrastructure Model.
Functionality configured on ISPFOrganization
Basic commands such as Terminate, Copy, Update, and Edit Relationships are configured on this interface.
SPFUserUserOptions relationship definition
The SPFUserUserOptions relationship links the user to its user preferences object that stores many of the user preferences available from the File > Change User Preferences menu command in the Desktop Client and the User Preferences section in the Web Client Settings. The relationship is created automatically when the user is created.
SPFHomeCollectionUser relationship definition
The SPFHomeCollectionUser relationship links the user to its home collection and is created automatically when the user is created. The Home Collection is a special folder that is presented in the user's tree view into which the user can drop any object to provide a quick link for future reference.
SPFUserOrganization relationship definition
The SPFUserOrganization relationship links the user to its organization and is configured on the user create and update forms.
You can view files from their original location if a relationship does not exist
between a company and a user or between a company and a host. No defined relationships
are equal to having a blank value for the LocalFileServerfield option. If you are configuring integration with SPO/E, you must add the SPFOrganizationFileServerHost relationship.