Versions Compared

Old Version 111

changes.mady.by.user David E Tanner

Saved on

compared with

New Version 112

changes.mady.by.user Stephen Turner

Saved on

Key

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

...

Panel

Anchor
CSF Email properties
CSF Email properties

CSF Email properties description

Tip

Need more information about the csf-email email service?  Go to the CSF Email Service Technical Spec for more information.

  1. email.address.from:
    • Description:  A string containing an email address from whom the email is being sent.  The string may contain more than just an email address.
    • Usage:  Optional
    • Example:  email.address.from=registration@mit.edu ("MIT Office of the Registrar")
    • Dependencies:  If specified, this value will always be used in the from field of the email.
  2. email.address.test.to:
    • Description:  A string containing an email address to whom the email is being sent.
    • Usage:  Optional.  Recommend to be used on WORKSTATION, DEV, TEST and QA servers and not used on PRODUCTION servers.
    • Example:  email.address.test.to=rjrenolds@mit.edu
    • Dependencies:  Used in conjunction with the email.production.mode property.
        When email.production.mode=false:
          email will be sent to the email address specified with this property.
        When email.production.mode=true:
          email will be sent to the email address specified by the calling application.
  3. email.address.bcc:
    • Description:  A string of CSV email address(es) to be used in the email's bcc.
    • Usage:  Optional
    • Example:  email.address.bcc=rjrenolds@mit.edu
    • Dependencies:  Used in conjunction with the email.production.mode property.
        When email.production.mode=false:
          bcc addresses will not be added to the emails.
        When email.production.mode=true:
          bcc addresses will be added to the emails.
  4. email.production.mode:
    indent
    1
    1
    • Description:  Used to indicate whether or not the applicaition is deployed on a production server.
    • Usage:  Required
    • Example:  Only the boolean values true or false are allowed.
         When email.production.mode=false:
           the application is deployed to DEV, TEST or QA server and is not deployed to a PRODUCTION server.
         When email.production.mode=true:
           the application is deployed to a PRODUCTION server.
    • Dependencies:  None.
  5. email.app.id: 
    • Description: Used to identify the application that created the email.
    • Usage: Required
    • Example: email.app.id=ssb
         In this example, the application id is ssb and must be unique.
    • Dependencies: The application id must be unique.
  6. email.sendEmailSchedule: - under construction - to be updated soon 
    • Description: Used to set the time interval for sending emails. The property value follows the format for the Quartz cron trigger. IMPORTANT: in a clustered environment (i.e. TEST and PROD), this property should be different for every server in the cluster: we want to avoid multiple quartz jobs running against the same email data at the same time and sending duplicate emails. In fact we recommend effectively disabling the quartz job on all but one of the servers in a given cluster by specifying a schedule that will never be triggered (e.g. a data in the year 2099).
    • Usage: Required when using csf-email in a cluster.
    • Example: email.sendEmailSchedule=0 0/20 0-22 * * ?
         In this example, the emails will be send every 20 minutes, at 0, 20, and 40 minutes past the hour.
    • Dependencies: none.
    • Optional: if not specified, the csf-email 
    .deleteEmailSchedule: - under construction: to be updated soon
    • default schedule will be used (every 10 minutes starting at the top of the hour).
    • Recommended Settings In Clustered Environment (TEST/PROD):
       one server in cluster (e.g. sea-app-5 in TEST): email.sendEmailSchedule=0 0/10 0-22 * * ?
       other server(s) in cluster (e.g. se-app-6 in TEST): email.sendEmailSchedule=0 * * * * ? 2099
  7. email.deleteEmailSchedule: 
    • Description: Used to set the time interval for deleting emails that have been sent.
    • Usage: Required when using csf-email in a cluster.
    • Example: email.deleteEmailSchedule=0 0/15 0-22 * * ?
         In this example, the emails will be deleted every 15 minutes.
    • Dependencies:
...
 Panel
 Anchor
CSF User authorization properties
CSF User authorization properties
CSF User authorization properties description (for use with the uaws web service)
  1. roles.function.category: 
    • Description:  A string containing the application defined ROLES DB 3 character catagory.  The 3 character catagory is assigned by the ROLES DB administrator.
    • Usage:  Required.
    • Example:  roles.function.category=SFS.
    • Dependencies:
         Will only be used if local.authentication=false or local.mitroles has not been used.  This will override the default
         category (REG) used by the uaws webservice when retrieving the user's roles from the ROLES DB.
  2. roles.function.function: 
    • Description:  A string containing the application defined ROLES DB 3 character function.  The 3 character function is assigned by the ROLES DB administrator.
    • Usage:  Optional.
    • Example:  local.mitroles.function=SSB.
    • Dependencies:  If specified, this property will only be used if local.authentication=false or local.mitroles is not used.
  3. webservices.mitrolesws.proxy.user: 
    • Description:  A ROLES DB proxy user that will be used by the uaws webservice when retreiving the user's authorizations.  The ROLES proxy user is assigned by the ROLES DB administrator.
    • Usage:  Required.
    • Example:  webservices.mitrolesws.proxy.user=REG$PRD.
    • Dependencies:  None
  4. webservices.mitroles.url: 
  5. webservices.keyStore: 
    • Description:  The Java keystore that is used to authenticate to the uaws webservice.
    • Usage:  Required.
    • Example:  webservices.keyStore=/certificates/keystores/registrar.jks.
    • Dependencies:  None
  6. webservices.keyStorePassword: 
    • Description:  The password for the Java keystore.  You can get the password from ops.
    • Usage:  Required.
    • Example:  webservices.keyStorePassword=changeit.
    • Dependencies:  None
  7. webservices.trustStore: 
    • Description:  The server trust store that is used to authenticate to the uaws webserver.  You can download the serverTrustStore.jks  now.
    • Usage:  Required.
    • Example:  webservices.trustStore=/certificates/keystores/serverTrustStore.jks.
    • Dependencies:  None
  8. webservices.trustStorePassword: 
    • Description:  The password for the Java truststore.
    • Usage:  Required.
    • Example:  webservices.keyStorePassword=changeit.
    • Dependencies:  None