Chat now with support
Chat with Support

ChangeBASE 6.2.2 - User Guide

Introduction Before You Start... Installing ChangeBASE Configuring ChangeBASE The Pre-Loading of Packages into ChangeBASE Import Options Applications Options Checks Options Dependency and Conflict Checker Dashboard Reporting Repackaging and Virtualization Web Capture

Creating a User Defined Dashboard Summary

Creating a User Defined Dashboard Summary

Included within the Predefined list of overviews on the left of the screen is a User Defined category that allows you to create your own summaries.

To create a summary

  1. Open up the Predefined list of overviews on the left of the screen, by clicking on the left of the screen.
  1. Drag User Defined onto the Dashboard. This displays a list of the applications in the product and their RAG statuses.

TIP: In order to have the maximum space in which to work, it is advisable to dock the User Defined summary over the full width of the full Dashboard window, and to close the Predefined list, by clicking .

  1. Enter the criteria for the overview at the top of the screen, for example: Select the <Count> Of <Application Name> Grouped by <Manufacturer>, where the items within angled brackets are selectable from drop-downs.
  2. Against Widget Title, enter a meaningful name for the overview. The name of the tab is updated.
  3. Right-click on the newly named tab and determine the format of the output by selecting Mode > Pie, Mode > Bar, or Mode > Grid as required. You can also select Expand to display the tab in the full Dashboard window.

To change the colors on a report

  1. Right-click on the newly named tab and select Mode > Colors > Rainbow/Dynamic.

To reconfigure the report

  1. Right-click on the newly named tab and select Mode > Config.
  1. Amend the criteria at the top of the summary as required.
  2. Right-click on the report tab and select Mode > Pie, Mode > Bar, Mode > Grid and/or Mode > Colors > Rainbow/Dynamic, as required.

Note: The new summary persists from one ChangeBASE session to the next.

Scheduled Jobs

The ChangeBASE Scheduled Jobs facility allows jobs of different types to be scheduled for execution at a specified time. Currently the scheduler supports two types of jobs: -

Script Jobs – for execution of Powershell scripts including scripts that access the ChangeBASE API

Check Update Jobs – for the application of updates at a schedule time. Update jobs are discussed further in the section on updates.

Viewing Jobs

You can access the facility from the Dashboard by creating a Scheduled Jobs Widget.

You can see an expanded view of the widget by clicking the down arrow in the top right hand corner of the widget and selecting Expand.

Job Maintenance

Job functions are accessed through the toolbar of the Scheduled Jobs Widget

Add – Create a new Job. Currently only new Script jobs can be created from here.

Cancel – Select the job you want to cancel and then click the Cancel button on the toolbar.

Start– Select the job you want to start immediately and click Start.

Edit – Select the job you want to change and click Edit. You can then Edit and save the time on the Scheduled Job Details panel. You can also edit jobs by double clicking on the relevant row in the table.

Script Jobs

The Script jobs function is aimed at users who wish to schedule ChangeBASE API scripts to run a specific time. However they may also use this function to run any other Powershell scripts that are relevant to their use of ChangeBASE.

Creating a New Script Job

To create a new script job choose Add->Script Job ( ) from the toolbar. You will then be presented with the Job edit screen where you must enter the following details: -

Name – Enter an identifying name for the Job. It doesn’t have to be unique.

Start Time – Select a time and date for the job to run. This must be a time in the future.

Script to Run – Enter a UNC Path to the Powershell script you wish to execute at the schedule time. The UNC path must be accessible from the ChangeBASE service.

When you have finished click Save to schedule the job or Revert to ignore these changes.

Viewing Script Results and Outputs

Once a Script job has been started by the Scheduler and is in progress or has been completed you can view a log for that script execution by double clicking on the job in the table.

The Script log shows details about the execution including:

When the script was started and which script was executed.

Any outputs from the script are prefixed with “Output = ”

Any errors from the script are shown at the end of the log and are flagged with a Severity warning or error.

 

You can see some working examples of ChangeBASE API Scripts that are suitable for use in Scheduled Jobs on the ChangeBASE Wiki.

Reporting

The Reporting window allows you to generate a number of predefined reports relating to your assessment groups and imported applications.

The window also allows you, via the Queries listed under the Queries tab, to create your own reports (refer to Creating Custom Reports).

