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

Customizing the Display

If you want to search for a particular item, right-click on a header and select Show Search Panel. A search box appears above the display.

If you want to change the columns that are displayed, right-click on a header and select Show Column Chooser, which allows you to drag additional columns onto the display, and to remove existing columns. Simply drag and drop from and to the Column Chooser table that is displayed when you select the Show Column Chooser option. For example, you can select Application and/or Package.

If you want to group the items by a particular column header, drag the header onto the group panel at the top of the table (this is the panel featuring the words "Drag a column header here to group by that column"). If at any time the panel is not displayed, select Show Group Panel from the right-click menu in any column. To hide the panel, select Hide Group Panel.

For example, to group the issues by application, drag Application into the group panel.

Note: You can drag the Application header onto the group panel direct from the Column Chooser.

The issues appear under the relevant applications.

To undo the above option, right-click Application Name in the group panel and select Ungroup.

If you right-click on a column when it is in place (that is to say, when it has not been dragged above the table), you see a different menu.

The Group By This Column option has the same effect as dragging the column above the table.

If you want to hide certain categories of checks, select Show at the top of the screen, and then remove the ticks from the following as required.

Therefore, if you want to hide all the Green categories of check, select Green. Simply reselect it to restore the Green categories.

For Ignored Issues, refer to Overriding Issues, and for Excluded by User, refer to Excluding Checks.

The Excluded by OS Condition hides those issues that are not relevant to the Operating System setup for your platform. For example, if an issue is contained with a component which is conditioned to only install on Windows 8, but the platform Operating System is Windows 7, then the issue will be excluded.

Excluding Checks

You can hide a category of checks while you are working within a platform tab, so that they have a temporary RAG Status of Green.

To hide a category

  1. Select the category in the left hand panel, and then select Exclude at the top of the screen.
  2. To make the category available for fixing again, and restore it to its former RAG status, select Restore at the top of the screen.

Overriding Issues

To override any Amber or Red issues permanently, select them and click Ignore Issue at the top of the screen. You are then prompted as to whether you want these issues to be considered as Green. Enter some explanatory text, and then click OK.

The issues are displayed next to the symbol, and are no longer available for fixing.

Bulk Fixing

To apply fixes for those issues that have not been overridden

  1. Ensure that the appropriate Transform options have been selected in Settings > Product > Fixing Settings.
  2. Select those issues that are to be auto-fixed (any that can be auto-fixed are indicated by the icon). Where there is a choice of fixes available, ensure that the required fixes have been selected from the drop-down in the Auto Fix column.
  1. Click Fix in the top left of the screen.
  2. The spinning icon is displayed while fixing takes place. Once fixing is complete, this is replaced by the icon in the Fix column. Where a fix has not been possible, the icon is displayed, meaning that further investigation is required (refer to Troubleshooting). The relevant fix files, for example CAB and MST files, are created in your Package Source.

Check Updates

The ChangeBASE product provides a facility to allow installation of new and updated checks. These Check Updates are available through external download or an offline update file which will be sent to you by Dell Support Services if requested .

The Updates Screen

The Check Updates screen is accessed through a tab on the Settings screen. Its function is to check the availability of Updates, allow the import of an offline update and then to select and apply the updates that the user wishes to install.

Checking the availability of and downloading updates

ChangeBASE is pre-configured to download updates immediately without a proxy server. The user can check availability and download updates by clicking on the Download update button. If you require a proxy server to be configured to allow connection to the update server then first refer to the section on Auto Update and Proxy Server settings.

After the update download button has been clicked the Update File box will be cleared and the user will be shown progress information about the download: -

If you wish to Cancel the download then click on the Cancel button to the right of the Update File box.

Note that you will only be able to download updates if your license is valid and in maintenance .

Browsing an Offline Update

ChangeBASE update files are encrypted binary files that have an extension of .CBU. To select an offline update, click on the button and then select the file from the browse window and choose Open.

If the file is opened successfully, you will see the path of the file in the Update File box. You will also see a list of the checks which are available for update contained within that file.

Viewing Check Updates

Once the Update has been loaded, you will be given a list of checks which are available for update. This list will not show checks that have been previously applied.

The list is shown as a tree and allows you to select one of two views: -

View By Check

The list shows the name of the check at the top level of the tree. It then shows the Assessment groups as children of the checks once expanded.

View By Assessment Group

The list shows the name of the Assessment group at the top level of the tree and below that the children of the assessment group are the checks that are available for update.

The list also shows details about the current and new versions of each check to be updated.

Viewing Check Details

