INTERSYSTEMS LEARNING SERVICESInterSystems Change Control

InterSystems Change ControlConfidential - Do Not Duplicate

COPYRIGHT NOTICE© 2020 InterSystems Corporation, Cambridge, MA. All rights reserved.
InterSystems is a registered trademark of InterSystems Corporation.

InterSystems, InterSystems Caché, InterSystems Ensemble, InterSystems HealthShare, HealthShare, InterSystems TrakCare,TrakCare, InterSystems DeepSee, and DeepSee are registered trademarks of InterSystems Corporation.

InterSystems IRIS data platform, InterSystems IRIS for Health, InterSystems IRIS, InterSystems iKnow, Zen, and Caché Server Pages
are trademarks of InterSystems Corporation.
All other brand or product names used herein are trademarks or registered trademarks of their respective companies or organizations.
This document contains trade secret and confidential information which is the property of InterSystems Corporation, One MemorialDrive, Cambridge, MA 02142, or its affiliates, and is furnished for the sole purpose of the operation and maintenance of the products ofInterSystems Corporation. No part of this publication is to be used for any other purpose, and this publication is not to be reproduced,
copied, disclosed, transmitted, stored in a retrieval system or translated into any human or computer language, in any form, by anymeans, in whole or in part, without the express prior written consent of InterSystems Corporation.
The copying, use and disposition of this document and the software programs described herein is prohibited except to the limited extent
set forth in the standard software license agreement(s) of InterSystems Corporation covering such programs and related
documentation. InterSystems Corporation makes no representations and warranties concerning such software programs other thanthose set forth in such standard software license agreement(s). In addition, the liability of InterSystems Corporation for any losses ordamages relating to or arising out of the use of such software programs is limited in the manner set forth in such standard software
license agreement(s).
THE FOREGOING IS A GENERAL SUMMARY OF THE RESTRICTIONS AND LIMITATIONS IMPOSED BY INTERSYSTEMSCORPORATION ON THE USE OF, AND LIABILITY ARISING FROM, ITS COMPUTER SOFTWARE. FOR COMPLETE
INFORMATION REFERENCE SHOULD BE MADE TO THE STANDARD SOFTWARE LICENSE AGREEMENT(S) OF
INTERSYSTEMS CORPORATION, COPIES OF WHICH WILL BE MADE AVAILABLE UPON REQUEST.
InterSystems Corporation disclaims responsibility for errors which may appear in this document, and it reserves the right, in its sole
discretion and without notice, to make substitutions and modifications in the products and practices described in this document.
For Support questions about any InterSystems products, contact:
InterSystems WorldWide Response Center
Telephone: +1-617-621-0700
Tel: +44 (0) 844 854 2917
Email: support@InterSystems.com

Confidential - Do Not Duplicate

ICC 530: CCR Tier 1 –InteroperabilityComponents

0 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

Overview
 Best practices.
 Handling differences between environments.
 Management Portal source control hooks.

1 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

Best Practices
 Use Tier 0 CCRs when not feasible to maintain item in sourcecontrol.
 Makes change discoverable.
 Enforces workflow such as peer reviews.

 Use source control when possible.
 Tier 1 CCR.

2 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

Developing Interfaces
 Use iterative process to configure new interfaces.
 Disable interfaces in development.
 Configure by progressing small, discrete CCRs to Closed.
 When interface ready for Go-LIVE, progress CCR enablingfinished components.

3 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

Product Versions
 Versions in slides refer to releases for InterSystems IRIS®.
 HealthShare versions do not correlate to InterSystems IRISversions.

4 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

Differences Between Environments
 Some configuration fields for Production components differ
between environments.
 File paths.
 IP addresses.

 Production must be identical to integrate betweenenvironments.
 Cannot make changes to Production directly in TEST, UAT, or LIVE.

 Solution is System Default Settings.

5 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

System Default Setting Use to configure default values for settings of business components.
 Alternative to specifying values of settings in Production definition.
 Configure unique sets of default values in each Environment.

 Allows Production definition to be identical in all Environments.
BASE
To_LabFile Path = c:\BASE\InFailure Timeout = 15

