Desktop Banner Announcement

9.20. Desktop Banner Announcement

Introduction #

Desktop Banner Announcement is a system-level announcement message system.

When Desktop Banner Announcement is enabled, a pre-configured custom message is shown on the Workstation desktop, at logon and refresh, on all desktops logged on to this database environment.

The configuration of Desktop Banner Announcement can be found in the section “Maintain System Parameters” -> “Desktop Administration” -> “Banner Announcement Message”.

Example #

Workstation displaying an announcement message #

Configuration #

Using SysAdmin Utility #

Option Name	Description
`Enable Banner Announcement Message`	This option will enable or disable the Desktop Banner Announcement.
`Start Date`	If a Start Date is configured, the announcement message start date is limited to this value. If not configured, open-ended Start Date is used.
`End Date`	If an End Date is configured, the announcement message end date is limited to this value. If not configured, open-ended End Date is used.
`Message`	This is the content of the announcement message, shown on the desktops at login and refresh. The message allows URLs.

Sample Configuration #

Using web services (SOAP API) #

The configuration settings for Desktop Banner Announcement can be updated using a web service in the SOAP API in entrypoint SicsWsSystemAdministrationEntryPoint named updateSystemParameters.

The System Parameter Registry keys to be used in this service are:

System Parameter Registry Key	Type	Description
`DT_ANN_MSG_ENABLED`	`SystemParameterBoolean`	Corresponds to GUI-setting `Enable Banner Announcement Message`
`DT_ANN_MSG_START`	`SystemParameterDate`	Corresponds to GUI-setting `Start Date`
`DT_ANN_MSG_END`	`SystemParameterDate`	Corresponds to GUI-setting `End Date`
`DT_ANN_MSG_TXT`	`SystemParameterString`	Corresponds to GUI-setting `Message`

To retrieve Desktop Banner Announcement settings using the SOAP API, please use the web service in the SOAP API in entrypoint SicsWsDomainRetrievalEntryPoint named retrieveObject.

Sample SOAP messages #

Update settings #

<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:enc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.SicsNt.com/SystemAdministration" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <SOAP-ENV:Header />
  <SOAP-ENV:Body>
    <swsaep:updateSystemParameters xmlns:swsaep="urn:SicsWsSystemAdministrationEntryPoint">
      <genericInput />
      <updateSystemParametersInput>
        <systemParameters>
          <systemParameter xsi:type="ns1:SystemParameterBoolean">
            <systemParameterKey>DT_ANN_MSG_ENABLED</systemParameterKey>
            <systemParameterValue>true</systemParameterValue>
          </systemParameter>
          <systemParameter xsi:type="ns1:SystemParameterDate">
            <systemParameterKey>DT_ANN_MSG_START</systemParameterKey>
            <systemParameterValue>2022-07-17</systemParameterValue>
          </systemParameter>
            <systemParameter xsi:type="ns1:SystemParameterDate">
            <systemParameterKey>DT_ANN_MSG_END</systemParameterKey>                      
            <systemParameterValue xsi:nil="true"/>
          </systemParameter>
          <systemParameter xsi:type="ns1:SystemParameterString">
            <systemParameterKey>DT_ANN_MSG_TXT</systemParameterKey>
            <systemParameterValue>The System will be upgraded over the weekend of Saturday July 2 to Sunday July 3. All functions will be available from Monday July 4th. More details can be found at http://www.dxc.com/system_upgrades</systemParameterValue>
          </systemParameter>
        </systemParameters>
      </updateSystemParametersInput>
    </swsaep:updateSystemParameters>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>

NOTE:
To set an open-ended Start Date or End Date, please specify xsi:nil="true" on the system parameter value for the Start/End Date, please see the example below. An open-endend date will then be implicitly configured in SICS. There are no explicit System Parameter Registry Keys for setting open-ended Start Date or End Date with the SOAP API.

<systemParameter xsi:type="ns1:SystemParameterDate">
  <systemParameterKey>DT_ANN_MSG_END</systemParameterKey>
  <systemParameterValue xsi:nil="true"/>
</systemParameter>

Retrieve settings #

<?xml version="1.0" encoding="ISO-8859-1"?>
<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/" xmlns:enc="http://schemas.xmlsoap.org/soap/encoding/" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ns1="http://www.SicsNt.com/ReferenceItems" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" SOAP-ENV:encodingStyle="http://schemas.xmlsoap.org/soap/encoding/">
  <SOAP-ENV:Header />
  <SOAP-ENV:Body>
    <swdrep:retrieveObject xmlns:swdrep="urn:SicsWsDomainRetrievalEntryPoint">
      <genericInput />
      <input>
        <referenceObject xsi:type="ns1:SicsSystemParameterRegistryReference" />
        <specification>
          <retrieveAll>true</retrieveAll>
        </specification>
      </input>
    </swdrep:retrieveObject>
  </SOAP-ENV:Body>
</SOAP-ENV:Envelope>