DEV Server Tool v 2.1

User Guide

www.CyberDefenses.com

2

Table of Contents REASON TO DEPLOY ....................................................................................................................................... 3

CONFIG CHANGES – RESTART PLUGIN ............................................................................................................ 3

HOW TO BRAND ............................................................................................................................................ 4

ADD SUPPORT HYPERLINKS ........................................................................................................................... 5

CLUSTER TROUBLESHOOTING ........................................................................................................................ 6

DEV SERVER TOOL

3

REASON TO DEPLOY If you have ever run a demo, tested an access request, or deployed code in your production system – when you meant to do this in a lower environment, then you must install this plugin! The plugin allows System Administrators and End Users to visually identify what environment they are currently using, by changing the top menu color and allowing you to add a visual name of your choice. (Any other branding you may have configured will not be affected.)

CONFIG CHANGES – RESTART PLUGIN If you make any configuration changes, always restart the plugin. The System Administrator and End User menus are created and stored in memory, so that the only overhead in the plugin is checking the capabilities of the user and passing a single string item via a REST API. This makes the Plugin response and fast, but does require a restart of the plugin to see any changes.

DEV SERVER TOOL

4

HOW TO BRAND

1. Install the DEV Server Plugin

2. Select “Configure”

3. Choose an HTML color or your choice. If you don’t want to alter the color, type the word “none”.

4. Type any text you would like to distinguish the system (eg. Sandbox or UAT).

5. Using the green power button, restart the plugin and the changes will be applied.

DEV SERVER TOOL

5

ADD SUPPORT HYPERLINKS To help with UAT testing, CyberDefenses has provided some powerful options to improve efficiency. For instance, you can add a link to the testing software or a link to track/submit bugs or enhancement requests:

1. Go to the debug page.

2. Edit the “Configuration” element “CDI_CustomURL”

3. Add as many link entries as needed.

4. Restart the plugin

5. Login as a Non-System Adminstrator user and validate your links. NOTE: You can use $url if you need to link to another page inside IIQ. This is an ideal option for other plugins your team builds.

DEV SERVER TOOL

6

CLUSTER TROUBLESHOOTING When testing, problems may arise which cause the tester to question if a server in the cluster is not configured correctly or if a load balancer may be moving users around and causing some test cases to fail. You can make the hostname of the system you are suing show the End Users and the System Administrators so you can find and troubleshoot problems like these.

Make sure “Enable Show ServerName” is set to true. End Users will see the server name, but nothing happens if they attempt to select it. System Administrators will go to the “About Page” if the server name is selected.

DEV SERVER TOOL

7

EDIT LOG4J CONFIGURATION If you follow the best practice of setting up custom logs for each custom rule you create, this option is a great feature for any system. When you enable “Show EditableLog,” the system will find your log4j.properties file and display it in an editable window. Add the log entry you want and when you click “save”, the log file on that server will be updated and reloaded. In addition, a backup folder will be created, and each log configuration will be stored in the event it becomes corrupted or simply to provide a view of the history of your log4j configuration options. Log4j Properties

Also notice the slide where you can control if the update should set on all servers in the cluster or just the server you are currently connected to.

Access old versions if needed via the backup folder.

DEV SERVER TOOL