Part II: Studying for IRIS Developer Professional Certification with the "Ask Developer Community AI"

  The "Ask Developer Community AI" tool is an excellent resource for studying for the certification. I asked it about each topic that will be covered in the test and the results are below.
Note: I classified each answer by the assertiveness that I consider as good, average and bad.

Note 2: The article has 4 parts, each one for an exam area.

2. Best practices

2.1 Uses recommended development tools and workflows with InterSystems IRIS

[GOOD]  Uses Visual Studio Code to connect to InterSystems IRIS and develop client-side and server-side code

To use Visual Studio Code (VS Code) to connect to InterSystems IRIS and develop both client-side and server-side code, you need to follow these steps:
1.    Install Necessary Extensions: Install the InterSystems Server Manager Extension, InterSystems ObjectScript Extension, and InterSystems Language Server Extension for VS Code. These extensions help in defining server connections, writing, and compiling code files, and providing language support for ObjectScript [1].
2.    Configure Server Connections: Use the InterSystems Server Manager Extension to define connections to your InterSystems IRIS server. This involves adding the server details such as name, hostname, port, and username [2].
3.    Develop and Sync Code: You can edit code locally on your machine and sync it with the server. The ObjectScript extension allows you to save and compile code directly on the server. You can also use version control systems like Git to manage your code changes [3].
4.    Use SQLTools for Database Interactions: Install the SQLTools extension and the SQLTools InterSystems IRIS driver to connect to your IRIS instance and run SQL queries directly from VS Code [4].
5.    Access the IRIS Terminal: Depending on your IRIS version, you can use the Web Terminal or WebSocket Terminal to open a terminal session within VS Code. For IRIS versions 2023.2 and later, the WebSocket Terminal is available. For earlier versions, you can use the Web Terminal extension [5].
For detailed instructions on each step, refer to the respective sections in the documentation provided by InterSystems [6][2][1][5].

Sources
1.Setting up VS Code to work with InterSystems technologies
2.InterSystems VSCode ObjectScript Extension Pack in glance
3.Where to save the local cache code after connecting the IRIS server using Visual Studio Code
4.Connecting to InterSystems IRIS in VS Code using SQLTools
5.Accessing the IRIS Terminal: A Comprehensive Guide for Visual Studio Code Users
6.Connecting an IDE | InterSystems IRIS Data Platform 2024.3

[GOOD]  Uses InterSystems IRIS debugging tools (e.g., uses debugger in VS Code)

To use InterSystems IRIS debugging tools, such as the debugger in Visual Studio Code (VS Code), follow these steps:
1.    Install the InterSystems IRIS extensions for VSCode: Go to Extensions in VSCode, search for InterSystems, and install the necessary extensions, particularly the InterSystems ObjectScript Extension Pack.
2.    Set up a sample application: Clone a sample project from a repository, such as https://github.com/yurimarx/debug-objectscript.git, and set it up using Docker.
3.    Open the project in VSCode: Open the project directory in VSCode and configure the ObjectScript connection.
4.    Debugging: Set breakpoints in your ObjectScript code, and use the debugging tools in VSCode to step through the code, inspect variables, and control execution.
For detailed instructions on setting up and using the debugger, refer to the article “Debug the ObjectScript code using VSCode” [1].
Additionally, you can watch the video “Using the VS Code Debugger for InterSystems ObjectScript” on the InterSystems Developers YouTube channel for a visual guide [2].

Sources
1.Debug the ObjectScript code using VSCode
2.[Video] Using the VS Code Debugger for InterSystems ObjectScript

[AVERAGE]  Identifies components required in Compose files used for container development

The components required in Compose files used for container development include:
1.    Version: Specifies the version of the Docker Compose file format.
2.    Services: Defines the services (containers) that make up the application.
3.    Image: Specifies the Docker image to use for the service.
4.    Build: Specifies the build context for the service.
5.    Ports: Maps ports between the host and the container.
6.    Volumes: Mounts directories or files from the host into the container.
7.    Environment: Sets environment variables for the service.
8.    Command: Overrides the default command for the container.
9.    Restart: Specifies the restart policy for the container.
For more detailed information, refer to the articles on Docker Compose and its usage [1][2].

