2024 April Release

Struct FSCSCHEDULE@1.1001:TypeLongTermDeadlines Permanent link for this heading

Structure to persist long term deadlines of an object.

Properties Permanent link for this heading

Type

Property

Name

ComponentObject

ndbasedateattr

Base Date

Object

ndbasedateobj

Base Date Object for Time Interval

date

nddate

Date

date

nddatebackup

Date (Backup)

date

nddatebackupraw

Date (Backup, Conversion turned Off)

DeadlineObject

nddeadline

Action

string

nddeadlinekey

Deadline Identification

DeadlineReiteration

nddeadlinereiteration

Repetition Rule

date

ndduesince

Due Since

DeadlineDuration

ndduration

Duration

Object

ndinterval

Time Interval

RDOperator

ndintervaloperator

Operator

boolean

ndintervalsubtract

Subtract Time Interval

date

ndlastretry

Last Attempt on/at

Object

ndonbehalfof

Initiated by

Object[]

ndparameterobjs

Parameter (Objects)

date

ndprocessedat

Processed on/at

Object

ndprocessedby

Executed by

integer

ndprocessingtime

Execution Time of the Last Background Task in Milliseconds

boolean

ndrecalcdate

Recalculate the Date When the Base Date Changes

boolean

ndrecalcfinished

Ignore for Base Date Recalculation

boolean

ndrepeatedly

Execute Background Task Repeatedly

integer

ndretrycount

Attempts

Object

ndschedule

Background Task

boolean

ndscheduledbyreiteration

Scheduled by Reiteration Rule

Object

ndsource

Source

DeadlineState

ndstate

State

Properties Permanent link for this heading


Base Date (FSCSCHEDULE@1.1001:ndbasedateattr) Permanent link for this heading

The property from which the base date for dynamic deadline date calculation is taken.
Note: Can also be defined by an RDObject.

ComponentObject FSCSCHEDULE@1.1001:ndbasedateattr readonly(ui)

Additional Information


Base Date Object for Time Interval (FSCSCHEDULE@1.1001:ndbasedateobj) Permanent link for this heading

The object from which the base date for dynamic deadline date calculation is taken.
Note: Can also be defined by an RDObject.

Object FSCSCHEDULE@1.1001:ndbasedateobj readonly(ui)


Date (FSCSCHEDULE@1.1001:nddate) Permanent link for this heading

The date when the deadline should be executed.

Explanation:
The point in time at which the background task should be executed.

date FSCSCHEDULE@1.1001:nddate local readonly(ui)


Date (Backup) (FSCSCHEDULE@1.1001:nddatebackup) Permanent link for this heading

For internal use.
This property stores the original date of the deadline. This property is used for recurring deadlines. This property is used when the base date is defined as local

internal date FSCSCHEDULE@1.1001:nddatebackup local readonly(ui)


Date (Backup, Conversion turned Off) (FSCSCHEDULE@1.1001:nddatebackupraw) Permanent link for this heading

For internal use.
This property stores the original date of the deadline. This property is used for recurring deadlines. This property is used when the base date is not defined as local

internal date FSCSCHEDULE@1.1001:nddatebackupraw readonly(ui)


Action (FSCSCHEDULE@1.1001:nddeadline) Permanent link for this heading

The deadline object that should be executed.

Explanation:
The defined "Definition for Background Tasks" gets executed at the scheduled date.

DeadlineObject FSCSCHEDULE@1.1001:nddeadline not null readonly(ui)

Additional Information


Deadline Identification (FSCSCHEDULE@1.1001:nddeadlinekey) Permanent link for this heading

For internal use.
A unique key for each deadline entry for linking the entry to a protocol in case of a failed deadline.

internal string FSCSCHEDULE@1.1001:nddeadlinekey readonly(ui) invisible


Repetition Rule (FSCSCHEDULE@1.1001:nddeadlinereiteration) Permanent link for this heading

Defines the iteration rules of repeated deadlines.

Explanation:
Defines the settings for the repetitions.

DeadlineReiteration FSCSCHEDULE@1.1001:nddeadlinereiteration readonly(ui)


Due Since (FSCSCHEDULE@1.1001:ndduesince) Permanent link for this heading

For internal use.
The due date of the deadline.

internal date FSCSCHEDULE@1.1001:ndduesince local readonly(ui)


Duration (FSCSCHEDULE@1.1001:ndduration) Permanent link for this heading

The expected duration of the deadline.
Note: This setting is initialized form the deadline object.

DeadlineDuration FSCSCHEDULE@1.1001:ndduration readonly(ui)


Time Interval (FSCSCHEDULE@1.1001:ndinterval) Permanent link for this heading

The interval for dynamic deadline date calculation.
Note: Can also be defined by an RDObject.

Object FSCSCHEDULE@1.1001:ndinterval readonly(ui)

Additional Information


Operator (FSCSCHEDULE@1.1001:ndintervaloperator) Permanent link for this heading

