Topic 8.3.1: System Management Console (SMC)
- About System
Management Console
- The System Management Console (SMC) provides ArchestrA
Application Server application diagnostics by allowing you to view the run-time
status of some system objects and to perform actions upon those objects.
Actions include setting platforms and engines in an executable or idle mode and
starting and stopping platforms and engines.
- The System Management Console is used to assist
system integrators and system administrators in performing
administrative tasks and diagnostics on an ArchestrA application. It provides
application infrastructure diagnostics by allowing the viewing of runtime
status of some system objects and the ability to perform actions
upon those objects.
Actions include setting
Platforms and Engines in an
executable or idle mode and starting and stopping Platforms and Engines
- Features of
the System Management Console
- Some of the key features of the Platform Manager are that it:
- Runs with minimal ArchestrA
and operating system
requirements, equivalent to "Safe
mode"
- Uses the local
platform as the gateway to the ArchestrA application
- Does not rely on
the Galaxy Repository to exists.
- Allows viewing of
the layout of the Galaxy Repository, Platforms, and Engines
- Provides the
ability to set Platforms and Engines OnScan or
OffScan
- Provides the
ability to start and stop Platforms and Engines
To Start the System Management Console --> click Start Select All Programs/Wonderware/System Management
Console.
- Some of the key features of the Platform Manager are that it:
- Runs with minimal ArchestrA and operating system requirements, equivalent to "Safe mode"
- Uses the local platform as the gateway to the ArchestrA application
- Does not rely on the Galaxy Repository to exists.
- Allows viewing of the layout of the Galaxy Repository, Platforms, and Engines
- Provides the ability to set Platforms and Engines OnScan or OffScan
- Provides the ability to start and stop Platforms and Engines
To Start the System Management Console --> click Start Select All Programs/Wonderware/System Management Console.
- The Platform Manager appears under the ArchestrA System Management Console (SMC)
- If the Galaxy has security enabled, the Platform Manager Login dialog box appears when the user attempts to access the Platform Manager from the System Management Console (SMC).
- Console Tree
- The console tree has a Windows Explorer-type hierarchical structure layout, with the ArchestrA System Management Console appearing as the root node and the SMC snap-ins appearing below this node. Like Windows Explorer, the console tree can be expanded or collapsed by clicking on the "+" or the "-" symbols that appear next to the snap-in.
- The console tree shows the items that are available in the console. The snap-ins that appear below the ArchestrA SMC node will depend upon the software installed:
- Galaxy Database Manager (GR Node only)
- DAServer Manager (DAServer or WinPlatform deployed)
- Log Viewer (all Wonderware nodes)
- Platform Manager (all Application Server nodes)
- Other snap-ins (for example IndustrialSQL Server) will be available when other Wonderware software is installed
- Each snap-in has its own toolbar, menu options, detail
panel, and so on. The contents of these items will change as you select
different items in the console tree.
- Security
- For all ArchestrA administrative utilities, including
Platform Manager, security is configured through the ArchestrA IDE. By default,
there is no security enabled
for Platform Manager
or any of the other snap-ins.
- For all ArchestrA administrative utilities, including Platform Manager, security is configured through the ArchestrA IDE. By default, there is no security enabled for Platform Manager or any of the other snap-ins.
- Galaxy Database
Manager
- Selecting the Galaxy Database Manager on the SMC Menu allows you to view all the galaxies in the Galaxy Repository, as well as the nodes they reside on.
- You must have Administrative privileges to use the Galaxy Database Manager.
- Galaxy Backup
/ Restore
- Be sure to back up your Galaxies so that if a Galaxy
becomes corrupted, you can restore the Galaxy. You can choose a backup file to
overwrite an existing, corrupted Galaxy or to reproduce a Galaxy in another
Galaxy Repository.
- The Galaxy Database Manager is automatically installed on every
Galaxy Repository node.
- Backup
- When running a Galaxy backup, no other applications may
write to the GR node. Be sure to perform the backup operation when no
database-write operations will occur.
- Select the Galaxy to backup, and select Action / Backup.
- Name the .cab file to be created, and click Save.
- Select the Galaxy to backup, and select Action / Backup.
- Name the .cab file to be created, and click Save.
- Click
Close when the backup is complete.
- Create a new galaxy with a galaxy backup (.cab) file
- You may also create a new galaxy using the .cab file created
when a Galaxy backup is performed.
You must first copy the backup .cab
file to:
- C:\Program Files\ArchestrA\Framework\Bin\BackupGalaxies
- In the New Galaxy window,
create a new galaxy and select your backup Galaxy in the Galaxy type field.
- C:\Program Files\ArchestrA\Framework\Bin\BackupGalaxies
- Restore
- When you restore a database from backup, any information
saved to the database since the backup was performed is overwritten with the
restored information. All changes to the database since the backup are lost.
Also, any transactions in progress when the backup was performed are rolled
back.
- On the Action menu, click Restore.
- Click Yes to continue restoring and No to terminate the restore function.
- Select the name(.cab extension) of the backup file you want to use and click Restore.
- If you have an active client connected to the Galaxy Repository, a message appears. You are required to quit those client programs before restore can continue.
- A confirmation dialog box displays when the restore function is finished.
- DAServer Manager
- The DAServer Manager allows local or remote
configuration of the DA Server and its device groups and items, and can monitor
and perform diagnostics on DAServer communication with PLCs and other devices.
Log Viewer
- The ArchestrA Logger is a utility that records information regarding the activity occurring on the computer. For example, it records start-up data, error conditions, and DAServer information.
- The Log Viewer can:
- Monitor messages on any machine in the system
- Send a portion of the log to notepad or E-mail
- Filter messages on a flag
- When running an ArchestrA application, the Logger runs as a system service. The Log Viewer is a Microsoft Management Console (MMC) snap-in that provides a user interface for viewing messages reported to the Logger. The MMC is a host or container utility for the Log Viewer with its own generic functions.
Note: If a problem occurs while running an ArchestrA application, always check logged messages by using the Log Viewer prior to calling Technical Support.The following commands are available from the Platform Manager Action menu when you select a platform or engine in either the console tree or the details pane.
Command |
Description |
Configure |
Allows configuration of the Log Viewer and Storage |
Log Flags |
Opens the Log Flag editor |
Open Log File |
Allows the opening of a Log File |
Connect |
Allows either local or remote connections configuration |
Messages |
Allows Messages to be exported, purged, or printed |
Refresh |
Refreshed the database |
Help |
Access to the System Management Console Help files |
- These commands are also available by right-clicking an item in either the console tree or the details pane. The available commands are dependent on the current state of the object and your security permissions. If you do not have permission to perform a particular command, then that command is grayed out.
- The following commands are available from the Platform Manager Action menu when you select Log Viewer in either the console tree or the details pane.
Command |
Description |
Monitor |
System messages provide information about the state of the IndustrialSQL Server historian as it starts up, runs, or shuts down. For more information about system messages, see System Messages. |
Open Log File |
Use this dialog box to locate and open a log file of saved messages. |
Connect |
Allows the opening of a Log File |
About Log Viewer |
Displays copyright and version information |
New |
Create a new log file. |
Refresh |
Update the contents of the Log File window. |
Export List |
You can export the currently shown log messages to a log file. Log files have an .aaLGX extension. The default file name is LogExport with the current date in the format (mmddyyyy) appended as a suffix. You can edit the name of a log file but not its extension. |
Help |
Access to the System Management Console Help files |
- The following commands are available from the Platform
Manager View menu when you select a platform or engine in either the console tree or the details pane.
Command |
Description |
Filter |
Allows filtering of Messages, Time Range, or Terminal Sessions |
Find |
Search capability on Process ID, Thread ID, Log Flag, Component, or Message |
Go To |
Allows redirection to a Bookmarked location |
Bookmarks |
Allows Adding or removing of a Bookmark |
Mark |
Allows the entry of a Marker Message to the log |
Choose Columns |
Select specific columns to show or hide |
Customize |
Change the appearance of the view |
- The Logger and Log Viewer are automatically installed when an
ArchestrA component is installed.
- Logger - This is the background process that stores
messages and events
in the system. This process occurs without any prompting from or
interaction necessary from the user. The
logging process can be customized with the LogFlag Editor Snap-In utility. The
Logger is installed as a system service, and can be configured to be an Auto
Service or Manual Service. As an Auto Service utility, the Logger is started
when the PC is booted up. As a Manual Service utility, the Logger requires a
manual start through the System Services utility in Windows’ Control Panel. In
either case, the logging process is always started when an ArchestrA component
begins functioning.
- Log Viewer - This utility is used to view error and informational messages that are sent by ArchestrA components. The
look-and-feel and the format of the user interface can be customized to suit
individual needs.
- The Log Viewer is primarily a troubleshooting tool.
After initially installing an ArchestrA-enabled program and on occasion, you
might check logged messages to determine whether all processes are functioning
well. But typically, you would use the Log Viewer to work through problems you
encounter with a DAServer, the ArchestrA IDE or other ArchestrA component.
Note: The Log Viewer displays error messages in red-highlighted stripes.
These indicate malfunctioning processes and should be resolved quickly. Warning
messages are displayed in yellow stripes. These indicate major events in the
system.
- A good strategy for troubleshooting problems
- Gather as much information first
about the process that is malfunctioning. For instance, you attempted to deploy an object in the ArchestrA IDE and a message was displayed stating
the deployment was not completed. Note the function you attempted and
the message you received.
- Open the Log Viewer by clicking Start, pointing to Programs and then to
Wonderware, and then clicking System Management Console. In the SMC, select Log Viewer and then the node the
ArchestrA IDE is located on. Look for red and yellow messages. Also, use the
information you collected
about the failed
process to search
for clues in the logged
messages.
- Use the Find command on the View menu
to single out messages by message text or other category of data, or use the Filter command on the View menu to reduce the number of
displayed messages based on message, time range or terminal session criteria.
- The journey of a Log Message originates with the
Application where Log Flags are generated. These are passed to the Logger where
they are then stored in the Log Message Storage. They are then available for
viewing by the LogFlag Viewer. The LogFlag Editor provides the capability to
edit the LogFlags. This is illustrated in the following diagram.
- The Log Viewer is primarily a troubleshooting tool. After initially installing an ArchestrA-enabled program and on occasion, you might check logged messages to determine whether all processes are functioning well. But typically, you would use the Log Viewer to work through problems you encounter with a DAServer, the ArchestrA IDE or other ArchestrA component.
- Gather as much information first about the process that is malfunctioning. For instance, you attempted to deploy an object in the ArchestrA IDE and a message was displayed stating the deployment was not completed. Note the function you attempted and the message you received.
- Open the Log Viewer by clicking Start, pointing to Programs and then to Wonderware, and then clicking System Management Console. In the SMC, select Log Viewer and then the node the ArchestrA IDE is located on. Look for red and yellow messages. Also, use the information you collected about the failed process to search for clues in the logged messages.
- Use the Find command on the View menu to single out messages by message text or other category of data, or use the Filter command on the View menu to reduce the number of displayed messages based on message, time range or terminal session criteria.
- Platform Manager
- Platform Manager is a common component of an Application Server application and it is available from any PC node in the application that has a deployed platform; therefore, you do not need to install it onto each node. This ensures that all nodes used within a galaxy have access to Platform Manager.
- When you use Platform Manager, you can access the platforms and engines deployed to the local PC node and to any other PC node in the Galaxy. Platform Manager does not require the GalaxyRepository to be installed on the PC node.
- After highlighting a Galaxy or an Engine, you can use the Action menu to start or stop the object, or set it OnScan/OffScan. If the galaxy has security implemented, you must log on as a user configured with the proper SMC permissions to start SMC, Start/Stop engines and platforms, or write from the Object Viewer.
- Console Menu
Commands
- The following commands are available from the Platform Manager
- Action menu when you select a Platform in either the console tree or the details pane.
- The following commands
are available from the Platform
Manager
- Action menu when you select an Engine in either the console tree or the details pane.
- The following commands are available from the Platform Manager
- Action menu when you select an Engine in either the console tree or the details pane.