There is also a report that rolls up the Microsoft Patch Tuesday updates from July 2013 onwards. This report is called 'Patch Assessment'. When you run the report, it shows the packages in your ChangeBASE database on which the updates are likely to have an impact. The current RAG statuses of your applications remain unaffected by the report.

Note: If you are going to be uploading reports to a central location or Web server, enable the Upload button on the far right of the toolbar by ensuring that you have entered the required fields in Reporting Settings.

To run a predefined report, simply highlight it and then click the Run button . The report is previewed in the main window.

Using the tools above the report, you can print, export, email it, and upload it to a central location, as required.

Creating Custom Reports

You can create your own custom reports using the predefined Queries listed under the Queries tab. You can also create your own queries.

To create a custom report

  1. Go to the Queries tab, select the query that contains the required fields, and then preview it by clicking the Run button .
  1. Once you have successfully previewed the query that you wish to use, go to the Reports tab Properties at the bottom of the screen. If the word New is not already displayed, click the button.
  1. Give your report an appropriate Name and Description.
  2. From the Query drop-down, select the query that you previewed earlier, for example All Applications.
  3. Click the Save button .
  4. Click the Designer button to open a separate Report Designer window.
  1. Click to drag a text label into the top panel and enter some header text, formatting it as required using the tools at the top of the window. Anything in this top panel will be displayed on every page of the report.
  1. For the report detail, go to the Field List on the right of the window, and drag the required fields into the detail area.

Note: If you need to show all the instances of an application, or an aggregate, under the field(s) in the detail area, right-click and select Insert Detail Report, followed by the required option.

The associated Detail Report band is inserted. You then need to insert the required field(s) into the Detail Report band.

  1. If you wish to insert a footer into the report, to appear at the bottom of very page, drag the required page control, text label and/or fields into the bottom area of the report.
  1. If you wish to preview the report, click the Preview button to verify that the results are as required.

Note: You need to click the Designer button to exit the preview.

  1. Once the report is as required, click Save at the top of the Report Designer window.
  2. Exit the Report Designer to return to ChangeBASE, where the report is now available from the Reports tab.

If you need to edit the report in the future, simply click the Designer button again.

Creating a Custom Report using the 'MaxRAG' field

To create a custom report showing RAG statuses, you would create a report incorporating the MaxRAG field, as follows:

  1. Go to the Queries tab, select the query that contains the required fields, and then preview it by clicking the Run button . In this case, you might select the All Applications query.
  1. Once you have successfully previewed the query that you wish to use, go to the Reports tab and click the button.
  1. Give your report an appropriate Name and Description.
  2. From the Query drop-down, select the query that you previewed earlier, for example All Applications.
  3. Click the Save button .
  4. Click the Designer button to open a separate Report Designer window.
  1. Click to drag a label into the top panel and enter some header text, formatting it as required using the tools at the top of the window.
  1. For the report detail, go to the Field List on the right of the window, and drag the required fields, including the MaxRAG field, into the detail area.
  1. Insert a footer into the report if required.
  2. Click the Preview window to verify that the results are as required.
  1. It is possible to make the report more accessible by assigning conditions to particular fields, for example by assigning the Green, Amber or Red color to the MaxRAG field when this field has a value of 0, 1 or 2, respectively, as follows.
    1. Click the arrow above the MaxRAG field to display the Label Tasks.
    1. Click ... in Formatting Rules, to bring up the Formatting Rules Editor, click Edit Rule Sheet, and then click to create a new rule.
    1. Set the Background and Foreground Colors as required (for example, Green and Transparent respectively), and give the rule a name.
    1. Set a condition by clicking ... in the Condition, to bring up the Condition Editor.
    2. Enter the condition, for example the field MaxRAG must be equal to zero (Green) to display the above color formatting.
    1. Click OK and apply the rule by moving it across to the right hand pane. Then click OK again.
    1. Now, when you preview the report, the zero RAG statuses are displayed as Green.
    1. Repeat from step b. above to create further rules for Amber and Red (where MaxRAG = 1 for Amber and 2 for Red).
  2. Save the report and exit Report Designer.
  3. When you now run the report from ChangeBASE, it should show the relevant color in the far right column for each application. Using the tools above the report, you can print, export, email it, and upload it to a central location, as required.

If you need to edit the report in the future, simply click the Designer button again.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating