Switch to Log based TRS

Authors: WilliamChatham
Build basis: IBM Engineering Requirements Management DOORS Next, V7.0.2, V7.0.3 and (temporarily) V7.1.

The objective of page is to provide an overview and assist to Customers who wish to move from TRS Event based to TRS Log based. DOORS Next 7.1 authoritative information will be in the product documentation. For those upgrading to 7.1, we recommend starting with the interactive upgrade guide.

Why switch to Log based TRS?

TRS Event-based mode:

• Bugs leading to loss of TRS change log updates
• Server shutdown/crash can lose changes (Need to be fixed with a TRS Validation)
• Very difficult to diagnose problems

TRS Log-based mode:

• Improves TRS inconsistency (out of date configurations, skipped resources, missing/extra requirements, out of date requirements.
• Improves error-detection (Better serviceability).
• Improves TRS Validation (detect/correct a wider range of problems).
• Note performance is very much the same between Log based and Event based.
  

Log based TRS Key points:

• A full RM TRS Rebase and LQE RM Datasource Reindex/LDX Reindex is required when switching to Log based TRS from Event based TRS and vice versa (See Steps to improve Rebase and Reindex Performance below).
• in V7.0.2 and V7.0.3 You can switch back to Event based TRS at any time, This is not possible in V7.1 as Event based TRS is no longer supported in this release.
• You should use the latest available ifix when switching to log based TRS to have the latest fixes installed.
• IBM Recommends that You test Log Based(Switch and usage) in a comparable test environment before switching in production.
  
  

Version specific switch to log based TRS

V7.1

New V7.1 installs, the TRS is set to Log based by default.
Customers who upgrade to V7.1 must also switch to Log based as Event based is no longer supported in V7.1.

V7.1 Switch process:

See the Interactive upgrade here:Upgrading Engineering Lifecycle Management Suite

V7.0.3

New V7.0.3 installs, the TRS is set to Log based by default.

Customers who upgrade to V7.0.3 the TRS that is set in the previous release is what is used in the upgraded V7.0.3.

Customers can switch to Log based TRS from Event based TRS in V7.0.3GA and later releases.

• For V7.0.3 the switch Does not require a Key from Support.

Update with the most recent 7.0.3 iFix before switching to log-based TRS.

V7.0.3 Switch process:

1. Navigate to https://:/rm/admin.
2. Select Advanced Properties. Search for Enable log-based TRS maintenance and set this to True.
3. Save the changes and restart the server as per the message returned : The configuration changes were saved successfully. To complete the updates, you must restart the server.
4. After the restart confirm Log-based TRS is enabled by checking the Advanced Properties to ensure Enable log-based TRS maintenance is set to true.
5. Also access the rmTRS.log and confirm Log-based TRS changelog maintenance is enabled is recorded, example below:

 2024-08-27T15:00:07,123+0000 [][EventAdmin Async Event Dispatcher Thread] INFO m.fronting.server.services.trs.internal.TrsService - Log-based TRS changelog maintenance is enabled.
 2024-08-27T15:00:07,358+0000 [][EventAdmin Async Event Dispatcher Thread] WARN  com.ibm.rdm.fronting.server.services.trs - Log-based mode is TRUE

. Perform a full RM TRS Rebase and LQE RM Datasource reindex and LDX Reindex as per: Perform a Rebase and Reindex for IBM Engineering Requirements Management DOORS Next

V7.0.2

Customers can switch to Log based TRS from Event based TRS from V7.0.2 ifix025 and later releases.

• For V7.0.2 the switch requires a key from IBM Support.

Update with the most recent 7.0.2 iFix before switching to log-based TRS.

V7.0.2 Switch process:

1. Navigate to https://:/rm/admin.
2. Select Advanced Properties. Search for Log-based TRS activation key and enter the key: To be provided by IBM Support.
3. Also search for Enable log-based TRS maintenance and set this to True.
4. Save the changes and restart the server as per the message returned : The configuration changes were saved successfully. To complete the updates, you must restart the server.
5. After the restart confirm Log-based TRS is enabled by checking the Advanced Properties to ensure Enable log-based TRS maintenance is set to true.
6. Also access the rmTRS.log and confirm Log-based TRS changelog maintenance is enabled is recorded, example below:

2024-08-27T15:00:07,123+0000 [][EventAdmin Async Event Dispatcher Thread] INFO m.fronting.server.services.trs.internal.TrsService - Log-based TRS changelog maintenance is enabled
2024-08-27T15:00:07,358+0000 [][EventAdmin Async Event Dispatcher Thread] WARN  com.ibm.rdm.fronting.server.services.trs - Log-based mode is TRUE

1. Perform a full RM TRS Rebase and LQE RM Datasource reindex and LDX Reindex as per: Perform a Rebase and Reindex for IBM Engineering Requirements Management DOORS Next
   
   

Known issues:

Log based specific Known issues to be aware of:

No	Known Issue	Defect	Fixed in
1.	DT253617	TRS does not update changelog due to repeated exceptions dealing with project create event (145905)	V7.0.2 ifix027 V7.0.3 GA
2.	DT258794	TrsDeltaMonitorTask - Unable to process repository changes (146646)	V7.0.2 ifix028 V7.0.3 ifix003
3.	DT387232	IllegalstateException: This stopwatch is already stopped in log-based mode(147405)	V7.0.2 ifix030 V7.0.3 ifix007
4.	DT409193	TRS validation of dnext resources on Perf FGC environment has discrepancies when large module contains artifact bound more than once(148018)	V7.0.2 ifix032 V7.0.3 ifix010. Note: Can result in missing Data/links, Validation failures and skipped resources (Duplicate key).
5.	DT260176	Archive/Restore compensation in log-based mode is slow (146346)	V7.0.2 ifix029 V7.0.3 ifix004
6.	DT389482	Archiving/unarchiving large containers can block "normal" TRS updates for a very long time (147438)	V7.0.2 ifix030 V7.0.3 ifix007
7.	DT380590	Missing report data due to checksum value mismatch in subsequent RDF patches(147195)	V7.0.2 ifix030 V7.0.3 ifix007. Note: Although the checksums are incorrect, the content of the selection resource is correct, so report content is not affected by this bug.

• 1. , 2. , 3. , 4. should be in place to reduce the risk of TRS update failures.
• 5. and 6. may not be a concern if you do not plan on utilizing archive/restores of projects with a large number of configurations.

Log based and Event based Known issues to be aware of:

Known Issue	Defect	Fixed in
DT382088	DOORS Next Generation TRS Validation: Query performance is poor(147283)	V7.0.2 ifix030 V7.0.3 GA.
DT363651	ERM TRS Validation reports false positive Extra and missing resources in the feed (146949)	V7.0.2 ifix031 V7.0.3 ifix008
DT380779	TRS validation incorrectly reports missing resources (opt-out only; event-based and log-based)(147159)	V7.0.2 ifix031 V7.0.3 GA.
DT260140	TRS Validation results Summary reports Selection failures that are repaired(572188)	V7.0.2 ifix031 V7.0.3 ifix009.
DT261704	TRS Validation fails with reported error: Event with patch for Selections resource unknown to validation(572499)	V7.1. Note: Issue is rare and there is a workaround (Validation).
DT379224	TRS Validation fails due to Error encountered Validating TRS change log in com.ibm.rdm.fronting.server.trs.validation': Failed deleting TRS Selection cache file…(574208)	Open. Note: To occur, this requires a file system full during a validation and there is a workaround).

• IBM Recommends that you use the latest available ifix when switching to log based TRS to have the latest fixes installed.
  
  

Steps to improve Rebase and Reindex Performance:

1. Set your configuration cache to number of configs:See: Tuning the configuration cache for IBM Engineering Requirements Management DOORS Next V7.X
2. Increase RAM/CPU/heap to handle re-indexer threads: See: How to speed up the reindex of Lifecycle Query Engine (LQE) data sources
3. Increase your LQE/LDX throughput for DOORS Next Datasources: See: Increasing Threads
   
   

. Perform a full RM TRS Rebase and LQE RM Datasource reindex and LDX Reindex as per: Perform a Rebase and Reindex for IBM Engineering Requirements Management DOORS Next

Additional contributors: