2022 June Release

Class COOSYSTEM@1.1:User Permanent link for this heading

Class Hierarchy

Object > AdministrationObject > User

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

Properties Permanent link for this heading

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

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

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 Permanent link for this heading

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 Permanent link for this heading


Active (COOSYSTEM@1.1:active) Permanent link for this heading

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.

boolean COOSYSTEM@1.1:active not null


Addresses (FSCFOLIO@1.1001:address) Permanent link for this heading

Address[] FSCFOLIO@1.1001:address


Address (Business) (FSCCONTACTMGMT@1.1001:addressbusiness) Permanent link for this heading

Address[] FSCCONTACTMGMT@1.1001:addressbusiness readonly volatile


Address (Invoice Address) (FSCCONTACTMGMT@1.1001:addressinvoice) Permanent link for this heading

Address[] FSCCONTACTMGMT@1.1001:addressinvoice readonly volatile


Address (Private) (FSCCONTACTMGMT@1.1001:addressprivate) Permanent link for this heading

Address[] FSCCONTACTMGMT@1.1001:addressprivate readonly volatile


Assigned References (FSCFOLIO@1.1001:assignedreferences) Permanent link for this heading

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

Additional Information


Amount of Remarks (FSCFOLIO@1.1001:boremarkamount) Permanent link for this heading

unsigned integer FSCFOLIO@1.1001:boremarkamount readonly invisible

Additional Information


Remarks (FSCFOLIO@1.1001:boremarks) Permanent link for this heading

content FSCFOLIO@1.1001:boremarks readonly

Additional Information


Remarks (FSCFOLIO@1.1001:boviewremarks) Permanent link for this heading

content FSCFOLIO@1.1001:boviewremarks readonly volatile


File (COOSYSTEM@1.1:content) Permanent link for this heading

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

Content COOSYSTEM@1.1:content

Additional Information


E-Mail Address (Business) (FSCCONTACTMGMT@1.1001:emailbusiness) Permanent link for this heading

string[] FSCCONTACTMGMT@1.1001:emailbusiness readonly volatile


E-Mail Addresses (COOMAPI@1.1:emailinformation) Permanent link for this heading

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

EmailInformation[] COOMAPI@1.1:emailinformation

Additional Information


E-Mail Address (Private) (FSCCONTACTMGMT@1.1001:emailprivate) Permanent link for this heading

string[] FSCCONTACTMGMT@1.1001:emailprivate readonly volatile


Main Address (FSCFOLIO@1.1001:mainaddress) Permanent link for this heading

Addressee FSCFOLIO@1.1001:mainaddress readonly invisible


Name and Address (FSCFOLIO@1.1001:nameandaddress) Permanent link for this heading

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


Date of Birth (FSCFOLIO@1.1001:persbirthday) Permanent link for this heading

date FSCFOLIO@1.1001:persbirthday


Language for Communication (FSCFOLIO@1.1001:perscommlanguage) Permanent link for this heading

Language FSCFOLIO@1.1001:perscommlanguage


Function in Organization (FSCFOLIO@1.1001:persfunction) Permanent link for this heading

string FSCFOLIO@1.1001:persfunction


Photo (FSCFOLIO@1.1001:persimage) Permanent link for this heading

Content FSCFOLIO@1.1001:persimage

Additional Information


Organization (Text) (FSCFOLIO@1.1001:persorgtxt) Permanent link for this heading

string FSCFOLIO@1.1001:persorgtxt


Post Title (FSCFOLIO@1.1001:persposttitle) Permanent link for this heading

string(65) FSCFOLIO@1.1001:persposttitle


Salutation (FSCFOLIO@1.1001:perssalutation) Permanent link for this heading

string FSCFOLIO@1.1001:perssalutation


Sex (FSCFOLIO@1.1001:perssex) Permanent link for this heading

Sex FSCFOLIO@1.1001:perssex


Follow-Ups (FSCNOTIFICATION@1.1001:recipientresubmissions) Permanent link for this heading

unique Notification[] FSCNOTIFICATION@1.1001:recipientresubmissions readonly invisible

Additional Information


References (FSCFOLIO@1.1001:references) Permanent link for this heading

unique Object[] FSCFOLIO@1.1001:references

Additional Information


Telephone Numbers (FSCFOLIO@1.1001:telephone) Permanent link for this heading

Telephone[] FSCFOLIO@1.1001:telephone


Phone Number (Fax) (FSCCONTACTMGMT@1.1001:telephonefax) Permanent link for this heading

string[] FSCCONTACTMGMT@1.1001:telephonefax readonly volatile


Phone Number (Mobile) (FSCCONTACTMGMT@1.1001:telephonemobile) Permanent link for this heading

string[] FSCCONTACTMGMT@1.1001:telephonemobile readonly volatile


Phone Number (Private) (FSCCONTACTMGMT@1.1001:telephoneprivate) Permanent link for this heading

string[] FSCCONTACTMGMT@1.1001:telephoneprivate readonly volatile


Abbreviation (COOSYSTEM@1.1:userabbreviation) Permanent link for this heading

string(15) COOSYSTEM@1.1:userabbreviation


First Name (COOSYSTEM@1.1:userfirstname) Permanent link for this heading

Defines the first name of the user.

string(64) COOSYSTEM@1.1:userfirstname


Member of (COOSYSTEM@1.1:usermemberof) Permanent link for this heading

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

unique Group[] COOSYSTEM@1.1:usermemberof

Additional Information


Must Use Role (COOSYSTEM@1.1:usermustuserole) Permanent link for this heading

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.

boolean COOSYSTEM@1.1:usermustuserole


Roles per Tenant (COOSYSTEM@1.1:userroles) Permanent link for this heading

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

unique UserRoleList[] COOSYSTEM@1.1:userroles


Security Clearance (COOSYSTEM@1.1:usersecclearance) Permanent link for this heading

unique SecurityLevel[] COOSYSTEM@1.1:usersecclearance


Substitutions (COOSYSTEM@1.1:usersubst) Permanent link for this heading

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) Permanent link for this heading

Defines the last name of the user.

string(64) COOSYSTEM@1.1:usersurname not null


Title (COOSYSTEM@1.1:usertitle) Permanent link for this heading

Defines the title of the user.

string(64) COOSYSTEM@1.1:usertitle


Web Sites (FSCFOLIO@1.1001:website) Permanent link for this heading

string[] FSCFOLIO@1.1001:website

Actions Permanent link for this heading


COOWF@1.1:CanManageWorkFlowDiagrams Permanent link for this heading

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

Name

Description

context

silent

canmanage


COOWF@1.1:CheckActive Permanent link for this heading

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


FSCORGMGMT@1.1001:GetAllOrganizationManagers Permanent link for this heading

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 Permanent link for this heading

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

Name

Description

baseurl


COOWF@1.1:GetCurrentUserActivities Permanent link for this heading

Gets all activities contained in the WorkList of the current user

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

Name

Description

actinsts


FSCORGMGMT@1.1001:GetPrimaryPosition Permanent link for this heading

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

Name

Description

organization

primaryposition


FSCNOTIFICATION@1.1001:GetResubmissions Permanent link for this heading

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 Permanent link for this heading

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 Permanent link for this heading

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 Permanent link for this heading

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. @see ObjectCreate

virtualobject


FSCFOLIO@1.1001:SendBackgroundSecure Permanent link for this heading

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

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 Permanent link for this heading

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 Permanent link for this heading

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 Permanent link for this heading

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