About the Workspace Window
With the Workspace window, you can configure a complete XML document, including commands, that can then be transmitted to the server or be exported to an XML file and sourced on the server by other means. If you transmit the document from the Workspace, you can also use run-time commands to interact with the server including query Operational Measurements (OMs), execute actions, and control the node operations. This topic presents an overview of the arrangement of the window and the controls that are available.
The Configuration Tab
The Configuration tab contains the same information as the config element in the dsTest schema - the configurations of the node emulators including applications, interfaces and subscribers. Check boxes are used to select the node emulator(s) to be configured. As emulators are selected, a sub-tab containing the configurable parameters is added.
Refer to Creating a Document for more information about defining a configuration.
The Document Outline Panel
Whenever a Workspace or XML Snippet file is open and selected, the XML hierarchy, as defined by the dsTest schema, is displayed in the Document Outline Panel. Elements that contain other elements (parent icons) or that contain multiple instances of one element are represented with a icon. Multiple instance containers are labeled with the element name plus "Group". Elements that contain a value or are significant merely by their presence are represented with a icon.
Elements that have been deprecated are represented with a icon, indicating that they should no longer be used. Deprecated elements will be removed in the next major release. For more information on current deprecated items, click here.
Several visual indicators are used to track the status of your document:
Usage - elements that have not been selected and will not be included in the final XML document or snippet are shown with a gray icon and label
Modifications - elements whose value and/or structure have been modified display an asterisk (*)
Errors - elements that have failed validation are displayed with a red label
Modification and error indications ripple upwards through the document's hierarchy, which enables you to locate erroneous elements in a large document by drilling down through the structure. Errors can also be located by using the F3 key.
The Commands Tab
The Commands tab is divided into three sections:
Initial Commands - contains the commands that will be included in your XML document and executed immediately after the configured nodes have been initialized
Run-Time Commands - contains the commands that you may issue after successfully transmitting your document to the server
Server Responses - serves as a command log, displaying the description of Run-Time Commands as they are issued and the feedback received from dsTest as all commands are executed
Each of the command sections contains a table that lists the commands that you have configured using the Command Wizard, and includes controls used to manage and use your commands:
- adds a new command and displays the Command Wizard
- opens the selected command in the Command Wizard for editing or viewing
- deletes the selected command
- moves the selected command down or up one row
- issues/activates the selected Run-Time Command
Commands can be copied within a command section, or to the other section with drag-n-drop:
A simple drag moves a command to a different row in the same table or to a row in the other table. Pressing and holding Ctrl before initiating a drag performs a copy. If the copy is dropped in the same table "Copy of" prefix is added to the command name.
Command(s) can be opened/viewed by double-clicking the table row.
All of these actions can be performed on multiple commands but note the that selection of table rows and initiating a drag cannot be done with the same mouse press. The mouse must be released after selecting table rows before the selected rows can be dragged to the new location.
Refer to Creating a Document and Issuing Commands for more information about working with Initial Commands and Run-Time Commands.
The Report Tab
A chart or tabular report can be configured locally or a standalone report can be linked in, similar to the way snippets are handled. As with snippets, a linked report can be converted to a local configuration and a locally configured report can be saved off as a standalone report.
The report can be configured to start automatically - after the configuration has been successfully sourced (will not start if error returned by dsTest) or when the state is manually changed to RUNNING using the 'Test is Active' button - or it can be started manually by clicking the play button which is enabled while in the RUNNING state.
All report functionality is supported. When the report has been linked in it will have its own 'Save' and 'Save As' buttons; otherwise the report definition is saved with the workspace along with the report selection and start options.
The OM tree will display all objects from the live database.
For more information regarding OM charting and reporting see Operational Measurements.
A series of buttons along the bottom of the Workspace window execute actions that involve the entire Workspace:
Save - used to save modifications made to an existing Workspace
Save As... - used to save a new Workspace or to save an existing Workspace with a different name or to a different directory in your library
Find/Replace - used to make multiple changes to values of elements with one interaction
To XML... - generates a complete dsTest XML document including any configured Initial Commands. This action only becomes available when all validation errors have been cleared. The XML document is displayed in a pop-up window. Click the Save button and save the document wherever you choose or copy the XML (Ctrl + a selects the window contents) and paste it into a file.
Test Connection - can be used to test the connection with the Workspace server or to attempt to restore the connection after a communications failure. A pop-up dialog will inform you of the resulting connection status.
Test is Active - This button shifts the workspace to RUNNING mode, enabling run-time interactive actions.
Calculate Resources - The current configuration will be sourced/transmitted with the resource attribute set, causing dsTest to assess the memory and TPS required by the configuration and compare to the current capability of the server. The response from dsTest is posted to the Commands tab (workspace will switch to that tab if it's not already selected). The button is enabled using the same rules as the trasmit button - server is connected, no validation errors, and not already in the running state. Low priority port is used for the command. This feature is part of the Automated Testing Support in dsTest.
Transmit to Server - generates the dsTest XML document and transmits it to the Workspace server, effectively issuing a source command. This action only becomes available when all validation errors have been cleared and a connection to the Workspace server is present. Workspaces register for status_change notifications upon entering the running state (transmitting a configuration to the server) and deregister when cleaning up or entering the editing state. Notifications received are displayed with a time stamp in a response container that is always first in the list and that will expand as new notifications are received.
Collect Results - Becomes available after exiting the running state, and the workspace will now roll the log prior to transmitting a configuration. The button presents a standalone window that allows the user to either collect the OM databases resulting from the test or collect the files necessary for support assistance. If the workspace window was open from the time the configuration was transmitted, the remote files displayed will be filtered by time stamp and only those written to after the log was rolled are shown. The workspace window may be closed as all pertinent information is conveyed to the collection window. If the workspace was opened while the test was active all files from the run directory are shown and the user must select the appropriate files. All files collected are zipped to the destination file specified by the user and a popup dialog will notify the user when the file is ready.
The remote file list will include all dsTest and packetPipe log files, pcap files, and OM databases, any CSV files associated with the workspace, and an exported workspace bundle will be added automatically to the zip file. The user can add any local files that may be useful (flow diagram, requirements, spec, etc.). If the start time was available from the workspace all remote files in the filtered list will be downloaded by default. However if specific files were selected, only those files will be included. If a streaming error is causing many log files to be filled, for example, it may make more sense to only include the first and last log files along with the database and pcap files.