Skip to main content

Author Archives: Anthony Rizzo

Progeny Licensing

What is Global Licensing?

Progeny registrations are monitored by the concurrent license usage, which allows your facility to have as many named users as needed for your convenience. For example, if you have purchased 10 licenses (as comes with our Premium Cloud accounts) when the 11th user attempts to log in to Progeny, they would receive a License Usage Exceeded notification and would not be allowed to log into the software until another user logs out.

How does it work?

Progeny communicates with the Global License Server (GLS) with a simple handshake to let the server know that one of the users of a specific license is using the software. The same thing happens when a user closes or logs out of the software.

Is this secure?

Absolutely, the handshake between your web client and the GLS does not pass any data or private information from your database. It uses your license registration number to let the server know when a user logs in and logs out. The transactions are completely encrypted between the client and the GLS.

What is required from my facility in order for Global Licensing to work?

The GLS will choose any random port open on the client side and will connect on port 443 (TLS). In the event, your firewall blocks this connection attempt, a static route from the client to the GLS would be required to allow the connection to the host address: gls.progenygenetics.com.

How to Register Progeny Web Client:

Please note: the following instructions should only be performed by your Progeny Genetics software administrator and/or the IT personnel.

  1. Log into the web-client configuration portal on the server where the web-client is installed.
    1. Make sure you use the localhost to log in, not a domain or server name.
    2. Example: http://localhost/CONFIG?id=162d2827-d57f-45c3-b385-49060d087fa0
  2. Enter the configuration credentials. Please contact Progeny Support if you do not have this information.
  3. On the Security Management module, enter your License ID.
  4. Click Generate to generate a Client Serial ID.
  5. Click Verify License:
  6. A message will confirm that the license has been successfully validated.

Individual/Relative Questionnaire Sending Workflow

  1. Click INVITES.
  2. Select Invite Status.
  3. Select Invite Patient.
  4. Select the questionnaire to send, then click Next.
  5. Select whether you want to send the questionnaire to Members of one family (you will search for and select a pedigree/individual) or whether you want to use a saved query from the invites module to  send this invitation to Patients who meet specific criteria (for example, send to all relatives who have cancer or to send to a patient who has completed their baseline questionnaire greater than 1 year ago -please note that this query needs to exist in the Query Formats section of the invites module)
    • Members of one family
      1. Search for the pedigree, select it and click Next.
      2. Select each individual to send the questionnaire to and click Next.
      3. A preview of the invitation email will be displayed for review and can be updated if needed (it will only update the email content for this patient, not the saved email template). Click Send an Invite to send out the questionnaire.
      4. A popup box will be displayed that says, The Questionnaire invitation emails were successfully submitted.
    • Patients who meet specific criteria
      1. Select a saved query and click Next.
      2. Edit the query definition, if necessary, then click Next.
      3. Select patients who meet the query criteria for sending the invite to and click Next.
      4. A preview of the invitation email will be displayed for review and can be updated if needed (it will only update the email content for this patient, not the saved email template). Click Send an Invite to send out the questionnaire.
      5. A popup box will be displayed that says, The Questionnaire invitation emails were successfully submitted.

FHQ Sending Workflow

Sending a Questionnaire to a new Patient
  1. Click the INVITES drop-down from the top navigation bar.
  2. Select Invite Status.
  3. Click Invite Patient.
  4. Select the questionnaire to send, then click Next.
  5. Select New Patient and click Next.
  6. Select the folder to create this pedigree in, enter the name of the new pedigree, enter the gender of the proband, and enter the patient’s email, then click Next.
  7. Enter the additional data if known, to continue, click Next.
    Please note that the fields on this window can be customized by your group and may appear different than what is shown in the image.
  8. A preview of the invitation email will be displayed for review and can be updated if needed (it will only update the email content for this patient, not the saved email template). Click Send an Invite to send out the questionnaire.
  9. A popup box will be displayed.

Email Service Configuration Parameters

Web Configuration Parameters Menu

From the Progeny Web Client Configuration, the following parameters are used to configure how Progeny Web handles email communication for the FHQ module. You are able to use any type of email system – on-premise server, open relay, authenticated relay, hosted provider…the specific type does not matter.  The Progeny Web server can connect to any SMTP-based email service using the parameters below.

  • EMAIL_TRIGGER_DB_ALIAS
    • Determines which database the email service will operate under. This will be the same value for the Connection Name of the FHQ database in the Database Connection Configuration module.
  • EMAIL_TRIGGER_INTERVAL
    • Sets the time interval between email service activations.
    • The minimum interval is 1 minute, 3-5 minutes recommended for most deployments.
  • EMAIL_TRIGGER_SMTP_AUTH
    • Determines login process to the email server
      • 0 = unauthenticated “anonymous” connection that does not require a username or password.
      • 1 = authenticated connection, passing EMAIL_TRIGGER_SMTP_USERNAME and EMAIL_TRIGGER_SMTP_PASSWD parameters entered below.
  • EMAIL_TRIGGER_SMTP_EMAIL_FROM
    • Determines the “from” email address on all emails being sent.
    • This value needs to be the email address associated with the user account used when making authenticated connections to an email server to prevent emails being marked as spam or phishing.
  • EMAIL_TRIGGER_SMTP_PASSWD
    • The user account password when making an authenticated connection to the email server.
  • EMAIL_TRIGGER_SMTP_PORT
    • The port number for SMTP connection (usually 587 or 25).
  • EMAIL_TRIGGER_SMTP_SERVER
    • The email server that Progeny Web will connect to.
  • EMAIL_TRIGGER_SMTP_TRANSPORT_SSL
    • Determines the encryption type used when connecting to the email server.
      • 0 = No encryption (encryption is not required or making an unauthenticated connection).
      • 1 = SSL encryption.
      • 2 = TLS encryption (most Exchange servers and hosted services like Gmail and Office 365 use this type).
  • EMAIL_TRIGGER_SMTP_USERNAME
    • The username for the account used when making an authenticated connection to the email server.

User Access to Invites Module

Progeny Desktop Client
  1. Login to the Desktop Client.
  2. Go to Administration and then User Maintenance.
  3. If the user is in a user class, make sure to update the user class to include Invites.
  1. If the user is not in a user class and you set permissions based on the Licensing tab, make sure to update to include Invites for each user.

Updating the Questionnaire Logo

On the FHQ, external DMZ, server
  1. Locate the Apache Tomcat png folder. You will find your current logo file(s) in this folder. For example: C:\Program Files\Apache Software Foundation\Tomcat 8.0\webapps\ROOT\png.
    • If you name your new logo the exact same name, there is NOTHING you need to do after replacing the old logo file with the new logo file.
    • If the logo file(s) has a new name, then follow the steps below:
      1. Login to the Progeny Web Configuration back-end and go to the Web Data Capture Configuration module.
      2. Select the questionnaire from the drop-down at the top. Select the Login Logo URL and Logo Questionnaire URL configurable options and update the URL of the new logo (for example if the name of the logo file changes)
        • Login Logo URL: the logo on the FHQ login screen.
          • Good height=75-100px. Max width=1123px
        • Logo Questionnaire URL: the logo that appears on every page of the questionnaire.
          • Good height=75-100px. Max width=800px
Progeny Web Client
  1. Login to Progeny web.
  2. Select Email Templates from the Invites Module.
  1. Select an email template. Highlight the logo in the HTML editor box and click on the little insert image button in the HTML editor (red arrow below) and enter the new image URL that you want to use in the email format. Repeat for each email template as necessary.
  1. Click Save.

Updating the Questionnaire

Progeny Desktop Client
  1. To update a page of the patient/proband questionnaire, you need to update the FHQ/questionnaire individual datasheet format. Open any individual in the Templates folder.
    • Typically there is a ‘Family History Questionnaire Template’ pedigree with one individual in it that can easily be used for template updates.
  2. Select Form Design.
  3. You will notice that each tab is one of the pages of the patient/proband portion of the questionnaire.
  4. Find the tab/page that needs to be edited.
  5. Select and edit the text that needs to be edited.
  6. You can update the text settings by clicking the Style button.

    1. If the text does not highlight, it means that the text is a field display heading. Select the field and click Properties.
    2. Edit the Display Heading in the middle of the Properties box.

      • You may need to move the field around on the tab/page display if the display heading is longer/shorter than it was before.
  7. Additional fields/questions can be asked by using the Fields button and adding fields to the datasheet – you can then use added text or display headings to edit the question that is supposed to go with the new field/question added to the datasheet.
  1. Ensure that you keep all text boxes and field boxes within a width of 44 grid boxes or it will cause the FHQ to have a left/right scrollbar for that page.
  2. Click Save Fmt and click Save in the Save Format dialog box.
  3. Click Yes when prompted that there is a format with that name that already exists and would you like to overwrite it. You want to overwrite the existing individual datasheet format so that the skip logic for your questionnaire remains intact.

View Video: Edit Questionnaire Datasheet

Updating Skip Logic

Web Client Configuration Module
  1. Login to the Progeny Configuration Web back-end.
  2. Navigate to the Skip Logic Configuration module.
  1. Select a format from the Select Format drop-down (choose folder and name of individual datasheet).
  2. Each tab from the datasheet is displayed on the left-hand side.
  3. Choose which tab needs the skip logic added/updated.
  4. Select Show only if condition below is true.
  5. Click the green plus symbol to add a field to the conditions.
  1. Add as many fields as needed for the query for what is required for this page to display.
  2. After the query setup is complete, click Save.

View Video: Edit Questionnaire Skip Logic

Updating Phone Number/Email Address

Progeny Web Client
  1. Login to Progeny Web.
  2. Navigate to the Invites module.
  3. Click Edit Questionnaires.
  4. Select the questionnaire in which the phone number/email address needs to be updated
  5. Help Text
    1. Select the General settings tab.
    2. Update the phone number/email address in the Help text section.
  6. Login Screen
    1. Select the Login Screen tab.
    2. Update the phone number/email address in Login Page Instructions.
  1. Update the phone number/email address in the Email Templates (see Setting up email templates workflow).
Progeny Web Client Configuration
  1. Login to the Progeny Web configuration back-end.
  2. Navigate to the Web Data Capture Configuration module.
  3. Select the FHQ folder from the Select Folder drop-down at the top.
  4. If the email that gets the notifications when patients started, edit, and finishes the FHQs needs to be updated, select the Email to notify option and update the email address.

Setting Up ‘Reviewed’ Status Actions

  1. Go to Invites module.
  2. Click Edit Questionnaires.
  3. Select the questionnaire in which you want to add/update automatic reminders.
  4. Go to Status Actions tab.
  5. Three different actions can occur when an invitation is marked as Reviewed in the invites module. You can use one, two, or all of the status actions.
    • Send Email
      • Upon setting an invitation as Reviewed in the invites module, this status action setting can also send an email to either the patient, staff (the same email address that receives questionnaire status notifications), or both. A new separate email format specific for this status action can be created in the Email Templates section and then selected here.
    • Move To Folder
      • Just like when a pedigree is moved to the completed folder after a patient submits the Family History Questionnaire when you mark an invitation has Reviewed in the invites module, this action can automatically move the pedigree to another folder.
    • Transmit Pedigree PDF to EMR
      • If you have Progeny and EMR integration setup and you transmit your pedigrees to your EMR, marking the invitation as Reviewed can also submit this transmit request.