Configuring Email Statusing Service for P6

To configure Email Statusing Service for P6:

From the P6 Team Member home directory (for example, C:\P6EPPM_1\tmws), extract the files from the p6tm-email-service.zip to any location on the application server. (That location will be referred to as EMAIL_HOME).
Make a backup copy of the config.properties file before you edit it.
Edit the config.properties file to configure the settings for the email application.
Note: When you are finished editing the config.properties file, move it to a secure location.
In the P6 Configuration section, locate and specify the following:
1. In the p6.admin.user = line, specify a P6 user who is assigned to at least one module access and has resource access.
2. In the p6.notify.user = line, specify the email addresses, separated by commas, of users who can send Notify Task lists to other users. As you see the P6 Help for more information on sending team members their tasks.
3. In the p6.max.tmusers = line, specify the maximum number of email recipients that can receive notification emails at one time. You should keep the number below 500 to avoid performance problems.
4. In the p6.bootstrap = line, specify the location of the BREBootstrap.xml file.
  For example, the location could be one of the following: C:/P6EPPM_1/p6, C:/EMAIL_HOME, /usr/P6EPPM_1/p6, or /usr/EMAIL_HOME or you can use the following: C:\\P6EPPM_1\p6, C:\\EMAIL_HOME.
5. In the mail.read.schedule = line, specify how often your email should process new messages. Use cron expressions for your formatting. For example:
  0 */5 * * * ?
  
  will process new messages every five minutes.
  
  Note: For more information on cron expressions, see http://www.quartz-scheduler.org/documentation/quartz-2.2.x/tutorials/tutorial-lesson-06.html.
In the Outgoing mail (SMTP Settings) section, locate and specify the following:
1. In the send.host = line, specify the SMTP server hostname or IP address that you will use to send emails.
2. In the send.port = line, specify the port number that connects to the SMTP server.
3. In the send.ssl = line, specify true to use SSL or false if you will not use SSL.
  Note: Oracle recommends that you always use SSL in a production environment for secure communications.
4. In the send.starttls = line, specify true to use TLS or false if you will not use TLS.
5. In the send.email = line, specify the email address or User Principal Name (UPN) where team members will send their status update requests.
6. In the send.replyto = line, specify an email address for team members to respond to when they receive emails. If this field is left blank, the reply address will be the send.email address you specified above.
7. In the send.password = line, specify the password for the email address or UPN you just specified.
  Notes:
  - If you do not specify a password now, the email application prompts you to specify one when it runs.
  - You can also specify a password by running the following parameter when you run the 'run.bat' or 'run.sh' file:
    -Dsend.password=YOUR_PASSWORD
    where Your_Password is the password for your status email address.
    For example:
    In Windows: ./run.bat -Dsend.password=YOUR_PASSWORD
    In UNIX: ./run.sh -Dsend.password=YOUR_PASSWORD
  - Oracle recommends using the option in the config.properties file and then moving that file to a secure location when you are finished modifying it.
  - If you want to set up anonymous authentication for an SMTP server, comment this field out.
In the Incoming Mail (IMAP Settings) section, locate and specify the following:
1. In the imap.host = line, specify the IMAP protocol host to read emails.
2. In the imap.port = line, specify the IMAP port number.
3. In the imap.ssl= line, specify true to use SSL or false if you will not use SSL.
  Note: Oracle recommends that you always use SSL in a production environment for secure communications.
4. In the imap.username = line, specify the IMAP user name (which will be your email address) or User Principal Name (UPN).
5. In the imap.password = line, specify the password for the user name you just specified.
  Notes:
  - If you do not specify a password now, the email application will ask you to specify one when it runs.
  - You can also specify a password by running the following parameter when you run the 'run.bat' or 'run.sh' file:
    -Dimap.password=YOUR_PASSWORD
    where Your_Password is the password for your status email address.
    For example:
    In Windows: ./run.bat -Dimap.password=YOUR_PASSWORD
    In UNIX: ./run.sh -Dimap.password=YOUR_PASSWORD
  - Oracle recommends using the option in the config.properties file and then moving that file to a secure location when you are finished modifying it.
  - If you want to setup anonymous authentication for an SMTP server, comment this field out.
