You can create a running production with the default set of sample data and workflows listed below. If you extend the installed template class, you can customize this sample data as desired before you create your demo instance.

Specifically, the provided class method:

• Creates and activates a unique Personal Community namespace

• Creates and activates a reporting namespace

• Creates a public web site for Personal Community member use

• Creates the Workbench user interface

• Starts the Personal Community production

• Configures a test facility and assigning authority

• Configures a Personal Community facility OID for the Unified Care Record

• Configures PIX notifications

• Configures an authentication domain called   HealthShare Domain

The sample production includes the following data and workflows:

Workbench Users

Organizations

Clinical Groups, Providers, Specialties, Messaging, and Workflow Groups

Questionnaires

Pharmacies

Site Configuration Settings

System Default Settings

RSS Feed

InterSystems Pulse Blog

To create a demo production the simplest way (with default sample data and workflows):

1. Open Terminal and, if necessary, log in to the Personal Community instance with a system-level account.

2. Switch to the   %SYS   namespace:   zn "%SYS"

3. Run the following class method, with parameters as specified:

   set status = ##class(%ZHSPortal.Utils).%CreatePersonalCommunityDemoNamespace(<TemporaryNamespace>, <PortalNamespace>, <TemplateClassname>, 
   <TemplateFilename>, <HubHost>, <HubPort>, <HubNamespace>, <SenderEmail>, <SMTPServer>, <AssigningAuthorityFacilityCode>, <AssigningAuthorityOID>, 
   <PIXServiceName>, <PIXDeviceName>, <PIXOID>, <StatusFilePath>, <ConnectSecurely>, <SSLConfig>, <SecureHubHost>, <SecureHubPort>)
   write status
   

   • <TemporaryNamespace>   — String; required. The name of a temporary namespace for the exclusive use of this class method. If the method runs successfully, this namespace is deleted.

   • <PortalNamespace>   — String; required. The name of the new Personal Community namespace for the installation.

   • <TemplateClassname>   — String. If left empty, the class method uses the default demo installation class,   HSPortal.Production.DemoProduction. 

   • <TemplateFilename>   — String. The name of the file that contains your custom class. If you are using the default sample data and workflows, leave this field empty.

   • <HubHost>   — String; required. The fully-qualified domain name or the IP address of the machine that is running your Unified Care Record.

   • <HubPort>   — String; required. The web server port number of your Unified Care Record.

   • <HubNamespace>   — String; required. The namespace of your Unified Care Record Registry, using the case in which it appears in the Unified Care Record Management Portal (for example,   HSREGISTRY ).

   • <SenderEmail>   — String; required. The email address from which Personal Community email will be sent.

   • <SMTPServer>   — String; required. The fully-qualified domain name of the SMTP server that routes Personal Community email messages to members.

   • <AssigningAuthorityFacilityCode>   — String; optional. The assigning authority facility code by which Personal Community will be recognized in the Unified Care Record. If you leave this parameter empty, it defaults to   HSPortal_FacilityCode . If you supply a value here, you must also supply a value for   AssigningAuthorityOID .

   • <AssigningAuthorityOID>   — String; optional. The OID by which the Personal Community assigning authority will be recognized in the Unified Care Record. If you leave this parameter empty, it defaults to   2.999.11.111.111 . If you supply a value here, you must also supply a value for   AssigningAuthorityFacilityCode .

   • <PIXServiceName>   — String; optional. The name of the Unified Care Record Service Registry entry for the PIX service. If you leave this parameter empty, it defaults to   HSPortal.PIXv3Consumer . If you supply a value here, you must also supply a value for   PIXDeviceName   and   PIXOID .

   • <PIXDeviceName>   — String; optional. The name of the Unified Care Record OID Registry entry for the PIX device. If you leave this parameter empty, it defaults to   HSPortal.PIXv3ConsumerDevice . If you supply a value here, you must also supply a value for   PIXServiceName   and   PIXOID .

   • <PIXOID>   — String; optional. The OID associated with the Unified Care Record OID Registry entry for the PIX device. If you leave this parameter empty, it defaults to   2.999.11.111.222 . If you supply a value here, you must also supply a value for   PIXServiceName   and   PIXDeviceName .

   • <StatusFilePath>   — String; optional. A full physical pathname for a text file on your device; if the file does not yet exist, it will be created. If the method succeeds,   1   will be written to the file. In the case of an error,   0   is written as the first line of the file, and the error status text returned from the method is then written to this file.

   • <ConnectSecurely> – Boolean; optional.  Whether or not to connect to the Unified Care Record Registry over SSL. This is required if setting up a secure system.
   • <SSLConfig> – String;  required if ConnectSecurely is true. This is the SSL Configuration to be used to secure the connection.
   • <SecureHubHost> –  required if ConnectSecurely is true. This is the fully qualified hostname for the Unified Care Record Registry.
   • <SecureHubPort> – required if ConnectSecurely is true.  This is the secure port to access the Unified Care Record Registry.

