Release and Upgrade Information for Ensemble 2013.1
New Features in Ensemble 2013.1
Ensemble 2013.1 introduced the following new features and enhancements:
Complex Record Mapper
Enterprise Message Viewer
Custom HL7 Schema Editor
Temporary variables in business rules
Enhanced EDI XML supports Document.Validate method
Documentation reorganization and MSMQ Adapter documentation removed
Compatibility Issues for Upgrades to Ensemble 2013.1
The following changes in this release may affect the operation of your existing system. Review these following issues before upgrading a previous instance of Ensemble.
Also review the Caché Release Note and Upgrade Checklist.
Simplified X12 Schema Representation
In this release, when you load a SEF file into Ensemble, Ensemble converts the schemas into a format that is simpler than the raw SEF definition. This simplified X12 schema format can be exported as XML and edited in Studio. The main simplifications of the schema format are as follows:
Segment definitions are the same across a schema, rather than different for every usage of a segment within a structure within a schema.
Successive segments of the same type are rolled into one repeating segment.
Loops are qualified using key fields for HL or NK1 trigger segments only where needed for disambiguation.
It is necessary to adjust any X12 virtual property paths that you created in Ensemble version 2012.1 or earlier.
Need to Perform Cleanup after Upgrading from Previous Versions
If you upgraded Ensemble from a previous version to version 2012.2, 2012.2.1, or 2012.2.2, the upgrade process cleaned up the UTC index. In some installations, this cleanup process took an extended time and delayed the upgrade process. In Ensemble 2012.2.3, Ensemble 2013.1, and later versions, this cleanup process is not automatically done during the upgrade but should be done manually after the upgrade. If you have already upgraded a system to Ensemble 2012.2.1 or 2012.2.2, the cleanup process has been completed and you do not need to do anything for any future upgrades.
If you are upgrading from Ensemble 2009.1 or earlier, some message headers or log entries won’t be visible until after you run the cleanup procedure. Consequently, you should run the cleanup procedure soon after upgrading Ensemble. If you are upgrading from Ensemble 2010.1 or later, you can run the cleanup procedure at a convenient time after upgrading Ensemble.
If you are upgrading from Ensemble 2012.1 or earlier to Ensemble 2012.2.3, Ensemble 2013.1, or a later version, follow this procedure:
When Ensemble is being upgraded, it detects whether any namespaces on the system need the UTC index cleanup. If any namespaces need the cleanup, Ensemble logs a warning to cconsole.log indicating each namespace that needs to be cleaned up.
Check the cconsole.log file after upgrading to find the namespaces that need to be cleaned up.
After the system has been upgraded and Ensemble is running normally, you can run the cleanup on each namespace that requires it. You may wish to run the cleanup at an off-peak time when the system load is low. To run the cleanup for a specified namespace, enter the following in Ensemble Terminal:
zn <namespace> set status = ##class(%Library.EnsembleMgr).UpgradeUTCIndices(<namespace>)
You can also check to see if a namespace requires the UTC index cleanup by entering the following at the terminal:
If the namespace needs cleanup, CheckUTCIndices displays a message indicating that cleanup is required for the specified namespace. Otherwise it displays a message indicating that no UTC index globals need repair.
Improve Access to ASTM Documents by Building Index
Ensemble 2012.1 and later versions provide improved access to ASTM documents by adding an index for the OriginalDocId field. If you have created your production with Ensemble 2012.1 or later, this index is present for all ASTM documents. However, if you created your production with Ensemble 2010.2 or an earlier version and then have upgraded to 2012.1 or a later version, the index is created for new documents, but any existing documents created with the earlier version will not have the OriginalDocId index.
After upgrading Ensemble, if you have ASTM documents, you should build the index for the OriginalDocId field. You can build the index while the production is running, but you cannot build the index while ASTM messages are being purged or deleted. To rebuild the index, enter the following in Ensemble Terminal for each namespace that contains ASTM documents:
zn <namespace> Do ##class(EnsLib.EDI.ASTM.Document).%BuildIndices("OriginalDocId")
For information on ASTM documents, see the Ensemble ASTM Development Guide.
Enable Access to DeepSee Dashboard Pages
Beginning in this release, application access to arbitrary %CSP pages, including DeepSee, can now be better controlled. By default, only the SAMPLES namespace can access DeepSee pages, including dashboards. To enable DeepSee access in the ENSDEMO namespace and its associated web application, /csp/ensdemo, enter the following command in an Ensemble terminal window:
You should enter this command for any namespace that uses DeepSee dashboards or other DeepSee pages. In order to find the name of the web application associated with an Ensemble namespace, go to the System Administration,Security,Applications,Web Application page in the Ensemble management portal. Note that for HealthShare installations, the web application name is /csp/healthshare/ensdemo. Alternatively, you can enable DeepSee access for all namespaces and web applications by entering the following command: