Skip to main content

xRM Update Manual 2025.9.1

2025-11-17

Modules of General​

data-migrator (2.0.0)​

Breaking Changes

  • Switched "text.html2textTika" to "HtmlUtils.html2Text"
  • Dependencies changed (with utility version 3.0.1 "HtmlUtils" was added)

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/utility@^3.0.1 || ^4.0.0

CHANGELOG.md · main · xrm-modules / data-migrator · GitLab

documentation (2.0.0)​

Breaking Changes

  • The logic for linking support tickets with knowledge management has been moved into a new link-support-ticket-knowledge-management module, which has resulted in changes to this module dependencies.

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/knowledge-management@^2.0.0
  • @aditosoftware/link-support-ticket-knowledge-management@^1.0.0

CHANGELOG.md · main · xrm-modules / documentation · GitLab

Modules of Platform​

utillity (4.0.0)​

Breaking Changes

  • EntityUtils.recordsRecipeToArray and EntityUtils.recordsRecipeTo2dArray
    • Added a rowCount check before entities.getRows to verify the number of records being loaded
    • Logs a warning if more than 2000 records are requested
    • Added default record sorting to prevent inconsistent results or infinite loops when autoOrderById is disabled
  • New Parameters:
    • validateRowCount (default: true) – Enables the row count check and logging.
    • autoSort (default: true) – Ensures stable sorting of retrieved records.
    • Notes: Both parameters can be disabled for higher performance if safe to do so.

Instructions / Newer Versions of required Dependencies

  • None

CHANGELOG.md · main · xrm-modules / xRM-Platform / utility · GitLab

root (8.0.0)​

Breaking Changes

  • Relocation of ObjectLink-Related Files: ObjectLink-related files have been moved from the projectticket module to the root module.

Instructions / Newer Versions of required Dependencies

  • Update all imports, dependencies, and references to ObjectLink classes or resources to point to the root module.
  • Ensure that the root module is included where the functionality is used.

CHANGELOG.md · main · xrm-modules / xRM-Platform / root · GitLab

workflow (5.0.0)​

Breaking Changes

  • Removal of Deprecated Workflow Code and Migration to Event-Handler Module: Workflow-related code that was already migrated to the event-handler module has now been fully removed from the workflow module. This includes the following components:
    • WorkflowSignalSender_lib
    • workflowExtension_serverProcess
    • Workflow service implementation for eventHandlerHooks_service
  • These removals may impact any custom extensions or integrations still referencing these classes or services.

Instructions / Newer Versions of required Dependencies

  • Remove any dependencies or references to the deleted workflow components
    • WorkflowSignalSender_lib
    • workflowExtension_serverProcess
    • eventHandlerHooks_service
  • Use the corresponding implementations from the event-handler module instead.

CHANGELOG.md · main · xrm-modules / xRM-Platform / workflow · GitLab

Modules of AI​

aditoAi-api (2.0.1)​

Breaking Changes

  • AditoAiLanguageUtils.getAnswerToPrompt now accepts a configuration object, replacing the previous separate parameters, which simplifies passing LLM-specific options.
  • Additionally, a service implementation now allows passing a guided_json to the promptBuilder.

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/ai-base-api@^3.0.0

CHANGELOG.md · main · xrm-modules / ai_modules / aditoAi-api · GitLab

ai-openAi-api (3.0.1)​

Breaking Changes

  • OpenAILanguageUtils.getAnswerToPrompt now accepts a configuration object, replacing the previous separate parameters, which simplifies passing LLM-specific options.
  • Additionally, a service implementation now allows passing a json_schema to the promptbuilder.

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/ai-base-api@^3.0.0

CHANGELOG.md · main · xrm-modules / ai_modules / ai-openAi-api · GitLab

ai-base-api (3.0.0)​

Breaking Changes

  • The AiPromptBuilder can now be extended via services:
    • AiPromptBuilderProperties_service allows adding additional attributes to the configuration object.
    • AiPromptBuilderSetter_service allows extending setter functions in the library.
  • AiPromptBuilder.prototype.getResponse now uses a single configuration object instead of separate parameters, making it easier to pass LLM-specific options and extend functionality in a structured way.

Instructions / Newer Versions of required Dependencies

  • None

CHANGELOG.md · main · xrm-modules / ai_modules / ai-base-api · GitLab

ckeditorAi-tools (1.0.0) 🆕​

Breaking Changes

  • Initial module version released and ready for integration.

Instructions / Newer Versions of required Dependencies

  • This is a new module and has no breaking changes

CHANGELOG.md · main · xrm-modules / ai_modules / ckeditorai-tools · GitLab

Modules of Contact Management​

activity (6.0.0)​

Breaking Changes

  • Switched "text.html2textTika" to "HtmlUtils.html2Text"
  • Dependencies changed (with utility version 3.0.1 "HtmlUtils" was added)

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/utility@^3.0.1 || ^4.0.0

CHANGELOG.md · main · xrm-modules / xRM-ContactManagement / activity · GitLab

correspondence (6.0.0)​

Breaking Changes

  • Switched "text.html2textTika" to "HtmlUtils.html2Text"
  • Dependencies changed (with utility version 3.0.1 "HtmlUtils" was added)

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/utility@^3.0.1 || ^4.0.0

CHANGELOG.md · main · xrm-modules / xRM-ContactManagement / correspondence · GitLab

contact(5.0.0)​

Breaking Changes

  • Dependency on Root Module (8.0.0) for ObjectLink Functionality
  • The contact module now requires version 8.0.0 of the root module.
  • All ObjectLink-related functionality has been refactored to rely on the new implementation provided by the root module.

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/root@^8.0.0

CHANGELOG.md · main · xrm-modules / xRM-ContactManagement / contact· GitLab

usermanagement-contact (4.0.0)​

Breaking Changes

  • The following services have been cleaned up and their implementations adjusted to fix transpilation errors:
  • indexPatternExtension_service
  • providerFilterVariables_service
  • The module now requires a newer version of the usermanagement module that provides the indexPatternExtension_service. Older versions are no longer compatible.

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/usermanagement`@^5.2.0

CHANGELOG.md · main · xrm-modules / xRM-ContactManagement / usermanagement-contact· GitLab

task (4.0.0)​

Breaking Changes

  • Dependency on Root Module (8.0.0) for ObjectLink Functionality
  • The task module now requires version 8.0.0 of the root module.
  • All ObjectLink-related functionality has been refactored to rely on the new implementation provided by the root module.

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/root`@^8.0.0

CHANGELOG.md · main · xrm-modules / xRM-ContactManagement / task· GitLab

Modules of Sales​

ms-teams (2.0.0)​

Breaking Changes

  • Switched "text.html2textTika" to "HtmlUtils.html2Text"
  • Dependencies changed (with utility version 3.0.1 "HtmlUtils" was added)

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/utility@^3.0.1

CHANGELOG.md · main · xrm-modules / xRM-Sales / ms-teams · GitLab

workflow-approval (2.0.0)​

Breaking Changes

  • A newer workflow version is used to enable certain translations

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/workflow@^5.0.0

CHANGELOG.md · main · xrm-modules / xRM-Sales / workflow-approval · GitLab

competition (2.0.0)​

Breaking Changes

  • Moved competitor logic from opportunity to the competition module which requires a newer opportunity package

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/opportunity@^1.1.0

CHANGELOG.md · main · xrm-modules / xRM-Sales / competition · GitLab

receipt (2.0.0)​

Breaking Changes

  • The e-invoice module got integrated into the receipt module

Instructions / Newer Versions of required Dependencies

  • The e-invoice module can no longer be used with receipt and must be removed

CHANGELOG.md · main · xrm-modules / xRM-Sales / receipt · GitLab

Modules of Marketing​

campaign (2.0.0)​

Breaking Changes

  • Removed field type in campaign and all fields and logic related to campaign type event

Instructions / Newer Versions of required Dependencies

  • Code locations that use this type may need to be adjusted

CHANGELOG.md · main · xrm-modules / xRM-Marketing / campaign· GitLab

snapaddy-visitreport (1.0.0) 🆕​

Breaking Changes

  • None

Instructions / Newer Versions of required Dependencies

  • This is a new module and has no breaking changes

CHANGELOG.md · main · xrm-modules / xRM-Marketing / snapaddy-visitreport· GitLab

Modules of Service​

knowledge-management (2.0.1)​

Breaking Changes

  • Moved link logic between "knowledge-management" and "support-ticket" to "link-support-ticket-knowledge-management" module
  • Dependencies changed (with utility version 3.0.1 "HtmlUtils" was added)

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/utility@^3.0.1
  • For usage of knowledge-management inside of support-ticket use the following packages:
    • @aditosoftware/link-support-ticket-knowledge-management@^1.0.0
    • @aditosoftware/support-ticket@^2.0.0
    • @aditosoftware/knowledge-management@^2.0.0

CHANGELOG.md · main · xrm-modules / xRM-Service / knowledge-management· GitLab

support-ticket (2.0.0)​

Breaking Changes

  • Moved link logic between "knowledge-management" and "support-ticket" to "link-support-ticket-knowledge-management" module

Instructions / Newer Versions of required Dependencies

  • For usage of knowledge-management inside of support-ticket use the following packages:
    • @aditosoftware/link-support-ticket-knowledge-management@^1.0.0
    • @aditosoftware/support-ticket@^2.0.0
    • @aditosoftware/knowledge-management@^2.0.0

CHANGELOG.md · main · xrm-modules / xRM-Service / support-ticket· GitLab

link-support-ticket-knowledge-management (1.0.2) 🆕​

Breaking Changes

  • Moved link logic between "knowledge-management" and "support-ticket" to "link-support-ticket-knowledge-management" module

Instructions / Newer Versions of required Dependencies

  • For usage of knowledge-management inside of support-ticket use the following packages:
    • @aditosoftware/link-support-ticket-knowledge-management@^1.0.0
    • @aditosoftware/support-ticket@^2.0.0
    • @aditosoftware/knowledge-management@^2.0.0

CHANGELOG.md · main · xrm-modules / xRM-Service / link-support-ticket-knowledge-management· GitLab

Modules of Collaboration​

project (2.0.0)​

Breaking Changes

  • Dependency on Root Module (8.0.0) for ObjectLink functionality
  • The project module now requires version 8.0.0 of the root module
  • All ObjectLink-related functionality has been refactored to rely on the new implementation provided by the root module

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/root@^8.0.0

CHANGELOG.md · main · xrm-modules / xRM-Collaboration / project · GitLab

projectticket (2.0.0)​

Breaking Changes

  • Dependency on Root Module (8.0.0) for ObjectLink Functionality
  • The projectticket module now requires version 8.0.0 of the root module
  • All ObjectLink-related functionality has been refactored to rely on the new implementation provided by the root module

Instructions / Newer Versions of required Dependencies

  • @aditosoftware/root@^8.0.0

CHANGELOG.md · main · xrm-modules / xRM-Collaboration / projectticket · GitLab

Additional Information​

basic-base (Deprecated)​

Breaking Changes

  • None

Instructions / Newer Versions of required Dependencies / Additional Information

  • The module is no longer required in xRM and has been removed from the dependency list. Its relevant functionality has been redistributed to the appropriate feature modules.