Pure text messages are archived in the message archive. They can also be displayed in the menu (html/WAP). Each message text gets a unique message key so that a further evaluation in MS-EXCEL® is possible, for example. As many different messages as desired can be archived in a message archive. These share the ring memory of an archive. Several message archives can be defined.
A message archive can be sent via e-mail, retrieved via http, and stored externally via ftp.
A message archive can be sent via e-mail, retrieved via http, and stored externally via ftp.
1.Tabs
1.1.Data
The basic definition of the message archive takes place here.
Designation
The message archive is contained under this term in the HS/FS Expert.
Message archives can be searched via the end point interface, where a word from the designation begins with the search word used there.
Message archives can be searched via the end point interface, where a word from the designation begins with the search word used there.
Ring memory
The number entered here specifies the maximum number of data records in the message archive. If the number is reached, the oldest data record is always replaced by the newest one.
The limits are as follows and the first that takes affect will apply. The limits differ for the HomeServer and the FacilityServer:
The limits are as follows and the first that takes affect will apply. The limits differ for the HomeServer and the FacilityServer:
| HomeServer | FacilityServer | |
|---|---|---|
| 1 archive | 50,000 | 200,000 |
| ALL archives | 100,000 | 400,000 |
1.2.End point
Message archives can be accessed via the end point interface of the HS/FS.
There is a description of the call parameters here.
There is a description of the call parameters here.
Note
Any message archive can of course be used instead of the message archive used for the call-up examples in the following table.
Placeholders are specified in UPPER CASE.
Placeholders are specified in UPPER CASE.
1.2.1.Methods
| Method | Description/Call |
|---|---|
| meta | Retrieval of metadata from the message archive.https://HS_IP/endpoints/call?key=MA@my_msgs&method=meta&user=USER&pw=PWD |
| get | Retrieval of a quantity of the last entries of a message archive.https://HS_IP/endpoints/call?key=MA@my_msgs&method=get&count=10&user=USER&pw=PWD |
1.2.2.Fields
ID
The value entered here forms the unique object keyof the end point, together with the fixed prefix "MA", with which the ID is connected by an '@' character.
Permitted characters are: A-Z, a-z, 0-9, hyphen ("-") and underscore ("_")!
Permitted characters are: A-Z, a-z, 0-9, hyphen ("-") and underscore ("_")!
Description
A meaningful description of the message archive.
Message archives can be searched via the end point interface, where a word from the description begins with the search word used there.
Message archives can be searched via the end point interface, where a word from the description begins with the search word used there.
Tags
A list of terms, separated by commas (",").
Message archives can be searched via the end point interface, where an individual tag completely matches the search word used there.
Permitted characters are: A-Z, a-z, 0-9, hyphen ("-") and underscore ("_")!
Message archives can be searched via the end point interface, where an individual tag completely matches the search word used there.
Permitted characters are: A-Z, a-z, 0-9, hyphen ("-") and underscore ("_")!
User groups
Important
This item is only available when user groups have been activated!
User groups can be authorised to access this message archive (for reading) via the end point interface.
1.3.E-mail
Sending via e-mail
This list shows all definitions that can be sent by e-mail.
Actuate the operating buttons "Create/Change/Delete" on the right next to the list. A mask appears for processing.
Actuate the operating buttons "Create/Change/Delete" on the right next to the list. A mask appears for processing.
1.4.HTTP call
Http call
This list shows all definitions that can be retrieved via http query.
Actuate the operating buttons "Create/Change/Delete" on the right next to the list. A mask appears for processing.
Actuate the operating buttons "Create/Change/Delete" on the right next to the list. A mask appears for processing.
1.5.FTP
Sending via FTP
Note
This option is only available after support has been activated beforehand via Master data\Project\Network\FTP.
This list shows all definitions that can be stored externally via FTP.
Actuate the operating buttons "Create/Change/Delete" on the right next to the list. A mask appears for processing.
Actuate the operating buttons "Create/Change/Delete" on the right next to the list. A mask appears for processing.