Class COOSYSTEM@1.1:User

An object of this class is used to store user information. like the name, the roles, and the environments of the user.

Class Hierarchy

Properties

Type	Property	Name
boolean	active	Active
Address[]	address	Addresses
Address[]	addressbusiness	Address (Business)
Address[]	addressinvoice	Address (Invoice Address)
Address[]	addressprivate	Address (Private)
Object[]	assignedreferences	Assigned References
integer	boremarkamount	Amount of Remarks
content	boremarks	Remarks
content	boviewremarks	Remarks
Content	content	File
string[]	emailbusiness	E-Mail Address (Business)
EmailInformation[]	emailinformation	E-Mail Addresses
string[]	emailprivate	E-Mail Address (Private)
Addressee	mainaddress	Main Address
string[]	nameandaddress	Name and Address
date	persbirthday	Date of Birth
Language	perscommlanguage	Language for Communication
string	persfunction	Function in Organization
Content	persimage	Photo
string	persmiddlename	Middle Initial
string	persorgtxt	Organization (Text)
string(65)	persposttitle	Post Title
string	perssalutation	Salutation
Sex	perssex	Sex
Notification[]	recipientresubmissions	Follow-Ups
Object[]	references	References
Telephone[]	telephone	Telephone Numbers
string[]	telephonefax	Phone Number (Fax)
string[]	telephonemobile	Phone Number (Mobile)
string[]	telephoneprivate	Phone Number (Private)
string(15)	userabbreviation	Abbreviation
AppDashboard[]	userappdashboards	App Dashboards
string(64)	userfirstname	First Name
Group[]	usermemberof	Member of
boolean	usermustuserole	Must Use Role
UserRoleList[]	userroles	Roles per Tenant
SecurityLevel[]	usersecclearance	Security Clearance
UserSubstitution	usersubst	Substitutions
string(64)	usersurname	Surname
string(64)	usertitle	Title
string[]	website	Web Sites

Actions

Return Type	Signature
boolean	CanManageWorkFlowDiagrams( object context, optional boolean silent, out retval boolean canmanage)
boolean	CheckActive( out retval boolean active, optional boolean checkapplicense, optional object context)
User[]	GetAllOrganizationManagers( Group organization, optional OrganizationalPosition[] positionstoskip, optional OrganizationalUnit[] orgunitstoskip, out retval User[] allmanagers)
string	GetBaseURL( out retval string baseurl)
object[]	GetCurrentUserActivities( out retval object[] actinsts)
OrganizationalPosition	GetPrimaryPosition( Group organization, out retval OrganizationalPosition primaryposition)
Notification[]	GetResubmissions( boolean includedepending, out retval Notification[] resubmissions, out Notification[] dependingresubmissions)
boolean	IsWFSubstitutionActive( out retval boolean isactive, out User[] substitutes)
boolean	IsWorkFlowServiceUser( out retval boolean isserviceuser, out Group[] servicegroups)
object	ObjectCopy( ref optional object placement, out retval object object, optional string address, optional boolean virtualobject)
void	SendBackgroundSecure( any[] to, optional any[] cc, optional any[] bcc, any subject, string[] body, optional object[] attachments, optional boolean usepubliclinks, optional ContentFormat downloadformat, out string[] errorlog, optional string replytoaddress, optional string headertitle, optional Language fallbacklanguage)
datetime	Str2DateTime( string str, out retval datetime value)
float	Str2Float( string str, out retval float value)
integer	Str2Integer( string str, out retval integer value)

Properties

Active (COOSYSTEM@1.1:active)

Defines whether the working environment of the user is accessible. If set to true, the user is active and can work with the installation. If set to false, the user can only be referenced. The initial value is true.

Explanation:
This field defines whether the user or the organizational unit is active.
Note: Only active users are able to log on to the system.

boolean COOSYSTEM@1.1:active not null

Addresses (FSCFOLIO@1.1001:address)

In this field addresses for the contact can be defined.

Address[] FSCFOLIO@1.1001:address

Address (Business) (FSCCONTACTMGMT@1.1001:addressbusiness)

Address[] FSCCONTACTMGMT@1.1001:addressbusiness readonly volatile

Address (Invoice Address) (FSCCONTACTMGMT@1.1001:addressinvoice)

Address[] FSCCONTACTMGMT@1.1001:addressinvoice readonly volatile

Address (Private) (FSCCONTACTMGMT@1.1001:addressprivate)

Address[] FSCCONTACTMGMT@1.1001:addressprivate readonly volatile

Assigned References (FSCFOLIO@1.1001:assignedreferences)

unique Object[] FSCFOLIO@1.1001:assignedreferences readonly(ui) invisible

Additional Information

Access Types for Changing Property: AccTypeRead
Describes Child Relationship
Object Classes Allowed: ContentObject, URLObject
Property for Back Link: referencedby