6. In the imap.search.folder = line, specify the folder to use for processing incoming emails. For example:
  imap.search.folder = inbox
  
  Note: The email application will use this folder to search for incoming mail. Oracle recommends you use the inbox for this folder. If you select another folder, you must ensure that all emails get filtered there, or the email application will not be able to detect the messages.
In the IMAP Folder configuration section, locate and specify the following:
1. In the imap.success.folder = line, specify the folder where messages that process successfully will go. For example:
  imap.success.folder = P6Success
  
  Note: The email application will automatically create this folder if you do not create it now.
2. In the imap.failure.folder = line, specify the folder where messages that failed will go. For example:
  imap.failure.folder = P6Fail
  
  Note: The email application will automatically create this folder if you do not create it now.
3. In the imap.temp.folder = line, specify the folder where messages that are being processed will go. For example:
  imap.temp.folder = P6Temp
  
  Note: The email application will automatically create this folder if you do not create it now.
In the Task update options section, locate and specify the following:
1. In the reply.label.cleanup field, enter true if you want to remove HTML tags attached to the task field labels. Enter false if you don't want to remove the tags.
2. In the reply.label.tag.search field, enter the regular expression to remove unexpected HTML tags during reply message parsing.
  Note: See information on "regular expression" for more details on this field. For example, see https://developer.mozilla.org/en-US/docs/JavaScript/Guide/Regular_Expressions#Writing_a_Regular_Expression_Pattern.
3. In the update.debug field, enter true if you want to output the contents of the email message as it is parsed for updates. Enter false if you don't want to output the contents of the email message as it is parsed for updates. You should only enter true when you are troubleshooting issues with updating tasks.
In the Message Format options section, locate and specify the following:
1. In the update.task.search.term = line, specify the text that the email application should search for in the subject line of incoming messages. For example:
  update.task.search.term = Your Requested P6 Tasks
2. In the notify.update.task.search.term = line, specify the text that the email application should search for in the subject line of incoming messages that originated from a Notify message. For example:
  update.task.search.term = Your P6 Tasks
If the EMAIL_HOME is on a different server from your P6 home, copy the BREBootstrap.xml from your P6 home to your EMAIL_HOME.
If the EMAIL_HOME is on the same server as your P6 home, you will use the BREBootstrap.xml that is in your P6 home folder.
Run one of the following:
- In Windows, launch the run.bat file.
- In UNIX, launch the run.sh file.
When you launch the run file, you may have to complete the following steps depending on how you configured your Email Statusing Service:
1. If the config.properties file and the run file are in different folders, you will need to specify the config.properties location with the -Dconfig.file parameter.
  - In Windows (add a space between run.bat and -Dconfig):
    run.bat -Dconfig.file=C:\home\auser\somelocation\config.properties
  - In UNIX (add a space between run.sh and -Dconfig):
    ./run.sh -Dconfig.file=/home/auser/somelocation/config.properties
2. If you didn't specify the send.password= or imap.password=, you can specify them now. If you do not specify them now, the email application will prompt you to do so when it runs.
  - In Windows:
    run.bat -Dsend.password=YOUR_PASSWORD
  - In UNIX:
    ./run.sh -Dsend.password=YOUR_PASSWORD
  - In Windows:
    run.bat -Dimap.password=YOUR_PASSWORD
  - In UNIX:
    ./run.sh -Dimap.password=YOUR_PASSWORD
  where Your_Password is the password for your status email address
3. If your bootstrap file contains more than one database, you need to clarify which database you are using when you launch the run file.
  - In Windows:
    run.bat -Ddatabase.instance=db_id
    
    where db_id is your database instance (for example, -Ddatabase.instance=2).
  - In UNIX:
    ./run.sh -Ddatabase.instance=db_id
    
    where db_id is your database instance (for example, -Ddatabase.instance=2).

Once the run file finishes, you can verify that the email status application works. See Verifying Email Statusing Service.

Note: Anonymous SMTP authentication is supported.

Configuring Email Statusing Service for P6

Related Topics