› KCM Template Scripting Developer's Guide › Functions › Control functions › status_message

status_message

This function is deprecated.

The status_message function enables you to send status messages during a Master Template execution. The message to send has to be entered in the parameter of the function. The maximum length of the message is 250 characters.

Do not use this function if the Master Template is to be used in a KCM Core environment. 

 status_message ( the_message )

The result of this function is of type TEXT.

The function has one parameter:

  • the_message, type TEXT. This is the message that is sent to the user's screen when the Master Template is executed.

An example is provided here. 

 @( status_message("Processing invoice records..."))

The @ ( ) construction means that the result of the function is displayed in the text. You must use this construction in a text part of a Template script. The switch from the KCM mode to the text mode in a Template script is made with the # characters. A Template script starts in the text mode, the #BEGIN makes the switch to the KCM mode.