Amount of Remarks (FSCFOLIO@1.1001:boremarkamount)

unsigned integer FSCFOLIO@1.1001:boremarkamount readonly invisible

Additional Information

Access Types for Changing Property: AccTypeRead

Remarks (FSCFOLIO@1.1001:boremarks)

In this field text inputs are displayed that are made in the scope of processing the business object (e.g. during approval).

content FSCFOLIO@1.1001:boremarks readonly

Additional Information

Access Types for Changing Property: AccTypeRead

Remarks (FSCFOLIO@1.1001:boviewremarks)

In this field the remarks are shown.

content FSCFOLIO@1.1001:boviewremarks readonly volatile

File (COOSYSTEM@1.1:content)

Defines the multimedia content of the object and information like the size of the content or the date of the last change.

Explanation:
Defines the content.

Content COOSYSTEM@1.1:content

Additional Information

Access Types for Changing Property: AccTypeChangeContent
Access Types for Reading Property: AccTypeReadContent

E-Mail Address (Business) (FSCCONTACTMGMT@1.1001:emailbusiness)

string[] FSCCONTACTMGMT@1.1001:emailbusiness readonly volatile

E-Mail Addresses (COOMAPI@1.1:emailinformation)

Defines the e-mail information for the address book entry.

Explanation:
In this field the e-mail addresses of the contact can be defined.

EmailInformation[] COOMAPI@1.1:emailinformation

Additional Information

Access Types for Changing Property: AccTypeChange
Access Types for Reading Property: AccTypeRead

E-Mail Address (Private) (FSCCONTACTMGMT@1.1001:emailprivate)

string[] FSCCONTACTMGMT@1.1001:emailprivate readonly volatile

Main Address (FSCFOLIO@1.1001:mainaddress)

In an organization in this field the first address of the Address field is displayed.
In a person in this field the address of the Address field is displayed of which the entry in the Address Source field fits best in the current context. If the address of the applied organization is taken over as main address, this address is displayed.

Addressee FSCFOLIO@1.1001:mainaddress readonly invisible

Name and Address (FSCFOLIO@1.1001:nameandaddress)

string[] FSCFOLIO@1.1001:nameandaddress readonly(ui)

Date of Birth (FSCFOLIO@1.1001:persbirthday)

Defines the date of birth of the person.

date FSCFOLIO@1.1001:persbirthday

Language for Communication (FSCFOLIO@1.1001:perscommlanguage)

In this dropdown list the Language can be selected in which the communication with this person is handled.
The language for communication can e.g. be used in search queries which can be included in Addressee Lists as Stored Search Folder.

Language FSCFOLIO@1.1001:perscommlanguage

Function in Organization (FSCFOLIO@1.1001:persfunction)

In this field a contact person's function in the organization can be defined.

string FSCFOLIO@1.1001:persfunction

Photo (FSCFOLIO@1.1001:persimage)

In this field a photo of the person can be stored.

Content FSCFOLIO@1.1001:persimage

Additional Information

Access Types for Changing Property: AccTypeChangeContent, AccTypeChange

Middle Initial (FSCFOLIO@1.1001:persmiddlename)

Defines middle initials of the person.

string FSCFOLIO@1.1001:persmiddlename

Organization (Text) (FSCFOLIO@1.1001:persorgtxt)

In this field an organization can be defined as free-text which is not stored as an organization object.
Alternatively, if an organization object exists, this can be selected in the Organization field.

string FSCFOLIO@1.1001:persorgtxt

Post Title (FSCFOLIO@1.1001:persposttitle)

Defines the title of the person that is placed behind the name (e.g. "CIO").

string(65) FSCFOLIO@1.1001:persposttitle

Salutation (FSCFOLIO@1.1001:perssalutation)

A salutation for the person can be defined in this field (e.g. "Dear Mr. Miller").

string FSCFOLIO@1.1001:perssalutation

Sex (FSCFOLIO@1.1001:perssex)

Defines the gender of the person.

Sex FSCFOLIO@1.1001:perssex

Follow-Ups (FSCNOTIFICATION@1.1001:recipientresubmissions)

unique Notification[] FSCNOTIFICATION@1.1001:recipientresubmissions readonly invisible

Additional Information

Access Types for Reading Property: AccTypeRead
Property for Back Link: notificationrecipient

References (FSCFOLIO@1.1001:references)

In this field references to other objects can be stored.

unique Object[] FSCFOLIO@1.1001:references

Additional Information

Access Types for Changing Property: AccTypeRead
Object Classes Allowed: BasicObject, CompoundObject, ContentObject, URLObject, Folder

Telephone Numbers (FSCFOLIO@1.1001:telephone)

In this field the telephone numbers of a contact can be defined.

Telephone[] FSCFOLIO@1.1001:telephone

Phone Number (Fax) (FSCCONTACTMGMT@1.1001:telephonefax)

