Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

To configure the Data Steward, you must first make sure that you have created a user with Data Steward privileges. To create a Data Steward, please follow the instructions here:


Chapter 8.3 - Setting up the Data Steward user


After setting up the Data Steward user, you will need to configure the steward section within SHRINE's configuration file - shrine.conf. You must first enable the authorization type to be "shrine-steward" within the queryEntryPoint section and then configure the shrineSteward block as well.

...

Code Block
languagebash
themerdark
steward {    
    createTopicsMode = Approved
 
    emailDataSteward {
      sendAuditEmails = true  				//false to turn off the whole works of emailing the data steward
      interval = "1 day" 					//Audit researchers daily
      timeAfterMidnight = "6 hours" 		//Audit researchers at 6 am. If the interval is less than 1 day then this delay is ignored.
      maxQueryCountBetweenAudits = 30 		//If a researcher runs more than this many queries since the last audit audit her
      minTimeBetweenAudits = "30 days" 		//If a researcher runs at least one query, audit those queries if this much time has passed
 
      //You must provide the email address of the shrine node system admin, to handle bounces and invalid addresses
      from = "shrine-admin@example.com"
      //You must provide the email address of the data steward
      to = "shrine-steward@example.com"
 
      subject = "Audit SHRINE researchers"
      //The baseUrl for the data steward to be substituted in to email text. Must be supplied if it is used in the email text.
      stewardBaseUrl = "https://localhost:8443/steward/"
      externalStewardBaseUrl = "https://example.com/steward"
 
      //Text to use for the email audit.
      //AUDIT_LINES will be replaced by a researcherLine for each researcher to audit.
      //STEWARD_BASE_URL will be replaced by the value in stewardBaseUrl if available.
      emailBody = """Please audit the following users at STEWARD_BASE_URL at your earliest convenience: AUDIT_LINES"""
      //note that this can be a multiline message
 
      //Text to use per researcher to audit.
      //FULLNAME, USERNAME, COUNT and LAST_AUDIT_DATE will be replaced with appropriate text.
      researcherLine = "FULLNAME (USERNAME) has run COUNT queries since LAST_AUDIT_DATE."
    }
 
    database {
      dataSourceFrom = "JNDI"
      jndiDataSourceName = "java:comp/env/jdbc/stewardDB"
      slickProfileClassName = "slick.jdbc.MySQLDriver$"
                                //slick.driver.MySQLDriver$
                                //slick.driver.PostgresDriver$
                                //slick.driver.SQLServerDriver$
                                //slick.driver.OracleDriver$
                                //slick.driver.MSSQLServerProfile$
    }
  } // end steward

...