Struct FSCFOLIO@1.1001:History

Struct to store history events on an object

Properties

Type	Property	Name
string[]	histargs	History Arguments
boolean	histdatemodified	Occurred on/at (Modified)
LanguageStringList[]	histdescription	Multilingual Description
string	histdispdescription	Description
DocState	histdocstate	Document State
Object	histevent	Event
Object	histeventsource	Source for Entry
EventType	histeventtype	Event Type
HistoryEventType	histeventtypeobj	Event Type
Group	histgroup	Group
integer	histkey	Index Key
date	histoccurredat	Occurred on/at
Position	histposition	Position
User	histsubstuser	Substituted User
User	histuser	User
Object[]	nfhistattachments	Attachments
User[]	nfhistraters	Ratings from
SubHistory[]	nfhistsubhistory	Subhistory

Properties

History Arguments (FSCFOLIO@1.1001:histargs)

Formated arguments which will be evaluated when displaying the history. For example when the state of the object was changed, this property can supply the information to get the multilingual text of the state.

string[] FSCFOLIO@1.1001:histargs

Global Scope: dictionary

Occurred on/at (Modified) (FSCFOLIO@1.1001:histdatemodified)

Is set when the time stamp histoccurredat was modified by the set action AttrObjHistorySet.

boolean FSCFOLIO@1.1001:histdatemodified invisible

Multilingual Description (FSCFOLIO@1.1001:histdescription)

unique LanguageStringList[] FSCFOLIO@1.1001:histdescription

Description (FSCFOLIO@1.1001:histdispdescription)

string FSCFOLIO@1.1001:histdispdescription

Document State (FSCFOLIO@1.1001:histdocstate)

The document state of the object can be used for protocol reasons.

DocState FSCFOLIO@1.1001:histdocstate

Event (FSCFOLIO@1.1001:histevent)

The object which triggered the event. For example when an object was added to a container the added object will be saved in this property.

Explanation:
If available, this field contains details of the event. For example this field can contain a log file of sent invitations, which can be opened via the "Properties" context menu command.

Object FSCFOLIO@1.1001:histevent

Source for Entry (FSCFOLIO@1.1001:histeventsource)

Object FSCFOLIO@1.1001:histeventsource

Event Type (FSCFOLIO@1.1001:histeventtype)

The enumeration type which is migrated to this event type.

Explanation:
In this field the event is displayed (e.g. "Invitation Sent" or "Teamroom Created").

EventType FSCFOLIO@1.1001:histeventtype

Event Type (FSCFOLIO@1.1001:histeventtypeobj)

The history event type which ocurred.

HistoryEventType FSCFOLIO@1.1001:histeventtypeobj

Additional Information

Object Classes Allowed: HistoryEventType

Group (FSCFOLIO@1.1001:histgroup)

The the group of the current role of user who triggered the history event

Group FSCFOLIO@1.1001:histgroup

Additional Information

Object Classes Allowed: Group
Object Classes Not Allowed: Mailbox

Index Key (FSCFOLIO@1.1001:histkey)

unsigned integer FSCFOLIO@1.1001:histkey

Occurred on/at (FSCFOLIO@1.1001:histoccurredat)

The time stamp when the history entry occurred.

Explanation:
This field displays the date and the time of the event.

date FSCFOLIO@1.1001:histoccurredat local

Position (FSCFOLIO@1.1001:histposition)

The the position of the current role of user who triggered the history event

Position FSCFOLIO@1.1001:histposition

Substituted User (FSCFOLIO@1.1001:histsubstuser)

If the event was triggered while working in a substitution role the substituted users will be saved.

User FSCFOLIO@1.1001:histsubstuser

User (FSCFOLIO@1.1001:histuser)

The user who triggered the history event.

Explanation:
In this field the user, who executed this event, is displayed.

User FSCFOLIO@1.1001:histuser

Attachments (FSCNEWSFEED@1.1001:nfhistattachments)

List of object pointers

Object[] FSCNEWSFEED@1.1001:nfhistattachments

Ratings from (FSCNEWSFEED@1.1001:nfhistraters)

List of all users who have rated the entry

User[] FSCNEWSFEED@1.1001:nfhistraters

Subhistory (FSCNEWSFEED@1.1001:nfhistsubhistory)

List of sub structured history events and comments

SubHistory[] FSCNEWSFEED@1.1001:nfhistsubhistory