|
| Overview |
|
It is a guide to help you understand what are the variables, how to setup and configure Xeesa Downtime broadcast to your organisation. |
|
| Topics to cover |
1. Application Variables and Values
2. How to install Step by Step
For Downtime Broadcast
3.1 How to send a broadcast if server down?
3.2 How to send a broadcast if server up?
3.3 How to setup in an multi-institution environment?
3.4 How to use broadcast template for multiple applications?
For Endpoint Attention Alert
4.1 Settings to set in program folder(Endpoint)
4.2 Settings to set in IIS(Windows Server)
4.3 How to add an endpoint in the attentionlist?
4.4 How to remove an endpoint from the attentionlist?
Software Updates
5.1 Using Bigfix/SCCM to push to update software version
5.2 Other Information on license and lifecycle
|
|
| 1. Application Variables and Values |
| File Name |
Location |
Purpose |
Values able to set |
| atp.xb |
Program Folder |
Path reference pointing to attention list to check where the endpoint hostname is in the list. If yes, the blue bar will popout when attentionhour has reach or past for the day. |
atpth=\"\\xdbsvr\attention\ networksharedattentionlistfile.xb\"
You can set your own \\servername\folder\listfile.xb by amending this. |
| attnh.xb |
Program Folder |
Attention Alert hour to reach so the blue bar will show. If it is 5pm, the blue bar will popout when it reach or past 5pm for the day. This will happen if the endpoint hostname is found in the networksharedattentionlistfile.xb which atp.xb is pointing to. |
attnh=\"5pm\"
Available values:8am, 9am, 10am, 11am, 12pm, 1pm, 2pm, 3pm, 4pm, 5pm, 6pm, 7pm, 8pm, 9pm, 10pm, 11pm |
| ofreq.xb |
Program Folder |
Checking Frequency every certain amount of secs for any downtime and uptime alerts on server. For endpoint attention alert only from the first time it check. |
Ofreq=\"60secs\"
Available values:30secs, 60secs, 120secs, 180secs, 300secs |
| omode.xb |
Program Folder |
Operating Mode which consist of disable, downtime only(for downtime and uptime alerts only), endpoint only(for endpoint attention alerts), both. |
Omode=\"All\"
Available values:
Disable
Omode=\"Disabled\"
Downtime Only
Omode=\"DowntimeOnly\"
Endpoint Only
Omode=\"EndpointOnly\"
All
Omode=\"All\"
|
| issue.xb |
Program Folder |
Path reference pointing to networksharefileissue.xb to check whether the file exist. If yes, the program will read the value in this file and popout the red bar with the value in networksharedfileissue.xb output to the red bar. |
issue=\"\\xdbsvr\broadcast\ networksharedfileissue.xb\"
You can set your own \\servername\folder\downtimemsg.xb by amending this. |
| resolution.xb |
Program Folder |
Path reference pointing to networksharefileresolution.xb to check whether the file exist. If yes, the program will read the value in this file and popout the green bar with the value in networksharedfileresolution.xb output to the red bar. |
issue=\"\\xdbsvr\broadcast\ networksharedfileresolution.xb\"
You can set your own \\servername\folder\uptimemsg.xb by amending this. |
| responseurl.xb |
Program Folder |
Path reference pointing to IIS webserver URL after checking the endpoint hostname exist in the networksharedattentionlistfile.xb. Once the blue bar pop out, user click it. It will lead to the webpage from the IIS Webserver. |
reURL=\"http://downtime-broadcast.xeesa.com/attn.asp?hn=\"
You can set your own URL http://10.198.10.198/attn.asp?hn= by amending this as example. |
| networkshared attentionlistfile.xb |
File Server Shared Folder |
Consist of hostnames in the file which endpoint needs attention. Once the software checked the hostname is in it, the blue bar pop out, user click it. It will lead to the webpage from the IIS Webserver. |
Attnt=\"HOSTNAME1; HOSTNAME2;HOSTNAME3\"
You can use the db2aalistxb.asp to generate. |
| networkshared fileissue.xb |
File Server Shared Folder |
Consist of downtime alert message to show the users in the red bar. |
issue=\"Xeesa Downtime Broadcast is Down. Please use offline version.\"
You can change it according to your message. |
| networkshared fileresolution.xb |
File Server Shared Folder |
Consist of uptime alert message to show the users in the green bar. |
resol=\"Xeesa Downtime Broadcast is Up. You may use it now.\"
You can change it according to your message. |
| attn.asp |
IIS Webserver |
Webpage to show users what attention is needed for the endpoint. |
ASP page code provided to customers for endpoint attention alert use only. You may create your own page to try out. Our example is http://downtime-broadcast.xeesa.com/attn.asp?hn= for illustration if trying |
| xdbdb.asp |
IIS Webserver |
Access Database which is used via oledb. xdbdb.mdb will rename to xdbdb.asp in order to be able to use. |
This file will be provided to customers for endpoint attention alert use only. Usually customers will use excel with the same fields and columns like the access mdb file. Once data compiled in the excel, user can copy the cells from the excel and paste over to the xdbdb.mdb file. Then copy over to the webserver and rename to xdbdb.asp for better security |
| db2aalistxb.asp |
IIS Webserver |
To convert the database endpoint attention list to a networkshared attentionlistfile.xb which later will be paste to the file server share folder |
This file will be provided to customers. |
|
|
| 2. How to install Step by Step |
For faster explaination, if we mention XDBC, it mean Xeesa Downtime Broadcast Client. IIS is web server.
Pre-requisites of the settings files
For this example, we would require your server team server to provision 1 Windows Server with the availablity of File Server and IIS function. The file server shortname will be \\xdbsvr and the IIS(Website) will be http://xdbsvr or https://xdbsvr.
Our default settings in the client software installer package
issue.xb is pointing to \\xdbsvr\broadcast\networksharedfileissue.xb
resolution.xb is pointing to \\xdbsvr\broadcast\networksharedfileresolution.xb
atp.xb is pointing to \\xdbsvr\attention\networksharedattentionlistfile.xb
responseurl.xb pointing to http://xbdsvr/attn.asp
If you decide to change your server later, you will need to pushdown via bigfix or SCCM to your computers installed with XDBC replace it with your new .xb files pointing location due to different servername
Setting up IIS Webserver
Open Server Manager: Click the Start menu, then select Server Manager.
Add Roles and Features: Click "Manage" in the top-right corner, then select "Add Roles and Features".
Installation Type: Choose "Role-based or feature-based installation" and click Next.
Select Server: Choose the appropriate server from the server pool and click Next.
Select Server Roles: Check the box next to "Web Server (IIS)" and click "Add Features" when prompted.
Select Features: You can choose additional IIS features here, or use the defaults for a basic installation.
Confirm Installation: Review your selections and click Install.
Open Server Manager Again: Click the Start button and select Server Manager.
Add Roles and Features: In Server Manager, click Manage (in the top-right corner) and select Add Roles and Features.
Navigate to Server Roles: Click Next until you reach the Server Roles section of the wizard.
Expand Web Server (IIS) and Application Development:
Expand Web Server (IIS).
Expand Web Server.
Expand Application Development.
Enable ASP: Check the box next to ASP.
Complete the Installation: Click Next through the remaining steps of the wizard and then click Install.
Go to the wwwroot folder which your website is using.
Copy the attn.asp, db2aalistxb.asp, xdbdb.asp into this folder
You can try accessing http://xdbsvr/attn.asp and you should be able to see the page loading
Setting up File server
You may refer to google how to folder sharing on windows server if not sure. We skip this step assuming you know how to have folder sharing
Create these folder \\xdbsvr\broadcast and \\xdbsvr\attention on your file server.
Set these folders security to be able to read only by everyone.
Set write rights for your administrators accounts
Create this folder \\xdbsvr\admin on your file server.Set write rights for your administrators accounts. This folder is for your own use for broadcast templates, database files to amend before copying over to the broadcast folder or webserver wwwroot folder
Installing Xeesa Downtime Broadcast Client (XDBC)
You can download from our website and install the client.
The program will run in the background after installation.
|
|
| 3.1 How to send a broadcast if server down? |
For this example, the file server shortname will be \\xdbsvr and the IIS(Website) will be http://xdbsvr or https://xdbsvr.
Our default settings in the client software installer package
issue.xb in XDBC program folder is pointing to \\xdbsvr\broadcast\networksharedfileissue.xb
And we have the shared folder \\xdbsvr\admin
Example: The intranet is down now.
Goto \\xdbsvr\admin which you will store your networksharedfileissue.xb
Edit your networksharedfileissue.xb with notepad. issue=\"Intranet is down. Sorry for any inconvenience made.\"
Copy the networksharedfileissue.xb from \\xdbsvr\admin to \\xdbsvr\broadcast folder
The XDBC will popout the red bar on the endpoint's desktop stating Intranet is down. Sorry for any inconvenience made.
|
|
| 3.2 How to send a broadcast if server up? |
For this example, the file server shortname will be \\xdbsvr and the IIS(Website) will be http://xdbsvr or https://xdbsvr.
Our default settings in the client software installer package
issue.xb in XDBC program folder is pointing to \\xdbsvr\broadcast\networksharedfileissue.xb
resolution.xb in XDBC program folder is pointing to \\xdbsvr\broadcast\networksharedfileresolution.xb
And we have the shared folder \\xdbsvr\admin
Example: The intranet is finally up after sometime.
Goto \\xdbsvr\admin which you will store your networksharedfileresolution.xb
Edit your networksharedfileresolution.xb with notepad. issue=\"Intranet is up. You may use now.\"
Delete the networksharedfileissue.xb from \\xdbsvr\broadcast folder
Copy the networksharedfileresolution.xb from \\xdbsvr\admin to \\xdbsvr\broadcast folder
The XDBC will popout the green bar on the endpoint's desktop stating Intranet is up. You may use now.
Once after 1-2 hour later, you can delete the networksharedfileresolution.xb from \\xdbsvr\broadcast folder to stop the broadcast as it is no longer needed
|
|
| 3.3 How to setup in an multi-institution environment? |
Showing example of 3 institution in an education organization
| Files in XDBC |
Business School |
Engineering School |
School Museum/Showroom |
| atp.xb |
Can point to the same file \\servername\attention\networksharedattentionlistfile.xb |
| attnh.xb |
Can set the same standard 5pm |
| ofreq.xb |
Can set the same frequency to routine check |
| omode.xb |
All |
Endpoint Only(Due to principal do not want to show bad things on public) |
| issue.xb |
Point to the file \\servername\broadcast\ bizschnetworksharedfileissue.xb |
Point to the file \\servername\broadcast\ engschnetworkshared fileissue.xb |
Empty |
| resolution.xb |
Point to the file \\servername\broadcast\ bizschnetworkshared fileresolution.xb |
Point to the file \\servername\broadcast\ engschnetworkshared fileresolution.xb |
Empty |
| responseurl.xb |
Can use the same URL as centralized webserver |
So we can have different settings for different institution or functions due to users' nature of business like office/showroom type.
|
|
| 3.4 How to use broadcast template for multiple applications? |
Showing example of 3 common applications used in an organization
| Broadcast files\Apps |
Intranet |
Email |
ERP |
| Downtime Broadcast Values |
issue=\"Intranet is Down. Sorry for the inconvenience made.\" |
issue=\"Email is Down. Please use personal mobile first.\" |
issue=\"ERP is Down. Please use manual form first.\" |
| Downtime Broadcast Template Location |
\\xdbsvr\admin\broadcast \downtime\intranet\network sharedfileissue.xb |
\\xdbsvr\admin\broadcast \downtime\email\network sharedfileissue.xb |
\\xdbsvr\admin\broadcast \downtime\erp\network sharedfileissue.xb |
| Uptime Broadcast Values |
issue=\"Intranet is working. You may use now.\" |
issue=\"Email is working. You may use now.\" |
issue=\"ERP is Down. You may use now.\" |
| Uptime Broadcast Template Location |
\\xdbsvr\admin\broadcast \uptime\intranet\networkshared fileresolution.xb |
\\xdbsvr\admin\broadcast \uptime\email\networkshared fileresolution.xb |
\\xdbsvr\admin\broadcast \uptime\erp\networkshared fileresolution.xb |
It is good to have templates stored in the \\xdbsvr\admin subfolders, easy to copy and paste to the \\xdbsvr\broadcast folder fast.
|
|
| 4.1 Settings to set in program folder(Endpoint) |
Usually the difference of the settings depends on the endpoint's nature. We would touch on the omode.xb first
Disable Mode: Meant for those computers you cannot prompt for any broadcast or attention alert. Maybe these computers are very high-profile like showcase to public.
Broadcast Only Mode: Meant for those computers you can prompt downtime or uptime broadcast.
Endpoint Only Mode: Meant for those computers you can prompt attention alerts only. Usually for public facing computers like infoTV/kiosk but need support sometimes.
All Mode: Meant for those computers you can prompt attention alerts and downtime/uptime broadcast. Usually for office users which need support.
In order endpoint attention alerts to work, you must use either endpoint only or All mode.
Secondly, we would touch on the ofreq.xb, this setting is to set how frequently the XDBC check against the file server for the .xb file. If 30secs set, XDBC will check every 30secs for the file on the fileserver. If you have 30,000 endpoint making the check every 30 secs. It will be around 1000 check request in a sec. So you can delay the duration of check to every 300secs(5mins) to lesser down the traffic to 100 check requests in 1 sec. So the file server will less likely to jam up. We would recommend 60secs as default and not more than 10,000 computers checking the file on the same file server although File server can have 100k concurrent request at the same time
For endpoint only mode, it will make the check the first time the XDBC checking on the file \\xdbsvr\attention\networksharedattentionlistfile.xb. it will not check anymore after that. Hence, endpoint only mode is those who needs only support. No broadcasting of downtime or uptime alert.
|
|
| 4.2 Settings to set in IIS(Windows Server) |
Setting up IIS Webserver
Open Server Manager: Click the Start menu, then select Server Manager.
Add Roles and Features: Click "Manage" in the top-right corner, then select "Add Roles and Features".
Installation Type: Choose "Role-based or feature-based installation" and click Next.
Select Server: Choose the appropriate server from the server pool and click Next.
Select Server Roles: Check the box next to "Web Server (IIS)" and click "Add Features" when prompted.
Select Features: You can choose additional IIS features here, or use the defaults for a basic installation.
Confirm Installation: Review your selections and click Install.
Open Server Manager Again: Click the Start button and select Server Manager.
Add Roles and Features: In Server Manager, click Manage (in the top-right corner) and select Add Roles and Features.
Navigate to Server Roles: Click Next until you reach the Server Roles section of the wizard.
Expand Web Server (IIS) and Application Development:
Expand Web Server (IIS).
Expand Web Server.
Expand Application Development.
Enable ASP: Check the box next to ASP.
Complete the Installation: Click Next through the remaining steps of the wizard and then click Install.
Go to the wwwroot folder which your website is using.
Copy the attn.asp, db2aalistxb.asp, xdbdb.asp into this folder
You can try accessing http://xdbsvr/attn.asp and you should be able to see the page loading
|
|
| 4.3 How to add an endpoint in the attentionlist? |
Usually we will consolidate the list of computers you want to trigger the blue bar to be shown on the computer desktop.
Steps to do
Adding the hostnames to an working excel file(which you can share among your colleages) and what attention needed indicated in the at1 to at18 field(eg;at1 is for replacement of computer, indicate yes)
Copy the entire excel file to the working access file database attype table
Make sure the at1 in working access file database attypecontact table atdesc is stated as the computer replacement state(This computer is due to replace for better work performance), contact email and/or teams channel link of the replacement to be include in it
Copy the entire work access file to replace the IIS access file(overwrite it)
Goto http://xdbsvr/db2aalistxb.asp and copy the whole text to notepad. Save as to networksharedattentionlistfile.xb
Copy networksharedattentionlistfile.xb to \\xdbsvr\attention folder>
You can see the endpoint with the hostname found inside networksharedattentionlistfile.xb will have its blue bar blinking after the busy hours
|
|
| 4.4 How to remove an endpoint from the attentionlist? |
You can use this way.
Steps to do
Removing the hostnames to an working excel file(which you can share among your colleages) and see what attention needed indicated in the at1 to at18 field(eg;at1 is for replacement of computer, now is yes).
If there are other at still stating yes, you may delete the yes from the at1 cell and leave the hostname row there
If you only see at1 stating yes, you may delete the whole hostname row there
Copy the entire excel file to the working access file database attype table
Make sure the at1 in working access file database attypecontact table atdesc is stated as the computer replacement state(This computer is due to replace for better work performance), contact email and/or teams channel link of the replacement to be include in it
Copy the entire work access file to replace the IIS access file(overwrite it)
Goto http://xdbsvr/db2aalistxb.asp and copy the whole text to notepad. Save as to networksharedattentionlistfile.xb
Copy networksharedattentionlistfile.xb to \\xdbsvr\attention folder
If you have remove the entire hostname row in the access database table, the endpoint will not have its blue bar blinking after the busy hours
There is another faster way for skipping the front process
Steps to do
Edit the \\xdbsvr\attention\networksharedattentionlistfile.xb file with notepad
Find the hostname in the notepad, remove it. Save the file
If you have remove the hostname from the file, the endpoint will not have its blue bar blinking after the busy hours
We recommend the first option as the process is more appropriate and systematic.
|
|
| 5.1 Using Bigfix/SCCM to push to update software version |
For updating of software, you may compare the software version. Best is to remove the old versions and killtask c:/program files/xeesa/xeesa downtime broadcast/xb.exe and then install the later versions. Later on, execute another task to replace the default files like
issue.xb - Pointing path on the Downtime Alert to tell user the server is down
resoluton.xb - Pointing path on the Uptime Notice to tell user they can use already.
atp.xb - Pointing path on the endpoint attention alert list to tell user their computer replacement is due soon
attnh.xb - Attention Alert timing to do after busy hours like 5pm so it wont disrupt their operations
omode.xb - Operating mode for different endpoint situation type. Some do not need downtime alert like customer facing type(maybe endpointonly)
|
|
| 5.2 Other Information on license and lifecycle |
|
XDBC have a lifecycle of 6 mths preview + 1yr production year support. If you are using a version of 25.x.x, your version only last until 31 Dec 2025. Every year you need to get the latest version from us as we have tested against the latest few version of windows build in windows 11. If you are using our XDBC in 2025, you should be requesting version 26.x.x to replace the version 25.x.x. Preferably, recommend to get the next year version before the current version expire on 31 Dec 2025. Usually 26.x.x is release on 1 July 2025. Next 27.x.x will release on 1 July 2026 and so on.
|
Downtime Broadcast Guide & Settings
