Class FSCPERSONNELFILE@1.1001:PersonnelFile

Stores all documents concerning an employee in a structured manner

Class Hierarchy

Object > CompoundObject > BusinessObject > PersonnelFile

Properties

Type	Property	Name
Address[]	address	Addresses
EmailInformation[]	emailinformation	E-Mail Addresses
Addressee	mainaddress	Main Address
string[]	nameandaddress	Name and Address
date	persbirthday	Date of Birth
Language	perscommlanguage	Language for Communication
date	persentrydate	Entry Date
Content	persimage	Photo
string(65)	persposttitle	Post Title
string	perssalutation	Salutation
date	persseparationdate	Separation Date
Sex	perssex	Sex
QualificationLevel[]	pfacquiredquals	Acquired Qualifications
string[]	pfadditionalpersnums	Additional Personnel Numbers
Object[]	pfalldocuments	All Documents
BankAccountData	pfbankaccount	Bank Account
string	pfbirthplace	Birthplace
string	pfcompany	Company (Textual)
string	pfdenomination	Denomination
Object[]	pfdocumentoverview	All Documents
EmployeeCompany	pfemployeecompany	Company
EmployeeLocation	pfemployeelocation	Location
OrganizationalPosition	pfemployeeorgpos	Position
OrganizationalUnit	pfemployeeorgposgroup	Organizational Unit
string	pfemployeeorgposjobtitle	Job Title
Position	pfemployeeorgpostype	Type
integer(3)	pffulltimeequivalent	Full-Time Equivalent (in Percent)
float(3, 2)	pffulltimefactor	Full-Time Equivalent (in Percent)
QualificationLevel[]	pffurthertrainingquals	Request Further Trainings for
TemporaryFileInspection[]	pfinspection	Temporary Access
AdministrationObject[]	pfinspectors	Temporary Access (Active)
string	pfnationality	Nationality
OrganizationalPosition[]	pforgpos	Positions
string	pforgunit	Organizational Unit (Textual)
string	pfpersnum	Personnel Number
string[]	pfpreviousnames	All Previous Names
float	pfresidualleave	Residual Leave (in Days)
RoleDescription[]	pfroledescs	Role Descriptions
string	pfsocialsecid	Social Security Number
PersonnelFileState	pfstate	State
PersonnelFileFolder[]	pfstructure	Folders
AdministrationObject[]	pftempaccessinspectors	Temporary Access (Active)
FurtherTraining[]	pftrainings	Further Trainings
ContentObject[]	pfuploadeddocuments	Uploaded Documents
float(4, 2)	pfworkload	Workload (in Percent)
Telephone[]	telephone	Telephone Numbers
string(64)	userfirstname	First Name
string(64)	usersurname	Surname
string(64)	usertitle	Title

Actions

Return Type	Signature
PersonnelFileShelf	GetFileShelf( out retval PersonnelFileShelf shelf)
PersonnelFile	GetPersonnelFile( out retval PersonnelFile personnelfile)
boolean	IsCanceled( out retval boolean iscanceled)
boolean	IsClosed( out retval boolean isclosed)
boolean	IsInProgress( out retval boolean isinprogress)
boolean	IsReplaced( out retval boolean isreplaced)
object	ObjectCopy( ref optional object placement, out retval object object, optional string address, optional boolean virtualobject)

Properties

Addresses (FSCFOLIO@1.1001:address)

In this field addresses for the contact can be defined.

Address[] FSCFOLIO@1.1001:address

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

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

Entry Date (FSCFOLIO@1.1001:persentrydate)

The entry date of the employee.

date FSCFOLIO@1.1001:persentrydate

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

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

Separation Date (FSCFOLIO@1.1001:persseparationdate)

The separation date of the employee.

date FSCFOLIO@1.1001:persseparationdate

Sex (FSCFOLIO@1.1001:perssex)

Defines the gender of the person.

Sex FSCFOLIO@1.1001:perssex

Acquired Qualifications (FSCPERSONNELFILE@1.1001:pfacquiredquals)

Fair copies

unique QualificationLevel[] FSCPERSONNELFILE@1.1001:pfacquiredquals

Additional Information

Access Types for Changing Property: AccTypeChangeSkills
Access Types for Reading Property: AccTypeReadSkills

Additional Personnel Numbers (FSCPERSONNELFILE@1.1001:pfadditionalpersnums)

Additional personnel numbers.

Explanation:
Per line an additional personnel number can be defined.

string[] FSCPERSONNELFILE@1.1001:pfadditionalpersnums

All Documents (FSCPERSONNELFILE@1.1001:pfalldocuments)

All documents

Object[] FSCPERSONNELFILE@1.1001:pfalldocuments readonly volatile

Bank Account (FSCPERSONNELFILE@1.1001:pfbankaccount)

Bank account.

Explanation:
Defines the bank account of the employee.

BankAccountData FSCPERSONNELFILE@1.1001:pfbankaccount

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Access Types for Reading Property: AccTypeChangeSensitive

Birthplace (FSCPERSONNELFILE@1.1001:pfbirthplace)

Birthplace.

Explanation:
The birthplace of the person.

string FSCPERSONNELFILE@1.1001:pfbirthplace

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Access Types for Reading Property: AccTypeChangeSensitive

Company (Textual) (FSCPERSONNELFILE@1.1001:pfcompany)

Company.

Explanation:
The company of the employee can be defined textually, if no position is specified.

string FSCPERSONNELFILE@1.1001:pfcompany volatile

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive

Denomination (FSCPERSONNELFILE@1.1001:pfdenomination)

Denomination.

Explanation:
The denomination of the person.

string FSCPERSONNELFILE@1.1001:pfdenomination

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Access Types for Reading Property: AccTypeChangeSensitive

All Documents (FSCPERSONNELFILE@1.1001:pfdocumentoverview)

All documents

Object[] FSCPERSONNELFILE@1.1001:pfdocumentoverview readonly volatile

Company (FSCPERSONNELFILE@1.1001:pfemployeecompany)

Company.

Explanation:
If a corporation consists of several companies, a company can be assigned here.

EmployeeCompany FSCPERSONNELFILE@1.1001:pfemployeecompany readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Object Classes Allowed: EmployeeCompany

Location (FSCPERSONNELFILE@1.1001:pfemployeelocation)

Location

EmployeeLocation FSCPERSONNELFILE@1.1001:pfemployeelocation readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Object Classes Allowed: EmployeeLocation

Position (FSCPERSONNELFILE@1.1001:pfemployeeorgpos)

Position.

Explanation:
The position that is assigned to the personnel file.

OrganizationalPosition FSCPERSONNELFILE@1.1001:pfemployeeorgpos readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Object Classes Allowed: OrganizationalPosition

Organizational Unit (FSCPERSONNELFILE@1.1001:pfemployeeorgposgroup)

Organizational unit

OrganizationalUnit FSCPERSONNELFILE@1.1001:pfemployeeorgposgroup readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Object Classes Allowed: OrganizationalUnit

Job Title (FSCPERSONNELFILE@1.1001:pfemployeeorgposjobtitle)

Job title

string FSCPERSONNELFILE@1.1001:pfemployeeorgposjobtitle readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive

Type (FSCPERSONNELFILE@1.1001:pfemployeeorgpostype)

Type

Position FSCPERSONNELFILE@1.1001:pfemployeeorgpostype readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Object Classes Allowed: Position

Full-Time Equivalent (in Percent) (FSCPERSONNELFILE@1.1001:pffulltimeequivalent)

Full-time equivalent (in percent)

unsigned integer(3) FSCPERSONNELFILE@1.1001:pffulltimeequivalent invisible

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Access Types for Reading Property: AccTypeReadSensitive

Full-Time Equivalent (in Percent) (FSCPERSONNELFILE@1.1001:pffulltimefactor)

Full time factor

unsigned float(3, 2) FSCPERSONNELFILE@1.1001:pffulltimefactor

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Access Types for Reading Property: AccTypeReadSensitive

Request Further Trainings for (FSCPERSONNELFILE@1.1001:pffurthertrainingquals)

Request further trainings for

unique QualificationLevel[] FSCPERSONNELFILE@1.1001:pffurthertrainingquals

Additional Information

Access Types for Changing Property: AccTypeChangeSkills
Access Types for Reading Property: AccTypeReadSkills

Temporary Access (FSCPERSONNELFILE@1.1001:pfinspection)

Temporary file inspection

TemporaryFileInspection[] FSCPERSONNELFILE@1.1001:pfinspection

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel

Temporary Access (Active) (FSCPERSONNELFILE@1.1001:pfinspectors)

Temporary access (active)

AdministrationObject[] FSCPERSONNELFILE@1.1001:pfinspectors readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User, Group
Object Classes Not Allowed: Mailbox

Nationality (FSCPERSONNELFILE@1.1001:pfnationality)

Nationality.

Explanation:
The nationality of the person.

string FSCPERSONNELFILE@1.1001:pfnationality

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Access Types for Reading Property: AccTypeChangeSensitive

Positions (FSCPERSONNELFILE@1.1001:pforgpos)

Positions

unique OrganizationalPosition[] FSCPERSONNELFILE@1.1001:pforgpos readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Access Types for Reading Property: AccTypeReadSensitive
Property for Back Link: oppersfile

Organizational Unit (Textual) (FSCPERSONNELFILE@1.1001:pforgunit)

Organizational unit (textual).

Explanation:
The organizational unit of the employee can be defined textually, if no position is specified.

string FSCPERSONNELFILE@1.1001:pforgunit volatile

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive

Personnel Number (FSCPERSONNELFILE@1.1001:pfpersnum)

Personnel number.

Explanation:
Depending on the configuration a unique personnel number is automatically assigned or it must be set manually.

string FSCPERSONNELFILE@1.1001:pfpersnum not null

All Previous Names (FSCPERSONNELFILE@1.1001:pfpreviousnames)

Previous names.

Explanation:
The previous names may ease the search for an employee.

string[] FSCPERSONNELFILE@1.1001:pfpreviousnames

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Access Types for Reading Property: AccTypeReadSensitive

Residual Leave (in Days) (FSCPERSONNELFILE@1.1001:pfresidualleave)

Residual leave (in days)

float FSCPERSONNELFILE@1.1001:pfresidualleave

Additional Information

Access Types for Changing Property: AccTypePersAccount
Access Types for Reading Property: AccTypePersAccount

Role Descriptions (FSCPERSONNELFILE@1.1001:pfroledescs)

Role description

unique RoleDescription[] FSCPERSONNELFILE@1.1001:pfroledescs

Additional Information

Access Types for Changing Property: AccTypeChangeSkills
Access Types for Reading Property: AccTypeReadSkills
Object Classes Allowed: RoleDescription
Property for Back Link: rdpersfiles

Social Security Number (FSCPERSONNELFILE@1.1001:pfsocialsecid)

Social sec ID.

Explanation:
The social security number of the employee.

string FSCPERSONNELFILE@1.1001:pfsocialsecid

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Access Types for Reading Property: AccTypeChangeSensitive

State (FSCPERSONNELFILE@1.1001:pfstate)

State.

Explanation:
The state of a personnel file can be "Active" (continued employment), "Inactive" (entry date in the future or leaving date in the past) or "Canceled" (no longer needed).

PersonnelFileState FSCPERSONNELFILE@1.1001:pfstate readonly(ui)

Additional Information

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

Folders (FSCPERSONNELFILE@1.1001:pfstructure)

Folders

PersonnelFileFolder[] FSCPERSONNELFILE@1.1001:pfstructure

Additional Information

Access Types for Changing Property: AccTypeChangeComp
Access Types for Reading Property: AccTypeReadComp
Describes Child Relationship

Temporary Access (Active) (FSCPERSONNELFILE@1.1001:pftempaccessinspectors)

Temporary access (active)

AdministrationObject[] FSCPERSONNELFILE@1.1001:pftempaccessinspectors readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeSecRel
Access Types for Reading Property: AccTypeReadSecRel
Object Classes Allowed: User, Group
Object Classes Not Allowed: Mailbox

Further Trainings (FSCPERSONNELFILE@1.1001:pftrainings)

Further trainings

FurtherTraining[] FSCPERSONNELFILE@1.1001:pftrainings readonly(ui)

Additional Information

Access Types for Changing Property: AccTypeChangeSkills
Access Types for Reading Property: AccTypeReadSkills
Describes Child Relationship
Property for Back Link: ftpersfile

Uploaded Documents (FSCPERSONNELFILE@1.1001:pfuploadeddocuments)

Uploaded documents

ContentObject[] FSCPERSONNELFILE@1.1001:pfuploadeddocuments readonly volatile

Additional Information

Access Types for Changing Property: AccTypeChangeSensitive
Access Types for Reading Property: AccTypeChangeSensitive
Describes Child Relationship

Workload (in Percent) (FSCPERSONNELFILE@1.1001:pfworkload)

Workload (in percent)

unsigned float(4, 2) FSCPERSONNELFILE@1.1001:pfworkload readonly volatile

Additional Information

Access Types for Reading Property: AccTypeReadSensitive

Telephone Numbers (FSCFOLIO@1.1001:telephone)

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

Telephone[] FSCFOLIO@1.1001:telephone

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

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

Actions

FSCPERSONNELFILE@1.1001:GetFileShelf

Retrieve the personnel file shelf for the current object

PersonnelFileShelf FSCPERSONNELFILE@1.1001:GetFileShelf(
out retval PersonnelFileShelf shelf)

Name	Description
shelf	the personnel file shelf of the current object

FSCPERSONNELFILE@1.1001:GetPersonnelFile

Calculate parent personnel file for any object in file

PersonnelFile FSCPERSONNELFILE@1.1001:GetPersonnelFile(
out retval PersonnelFile personnelfile)

Name	Description
personnelfile	the personnelfile

FSCPERSONNELFILE@1.1001:IsCanceled

Helper to check if an object or personnel file is already canceled

boolean FSCPERSONNELFILE@1.1001:IsCanceled(
out retval boolean iscanceled)

Name	Description
iscanceled	the result

FSCPERSONNELFILE@1.1001:IsClosed

Helper to check if an object or personnel file is already closed

boolean FSCPERSONNELFILE@1.1001:IsClosed(
out retval boolean isclosed)

Name	Description
isclosed	the result

FSCPERSONNELFILE@1.1001:IsInProgress

Helper to check if an object or personnel file is in progress

boolean FSCPERSONNELFILE@1.1001:IsInProgress(
out retval boolean isinprogress)

Name	Description
isinprogress	the result

FSCPERSONNELFILE@1.1001:IsReplaced

Helper to check if an object or personnel file is already replaced

boolean FSCPERSONNELFILE@1.1001:IsReplaced(
out retval boolean isreplaced)

Name	Description
isreplaced	the result

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