Details about the check update are shown on the right hand side of the screen. You can view the details of the update by selecting a row in the tree which shows a check name and version.

Name - The Name of the check.

Package Types – Indicates the package types (e.g. MSI, SFT) that will be assessed against this check.

Description - The new description for this check.

New RAG(s) - The RAG statuses of the new check.

Original RAG(s) - The Original RAG statuses of the old check.

Changes - A description of the changes that have been made to the check.

Selecting Check Updates

Once you have decided which updates you wish to apply you must select those updates by ticking the items in the tree. You can select or unselect all of the checks from the toolbar.

If you tick a check then only that check will be selected for update, however, if you select an Assessment group then ALL of the checks that apply to that assessment group will be selected for update.

New Check Versions and Enable After Update

As described in [Section on Disabling/Enabling Checks] you may have disabled an old version of a check which is now to be updated with a new version.

If the current version of a check is disabled then after you have loaded an update, you will see the check version displayed next to the check name along with the current check version number. You will also see a disabled icon ( ) next to the previous version number. When the update is applied you can choose to enable the new check version after update by checking the box in the Enable After Update column.

Applying and Scheduling Updates

When you have selected your checks for update you must then carefully consider when to apply your update. Do not schedule ChangeBASE check updates to occur during times when you expect to reboot, install system patches, or make any system changes on the machine that is running the ChangeBASE service. Updates can be applied through the Apply Update option on the toolbar.

Updates are a long running operation and may take some time to complete if you have a large number of packages in your database, therefore, you must consider a suitable time to schedule the updates. When the check update occurs the ChangeBASE service will restart itself, ALL open ChangeBASE clients will be disconnected and ALL repositories will be stopped until the operation is complete. It is recommended to back-up the ChangeBASE repository databases before the update is applied.

The Apply Update window allows the user to schedule the update to occur at a later time. If no alternate time is scheduled the update will be kicked off two minutes after Apply Update is selected. Once an update has been scheduled it is not possible to schedule another update until the first one has been completed or is cancelled.

Note: Do not restart the ChangeBASE server when applying an update and be aware that when the update occurs all clients and repositories will be stopped.

Caution: The SQL Server Collation must be Case Insensitive (CI).

Update Process

Once the update has been scheduled you will see the clock icon on the title bar. Clicking this icon will take you to the Dashboard from where you can see the Scheduled Job screen and control the running the update. See the section on Scheduled Jobs.

When the update process is triggered the ChangeBASE service will restart and all connected clients will see a warning message.

The Update will run silently and it will not be possible for clients to connect to ChangeBASE until the process is complete. The time it takes will be dependent on the number of applications currently imported into ChangeBASE as each updated check must be reassessed against those applications.

Verifying Update Results

After the ChangeBASE service has restarted the clients will be able to reconnect to the service. You will then see your updated checks on the Checks screen.

You can verify which Checks were updated by looking at the Recent Activity widget and you can also verify the state of the Scheduled job by looking at the Scheduled Jobs widget.

Cancelling or Rescheduling a Check Update

To Cancel or Reschedule a scheduled update from the Scheduled Jobs widget on the Dashboard.

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

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

Reschedule – Select the update you want to reschedule and click Edit. You can then Edit and save the time on the Scheduled Job Details panel.

For further information on this screen see the section on Scheduled Jobs.

Update Features and Role Restrictions

The following Update features can be restricted in the Roles screen

Feature Description

Schedule check updates Allow a user to schedule an update from the Check Updates screen. This process creates a Scheduled Job which can then be controlled by the other features in this table.

Cancel a scheduled job If the user wants to be able to Cancel a Check Update job then this feature must be enabled.

Modify a scheduled job If the user wants to be able to change the timing of a Check Update job then this feature must be enabled.

Start a scheduled job immediately If the user wants to be able to change Start a Check Update job immediately then this feature must be enabled.

Download and Proxy Settings

Auto Update Settings

To configure the Auto Update server URL

Enter the URL in the Server URL box

Select Save.

NOTE: You should not change this URL unless instructed to by Dell support services.

Proxy Settings

Proxy settings must be configured if ChangeBASE should access the Auto Update download server through your company’s proxy server. Details of the Auto Update download server are provided in the section on Auto Update Settings. As a guide you should enter the proxy settings as you would normally configure settings in your browser.

To set up a proxy

Check Use Proxy.

Check Bypass for Local Servers if you do not want the proxy server to be used when you connect to a computer on the local network (this may speed up performance).

In the Server Address field, enter the hostname or IP address of the proxy server, without the http:// prefix.

In the Port Number field, type the port number that is used by the proxy server for client connections.

Enter the Username, Password and Domain as required.

Select Save.

Custom Checks

The Design view of the Checks window allows you to create your own checks and publish them to existing assessment groups of checks.

Note: For further information and examples relating to checks, refer to Overview of Checks.

Once you select Switch to Design at the top of the Checks window, a list of checks that you can clone is displayed in the left-hand panel. Highlight a check to see the associated Name, Description and Rules, in the right-hand panel.

The right hand panel containing the Rules tree view and the toolbox of Operators in the bottom right of the panel, does not become active until you either:

  • Click Add at the top of the screen to start creating your own check from scratch - an empty check called New Check is automatically created and highlighted in the left hand panel; Or
  • Highlight a check that is close to the one that you wish to create, select Clone to create a copy of it, and then highlight this copy.

The assessment groups and toolbox are now active, for example.

Once the custom check screen has been activated, you can customize the check.

To customize the check

  1. Overwrite the default Name with the name of your new or cloned check.
  2. Overwrite the default Description with the descriptive text for your new or cloned check. This will be the text that appears immediately below the check when you drill down into the check from the Applications window (refer to Drilling Down into an Application).
  3. In the top right hand corner of the screen, select the assessment groups to which you want the check to be published.
  4. For the first Rules tab, enter the Message that will appear in both the Checks Options and the Applications window when you drill down into the check (refer to Drilling Down into an Application).
  5. From the RAG drop-down, select the RAG status that you want to be displayed when the issue associated with the check is found (select Amber or Red as appropriate).
  6. From the Category drop-down, select from the following: Investigate Red Issues or Investigate Remaining Issues.
  7. In the Effort boxes, enter the recommended fraction of hours that it would take to fix the check issues manually (Manual). Then enter the maximum recommended effort (Max).
  8. Enter the Query, dragging Operators from the toolbox on the right as required, and specifying the associated values. Refer to Example Query below.

TIP: If you hold the <Shift> key down when you drag on an Operator, it is inserted as a new level in the hierarchy. So if, for example, you were creating a check looking for Excel Add-ins, and had written a Rule checking for "File_Extension" "Equals" "XLA", you could use the depressed <Shift> key to insert an "OR" above the "Equals" (for example, to search for the "XLL" extension as well).

  1. The authoring process is interactive, so, as you code the check Rules, click Test to verify the internal logic of each Rule.
  2. Once the Rules have been verified successfully, click Execute to run them against the packages in the Applications window - the results appear at the bottom of the right-hand panel.
  3. Select Save to preserve your changes.

  4. Select Publish to add the check to the selected assessment groups, so that the packages in the Applications window can be assessed against it, and so that it can be listed in the Checks window.

Example Query

If, for example, you want to write a packaging standards compliance check that verifies the existence of Manufacturer in the MSI Property table.

  1. Click Add at the top of the screen - an empty check called New Check is automatically created and highlighted in the left hand panel.
  1. Overwrite New Check with the name of your new check, for example Verify Package Has Manufacturer Property.
  2. Overwrite the Description with the descriptive text for your new check.
  3. In the top right hand corner of the screen, select the assessment groups to which you want the check to be published.
  4. For the first Rules tab, enter the Message that will appear in both the Checks Options and the Applications window when you drill down into the check (refer to Drilling Down into an Application) - for example, Package does not have Manufacturer Property.
  5. From the RAG drop-down, select Amber.
  6. From the Category drop-down, select Investigate Remaining Issues.
  7. In the Effort boxes, enter the recommended fraction of hours that it would take to fix the check issues manually (Manual). Then enter the maximum recommended effort (Max).
  8. Go to the toolbox on the right, and drag Not from the Set Operators, to Query.
  9. Drag Entity Equals from the Set Operators, to Not, and select Package from the drop-down.
  10. Drag To Parent from the Map Operators, to Not.
  11. Drag Equals from the Basic Operators, to Map to Parent.
  12. Select Property_Name from the Equals drop-down, and enter Manufacturer in the Equals text box.
  13. Your Query should appear as follows:

  1. Click Test to verify the internal logic.
  2. Once the Query has been verified successfully, click Execute to run it against the packages in the Applications window - the results appear at the bottom of the window.
  1. Select Save to preserve your changes.

  2. Select Publish to add the check to the selected assessment groups.

TIP: The Design view of the Checks window also provides a useful way of displaying all the applications that return issues for an existing check. Simply clone the check in which you are interested, and then, with the clone highlighted, click Execute. The applications returned by the check's Rules appear at the bottom of the screen.

Return to Results View

To go back to the main Checks Options, select Switch to Results at the top of the screen.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating