Table of Contents

NTF - Notify Entries

Module NTF

Description

The notify table collects short event texts, which are intended to be
presented to a user or a specific session. The intention is to be able
to control a running system and to be able to signal every user with
information of different importance. Additionally, the notify table shall
enable remote control user processes to be able to shut down the
system in a controlled manner.


Datafields

Name Description Data Type Len Dec. View lines View type Inst. Visible Codetable
INR Internal Unique ID of Notify Entry Text 8 1 Edit Yes Public
USR User (Optional Field, when SSNINR Specified) Text 8 1 Edit Yes Public
SSNINR Session ID to Address Sessions (Optional Field) Text 8 1 Edit Yes Public
TYP Type of Notify Entry Text 1 1 Edit Yes Public Embedded
DATTIM Timestamp of Issuance Datetime 15 0 Unknown Yes Public
EXPDATTIM Timestamp of Expiry Datetime 15 0 Unknown Yes Public
TXT Text of Entry Block 60 3 3 Block Yes Public
SHWDATTIM Timestamp when Processed Datetime 15 0 Unknown Yes Public
SHWSSNINR Session ID where Processed Text 8 1 Edit Yes Public
SHWFLG Processing Mode Text 1 1 Edit Yes Public Embedded
INIUSR Creating User ID Text 8 1 Edit Yes Public
INISSNINR Creating Session ID Text 8 1 Edit Yes Public
VER Version Counter Text 4 1 Edit Yes Public

Indices

Name Fields Properties
NTF_INR INR Unique
NTF_SHWSSNINR SHWSSNINR
NTF_SSNINR SSNINR
NTF_USR USR

/


Lock

INR

Datafield Description and Properties


Datafield INR Internal Unique ID

Description

Unique internal ID of a record within the table. The INR is a text field, which is created by retrieving the next valid entry from the counter NTF. The field INR is used to maintain links from other tables into this table.

Helpinformation

Unique internal ID of a record within the table. The INR is a text field, which is created by retrieving the next valid entry from the counter of this table. The field INR is used to enable links from other tables to this table.

For contractdata the INR also links the two tables xxD and xxT as associated entries hold the same INR.


Datafield USR User (Optional Field, when SSNINR Specified)

Description

The user to whom this notify message is to be sent. If this field is empty, the SSNINR has to be specified. If this field is filled, any session of the specified user will process the notify message, if the user is logged in until this notify message expires.

Helpinformation

Defines the user to whom this message is to be sent. If this field is empty, the Session ID field has to be specified. Once this field is filled, any session relating to that user will process the notify message, providing the user remains logged in until this notify message expires.


Datafield SSNINR Session ID to Address Sessions (Optional Field)

Description

The INR of the session to which this notify message is sent. If the field is empty, the USR field has to be specified. If this field is filled, it specifies the session which should process this notify message.

Helpinformation

The ID number of the session to which this notify message was sent. If the field is empty, the User ID field has to be specified. If the field is filled, it specifies the session assigned to process the notify message.


Datafield TYP Type of Notify Entry

Description

This field identifies the type of the notify entry. Depending on the type, the receiving session might act differently. The shown icon will be different and depending on the severity, the notifier will sound an alarm and/or will automatically pop up. The decoding of the type to the different icons and actions is done in the rule NTFMOD.NtfCheck.

Helpinformation

This field identifies the entry type. This type then determines how the received message is displayed. Icons displayed may vary and, depending on the severity, the notifier may sound an alarm and/or a warning will pop up.

Codetable
Code Text
1 Emergency
2 Alert
3 Critical
4 Error
5 Warning
6 Notice
7 Info
8 Hint
C Close transaction
U Update session status
X Exit session
9 Debug

Datafield DATTIM Timestamp of Issue

Description

This field holds the date and time at which the entry was issued. The date and time of the application server is taken.

Helpinformation

This field holds the date and time when the entry was made. The date and time of the application server is taken.


Datafield EXPDATTIM Timestamp of Expiry

Description

Upon issuance an expiry date and time might be defined to limit the lifetime of a notify entry. If such a limit is issued, the date and time of the expiry is stored in this field. Entries with an expiry in the past might still stay in the database, but the notify routine should no longer prompt the user with those entries.

Helpinformation

When issued, an expiry date/time can also be defined to limit the life of a notify entry. If such a limit is issued, the date and time of expiry is stored here. Entries with expiry dates in the past can still remain in the database, but the notify routine will no longer prompt the user.


Datafield TXT Text of Entry

Description

The notify text which is intended to be shown to the user, if possible.

Helpinformation

The notify text to be shown to the user.


Datafield SHWDATTIM Timestamp when Processed

Description

The date and time when this notify entry has been processed. The type of processing is stored in the field SHWFLG.

Helpinformation

The field identifies the date/ time when this notify entry was processed.


Datafield SHWSSNINR Session ID where Processed

Description

The session, identified by its INR, which processed this notify entry. The type of processing is stored in the field SHWFLG.

Helpinformation

The session, identified by its ID number, which processed this notify entry.


Datafield SHWFLG Processing Mode

Description

Any non-blank status in this field identifies entries, which are already processed and shall no longer be automatically shown. The status 'Expired' is set, when at the time of processing the entry the expiry time has already passed. In this case the only action is to update the notify entry and mark the entry as expired. The status 'Processed' shows that the requested actions (Update of Session, Return to Menu or Logoff) have been initiated. The status 'Sent to Notify' is set, when the text of the notify message has been sent to the notifier of the user.

Helpinformation

Non-empty values in this field identify entries that have already been processed and are no longer displayed automatically. 'Expired' means that at the time of processing the expiry time has already passed. In this case, the only action is to update the notify entry and mark the entry as expired. 'Processed' shows that the actions requested (Update Session, Return to Menu, or Logoff) have been initiated. 'Sent to Notify' means that the notify message has been sent to the user's notifier.

Codetable
Code Text
Pending
X Expired
N Sent to Notify
P Processed

Datafield INIUSR Creating User ID

Description

The user who created this notify entry is identified in this field by his user ID.

Helpinformation

The user creating this notify entry is identified in this field by the User ID.


Datafield INISSNINR Creating Session ID

Description

The session which created this notify entry is identified in this field by the INR of the session.

Helpinformation

The session which created this notify entry is identified in this field by the ID number of the session.


Datafield VER Version

Description

This field holds the version counter to keep track of the version history of an NTF entry. The individual versions are controlled by entries in the SLG table.

Helpinformation

This field holds the version counter used to keep track of the history of an entry of this table. The individual versions are managed by entries in the SLG table.