A login banner is a message that appears when users attempt to access the system. They must acknowledge the message before they can log in. Content-Type: application/vnd.plcm.plcm-login-banner-config+xml All attributes are used in ETag calculation except for entity-tag and atom-link.
| Name | Type | Description | Attributes |
|---|---|---|---|
| atomLinkList | Array of Link | See Definition of Link | |
| loginBannerEnabled | boolean | Enables the display of a login banner. | Mandatory |
| messageToDisplay | MessageToDisplay | Message to be displayed on login. This field is mandatory if value of 'login-banner-enabled' is set to 'true'. | |
| message | Message | Message to be displayed on login. This field is mandatory if value of 'login-banner-enabled' is set to 'true'. This field can also accept a variable, %hostname%. It will display the actual system host name in the message when %hostname% is presented | |
| deploymentDescriptionToDisplay | DeploymentDescriptionToDisplay | Display the actual description, as specified in deployment-description-config. This is a read-only field | |
| deploymentDescription | DeploymentDescription | A brief (one or two word) description to be displayed on or near the application's menu bar. If this value is not blank, it will be displayed regardless of whether any login banner message is enabled. Use this field to inform users what the deployed configuration of the system is intended for, e.g. 'DMA Edge' or 'DMA Core'. This field can also accept a variable, %hostname%. It will display the actual system host name in the description when %hostname% is presented | |
| entityTag | EntityTag | The unique value generated from the server object instance. This value is the same value that MUST be applied to the HTTP Entity Tag (ETag) header for a single instance of this object. Client modification of this field is not allowed for this instance. |
| Name | Type | Restrictions |
|---|---|---|
| EntityTag | string | Length of value must be >=1 Length of value must be <=64 |
| DeploymentDescription | string | Length of value must be >=1 Length of value must be <=128 |
| DeploymentDescriptionToDisplay | string | Length of value must be >=1 Length of value must be <=128 |
| Message | string | Length of value must be >=1 Length of value must be <=5000 |
| MessageToDisplay | string | Length of value must be >=1 Length of value must be <=5000 |