Sources
1.Introduction to Docker - Part2 (Docker Compose, Docker File, Docker Volume)
2.Running InterSystems Products in Containers | InterSystems IRIS Data Platform 2024.3

[AVERAGE]  Enumerates available development tools (e.g., %SYS.MONLBL, ^PROFILE, and ^TRACE)

The available development tools in InterSystems include:
1.    %SYS.MONLBL: This tool is used for monitoring and performance analysis.
2.    ^PROFILE: This tool is used for profiling code to analyze performance.
3.    ^TRACE: This tool is used for tracing code execution to debug and understand the flow of the program.
Additionally, synonyms for the GOTO ObjectScript command include “G” [1].

Sources
1.GOTO (ObjectScript) | ObjectScript Reference | InterSystems IRIS Data Platform 2024.3

[GOOD]  Describes options for automatically documenting code

There are several options for automatically documenting code:
1.    Using Documatic: You can generate class documentation from comments embedded in the code using Documatic. This includes documenting each column in SQL views with HTML markup similar to how you document each method of a class [1].
2.    Static Documentation Generators: There are several documentation generation solutions that produce web documentation portals. Some popular open-source options include:
o    MkDocs: Supports static and dynamic documentation generation, Markdown and HTML, and integration with Git pages.
o    Docsify: Lightweight, supports smart full-text search, multiple themes, and embedded files.
o    Docusaurus: Powered by Markdown, built using React, supports translations, document versioning, and search.
o    Slate: Clean design, single-page documentation, Markdown support, syntax highlighting, and editable via GitHub.
o    GitBook: Collaborative work, drafts and versioning, multiple output formats, and cloud hosting [2].
3.    CodeInspector: This tool helps in automating custom code validation by applying custom rules tailored to your development requirements. It generates detailed reports and can be configured to enforce consistent coding practices [3].
4.    VSCode Snippets: In VSCode, you can use snippets to create templates for code documentation. This allows you to standardize method descriptions and other documentation elements [4].
5.    Swagger for REST APIs: For documenting REST APIs, you can use the Swagger open-source framework to provide interactive documentation based on the OpenAPI 2.0 specification. This can be hosted and viewed using tools like Swagger UI [5].

Sources
1.Best way to document a SQL view
2.Static Documentation Generators
3.CodeInspector: Automating Custom Code Validation
4.Is it possible to export User-Defined Code Fragments from Studio?
5.Listing and Documenting REST APIs | Creating REST Services | InterSystems IRIS Data Platform 2024.3

[AVERAGE]  Chooses background execution strategy

In ObjectScript, you can execute programs in the background using the JOB command. This command allows you to run a process independently of the current process, usually without user interaction. The JOB command can be used to start a routine, a class method, or an instance method in the background.
For detailed instructions on how to use the JOB command, including its syntax and examples, please refer to the relevant documentation [1].

Sources
1.JOB (ObjectScript) | ObjectScript Reference | InterSystems IRIS Data Platform 2024.3

 

2.2 Integrates InterSystems IRIS with CI/CD pipelines

[GOOD]  Describes deployment options for InterSystems IRIS (e.g., containers vs InterSystems IRIS installer)

InterSystems IRIS can be deployed using various methods, including containers and the InterSystems IRIS installer. Here are the deployment options:
1.    Containers: Deploying InterSystems IRIS in Docker containers is agile, highly repeatable, and well-suited to public cloud platforms. Containers cleanly separate code from data and support CI/CD and a DevOps approach, allowing for fast improvements. The configuration merge feature supports automated container deployment by varying the configurations of InterSystems IRIS instances in containers deployed from the same image [1].
2.    InterSystems IRIS Installer: You can also install and run multiple instances of InterSystems IRIS on a single host system using the InterSystems IRIS installer. Each instance is a unique, independent environment that can be managed using the iris command or the Windows launcher [2].
For detailed steps on using Docker containers, refer to the articles on deploying InterSystems IRIS in Docker containers and using the ObjectScript Package Manager with Docker containers [3][4].

Sources
1.Deploy in Containers | InterSystems IRIS Data Platform 2024.3
2.Manage InterSystems IRIS Instances: The iris Command | System Administration Guide | InterSystems IRIS Data Platform 2024.3
3.Using ObjectScript Package Manager With InterSystems IRIS and IRIS for Health Docker Containers
4.InterSystems IRIS Docker Container Image With ObjectScript Package Manager

[GOOD]  Manages changes to CPF file to support continuous deployment

To manage changes to the CPF file to support continuous deployment, you can use the configuration merge feature. This feature allows you to specify a configuration merge file containing the desired changes, which can be applied to the CPF file programmatically. This supports automated deployment and reconfiguration of multiple instances from the same source. The configuration merge file can be used to modify settings such as memory, journal settings, mappings, and device configurations. For more detailed steps and examples, refer to the articles on using the configuration merge feature and automating configuration with configuration merge [1][2].

Sources
1.CPF (Tools/APIs) | InterSystems API Index | InterSystems IRIS Data Platform 2024.3
2.Introduction to the Configuration Parameter File | Configuration Parameter File Reference | InterSystems IRIS Data Platform 2024.3

[GOOD]  Uses the %UnitTest framework to write and run unit tests

To use the %UnitTest framework to write and run unit tests in InterSystems IRIS, follow these steps:
1.    Create Test Cases: Extend the %UnitTest.TestCase class to create your testing class. Add test methods to this class, ensuring that each test method name begins with “Test”. Each test method can contain multiple tests, typically using the $$$AssertX macros to compare the method’s output to expected values [1].
2.    Preparation and Cleanup: Add code to special preparation and cleanup methods within your test class to handle tasks that need to be performed before and after tests run. This includes methods like OnBeforeOneTest(), OnBeforeAllTests(), OnAfterOneTest(), and OnAfterAllTests() [2].
3.    Execute Tests: Use the RunTest() method from the %UnitTest.Manager class to execute your tests. This method will load, compile, execute, and then delete the test classes by default. You can view the general results in your terminal window or more detailed results in the Management Portal [2][3].
For detailed instructions on each step, refer to the relevant sections in the documentation:
•    Creating test cases: Extending the %UnitTest.TestCase Class
•    Preparation and cleanup methods: %UnitTest.TestCase Class Preparation and Cleanup Methods
•    Executing tests: Executing Unit Tests Using the %UnitTest.Manager Methods
This framework is designed to be flexible and accommodate various testing needs, making it a robust tool for unit testing in InterSystems IRIS.

Sources
1.Creating Test Cases: The %UnitTest.TestCase Class | The %UnitTest Framework for InterSystems IRIS | InterSystems IRIS Data Platform 2024.3
2.About the InterSystems IRIS %UnitTest Framework | The %UnitTest Framework for InterSystems IRIS | InterSystems IRIS Data Platform 2024.3
3.Executing Unit Tests Using the %UnitTest.Manager Methods | The %UnitTest Framework for InterSystems IRIS | InterSystems IRIS Data Platform 2024.3

[BAD]  Runs integration tests to confirm expectations in other applications

Integration tests are designed to confirm expectations in other applications and typically require an external context, such as a database server. They can reference external resources and require a specific context in which to run. Integration tests can take longer to complete and are often run manually or prior to project deployment. In Maven, the life cycle phase where integration tests are run is called the “verify” phase [1].
For running integration tests with InterSystems IRIS, you can use the IrisApiTester tool. This tool allows you to perform unit tests, integration tests, and even add a CI/CD continuous integration layer. You can create a web application and define routes for your tests, which can then be executed via API calls. This setup allows you to automate the testing process and integrate it with your development workflow [2].

Sources
1.Maven Projects - Mixing Java and ObjectScript
2.Automate API Testing with IrisApiTester: A Developer's Guide

[GOOD]  Runs system checks to check functional and non-functional requirements at production scale

To run system checks to verify functional and non-functional requirements at production scale, you can use the %UnitTest.TestProduction class in InterSystems IRIS. This class allows you to create tests that start and stop the production being tested, send input to the production components, and examine the output and any errors generated. You will need to override the callback methods such as OnBeforeProductionStart, OnAfterProductionStart, CheckResults, and CheckErrors to implement the specific checks and validations required for your production environment [1][2].