string[] FSCCONTACTMGMT@1.1001:telephonefax readonly volatile

Phone Number (Mobile) (FSCCONTACTMGMT@1.1001:telephonemobile)

string[] FSCCONTACTMGMT@1.1001:telephonemobile readonly volatile

Phone Number (Private) (FSCCONTACTMGMT@1.1001:telephoneprivate)

string[] FSCCONTACTMGMT@1.1001:telephoneprivate readonly volatile

Abbreviation (COOSYSTEM@1.1:userabbreviation)

In this field an abbreviation for a user can be defined. This abbreviation is also integrated into the user's object name.

string(15) COOSYSTEM@1.1:userabbreviation

App Dashboards (FSCTEAMROOM@1.1001:userappdashboards)

Attribute all AppDashboard objects of the current user

unique AppDashboard[] FSCTEAMROOM@1.1001:userappdashboards readonly

Additional Information

Access Types for Changing Property: AccTypeRead
Access Types for Reading Property: AccTypeRead
Property for Back Link: dbuser

First Name (COOSYSTEM@1.1:userfirstname)

Defines the first name of the user.

Explanation:
The first name of a person.

string(64) COOSYSTEM@1.1:userfirstname

Member of (COOSYSTEM@1.1:usermemberof)

Defines the list of groups the user is a member of.

Explanation:
This list defines the organizational units, to which a user should belong.
Note: When a user role is assigned to a user, the organizational unit of this role is automatically listed in the Member of list.

unique Group[] COOSYSTEM@1.1:usermemberof

Additional Information

Access Types for Changing Property: AccTypeChange, AccTypeChangeSecRel
Property for Back Link: grmembers

Must Use Role (COOSYSTEM@1.1:usermustuserole)

Defines whether the user has to work in the context of a role or if he is allowed to work without a role. If the value is true, the user has to work in the context of a role. If the value is false, the user is able to work without a role or in the context of a role. The initial value is true.

Explanation:
This field defines whether the user must use a role.

boolean COOSYSTEM@1.1:usermustuserole

Roles per Tenant (COOSYSTEM@1.1:userroles)

Defines the list of roles the user is allowed to switch to.

Explanation:
This list defines all available roles for the user.
Note: If a tenant is specified, the role is only considered in this tenant.
If more than one default role exists, the first matching role is used.

unique UserRoleList[] COOSYSTEM@1.1:userroles

Security Clearance (COOSYSTEM@1.1:usersecclearance)

unique SecurityLevel[] COOSYSTEM@1.1:usersecclearance

Substitutions (COOSYSTEM@1.1:usersubst)

Defines the substitution object of the user. The user can define his or her substitutions with this substitution object.

UserSubstitution COOSYSTEM@1.1:usersubst

Surname (COOSYSTEM@1.1:usersurname)

Defines the last name of the user.

Explanation:
Defines the surname of the person.

string(64) COOSYSTEM@1.1:usersurname not null

Title (COOSYSTEM@1.1:usertitle)

Defines the title of the user.

Explanation:
The titles of the person that are placed in front of the name.

string(64) COOSYSTEM@1.1:usertitle

Web Sites (FSCFOLIO@1.1001:website)

In this field website addresses can be defined.

string[] FSCFOLIO@1.1001:website

Actions

COOWF@1.1:CanManageWorkFlowDiagrams

This action is used to decide if the current user can manage workflow diagrams.

boolean COOWF@1.1:CanManageWorkFlowDiagrams(
  object context,
  optional boolean silent,
  out retval boolean canmanage)

Name	Description
context	the context object to define the target group for which the policy should be evaluated.
silent	if set to true no error is thrown if the user does not have the permission.
canmanage	the result

COOWF@1.1:CheckActive

This action checks if the current group or user is active. In case of users the action checks if the user has licensed the app AppWorkFlow. If the license is not valid the action returns with an error

boolean COOWF@1.1:CheckActive(
  out retval boolean active,
  optional boolean checkapplicense,
  optional object context)

Name	Description
active	The parameter return if the object is active. If the license check is performed and retrieves error the parameter `active` will remain empty.
checkapplicense	if the parameter is set the license check is performed or skipped. If the parameter is not set the workflow config is asked if the license check should be performed.
context	the object in which context the active check is performed

FSCORGMGMT@1.1001:GetAllOrganizationManagers

Get all managers of an user in the target organization

User[] FSCORGMGMT@1.1001:GetAllOrganizationManagers(
  Group organization,
  optional OrganizationalPosition[] positionstoskip,
  optional OrganizationalUnit[] orgunitstoskip,
  out retval User[] allmanagers)

Name	Description
organization	the target organization
positionstoskip	positions which should be skipped in calculation
orgunitstoskip	organizational units which should be skipped in calculation
allmanagers	the managers

COOMAPI@1.1:GetBaseURL

string COOMAPI@1.1:GetBaseURL(
out retval string baseurl)

Name	Description
baseurl

COOWF@1.1:GetCurrentUserActivities

Gets all activities contained in the WorkList of the current user

object[] COOWF@1.1:GetCurrentUserActivities(
out retval object[] actinsts)

Name	Description
actinsts	the activity instances

FSCORGMGMT@1.1001:GetPrimaryPosition

Gets the primary organizational position of an user.
The property opprimary of the organizational position is used to identify the primary position.
If not organizational position is marked by property opprimary, the first head position is used.

OrganizationalPosition FSCORGMGMT@1.1001:GetPrimaryPosition(
Group organization,
out retval OrganizationalPosition primaryposition)

Name	Description
organization	the primary position will be evaluated in the context of the supplied organization.
primaryposition	the result

FSCNOTIFICATION@1.1001:GetResubmissions

Retrieve resubmissions of the current object and all depending objects if requested

Notification[] FSCNOTIFICATION@1.1001:GetResubmissions(
  boolean includedepending,
  out retval Notification[] resubmissions,
  out Notification[] dependingresubmissions)

Name	Description
includedepending	the resubmissions of depending objects are included
resubmissions	the resubmissions of the current object
dependingresubmissions	the resubmissions of all depending objects

COOWF@1.1:IsWFSubstitutionActive

Checks whether the workflow substitution is active.

boolean COOWF@1.1:IsWFSubstitutionActive(
out retval boolean isactive,
out User[] substitutes)

Name	Description
isactive	true if active
substitutes	the current substitutes

COOWF@1.1:IsWorkFlowServiceUser

This action is used to decide if the current user is used as service user for background execution of workflow diagrams. For this user the user profile to filter activities and process definitions is not evaluated.

boolean COOWF@1.1:IsWorkFlowServiceUser(
out retval boolean isserviceuser,
out Group[] servicegroups)

Name	Description
isserviceuser	the result
servicegroups	the service groups of the user

COOSYSTEM@1.1:ObjectCopy

Creates a new object as the copy of the object. This action called on the source object. This action sets the property objsource on the copied object.

object COOSYSTEM@1.1:ObjectCopy(
  ref optional object placement,
  out retval object object,
  optional string address,
  optional boolean virtualobject)

Name	Description
placement
object	The created copy of the object.
address	The object address for the new object. If this parameter is used, it overrides the specified COO store in parameter `coost` or the automatically chosen COO store, if no COO store was specified.
virtualobject

FSCFOLIO@1.1001:SendBackgroundSecure

Sends an e-mail via SMTP to the given users. The body can be defined as plain text only. The mail will be sent as HTML. Sender is defined by the SMTP-Configuration.

void FSCFOLIO@1.1001:SendBackgroundSecure(
  any[] to,
  optional any[] cc,
  optional any[] bcc,
  any subject,
  string[] body,
  optional object[] attachments,
  optional boolean usepubliclinks,
  optional ContentFormat downloadformat,
  out string[] errorlog,
  optional string replytoaddress,
  optional string headertitle,
  optional Language fallbacklanguage)

Name	Description
to	List of objects (users, contacts) or a list of strings to which an e-mail should be sent.
cc	List of objects (users, contacts) or a list of strings to which an e-mail should be sent in CC
bcc	List of objects (users, contacts) or a list of strings to which an e-mail should be sent in BCC.
subject	A subject is essential for an e-mail to be able to be sent. A subject can be either a plain string or a string object. If a string object is passed as subject, the used language is based on the user communication language. If there is no subject passed, the name or address from the first attachment will be used instead.
body	The text for the e-mail. Can contain: STRING, STRINGLIST.
attachments	A list of attachment objects for which MX urls or public links are inserted into the e-mail.
usepubliclinks	Generate public links instead of MX urls.
downloadformat	Use this download format in case of public links.
errorlog	Error log containing send errors.
replytoaddress	Use this replyto e-mail address.
headertitle	the text will be used as header title of the email.
fallbacklanguage	The fallback language is used when the email recipients are specified only by an email address, or when no communication language can be determined for an email recipient object.

FSCEXPEXT@1.1001:Str2DateTime

Converts a string to a date time using the current locale information

datetime FSCEXPEXT@1.1001:Str2DateTime(
string str,
out retval datetime value)

Name	Description
str	the string
value	the result

FSCEXPEXT@1.1001:Str2Float

Converts a string to a float using the current locale information

float FSCEXPEXT@1.1001:Str2Float(
string str,
out retval float value)

Name	Description
str	the string
value	the result

FSCEXPEXT@1.1001:Str2Integer

Converts a string to an integer using the current locale information

integer FSCEXPEXT@1.1001:Str2Integer(
string str,
out retval integer value)

Name	Description
str	the string
value	the result