Example Command Lines for Creating a Demo Production

set status = ##class(%ZHSPortal.Utils).%CreatePersonalCommunityDemoNamespace("TEMPNS","MYPORTAL",,,"myvm.example.com","57772","HSREGISTRY",
"dev@example.com","mail.example.com",,,"MYPORTAL_PIXSERVICE","MYPORTAL_PIXDEVICE","2.999.4.5.777","/home/user/files/testTemplate", 1, "HS.Secure.Demo", "myvm.example.com","8443")

This invocation of the   %CreatePersonalCommunityDemoNamespace   method sets up a demo production as follows:

• Creates a temporary namespace for production setup,   TEMPNS , which is subsequently deleted if the configuration is successful.

• Creates a   MYPORTAL   namespace for Personal Community.

• Uses the configuration in the default production template provided with the installation of Personal Community except for the PIX settings as noted below.

• Points to a Unified Care Record on   myvm.example.com :8443   whose Registry namespace is   HSREGISTRY .

• Uses the email address   dev@example.com   as the sender for Personal Community emails.

• Uses the SMTP server   mail.example.com .

• Uses the defaults described above for Personal Community assigning authority facility settings.

• Creates a   MYPORTAL_PIXSERVICE   PIX service and an OID registered to a   MYPORTAL_PIXDEVICE   PIX device.

• Writes the return status to   /home/user/files/testTemplate .

Should you want to customize the sample data and workflows before you create the demo production:

1. Copy   <install-dir> /hscommunity-content/hscommlib/public/base/samples/HS.Local.PersonalCommunity.SampleProduction.cls   to a location of your choice. On a Linux or macOS system, make sure to copy the file to a location where the user and group accounts that own   <install-dir> /hscommunity-content/hscommlib/public/base/samples/HS.Local.PersonalCommunity.SampleProduction.cls   will have read access to it.

2. Make changes to the copied file as needed. The blocks of code that represent the various configuration items are well commented.

   IMPORTANT

   Do not change the class name or the name of the file.

   Configuration items in some code blocks are dependent upon others. Where this is the case, the code comments note it.

   To enroll and activate patients, populate the   PatientEnrollmentData   XData block at the end of   SampleProduction.cls   as follows:

   XData PatientEnrollmentData [ MimeType = application/json ]
   {
       {
          "CommonPassphrase" : "Pass1phrase",
          "CommonPassword"   : "Pass1word", 
          "Email": "test@example.com",
          "EnrollingUser": "wbadmin",
          "Patients":[
                {"AssigningAuthority": "UMC","MRN": "S215134"},
                {"AssigningAuthority": "CGH","MRN": "K4567"},
                {"AssigningAuthority": "EMERGENCY","MRN": "Ab443"},
                {"AssigningAuthority": "PHLS","MRN": "S2345"}
          ]
       }
   }
   

   IMPORTANT

   The patients you want to add must be present within the Unified Care Record for Personal Community, and the password and passphrase must meet validation requirements for your instance. The   EnrollingUser   value will be logged to the datamarts.

3. Save the file.

4. Open Terminal and, if necessary, log in to the Personal Community instance with a system-level account.

5. Switch to the   %SYS   namespace:   zn "%SYS"

6. Run   %ZHSPortal.Utils:%CreatePersonalCommunityDemoNamespace () using   HS.Local.PersonalCommunity.SampleProduction.cls   as   <TemplateClassname>   and the full pathname of the copied file as   <TemplateFilename> .