The operator for dynamic deadline date calculation.
Note: Can also be defined by an RDObject.

RDOperator FSCSCHEDULE@1.1001:ndintervaloperator readonly


Subtract Time Interval (FSCSCHEDULE@1.1001:ndintervalsubtract) Permanent link for this heading

Used only in forms to display ndintervalsubtract.

boolean FSCSCHEDULE@1.1001:ndintervalsubtract readonly(ui) invisible


Last Attempt on/at (FSCSCHEDULE@1.1001:ndlastretry) Permanent link for this heading

For internal use.
Timestamp of the last execution.

internal date FSCSCHEDULE@1.1001:ndlastretry local readonly(ui)


Initiated by (FSCSCHEDULE@1.1001:ndonbehalfof) Permanent link for this heading

The user who initiated the deadline (should not be set explicitly, it is filled with the current user).

Explanation:
Shows the user who triggered the background task.

Object FSCSCHEDULE@1.1001:ndonbehalfof readonly(ui)

Additional Information

  • Object Classes Allowed: User

Parameter (Objects) (FSCSCHEDULE@1.1001:ndparameterobjs) Permanent link for this heading

These objects are supplied as parameter objects to the expressions executed on deadline evaluation.

Object[] FSCSCHEDULE@1.1001:ndparameterobjs readonly(ui)


Processed on/at (FSCSCHEDULE@1.1001:ndprocessedat) Permanent link for this heading

The date when the deadline was executed.

Explanation:
Shows when the background task was executed.

date FSCSCHEDULE@1.1001:ndprocessedat local readonly(ui)


Executed by (FSCSCHEDULE@1.1001:ndprocessedby) Permanent link for this heading

The user who executed the deadline.

Explanation:
Shows the user who executed the background task.

Object FSCSCHEDULE@1.1001:ndprocessedby readonly(ui)

Additional Information

  • Object Classes Allowed: User

Execution Time of the Last Background Task in Milliseconds (FSCSCHEDULE@1.1001:ndprocessingtime) Permanent link for this heading

Stores how long the deadline did take to be executed.

internal unsigned integer FSCSCHEDULE@1.1001:ndprocessingtime readonly(ui)


Recalculate the Date When the Base Date Changes (FSCSCHEDULE@1.1001:ndrecalcdate) Permanent link for this heading

For internal use.
The recalculation can only be carried out, if it is a base date of the object or of a superordinate object. If the superordinate objects of a subordinate object change, the subordinate object has to be appended to the object list in #TV.FSCCHEDULE@1.1001:TV_REFRESH_ATTRIBUTEMONITORING_OBJECTS.

Explanation:
Defines whether the execution time of the background task should be modified when the base date is changed. Background tasks that have not yet been executed are executed at the newly calculated time. Note: The recalculation can only be carried out, if it is a base date of the object or of a parent object.

internal boolean FSCSCHEDULE@1.1001:ndrecalcdate readonly(ui)


Ignore for Base Date Recalculation (FSCSCHEDULE@1.1001:ndrecalcfinished) Permanent link for this heading

For internal use.
This property stores if the recalculation of the deadline date is finished.

internal boolean FSCSCHEDULE@1.1001:ndrecalcfinished readonly(ui)


Execute Background Task Repeatedly (FSCSCHEDULE@1.1001:ndrepeatedly) Permanent link for this heading

Defines whether the deadline is executed repeatedly.

Explanation:
Defines whether the background task is to be executed once or repeatedly.

boolean FSCSCHEDULE@1.1001:ndrepeatedly readonly(ui)


Attempts (FSCSCHEDULE@1.1001:ndretrycount) Permanent link for this heading

For internal use.
Defines how often the deadline was tried to be executed.
Note: After 10 retries the deadline is automatically suspended.

internal integer FSCSCHEDULE@1.1001:ndretrycount readonly(ui)


Background Task (FSCSCHEDULE@1.1001:ndschedule) Permanent link for this heading

The background task object form which the entry was generated and from which the values are taken.

Explanation:
The background tasks defines what is executed when.

Object FSCSCHEDULE@1.1001:ndschedule readonly(ui)


Scheduled by Reiteration Rule (FSCSCHEDULE@1.1001:ndscheduledbyreiteration) Permanent link for this heading

Defines whether the deadline entry was scheduled by a repeated deadline.

internal boolean FSCSCHEDULE@1.1001:ndscheduledbyreiteration


Source (FSCSCHEDULE@1.1001:ndsource) Permanent link for this heading

The object from which this deadline entry was automatically created. For example, when the deadline entry was created by a category.

Explanation:
Shows the object that defines the background task.

Object FSCSCHEDULE@1.1001:ndsource readonly(ui)


State (FSCSCHEDULE@1.1001:ndstate) Permanent link for this heading

The state of the current deadline.

Explanation:
Shows the execution state of the background task.

DeadlineState FSCSCHEDULE@1.1001:ndstate not null readonly(ui)