What's New in v25.2?

Topic Contents [Hide]Topic Contents [Show]
  1. CM4D Peruse Enhancements
    1. Home Page Routine Filters
    2. Graph Annotation
    3. CM4D Variable Support
    4. Subroutine Support for 3D Models
    5. Updated User Interface
  2. Spectrum Functionality Restored
  3. Results Database - Exclude Routines by Label or Routine Filter
  4. Results Services - Specify Managed DataSource
  5. Security and Configuration Manager Enhancements for CM4D Databases
    1. Synchronize Users, Groups and Access Privileges with Site Manager
    2. Generate New or Update Databases
  6. Database Utilities
  7. Docker Image Support for the following CM4D Services
  8. EventSmith SMTP V2
    1. Upgrade Steps:

After an upgrade, the following routine tasks are recommended:

  1. Run the Results Database Utility. This checks for any new or updated stored procedures and will perform any changes to the Results database. This utility does not change your data.
  2. Run the Site Database Utility and Datasource Database Utility. These utilities should only be run for CM4D version upgrades with a Schema change.

New Features

CM4D Peruse Enhancements

Home Page Routine Filters

Filters are now available on the starting page of CM4D Peruse. At this time, buttons are displayed for any configured Routine filters.

See the topic Home Page to review the functionality.

Graph Annotation

Annotation templates used for the Annotation Sets introduced in the previous version have been expanded to support some graph types. Additionally, the annotation templates are now used as Reports.

See the following topics to review the functionality:

Peruse Users - Report Panel

Peruse Admins - Peruse Report Configuration

CM4D Variable Support

The CM4D variables supported for use in CM4D Peruse annotations has been expanded to include nearly all CM4D variables, with a few exclusions.

See the topic Peruse Annotation Template Variables to see the complete list.

Subroutine Support for 3D Models

Subroutine information stored in the Results database now includes references to any 3D models associated to its parent Routine(s). Duplicate models are not generated or stored.

Updated User Interface

The appearance of CM4D Peruse has received a cosmetic update to make the interface more visually pleasing with better contrast. Two themes are available for the user to select a preference, either Light or Dark.

Dark Theme

Light Theme

See the topic Peruse User Options to review the functionality.

Spectrum Functionality Restored

Original CM4D functionality, View Spectrum, is returned using the HOOPS 3D engine upgraded in the initial release of v25. While most of the configuration options have returned as they were in v24 and earlier, the arrow type 'Label' has been deprecated.

Spectrum Type: Color with multiple Feature Types (Feature Mode - Feature Specific)

Spectrum Type: Color with multiple Feature Types (Feature Mode - Sphere)

See the topic Spectrum to review the functionality.

Results Database - Exclude Routines by Label or Routine Filter

A configuration option has been added to CM4D Managed DataSources in the CM4D Configuration plugin which allows you to select which Routines, if any, are to be completely excluded from the data transfer. In addition to selecting Routines by label, you can use Filter arguments to designate Routines for exclusion. The filter builder is only available if the selected Managed DataSource has Routine Filters configured.

See the topic Configure Results Exclusions to review the functionality.

Results Services - Specify Managed DataSource

The Results Sender service processes the database changes in CM4D for export. Distributed installations with databases in different regions that are organized within a single Site may cause inefficiencies. For example, if a Results Sender service in Europe processes changes for a database in Asia. A configuration option is now available which allows you to restrict a Results Sender instance to process only specified Managed Datasources. It is possible to configure a datasource by DataSource label or to specify a Site and include all Datasources within that Site. The Results Sender appsettings.json file has a configuration setting "ProcessDatasources" that takes an array of definitions.

See the topic Results Services to review the functionality.

Security and Configuration Manager Enhancements for CM4D Databases

Some enhancements have been added to the CM4D Configuration plugin.

Synchronize Users, Groups and Access Privileges with Site Manager

A tab has been added to the Site Settings section of the CM4D Configuration plugin which lets you synchronize security and user information between ATS Security Manager and CM4D Site Manager. The synchronized data includes users, roles (groups) and rights (privileges).

See the topic Site Management - Site Settings to review the functionality.

Generate New or Update Databases

The three database types used by CM4D - Site, CM4D, Results - have some degree of automation available when managed via the CM4D Configuration plugin. Each of these database types have options for both creating new databases or updating existing databases to the latest schema.

Alternately, you may choose to run the update scripts manually in SSMS (legacy method) or run the corresponding Database Utility (new - see next section).

See the following topics to review the functionality:

Configuration - Site Database

Database Utilities

Site Management - Managed DataSources

Site Management - Results Database

Database Utilities

Creating and updating databases for CM4D can be a lengthy process when done manually, so we have provided tools with the CM4D Server and CM4D Results Services installers to make this type of database maintenance easier. Instead of locating the scripts and running each script individually on each database (and in the right order), you can simply run each tool and select an action.

See the topic Database Utilities to review the functionality.

Docker Image Support for the following CM4D Services

The following ATS CM4D modules support Windows or Linux Docker deployments:

The available docker images can be found on the ATS Product repository on Docker Hub.

See the topic Docker Installations to review the functionality.

EventSmith SMTP V2

EventSmith SMTP has been upgraded to a separate installer and now supports password encryption by using NServicebus with SQL Transport infrastructure with queue tables created by the services in the Site database. The new EventSmith services (EventSmith Mailer and EventSmith Queue Processor) are a separate installer in order to allow for flexible deployments. CM4D creates event entries in the table EventQueue in the Site database, which are then picked up by the EventSmith services for processing through the Processing Queue and Mailer tables.

Upgrade Steps:

  1. Stop CM4D Services, particularly EventSmith SMTP and DataConnect.
  2. Uninstall CM4D Server.
  3. Install CM4D Server v25.2.
  4. Install EventSmith SMTP V2.
  5. Run Site Manager and check the SMTP Settings. If using SSL, the Authentication user name format should be the user name only (e.g., mjones), without either domain (e.g., ats-global\mjones) or email (e.g., [email protected]) formatting. This format requirement is a temporary Known Issue and will be fixed in a subsequent hot patch.
  6. Optionally, depending on your setup, configure the new EventSmith Services (Mailer and Queue Processor) to run as your preferred user (e.g., cm4d_service).
  7. Start the EventSmith Services.
  8. Check the CM4D Site database for 6 new tables.

See also:

EventSmith Services

Known Issues - SMTP_Mail_Server_Authentication_Username.

Fixed Bugs

Ticket # Issue Notes
INC54241 Classic and Interactive show a different 'Last Sample'.  
INC31603 CM4D Classic Cpk score anomaly  
INC54563 CM4D Interactive does not properly refresh the pages when switching active sample.  
INC33975 CM4Di Feature Grid Show All Rows does not work when you first use keep selected for some features  
INC31102 CM4Di sample label loses The reported issue was primarily a setup issue. A conformance summary with "Evaluate on current process only" makes sense only if the features have the same baseline setup. In the reported case, the features with 'missing' sample labels had a different baseline. Fixing the definition of the report solves the problem. but this version contains a modification that displays Sample labels even in cases where "Evaluate current process only" is used in the setup.
INC31650 DataSmith loses last line for Excel data  
INC49759 Orphans get generated  
INC37335 Auto Resize Image View in CM4Di   
INC33978 When unchecked Unload Last Query to Save Memory not restoring the settings done for the previous routine  
  DataUtility toolbar DataSource button disappears Support for DataUtility was added to the Reset BarState command line.

See Reset Bar State.

  EventSmith settings files are not encrypted. Solution: See New Feature - EventSmith SMTP V2

See here to see the release notes for previous versions.

Can we improve this topic?