6 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

TEST
To_LabFile Path = c:\TEST\InFailure Timeout = 15

Creating System Default Settings
 Configure > System Default Settings.
Can use * to match all.

Drag and drop settingfrom tree or select fromSetting Name dropdown.

7 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

Export System Default Settings
 Source control menu > CCR Controls > Export Default
Settings > Choose Production > Export.
 Exports to /backup subdirectory.
 Can bundle and upload in BASE only.
 Add to source control using itemsetsourcelink web application inIDE.

8 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

Add Exported File to Source Control
 Export file to source workspace.
 To find file in: VS Code – ObjectScript:
 From Explorer > itemsetsourcelink_system >custom_ccrs > …

 In Studio: From namespace view > CSP Files >itemsetsourcelink_system > custom_ccrs > …

 Right-click file > Source Control > Add
To Source Control > Yes.
 Bundle and upload to a CCR.

9 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

Management Portal Source Control Hooks
 Many pages in Management Portal have embedded hooks.
 Only visible in source control configured namespaces.
 Behavior same as source control menu in IDE.
 All items modified using Management Portal hooks automaticallyimported on ItemSet Deployment.
 Data Lookup Tables as of February 2019.

10 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

Management Portal Source Control Hooks(cont.)
 Commands.

 Outputs.

 Add to source control.

 View unread output of control.

 Checkout.

 Undo checkout.
 CCR controls.
 Diff.

11 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

 All source control output has beenviewed.

Pages with Hooks
 Production (v2019.4+)
 Data Lookup Tables.
 Business Processes.
 Data Transformations.
 Business Rules.
 Record Maps.
 Complex Record Maps.
 HL7 v2 Custom Schemas(v2019.1+).

12 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

HL7v2 Schema Editor
 v2019.1+:
 Has Management Portal hooks.
 Only visible if privileged to edit a custom schema.

 Pre-v2019.1:
 Use IDE to edit *.HL7 files.
 If not practical, do not include in source control.

 Management Portal does not honor IDE check out status.
 Consider locking down page to prevent accidental changes.

13 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

Productions (v2019.4+): Undo Checkout
 Steps:
1. Click> Undo Checkout.

2. Compile Production class in IDE.

3. Click Update button on Management
Portal Production page.

 Change not reverted until these2 additional steps completed!
 Only need to do this 3-stepprocess for Productions.
 Undo Checkout action sufficient forother components with hooks inPortal.
14 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

Productions (v2019.4+): Temporarily Start, Stop,Restart Normally, double-click
component to enable, disable, orrestart.
 Changes Production class definition,
therefore: Cannot do in TEST/UAT/LIVE.
 Requires checkout in BASE.

 Able to temporarily stop, start,or restart components.
 Select component > Actions.
 Does not require unlocking
environment or check out.
 Cannot temporarily start if disabled.
15 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

Business Component Setting Labels (v2019.4 –v2021.1)
 Fields greyed out when
Production read only.
 Must checkout Production inBASE to see color coding.
 Color coding indicates source ofvalue.

 Cannot see color coding in
TEST/UAT/LIVE because cannotcheckout Production.

16 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

No Portal Hooks but Editable in IDE
 Example items:
 Productions (pre-v2019.4).
 *.HL7 files (pre-v2019.1).
 HealthShare Patient Index Linkage Definitions.

 Use IDE source control hooks.
 Warning: Management Portal pages without hooks do nothonor IDE Check Out status.
 Someone can check out item in IDE and someone else can still editin Management Portal without checking out.

17 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

No Portal Hooks but Editable in IDE (cont.)
 Example workflow for Productions pre-v2019.4:
1. Checkout Production class from IDE.
2. Modify within Management Portal.
3. Make modification to Production in IDE (such as adding character
somewhere).
4. Compile Production.
5. Undo the change from step 3.
6. Compile Production.
7. Diff changes to verify exported version accurate.
8. Bundle and upload Production.
18 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

Summary What are the key points for this module?

19 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2

Do Exercise 530-1 and 530-2

20 | InterSystems Change Control | CCR Tier 1 – Interoperability Components | ICC530 v3.2