Sources
1.TestControl | Testing Productions | InterSystems IRIS Data Platform 2024.3
2.Callback Methods | Testing Productions | InterSystems IRIS Data Platform 2024.3

 

[BAD]  Identifies implications of promoting changes

Promoting changes in your system can have several implications. It is important to consider the following:
1.    Compatibility and Future Proofing: Ensure that the changes are compatible with both your current platform and any anticipated upgrades. For example, if you are currently using Ensemble 2018 and plan to upgrade to IRIS, you need to be aware that certain features like InterSystems Reports are only available on IRIS and not on Ensemble [1].
2.    End-of-Life Announcements: Be aware of any end-of-life announcements for technologies you are using. For instance, Zen Reports are being removed from InterSystems IRIS and IRIS for Health starting from version 2025.1, so it would be prudent to avoid dependencies on Zen Reports for new developments [1].
3.    Alternative Solutions: Consider alternative solutions that might be more future-proof or better supported. For example, converting HL7 to FHIR and using the FHIR SQL Builder to make datasets available as SQL tables, which can then be consumed by InterSystems Reports, might be a viable option [1].
4.    Data Access and Integration: Evaluate how the changes will affect data access and integration. Using ODBC/JDBC to access data and integrating with third-party BI tools like MS PowerBI or Tableau could be an alternative approach if it meets your needs [1].
By considering these factors, you can better manage the implications of promoting changes in your system.

Sources
1.Reports roadmap

2.3 Uses source control with InterSystems IRIS

[GOOD]  Describes options for integrating InterSystems IRIS with source control systems
To integrate InterSystems IRIS with source control systems, you can follow these steps:
1.    Creating a Source Control Class: Create a subclass of %Studio.Extension.Base or %Studio.SourceControl.Base. Implement necessary methods such as AddToSourceControl(), CheckIn(), CheckOut(), and GetStatus(). These methods will handle importing/exporting documents, interacting with the source control system, and updating the status of files in InterSystems IRIS [1].
2.    Activating a Source Control Class: In the Management Portal, navigate to System Administration > Configuration > Additional Settings > Source Control. Select the namespace and the source control class to use [1].
3.    Configuring Source Control Settings: Configure the namespace to specify the location of files to be loaded into the code databases. This configuration often involves setting up a global to contain the relevant information [1].
4.    Using Tools for Managing Documents and Files: Use $system.OBJ.ExportUDL() for exporting UDL files, $system.OBJ.Export() for XML files, and $system.OBJ.Load() for importing files. The %RoutineMgr.TS class method can be used to obtain timestamps and compile times for documents [1].
5.    Accessing Your Source Control System: Ensure that the InterSystems IRIS server can locate the shared library or file defining the source control system’s API. Implement methods to call the appropriate functions of the source control software [1].
For a practical example, you can refer to the git-source-control package, which supports IPM packages for source control and can be installed and configured using ZPM commands [2]. Additionally, Deltanji is a source control solution tailored for InterSystems IRIS, providing seamless integration with various client tools like VS Code, Studio, and Management Portal [3].

Sources
1.Integrating InterSystems IRIS with Source Control Systems | InterSystems IRIS Data Platform 2024.3
2.Enabling IRIS Interoperability Source Control with InterSystems Package Manager and git-source-control
3.[Webinar] Deltanji demo: source control tailored for InterSystems IRIS

[GOOD]  Mitigates effects of importing an updated class/schema definition
 To mitigate the effects of importing an updated class/schema definition, you can follow these best practices:
1.    Add the new property to the target class: First, add the new property to the class where you want it to be moved.
2.    Write a utility class: Create a utility class to move the existing content from the old property location to the new property location.
3.    Update methods: Ensure all methods access the new property location.
4.    Clean up: Once you are satisfied with the changes, you can remove the old property from the original class. Set it to an empty string, make it internal or private, or delete it entirely. However, do not touch the storage map during this process.
These steps help ensure that the data is correctly migrated and that the application continues to function correctly with the new class definitions [1].

Sources
1.Guidance on modifying class definitions and switching my application to the new definitions