1. Home
  2. On-premises 5.1
  3. Guides
    1. Start
    2. Administer
    3. Analyze
    4. Configure
      1. Server Configurations
      2. Tenant Configurations
      3. Email Configuration
      4. Apache Web Server Configuration
      5. Zookeeper Cluster Configuration
      6. Performance Tuning
      7. Optimize Performance
      8. Memory Usage
      9. Configure High Availability
      10. Memory Configuration
    5. Deploy
    6. Install
    7. Migrate
    8. Secure
    9. Upgrade
    10. Content Manager
  4. Tours
  5. Concepts
  6. Tools
  7. References
  8. Integrations
  9. Data applications
  10. Releases

Email Configuration

You can send Incorta Dashboards, or schedule an Incorta Dashboard to be sent if you have an SMTP server installed and configured for the Incorta environment.

There are two steps to configuring the SMTP server:

  • Verify the SMTP server installation
  • Update the server properties with the properties file, or by updating individual properties.

After configuring the server you can send dashboards, or schedule dashboards to be sent using email.

Verify the SMTP Server Configuration

  1. Verify the current email server properties.
  2. Navigate to Incorta home: cd <path to incorta_home>.
  3. Shut down the Incorta server if you are using the embedded database: ./stop.sh.
  4. Navigate to the tmt directory: cd tmt.
  5. List the tenants: ./tmt.sh -clnm <CLUSTER_NAME> -l. The response lists the current tenants.
  6. Run the following command to check the email values for a specific tenant: ./tmt.sh -clnm <CLUSTER_NAME> -lc <tenant name>. The response lists the current email values:
    • mail.smtp.auth. true
    • mail.smtp.host. Your SMTP server address
    • mail.smtp.port. The port number of the SMTP server
    • mail.smtp.socketFactory.class. javax.net.ssl.SSLSocketFactory
    • mail.smtp.socketFactory.port. 465
    • auth.forgot.password. The email password for the Incorta administrator
    • auth.forgot.password.email The email address of the Incorta administrator
  7. Update the tenant email properties.

Update the tenant properties using one of the following methods:

  • Modify the properties in a file and upload the file to Incorta
  • Update the properties individually

Update Properties Using a Properties File

To update the email related properties using a properties file:

  1. Edit a file, such as the company_email.properties file with the appropriate values.
  2. Place the property file into the <incorta home>/tmt folder.
  3. Run the following command to update the tenant properties: ./tmt.sh -u <tenant name> file <filename>.
  4. Restart Incorta server to see the updated properties.

Update Properties Individually

Use the following commands to to update the properties individually:

./tmt.sh -clnm <CLUSTER_NAME> -u <tenant name> <property name> <value>
./tmt.sh -clnm <CLUSTER_NAME> -u demo mail.smtp.host relay.music.com
./tmt.sh -clnm <CLUSTER_NAME> -u demo mail.smtp.port 25
./tmt.sh -clnm <CLUSTER_NAME> -u demo auth.forgot.password.email bob_dylan@music.com
./tmt.sh -clnm <CLUSTER_NAME> -u demo auth.forgot.password <put password here>
./tmt.sh -clnm <CLUSTER_NAME> -u demo mail.smtp.auth true

Send or Schedule a Dashboard Using Email

When your email server is properly configured, you can email Dashboards or schedule Dashboards to be sent.

To Send a Dashboard:

  1. Navigate to the dashboard to send or schedule.
  2. Select Send to specify the names or groups.

You can add an email address in the Send Dashboard window. The recipient does not have to be an Incorta user.

Change the Email Exchange Server Protocol to EWS

SMTP is the default email protocol for the Incorta Direct Data Platform email server. Alternately, you can choose the Microsoft Exchange Web Services (EWS) as the email protocol for sharing and scheduling dashboards. The following steps anticipate that you have already installed an SMTP mail protocol.

Changing the email server protocol requires replacing the current email protocol properties SMTP with EWS and restarting the Incorta server. You must stop the Incorta server if you are using Derby (embedded) as your selected database.

  1. Navigate to the INSTALLATION_PATH/directory.
  2. Stop the server: ./stop.sh.
  3. Navigate to the tmt folder: cd <INSTALLATION_PATH>/tmt.
  4. To list the current tenant configurations, type ./tmt.sh -clnm <CLUSTER_NAME> -lc <Tenant_Name>.
  5. Run the following commands to update the tenant email exchange server configuration properties. Replace EWS with SMTP to use EWS:
    • ./tmt.sh -clnm <CLUSTER_NAME> -u <TENANT_NAME> mail.protocol ews
    • ./tmt.sh -clnm <CLUSTER_NAME> -u <TENANT_NAME> mail.ews.url <EWS endpoint URL>
  6. Navigate to the INSTALLATION_PATH/ and start the Incorta server: ./start.sh.

Amazon Simple Email Service (SES)

Some SMTP email solutions such as Amazon SES require username/password pairs.

Starting with 4.6 you can configure the SMTP host to use a Sender’s Username Authentication.

To enable this option as default tenant configuration in the CMC, follow these steps:

  1. In the navigation bar, select Clusters.
  2. In the cluster list, select a Cluster name.
  3. In the canvas tabs, select Cluster Configurations.
  4. In the panel tabs, select Default Tenant Configurations.
  5. In the left pane, select Email.
  6. In the right pane, toggle Sender’s Username Auth to enable.
  7. In System Email Username, enter the SMTP username.
  8. Select Save.

To enable this option for a specific tenant configuration in the CMC:

  1. In the navigation bar, select Clusters.
  2. In the cluster list, select a Cluster name.
  3. In the canvas tabs, select the Tenants tab.
  4. In the Tenant list, for the given tenant, select Configure.
  5. In the left pane, select Email.
  6. In the right pane, toggle Sender’s Username Auth to enable.
  7. In System Email Username, enter the SMTP username.
  8. Select Save.