PowerChute Business Edition v10.0.5 Agent
PowerChute Business Edition v10.0.5 Agent
Related Documents . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 1
How to Log On . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 2
Account Lock-Out . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
Changing Language . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .2
Battery Management . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 5
Predicting the replacement date of your UPS battery . . . . . . . . .6
Internal and External Battery Packs . . . . . . . . . . . . . . . . . . . . . .6
Diagnostics . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 7
UPS Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 9
Power Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .9
General Settings. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 10
Bypass Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 11
PowerChute ..................................................................... 12
Event Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Description of events . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .12
Command file durations and shutdowns . . . . . . . . . . . . . . . . . .17
E-Mail Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 18
Adding and removing e-mail recipients . . . . . . . . . . . . . . . . . . .19
Authenticating e-mail . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .20
Shutdown .........................................................................29
Initial Setup . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Shutdown Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 29
Power Outage Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Power Outage Configuration and Shutdown on Event
Configuration . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 30
Interactivity in shutdown durations . . . . . . . . . . . . . . . . . . . . . 31
Scheduled Shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 33
Viewing and creating scheduled shutdowns . . . . . . . . . . . . . . 33
Overlapping scheduled shutdowns . . . . . . . . . . . . . . . . . . . . . 34
Daylight savings and scheduled shutdowns . . . . . . . . . . . . . . 35
Outlet Sequence . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 36
Examples of how you might use this screen . . . . . . . . . . . . . . 36
Using the graph and common fields . . . . . . . . . . . . . . . . . . . . 37
Choosing which individual outlet groups to turn off in a
shutdown . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 37
Deciding on delay times for individual outlet groups . . . . . . . . 38
Outlet Control. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 40
Shutdown Now. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 41
Logging ............................................................................42
Event Log. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 42
Data Log . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Log Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 43
Log files taking up disk space . . . . . . . . . . . . . . . . . . . . . . . . . 44
Energy Settings . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 45
Energy calculation . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . .46
About ...............................................................................47
General ............................................................................ 48
PowerChute Configuration File. . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 48
Resetting your Username and Password . . . . . . . . . . . . . . . . .48
Java Update . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 49
Preferences ..................................................................... 51
Customer Experience Improvement Program (CEIP) . . . . . . . . . . . . . 51
PowerChute Updates . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 51
Troubleshooting ............................................................... 52
PowerChute Files ZIP Archive . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . . 52
In the case of a UPS critical event, the software performs a graceful system shutdown of connected devices
before the UPS battery is exhausted.
Following installation, configure the software using the PowerChute initial setup wizard. This ensures that
PowerChute is configured to monitor and manage your system for power events.
This document describes the options available in the PowerChute Business Edition Agent user interface for a
Type B UPS.
• The UPS model is found on the printed label at the rear of your UPS:
– Type A
Smart-UPS models with prefix SMT, SMX, SURTD, SRT, SMTL, SCL, SMC, and SRTL
including models SRC2KUXI, SRC3KUXI, and SRC3KUXIX709.
– Type B
• Smart-UPS models excluding UPS models with prefix SMT, SMX, SURTD, SRT, SMTL, SCL,
SMC, SRTL, and models SRC2KUXI, SRC3KUXI, and SRC3KUXIX709.
• Easy UPS models SRVLPM1KRIL, SRVLPM2KRIL, and SRVLPM3KRIL.
Visit Knowledge Base article FA315835 on the APC website to find out more about UPS
model types.
Related Documents
This document describes the PowerChute Agent web user interface:
• For information on installing PowerChute Business Edition, see the PowerChute Business Edition
Installation Guide, available on the APC website.
• For security-related information, see the PowerChute Business Edition Security Handbook, available
on the APC website.
• For up-to-date information on the operating systems, JRE, service packs, and processors with which
PowerChute Business Edition is compatible, see the latest revision of PowerChute Business Edition
Operating System and Processor Compatibility Chart available on the APC website.
To access the PowerChute Business Edition Agent on a local Windows computer, select the Windows start
button, then select PowerChute Business Edition > PowerChute Business Edition.
To access the PowerChute Agent remotely, in a Web browser type the servername or Agent IP address and
port:
https://servername:6547
https://agentipaddress:6547
Account Lock-Out
PowerChute will automatically “lock out” for 2 minutes after three unsuccessful login attempts (incorrect
username and/or password) to prevent brute force password cracking.
Changing Language
The PowerChute Agent User Interface (UI) is available in two languages: English and Chinese. To change the
UI display language, click on the language selector in the top-right corner of the UI, and select a language from
the drop-down list. The country flags of the available UI languages are also displayed.
UPS Status
The UPS Status screen has three sections — System Status, Power Status, and Battery Status.
Each of the sections is collapsible and expandable by clicking the – and + icon to the left of the
section name.
System Status
The Device Status field under System Status indicates the present operating status of the UPS and displays
one of the following states listed in the table below.
Possible
Device Status Description
On Line The UPS is running normally on AC utility power.
On Line (Green The UPS is running normally on AC utility power, and the electrical input is being
Mode) utilized with high efficiency.
In addition, the value must be above the At runtime limit value set on Shutdown
Settings.
Initializing The UPS is attempting to establish communications with the UPS.
On Battery The UPS is using its battery to provide output power to the load.
Low Battery The UPS is on battery, and the Runtime Remaining reported by the UPS is less
than the At runtime limit value on the Shutdown Settings screen.
By default, a Low Battery shutdown begins. (It is possible to reverse this setting
on the Event Configuration screen).
Battery Discharged The UPS is on line, and the Runtime Remaining reported by the UPS is less than
the At runtime limit value on the Shutdown Settings screen.
PowerChute can display this status immediately after a runtime calibration (which
deeply discharges the battery) or when the UPS returns to On Line operation after
an extended power outage.
NOTE: It is possible to see this status when the Battery Charge under Battery
Status on this screen is displaying as 100%. This can happen when the Runtime
Remaining value falls below the At runtime limit value set on Shutdown
Settings.
Replace Battery The UPS battery has reached the end of its life.
NOTE: If you try to put the UPS on bypass while this condition exists, the UPS
loses all output power and the connected load shuts off.
Overloaded The UPS cannot support the current load. Unplug some equipment to reduce the
load.
If the UPS still indicates an overload, see the support services at www.apc.com/
support.
AVR Boost Active The UPS is using AVR Boost (Automatic Voltage Regulator) to correct a low input
voltage without switching to battery power.
AVR Trim Active The UPS is using AVR Trim to correct a high input voltage without switching to
battery power.
Performing Self Test The UPS is performing a self test, see Diagnostics.
Performing The UPS is performing a runtime calibration, see Diagnostics.
Calibration
Sleeping One or more outlets on your UPS are turned off but are scheduled to turn on.
UPS Communication The PowerChute Agent has lost communications with the UPS.
Lost
Make sure that the UPS cable is securely connected at both ends. For further
information, see the PowerChute Business Edition Product Center.
UPS Off Your UPS is turned off.
* While on bypass, the UPS can protect its supported equipment from power surges and minor power disturbances, but
not from other power problems like a power outage.
System Status also reports the following:
Field Description
UPS Load In watts, the power supplied by the UPS as a percentage of its full rating.
Runtime Remaining The amount of time the UPS — while on battery — could support the present
load. The value is shown in minutes.
NOTE: The maximum value of this field varies depending on the communication
method used with PowerChute. If USB connection is used, the maximum value
that will be shown is 1092. Whereas if serial connection is used, the maximum
value is 9999.
Internal Temperature The temperature inside the UPS.
Load Power In VA, volt-ampere, the power supplied by the UPS as a percentage of its full
rating.
Load Current The current drawn from the UPS by the connected equipment.
Battery Status
Battery Status reports the following:
Field Description
Battery Charge The present charge of the UPS battery, as a percentage of the total possible
capacity.
Battery Voltage The present voltage of the UPS battery.
Total Battery Packs This is only reported for some UPS types. It states the number of battery packs
connected to your UPS.
Battery Management
Use this screen to view the present status of your UPS batteries. The screen also lists information on your
battery packs including the part numbers, and can predict when your batteries need replacing.
Some fields described in this section do not display for every UPS and configuration.
Field Description
Battery Status The possible values here are Normal, Replace Battery, and No Batteries
Attached.
NOTE: For supported SRV Easy UPS models, it can take up to 10 minutes for
the UPS to detect a disconnected battery. The Battery Status will appear as No
Batteries Attached during this time.
If you need to replace your battery, see Battery Part Number below in this table.
Battery Charge The present charge of the UPS battery, as a percentage of the total possible
capacity.
Battery Voltage The present voltage of your UPS battery (as distinct from AC utility power) in
volts DC.
Runtime Remaining The amount of time the UPS battery could support its load.
Replacement This part number is essential for re-ordering. Click on the Re-Order Battery link to
Battery go to a web page where you can buy a new battery for your UPS online.
If a part number is not shown for your UPS device, the Re-Order Battery link will
take you to a web page where you can enter your UPS model number to find the
correct replacement battery for your device.
Battery Part Number This part number is essential for re-ordering. Click on the Re-Order Battery link to
go to a web page where you can buy a new battery for your UPS online.
If a part number is not shown for your UPS device, the Re-Order Battery link will
take you to a web page where you can enter your UPS model number to find the
correct replacement battery for your device.
Field Description
Battery Installation This displays the date that your UPS battery was installed.
Date
For some UPS devices, this information is derived from the UPS itself. For other
devices you can input an installation month and year. A link to the APC website
where you can re-order your battery is also provided.
Predicted This date is supplied by the UPS and indicates when it is recommended that the
Replacement Date battery be replaced.
If PowerChute cannot identify an internal battery pack, the battery pack information will be displayed in the
Battery Packs section.
For certain UPS models, the number of battery packs can be edited via the PowerChute Agent web interface.
The range of values permitted for Total Battery Packs is 0-99. Changing the total number of battery packs
changes the UPS Runtime Remaining on the UPS Status screen.
NOTE: Total Battery Packs must reflect the number of physical battery packs connected to the UPS, or
unexpected behavior may occur.
Field Description
On UPS start-up The UPS performs a self test when it turns on.
On UPS start-up and The UPS performs a self test when it turns on and subsequently performs a test
every 7 days since every 7 days. (The dates do not deviate from the 7-day interval unless you turn the
start-up date UPS off and then on again).
For example, you turn on the UPS on September 3, so it performs a self test at
turn-on and subsequently on Sept. 10, Sept. 17, Sept. 24, etc.
On UPS start-up and The UPS performs a self test when it turns on and subsequently performs a test
every 14 days since every 14 days.
start-up date
See the example in the row above.
On UPS start-up and The UPS performs a self test when it turns on and subsequently performs a test
every 7 days since every 7 days. However, if you manual initiate a self test, using this screen or
last test directly on the UPS, this changes the dates (in contrast to the second item in the
drop-down box where the dates would not change).
For example, you turn on the UPS on September 3, so it performs a self test at
turn-on and subsequently on Sept. 10. You then initiate a manual self test on Sept.
12, and the 7-date intervals continue on Sept. 19, Sept. 26, etc.
This is not relevant for the other tests: alarm test and calibration
Failed Your self test, alarm test, or calibration did not succeed.
For a calibration, this will happen when the load on the UPS is less than 10% of its
full capacity. In addition, for a calibration the UPS battery must be fully charged.
For a self test on a Type B UPS model connected to a PowerChute Business Edition
Agent via USB, this will happen when there is system status of Battery Discharged.
To find out if your UPS is a Type B model, visit Knowledge Base article FA315835 on
the APC website.
Aborted Your self test, alarm test, or calibration could not run to completion because
something stopped it, for example, a power outage, or it was canceled by a user.
Completed Your runtime calibration has finished successfully.
Unknown The status of your diagnostic test is unknown. This could be caused by a
communication issue.
The options explained below do not display for all UPS devices. Only supported options will be
displayed for your UPS model.
Power Settings
Field Description
a The voltage the UPS will supply when operating on battery power.
Output Voltage
NOTE: For some UPS models, you can only change this setting on the
UPS directly.
Upper Bypass Limitb When operating in bypass, this is the highest voltage the UPS will
supply to the connected load.
Lower Bypass Limit When operating in bypass, this is the lowest voltage the UPS will supply
to the connected load.
High Transfer Voltage On UPS devices that do NOT support bypass, this is the highest
voltage the UPS will supply to the connected load.
NOTE: On UPS devices that support AVR Trim, it will be reported when
the Input Voltage is higher than this value.
Low Transfer Voltage On UPS devices that do NOT support bypass, this is the lowest voltage
the UPS will supply to the connected load.
a) If you change the Output Voltage setting, the UPS sometimes changes the Upper and Lower Bypass Limit
values, also displaying on this screen. When that happens, these fields become read-only. Check these values
after you set output voltage.
b) If the supported equipment can tolerate a wide voltage range for On Line operation, you can increase the
Upper Bypass Limit value and decrease the Lower Bypass Limit value. A wider voltage range reduces the
number of times the UPS switches to battery operation, especially in areas where the input voltage is unstable
or is chronically high or low.
Field Description
UPS Name A user-customizable name for the UPS. You can use US-ASCII
characters only, codes 32-126.
This temperature should be greater than (or at least equal to) the
High Internal Temp Warning Threshold in the row below.
NOTE: Set this value above the normal temperature range of the
UPS. If you don’t, the Internal Temperature Exceeds Critical
Range event will be continually generated.
The options explained below do not display for all UPS devices. Only supported options will be
displayed for your UPS model.
To place the UPS in bypass, the input voltage to the UPS must fall between the upper and lower bypass limits.
Status Description
Acceptable Input voltage is within the bypass limits. The UPS can be placed into bypass mode.
Voltage Too High Input voltage is above the upper bypass limit.
Voltage Too Low Input voltage is below the lower bypass limit.
Return from Bypass This option is available when the UPS is in bypass mode.
Event Configuration
The Event Configuration screen lists the events that can occur and separates them into three categories -
critical (severe), warning, and informational. You cannot change an event's category.
By default, the Informational events are hidden, click the + icon beside Informational to display
them. You can also click the - sign to hide any of the three categories.
You can configure events to cause certain actions, named in separate columns:
• Logging: Records the event in the Event Log when the checkbox is selected.
IMPORTANT: Changing the shutdown and command file options for events has a direct
effect on the configuration you specify on the Shutdown Settings page. See Power
Outage Configuration and Shutdown on Event Configuration.
• Command File: Runs a user-specified command file when an event occurs.
Command files are often used to shut down open applications in order to avoid loss of data. They have to be
placed in this folder:
<Installation folder>\APC\PowerChute Business Edition\agent\cmdfiles
which for example is, by default on Windows, this folder:
C:\Program Files (x86)\APC\PowerChute Business Edition\agent\cmdfiles
Click on the Command File icon to enable it, and choose a file to run and a duration.
All command file types are supported.
IMPORTANT: PowerChute does not check the contents of a command file before executing it.
When you have enabled a command file for an event, the icon color changes from grey, , to
green, .
See also Command file durations and shutdowns and Power Outage Configuration and Shutdown on
Event Configuration.
Some events cannot be configured to trigger certain actions and have no checkbox for that action.
For example, most informational events cannot cause a shutdown so the checkbox is missing in
the Shutdown column for those events.
Description of events
For descriptions of individual events, see:
• Critical events
• Warning events
• Informational events
Critical events
Critical (severe) events can cause the UPS to stop supplying power to its supported equipment. These events
require your immediate attention.
Make sure that the proper communications cable is being used and that it
is connected correctly.
UPS Internal Temperature The internal temperature of the UPS has exceeded the user-configured
Threshold Exceeded threshold. This causes a shutdown which cannot be canceled, even if the
internal temperature returns to normal.
You can set this threshold in the High Internal Temp Threshold under
UPS Settings.
After this event occurs, to prevent it occurring repeatedly, when you log
onto the machine with the Agent installed, you must stop the Agent service
immediately. You should disconnect your UPS and wait for the temperature
to cool down.
Warning events
Warning events alert you to situations that should be monitored
If the overload was not caused by adding new load equipment, do the
following:
2. If the problem persists, disconnect all equipment from the UPS and
reboot the UPS.
If the overload still exists, the UPS needs to be repaired or replaced. For
further information, see the support services at www.apc.com/support.
Self Test Failed The UPS did not pass its last self test. It might have a bad battery.
If the self test fails again, see the support services at www.apc.com/
support.
Communication Lost Communication between PowerChute and the UPS has been lost while
the UPS was On Line. Make sure that the proper communications cable is
being used and that it is connected correctly.
This threshold event can be seen as a warning. The UPS itself determines
when the UPS is actually overloaded and this generates another more
serious event, see Overload.
Insufficient Runtime The UPS is On Line and is below the low runtime threshold - the Runtime
Available Remaining reported by the UPS is less than the total turn-off delays for
the outlet group supplying power to the Agent.
In a forced shutdown, the UPS might not have enough runtime available
to perform a graceful shutdown.
In a forced shutdown, the UPS will NOT have enough runtime available to
perform a graceful shutdown.
Battery Needs Replacing One or more UPS batteries need to be replaced.
AVR Boost Enabled The UPS began using AVR Boost to correct a low voltage condition.
AVR Trim Enabled The UPS began using AVR Trim to correct a high voltage condition.
Battery Disconnected The battery in your UPS has been disconnected or removed.
Reconnect the battery. If this does not clear the problem, see the
support services at www.apc.com/support.
This event will resolve when the input voltage returns to normal, or the
input voltage becomes too high to be gracefully decreased (On Battery
event).
If the devices connected to the UPS can accept a less sensitive input
power quality, configure the UPS to use the AVR Trim feature less
frequently, by setting the Upper Bypass Limit (or High Transfer
Voltage) to its highest setting, and the Power Quality Sensitivity to Low.
Frequent Undervoltage The UPS has been using its AVR Boost feature to increase a low input
voltage more than five times during the last 24 hours, or more than fifteen
times during the last seven days. This may indicate that the quality of the
input voltage provided to the UPS needs to be improved.
This event will resolve when the input voltage returns to normal, or the
input voltage becomes too low to be gracefully increased (On Battery
event).
If the devices connected to the UPS can accept a less sensitive input
power quality, configure the UPS to use the AVR Boost feature less
frequently, by setting the Lower Bypass Limit (or Low Transfer Voltage)
to its lowest setting, and the Power Quality Sensitivity to Low.
This event will resolve when the input voltage returns to normal, or the
input voltage becomes too high to be gracefully decreased (On Battery
event).
If the devices connected to the UPS can accept a less sensitive input
power quality, configure the UPS to use the AVR Trim feature less
frequently, by setting the Upper Bypass Limit (or High Transfer
Voltage) to its highest setting, and the Power Quality Sensitivity to Low.
This event will resolve when the input voltage returns to normal, or the
input voltage becomes too low to be gracefully increased (On Battery
event).
If the devices connected to the UPS can accept a less sensitive input
power quality, configure the UPS to use the AVR Boost feature less
frequently, by setting the Lower Bypass Limit (or Low Transfer Voltage)
to its lowest setting, and the Power Quality Sensitivity to Low.
Informational events
Informational events report data about the operation of the UPS device.
NOTE: Some UPS devices can incorrectly signal they are in this mode when
the internal battery is disconnected.
No Longer On Battery AC utility power has been restored; the UPS is no longer running on battery
power. This event follows On Battery.
Overload Solved The overload condition has been corrected. See Overload.
Output Load in Range The UPS load out-of-range condition has been corrected. See Output Load
Threshold Exceeded.
Shutdown Starting Various stages of the shutdown procedure.
Shutdown in Progress
Internal Temperature in The internal temperature of the UPS has returned to an acceptable level.
Range This event follows UPS Internal Temperature Threshold Exceeded or UPS
Internal Temperature Warning.
Configuration File Changed The pcbeconfig.ini file has been edited directly.
User Logged On A user has successfully logged into the PowerChute user interface.
User Logged Off A user has successfully logged out of the PowerChute user interface or the
PowerChute session has expired. By default, the PowerChute session
times out after 15 minutes of inactivity and users will be automatically
logged out of the PowerChute UI.
Command file durations and shutdowns
The Time for other applications to shut down on the Outlet Sequence screen is an important element in a
shutdown (see the OFF sequence for more details). The value is read-only on the Outlet Sequence screen.
For example, the Battery Discharged and On Battery events are both configured to shutdown. If you configure
the command file associated with the Battery Discharged event to have a duration of 3 minutes, and the On
Battery command file duration to 4 minutes, Time for other applications to shut down will be 4 minutes.
E-Mail Settings
The E-Mail Settings screen lists the e-mail addresses of users configured to be notified when an event occurs.
In order to receive e-mail notifications when an event occurs, the e-mail address must be set up here. See
Event Configuration for information on configuring an event to send an e-mail when it occurs.
The following five fields must be defined to enable PowerChute to send e-mail messages when events occur.
(This includes messages to pagers that accept e-mail).
• SMTP Server (Hostname, IPv4, or IPv6) identifies the SMTP server by one of the three methods
mentioned: its name, its IPv4 address, or its IPv6 address. An example hostname is mail.server.com.
• From E-Mail Address specifies the e-mail that the recipient gets the mail from. It is the e-mail account to
be used to send notifications.
• Port specifies the port number from which e-mail is sent via SMTP. Port numbers can have a maximum
of five digits and can be set to 25, 465, 587, or any number ranging from 5000 to 32768. If you do not
enter a port number, the default of 25 is used.
• Use SSL/TLS defines the e-mail encryption protocol that will be used when e-mail is sent. There are
three options available:
– None selected – if authentication is disabled, no e-mail encryption protocol will be used and e-mail
will be sent unencrypted. If authentication is enabled, e-mail will be encrypted using the SMTPS
protocol.
– SSL – e-mail will be encrypted using the SSL encryption protocol. You must select port 465 or the
port your email administrator has assigned for SSL communications.
– TLS – e-mail will be encrypted using the TLS encryption protocol. You must select port 587 or the
port your email administrator has assigned for TLS communications.
On Windows:
1. Stop the PowerChute service via the services console – APC PBE Agent – or using the
command net stop pbeagent
2. Copy server.crt (or server.cer) to the security directory in the installed PowerChute
directory (e.g. C:\Program Files (x86)\APC\PowerChute Business Edition\jre\lib\security).
3. Open a command prompt with Administrator privileges and navigate to this security directory.
4. Execute the following command to import the email certificate into the JRE trusted certificate
store:
..\..\bin\keytool -import –alias mailserv –file server.crt –keystore
cacerts –storepass changeit
5. Accept the certificate when prompted.
6. Start the PowerChute service via the services console – APC PBE Agent – or using the
command net start pbeagent
On Unix/Linux:
1. Stop the PowerChute service using one of the following commands: service pbeagent
stop, or systemctl stop PBEAgent.service, or /etc/init.d/PBEAgent stop
2. Copy server.crt (or server.cer) to the security directory in the installed PowerChute
directory (e.g. opt/APC/PowerChuteBusinessEdition/jre/lib/security).
3. Open a Terminal with Administrator privileges and navigate to this security directory.
4. Execute the following command to import the email certificate into the JRE trusted certificate
store:
../../bin/keytool -import –alias mailserv –file server.crt –keystore
cacerts –storepass changeit
5. Accept the certificate when prompted.
6. Start the PowerChute service using one of the following commands: service pbeagent
start, or systemctl start PBEAgent.service, or /etc/init.d/PBEAgent start
NOTE: In the above examples, mailserv is the alias of the mail server used within the cert file,
and server.crt is the self-signed SSL cert of the mail server. .cer files are also accepted.
For more information, see Replace Default PowerChute SSL Certificate.
To remove an e-mail, select the checkbox to the right of the address, and click Apply.
Filling in the Contact Name and System Location under Contact Information is optional. If present, the
information is included in e-mails. The name is intended to represent the person responsible for the
maintenance of the UPS. The location is the physical location of the server hosting the PowerChute Agent.
We advise testing your e-mail settings after configuration. You can do this by selecting an E-Mail
checkbox for an event with Event Configuration, and then create that event.
Authenticating e-mail
Authenticating e-mail is optional. You can enable it by selecting the Basic E-Mail for Authentication
checkbox. Contact your e-mail administrator if you’re not sure about authentication.
If you are going to use authentication, you can specify a server username and password in the respective
fields, but you do not have to do so. If you don’t specify a server username and password, PowerChute uses
the SMTP Server (Hostname, IPv4, or IPv6) to obtain a list of IP Addresses that are allowed to send
authenticated e-mails.
SNMP Settings
PowerChute Business Edition can be configured to communicate via Simple Network Management Protocol
(SNMP), and can be discovered via SNMP by a Network Management System (NMS). Using SNMP and the
PowerNet MIB, you can query and configure PowerChute settings, and generate SNMP traps to automatically
notify you of UPS shutdown events and lost communication events.
The PowerNet MIB is located in the etc directory in the PowerChute installation directory. The
latest version is also available on the APC website, choose Firmware Upgrades - MIB from the
Filter by Software / Firmware drop-down box.
SNMPv1 and SNMPv3 are supported by PowerChute Business Edition, and are enabled via the Agent web
interface. The SNMP Agent is not discoverable via SNMP until SNMPv1 or SNMPv3 is enabled, and one user
profile is configured.
SNMPv1 is less secure than SNMPv3. SNMPv1 does not provide encryption or authentication, and
the Community Name is sent over the network in plain text. To use encryption and authentication
with SNMP, configure SNMPv3 settings.
See:
• SNMP v1 Configuration
• SNMP v3 Configuration
• SNMP Trap Configuration
• SNMP Data Points
1. Community Name: The Community Name is sent with each SNMP request to obtain access to a
device. The maximum length is 15 ASCII characters.
2. NMS IP/Host Name: The IP address, Host Name or Fully Qualified Domain Name of the Network
Management System (NMS). An NMS is software that is used to manage software and hardware
components on the network. It can be used to manage PowerChute via SNMP by issuing SNMP GET
and SET commands. The default value of 0.0.0.0 permits access from any NMS.
3. Access Type:
– Disable: No SNMP GET or SET requests are permitted.
– Read: Only SNMP GET requests are permitted.
– Read/Write: SNMP GET and SET requests are permitted.
To edit an existing SNMPv1 user profile, click the button. To delete an SNMPv1 user profile, click the
button.
Certain Network Management Systems require the SNMP Engine ID to communicate via SNMP.
The SNMP Engine ID is displayed under the Miscellaneous section of the SNMP Settings page.
SNMP v3 Configuration
Select Enable SNMPv3 access to configure the SNMPv3 settings. Select Add Profile and configure:
1. User Name: In SNMPv3, all GET and SET requests and SNMP Traps are matched to a user profile by
the User Name. Enter a user name of a length less than or equal to 32 ASCII characters.
2. Authentication Protocol: Select MD5, SHA-1 or SHA-2 (SHA256 or SHA512) protocol. It is
recommended to use an SHA-2 protocol, if the NMS supports it.
3. Authentication Passphrase: Enter an authentication password for the protocol selected, of 8-32 ASCII
characters.
4. Privacy Protocol: Select AES-128, AES-192, AES-192 Ex†, AES-256, AES-256 Ex†, or DES. It is
recommended to use the AES-256 protocol, if the NMS and PowerChute JRE support it:
† NOTE: Certain SNMP Network Management Systems use a non-standard AES key extension
algorithm for 192 and 256 bit key lengths. This non-standard implementation or “Key extension
algorithm” is specified by the IETF.
If your NMS requires the use of the Key Extension algorithm, select Privacy Protocol options
AES-192 Ex or AES-256 Ex.
5. Privacy Passphrase: Enter a privacy password for the encryption protocol selected, of 8-32 ASCII
characters.
6. Access Type:
– Disable: No SNMP GET or SET requests are permitted.
– Read: Only SNMP GET requests are permitted.
– Read/Write: SNMP GET and SET requests are permitted.
To edit an existing SNMPv3 user profile, click the button. To delete an SNMPv3 user profile, click the
button.
Certain Network Management Systems require the SNMP Engine ID to communicate via SNMP.
The SNMP Engine ID is displayed under the Miscellaneous section of the SNMP Settings page.
To edit an existing SNMP Trap Receiver, click the button. To delete an SNMP Trap Receiver, click the
button.
When a shutdown event occurs and a Shutdown is triggered, PowerChute sends an SNMP trap to the
configured Trap Receiver detailing the Event Name.
• PowerChute Shutdown Event Resolved
If the option to Send Trap when condition is cleared is enabled, when the shutdown event which
triggered a Shutdown is resolved, PowerChute sends an SNMP trap to the configured NMS.
If the option to Send Trap when condition is cleared is enabled, a Communications Established trap is sent
when the communications lost event is resolved.
NOTE: Your UPS may not support all SNMP OIDs listed.
Refer to the PowerNet MIB available on the APC website for detailed descriptions of each OID,
including parameters for SET and GET operations.
UPS Information
SNMP OID Name Access Description
upsBasicIdentModel read-only The UPS Model Name (e.g. APC Smart-UPS 1000).
upsAdvIdentDateOfManufacture read-only The date that the UPS was manufactured, in mm/dd/
yy or mm/dd/yyyy format.
upsAdvIdentSerialNumber read-only The internal serial number of the UPS internal
microprocessor. NOTE: This value does not
correspond to the serial number at the back of the
UPS.
upsBasicBatteryStatus read-only The status of the UPS batteries.
upsBasicBatteryTimeOnBattery read-only The elapsed time since the UPS switched to battery
power.
upsBasicBatteryLastReplaceDate read-write The date that the UPS batteries were last replaced, in
mm/dd/yy or mm/dd/yyyy format.
upsAdvBatteryCapacity read-only The remaining battery capacity, expressed as a
percentage of full capacity.
upsAdvBatteryTemperature read-only The current internal UPS temperature, in Celsius.
upsAdvBatteryRunTimeRemainin read-only The time remaining before the UPS batteries will be
g depleted.
upsAdvBatteryReplaceIndicator read-only This value indicates if the UPS batteries need to be
replaced.
upsAdvBatteryNumOfBattPacks read-only The number of external battery packs connected to
the UPS.
upsAdvBatteryActualVoltage read-only The battery voltage, in Volts.
upsAdvInputLineVoltage read-only The current voltage of the input power to the UPS, in
VAC.
upsAdvInputFrequency read-only The current input frequency to the UPS, in Hertz.
upsAdvInputLineFailCause read-only The most recent reason why the UPS transferred to
battery power.
upsBasicOutputStatus read-only The current state of the UPS (e.g. On Line, On
Battery, etc.).
upsBasicOutputPhase read-only The current output phase.
upsAdvConfigLowBatteryRunTim read-write The desired runtime of the UPS, once the low battery
e condition is reached, in seconds.
upsAdvConfigShutoffDelay read-write The number of seconds the UPS remains on, once it
has been commanded to turn off.
upsAdvConfigAllowedSetTable read-only Read this OID to get the UPS data points for which
you set values, using an SNMP SET.
upsAdvTestDiagnosticSchedule read-write Write to this OID to control the battery test schedule of
the UPS.
upsAdvTestDiagnostics read-write Write to this OID to command the UPS to perform a
diagnostic self test.
upsAdvTestDiagnosticsResults read-only The results of the last diagnostic UPS Self Test.
upsAdvTestLastDiagnosticsDate read-only The date of the last UPS diagnostic test in mm/dd/yy
format.
upsAdvTestRuntimeCalibration read-write Writing to this OID provides options to perform a
Runtime Calibration Test.
upsAdvTestCalibrationResults read-only The results of the last Runtime Calibration test.
upsAdvTestCalibrationDate read-only The date the last Runtime Calibration test was
performed, in mm/dd/yy format.
upsCommStatus read-only The status of the SNMP Agent’s communication with
the UPS.
powerNetSoftwareSystemDescrip read-only A description of the PowerChute Business Edition
tion Agent.
upsOutletGroupStatusTableSize read-only The number of outlet groups in the UPS.
SNMP Traps
The tables below details the OID names of the SNMP traps sent by PowerChute for critical and lost
communication events.
Initial Setup
This option guides you through a series of screens that enable you to complete your shutdown configuration.
You can select this menu option at any time but this screen displays automatically when you first install
PowerChute.
The configuration screens are listed below in their display order. You can also access these screens individually
at any time.
• Shutdown Settings
• Outlet Sequence
• Scheduled Shutdown
You can exit the shutdown configuration on any of the screens. When you click the Next or
Advanced Setup button, your changes are saved and are retained even if you cancel out of the
Initial Setup sequence before the end.
Shutdown Settings
This screen summarizes your shutdown configuration and also enables you to configure some steps of the
shutdown sequence. (This screen is also part of the shutdown configuration accessible through Initial Setup).
The summary includes timing and delays, with the “base time” being the occurrence of the On
Battery event. The options chosen on this screen can affect the configuration of events, set up in
Event Configuration. This can include which events are selected to cause a shutdown. Read the
other sections below for further information.
See also:
• Immediately initiates a shutdown as soon as a On Battery event indicates that the UPS switched to
battery power.
• After UPS has been on battery for initiates a shutdown when the UPS has been operating on battery
power for the period of time configured here.
• At runtime limit configures the Low Battery event to shut down; this is viewable on the Event
Configuration screen.
The Low Battery event is generated when the UPS is on battery and the battery runtime falls below the
number of seconds you set here.
The Battery Discharged event is generated when the UPS is on line and the battery runtime falls below
the number of seconds you set here.
• Do not shut down during a power outage relies on the Low Runtime Warning event to cause a
shutdown.
The Low Runtime Warning event is generated when battery runtime falls below the combined time
configured for Application and Operating System shutdown: see the Operating System and
Application Shutdown section of this screen.
NOTE: This Low Runtime Warning event does not display on the Event Configuration screen as it is not
configurable (because it always causes a shutdown).
When you select different radio button options here, the displayed summary information on this screen (under
the Shutdown Summary heading) changes.
You can see this by selecting a radio button option here, pressing Apply, and going to the Event Configuration
screen to note the differences.
* The Low Runtime Remaining event is always configured to shutdown for these Power Outage Configuration options.
This event is only displayed in the Event Log, and is not configurable on the Event Configuration page.
For example, if you choose Immediately here and apply it, you will see in the On Battery row of Event
Configuration that the Shutdown checkbox has been selected automatically.
And if you then clear the Shutdown checkbox for the On Battery event of Event Configuration, apply it, and
return here to Shutdown Settings, the Immediate option will NOT be the selected option.
Another field on this Shutdown Settings screen, Time required for command file to run under Operating
System and Application Shutdown, interacts with the Command File Execution Duration field for the
Shutdown Starting event on Event Configuration. When they are changed, these fields automatically update
each other.
(Note that the Time required for command file to run field only displays on Shutdown Settings when you
have chosen a command file).
See Outlet Sequence for information on setting up delays and sequencing in shutdowns.
1.The scheduled shutdown is due to run within ten minutes. At this point, you cannot edit a schedule though
you can cancel it. The schedule is labeled as Pending.
2.The schedule can’t be run: something has happened since you created the scheduled shutdown. .
–You should edit or delete this schedule, see Creating and editing schedules.
See also:
To create a schedule:
• Click on a date in the main calendar view, and the Scheduled Shutdown dialog displays.
NOTE: You can only create shutdown schedules for a future time and date.
• Fill in the fields:
–Schedule Name: Provide a meaningful name for the schedule.
–Shutdown sequence starts at: Enter the date and time at which you want the shutdown sequence to
begin. Due to your UPS model, the time value can only be updated in 6-minute increments.
Notes:
•You can define the shutdown sequence by the configuring the Shutdown Settings.
• Once you enter a date and time to start the shutdown sequence, the Turn-on sequence time is
automatically populated to include:
•The Time required for command file to run (defined in the Shutdown Settings), plus
•The Time for Operating System to shutdown (defined in the Shutdown Settings), plus
•A minimum stay off delay of 6 minutes (to ensure that the attached device has enough time
to restart).
• Click on the scheduled shutdown in the main calendar view and the Scheduled Shutdown dialog
displays with the current details.
• Change any field value as necessary and choose OK.
• Choose the Delete button to erase it from the calendar view.
A schedule is removed from the calendar after it runs.
A scheduled shutdown starts with the shutdown being initiated, and ends with the turn-on
command. Though the schedule duration does not appear to include the turn-on delays, they are
added to the schedule when it is executed. See Outlet Sequence.
You can expand a schedule into a future date, but not into a past date. Expanding can save you time because
you don’t need to open the Scheduled Shutdown dialog.
To expand in the calendar view, hover the mouse pointer over the right edge of the schedule until you see the
double-headed arrow, and click and drag.
PowerChute Business Edition uses criteria to ensure that the overlapping schedules you enter make sense, as
well as actually being possible to run.
To achieve this, PowerChute prevents the creation of some overlapping schedules and enforces priorities and
rules, as outlined in Guidelines for running overlapping schedules.
How does PowerChute decide which one is run? By using this logic:
Prioritizing once-off schedules enables you to schedule a unique shutdown like a public holiday.
Prioritizing weekly over daily schedules enables you to shut down at the weekend, while maintaining daily
scheduled shutdowns.
IMPORTANT: As indicated, a schedule could be designated to start before an overlapping one and
still not run.
The transition hour means the skipped hour when daylight savings commences in Spring.
Additionally, you can choose whether your outlet group should automatically turn back on after a shutdown. (By
default, they turn on).
The delays on this screen apply to all shutdowns whether initiated by a power event, a scheduled
shutdown, or manually by a user.
An example of this usage is in electronic “Point of sale” transactions, where it is essential to ensure that all the
front office equipment has been shut down gracefully before the back office equipment shuts down also. This
maintains the accuracy of the sales transaction data.
Similarly, On Sequencing is achieved by delaying the turning on of individual outlet groups. This applies when
your system is starting up initially or on the return of AC utility power after an outage.
You might use on sequencing to avoid a temporary overload if all the devices connected to your UPS try to turn
on at the same time. Another use might be to ensure that certain equipment, such as network switch devices,
turns on before other equipment, such as servers, which need the network switch in order to communicate.
Turning On
Outlet Group Outlet Group Outlet Group
with no delay with 40 sec delay with 80 sec delay
0 100
Seconds
Time, in minutes and seconds, is measured along the bottom of the graph. The selected outlet group has a
green border in the graph.
Move your pointer over each section in the graph to display text with information on time values for that outlet
group.
View and edit the turn off and turn on values in individual fields lower down on the screen.
To move between outlets, you can either click on a different row in the graph, or select a different tab.
The Automatically turn on all outlet groups when AC utility power returns checkbox
underneath the graph applies to all outlet groups displayed on this screen. If you want to turn on
outlets manually after your system has turned off, clear this checkbox.
What displays here for other outlet groups depends on which type of outlet group — Main or Switched —
supplies power to the server that the PowerChute Agent is protecting. The different set-ups are discussed
below.
• If your UPS has a Main Outlet Group and it supplies power to the PowerChute Agent, then all outlet
groups will automatically turn off. When turning off, a Main Outlet Group always turns off all the Switched
Outlet Groups.
Group 1 Group 2
OFF sequence
The outlet group supplying power to the PowerChute Agent has these possible turn-off delay times:
• Time for other applications to shut down: this value represents a duration for applications like Siebel
and Microsoft SQL to shut down gracefully and for any command file to run.
This is a read-only value here. In many circumstances, it derives from Time required for
command file to run on Shutdown Settings. However, if you configure ANY individual shutdown
event to use a greater command file running time, then that is displayed here instead. (You
configure this on Event Configuration). See also the Interactivity in shutdown durations.
• Time for operating system to shut down: this value is configured on the Shutdown Settings screen.
Other
applications
+ Operating
System
shutdown shutdown
Main Outlet Group
Group 1
• Minimum battery charge required before outlet group turns on: Select the percentage of battery
charge that must be available before the outlet group will turn on. This value is included following a Low
Battery, On Battery or Time on Battery Threshold Exceeded-related event shutdown.
• Use this additional delay to sequence outlet group turn-on: Selecting different delay values in this
field causes the sequencing of turn ons. Place the mouse pointer over the different graph rows for further
information on the delay values shown.
• Select a value (in seconds) to wait before the UPS will turn on the Main Outlet Group.
• On
• On, turning off
• On, processing shutdown
• On, processing sleep
To choose an action for an outlet group, select it from the drop-down box and click Apply. The available actions
are below, (see also Outlet Sequence):
• Off with Delay - turn off the outlet group power while enforcing the configured delays.
• Shut down with Delay, AC restart - turn off the outlet group while enforcing the configured delays; if AC
utility power subsequently returns, the outlet group will restart, with configured delays.
When performing actions on the PowerChute Outlet Group, a turn off delay is always applied to allow for
graceful shutdown.
This user interface always displays a confirmation screen before carrying out any of these actions.
Use the Confirm button on that screen to continue with the action or Cancel to stop. The
confirmation screen also specifies any configured delays in seconds.
The screen can be used as a quick alternative to scheduling a once-off shutdown.In addition, it gives you the
option of manually turning on power to the UPS after a shutdown.
UPS Shutdown Type With both of these options in this drop-down box — Delayed
Wakeup and Manual Restart — the turn-off delays you have set
up on Outlet Sequence are observed.
Use it to specify the amount of time the UPS will remain turned off.
Use the Cancel Pending Shutdown button on this screen if you change your mind about shutting
down. It displays on this screen before the shutdown commences.
Event Log
A PowerChute event can be critical, warning, or informational. An example of a critical event is a low battery,
and a warning event could be when power to the UPS has been interrupted. Informational events are everyday
occurrences such as the monitoring of your system has started, or a self test has passed.
The View Event Log screen lists and classifies the recent UPS events and the date and time each event
occurred. The list starts with the most recent events. See Event Configuration for descriptions of events.
To export the log to a text file, EventLog.txt, click the Export button. View this file in
C:\Program Files (x86)\APC\PowerChute Business Edition\agent
(or wherever it is installed).
To delete the contents of the event log, click the Clear Log button at the bottom of the screen.
Click Refresh to view events that might have occurred after you first displayed this screen.
2010timestamp;realLoad(watts);relativeLoad(percentage);calculatedLoad(watts)
1. Calculate the difference between the UNIX timestamp starting point (01/01/1970) and the
2010timestamp value from the log (01/01/2010), which is 1262304000.
2. Add the timestamp value from the log file (for example 368633153) to 1262304000, which equals
1,630,937,153.
3. Using a third-party tool such as Epoch Converter, enter the value calculated in step 2 into the text box
and click Timestamp to Human date. The output will reveal the timestamp:
Converting 1630937153:
1. Multiply the load value by 300,000 to convert the interval from 5 minutes into milliseconds (5 x 60 x
1000).
2. Divide the value by 3,600,000,000 to convert the interval into seconds, then hours, and then from Watts
to Kilowatts (3600 x 1000 x 1000).
Data Log
The View Data Log screen logs are sorted by date, then time, with the most recent data appearing at the top of
each screen. This table gives a brief description of the fields:
Field Description
Input Line Voltage (VAC) The AC voltage being provided to the UPS at the time that
the entry is made in the data log.
UPS Output Voltage (VAC) The voltage, in volts AC, supplied by the UPS to its
supported equipment.
Battery Voltage (VDC) The voltage, in volts DC, on the UPS device's battery.
Battery Charge (%) The percentage charge of the UPS battery capacity.
Input Frequency (Hz) The frequency, in Hertz, of the input voltage to the UPS.
UPS Load (%) The percentage of the possible UPS load that your
equipment used during the recording interval.
Internal UPS Temp (°C) The UPS temperature in degrees Celsius or Fahrenheit.
Use the Show / Hide Columns button to hide any of the displayed columns, other than date and time which
cannot be hidden.
Click the button to display the column checkboxes and clear any checkbox to hide that column. This feature
affects the display only; all data is still recorded.
By clicking and dragging on a column heading, e.g. Output Frequency (Hz), you can move and re-arrange
columns. To return to the original, default arrangement, click on the Reset Columns button.
To delete all records in the data log, click Clear Log at the bottom of the screen.
Click Refresh to view new data since you first displayed this screen.
Log Settings
Log Settings enables you to configure the recording parameters of both the Event and Data Logs. This includes
disabling logging. If event logging is disabled, the options relating to logging in Event Configuration are also
disabled.
The Event Log records individual event occurrences. The Data Log, by contrast, provides you with a snapshot
of your system by recording values at regular time intervals.
• With the Expiration fields (Event Log Entry Expiration and Data Log Entry Expiration), choosing a long
time interval could mean that your log eventually takes up a lot of disk space.
• The Data Recording Interval field specifies how often the data is recorded to the Data Log. The smaller
the interval, the more times the data is recorded and the larger the log file.
• If you choose Do Not Delete Entries, the files might get very large after a period of time.
Energy Management accesses data on Schneider Electric servers by using the Internet.
Energy Reporting
The energy report gives you information on Energy consumed in kilowatts per hour and the Cost incurred in
your local currency.
On installation, PowerChute references your operating system and determines your system locale.
From the locale, PowerChute determines average prices and emissions for your country. (See
Energy Settings).
CO2: The carbon dioxide that was emitted in generating this energy. This is measured over the chosen time
period in kilograms or pounds.
Carbon dioxide is a greenhouse gas — it traps heat radiation that would otherwise escape from Earth — and is
a primary cause of climate change.
You cannot enter a date prior to the PowerChute installation date in the From field. You cannot enter a date
after today’s date in the To field.
If you change the From date, this new date becomes the default, whereas the To date is always today’s date.
(If you have performed a PowerChute upgrade, the From date is still the original installation date).
If you replace the UPS supporting your server with another UPS, the existing energy report values
are not deleted.
Energy Settings
With this screen, you can change the country used in energy calculations, the cost of your energy, and your
CO2 emissions calculation.
If you change your country here, ALL historical values, including CO2 emissions, are deleted. This
is because energy costs vary between countries, so the historical costs would be very likely
inaccurate.
The country selected is used to calculate average costs. However, if you know your energy costs from your
electricity bill, then you can use the Cost per <Kilowatt/ Pounds> Hour column to input a different value.
If you delete a row, it will not be used in any future energy calculation.
Energy calculation
The costs and dates on display here combine to generate the report on Energy Reporting.
For example, suppose your screen by default displays 04/25/2017 with a cost of 0.1. You add a row with a date
of 10/30/2017 and a cost of 0.15.
For the example, let’s say today’s date is January 3, 2018 (displayed as 01/03/2018).
In calculating the total cost, the Energy Reporting screen uses the 0.1 cost per hour for the dates 04/25 to 10/29
in 2017, and the 0.15 cost per hour for the period from 10/30/2017 to 01/03/2018.
Product Version
Parameter Description
PowerChute Business Edition The version number of the PowerChute Business Edition Agent
Agent Version running on the server.
Java Version The version number of Java running on the server.
• Scheduled Shutdown
• SNMP Settings
SNMPv3 passphrases are not saved to the configuration file as they need to be stored
securely. When the configuration file is copied over to another machine, you must manually
enter the passphrases. For more information, see Knowledge Base article FA360658 on the
APC website.
• Language Settings
After you have configured one installation of PowerChute, you can use the pcbeconfig.ini file to apply the
same configuration to another copy of PowerChute on a different machine.
1. Stop the PowerChute service. For more information, see Knowledge Base article FA360654 on the APC
website.
2. Replace the existing copy of pcbeconfig.ini in the Agent directory.
3. Start the PowerChute service.
Resetting your Username and Password
If you have forgotten the username or password created during installation, you can reset the credentials by
using the pcbeconfig.ini file:
1. Open the pcbeconfig.ini file with a text editor (e.g. Notepad) and add the following:
[Credentials]
username=
password=
Java Update
The Java Update feature enables you to change the Java Development Kit (JDK) used by PowerChute to any
other JDK already installed on your system. Follow the steps below to update the Java version used by
PowerChute:
1. Download a valid JDK on your system. JDKs can be downloaded from the OpenJDK website.
PowerChute v10.0.5 supports OpenJDK 17 or above. You can only update the Java
version used with PowerChute to a 64-bit JDK.
The Java versions supported by PowerChute are posted on the APC website at http://
www.apc.com/wp/?um=100.
2. Navigate to the PowerChute installation directory, and create a new folder called “Updates”. If the
default installation directory was chosen during installation, this location will be:
– C:\Program Files (x86)\APC\PowerChute Business Edition\Updates for Windows
systems
– /opt/APC/PowerChuteBusinessEdition/Updates/ for Linux systems
3. Copy the Java file (tar.gz or zip) downloaded in Step 1 above to the Updates directory.
4. Navigate to the About dialog in the PowerChute UI. Under Software Updates, the downloaded Java
file will be listed in a drop-down box in the Java Update Available field.
5. Select the Java version you want to update PowerChute to use from the drop-down box, and click
Update Java.
6. An authentication dialog will appear asking for your PowerChute credentials if you are upgrading the
Java version used for the first time. Enter your credentials and click Sign In. Upon successful
authentication, the Java upgrade process begins.
7. PowerChute restarts automatically during the Java upgrade process. Wait 3-5 minutes for the Java
version to successfully update.
8. When the PowerChute service restarts, refresh your browser and navigate to the About dialog. The
Java Version field will be updated to show the new Java used by PowerChute.
As part of the CEIP, we will collect certain information about how you configure and use PowerChute Business
Edition in your environment. This information is completely anonymous, and cannot be used to personally
identity any individual. For more information, please refer to the CEIP Frequency Asked Questions on the
APC website.
By default, you are participating in the PowerChute CEIP. If you prefer not to participate, unselect the Join
PowerChute Customer Experience Improvement Program ("CEIP") checkbox in the PowerChute
Customer Experience Improvement Program page. You can join or leave the CEIP at any time.
PowerChute Updates
PowerChute automatically checks for updates and informs you if a new version of the software is available
to download. This update check sends anonymous PowerChute environment data to the Schneider Electric
update server.
The Enable PowerChute Updates checkbox is selected by default. If you prefer to opt-out of checking for
updates, unselect this checkbox.
If you have a PowerChute customer issue, contact your regional Technical Support team, and provide the
PcbeFiles-<TimeStamp>.zip file to help resolve your issue.
For information on how to obtain local customer support, contact the APC by Schneider Electric
representative or other distributor from whom you purchased your APC by Schneider Electric product.
As standards, specifications, and designs change from time to time, please ask for confirmation of the information given in this publication.
© 2022 Schneider Electric. All Rights Reserved. Schneider Electric, APC and PowerChute are trademarks and the property of Schneider
Electric SE, its subsidiaries and affiliated companies. All other trademarks are property of their respective owners.
990-3773J-001 01/2022