Mobility Access Server-Side Configuration Settings

Installation adds the mobility_access.xml file to the <PPM_Home>/conf directory. The mobility_access.xml file stores the server-side configuration parameter settings for the Mobility Access Service.

Configuring the Email Server

After you enable the Mobility Access Service, you must configure an email account used to fetch and process the emails. This email account must meet the following requirements:

  • The account must not be shared with any other process or used for any other purpose.

  • The account must not be configured as the email address for a PPM user.

  • The account must be configured to receive notification response email messages no larger than 1 MB.

Note: Any email sent to the configured account that is not a notification response email for the Mobility Access Service is considered SPAM and is deleted.

The mobility_access.xml file contents are as follows:

<email_service_config>
<email_servers>
<inbound_email_server>
<hostname>imap.mail.hp.com</hostname>
<enabled>true</enabled>
<protocol>imap</protocol>
<email_address>ppm750_email_service@hp.com</email_address>
<email_account>ppm750_email_service </email_account>
<password><![CDATA[#!#3E7i:C/Vp}lhSN41)L~YLhFk-:w5tzJpR1ua~q`ekTD^ChnJ<>4UNxc51x7ip`6x~4`qZlx^3_18EAhzJtZ(b9O/RE&+{A,68156ApEcFqQpv9Kg{Rfx^&~ep_VtLPC(:nkk=:<A85x91v(A*(mk3{$kJcbrjlk@k)L{`|8$)<KPLxI@ 2R13^sL1p)i7#!#]]></password>
<default_folder>INBOX</default_folder>
<mail_archive_folder>PPM_PROCESSED_MAILS</mail_archive_folder>
<archive_messages>Y</archive_messages>
<send_success_feedback>N</send_success_feedback>
<send_failure_feedback>Y</send_failure_feedback>
<send_not_applicable_feedback>N</send_not_applicable_feedback>
<days_to_retain_messages>2</days_to_retain_messages>
<action_processor><value>com.kintana.sops.emailprocessor .server.WorkflowActionProcessor</value></action_processor>
<notes_logging>ONLY_EMAIL_MESSAGE</notes_logging>
<package_lines_bulk_approval>Y</package_lines_bulk_approval>
</inbound_email_server>
</email_servers>
<email_service_config>

To configure the email server:

  1. Navigate to the <PPM_Home>/conf directory and open the mobility_access.xml file in a text editor.

  2. Provide the information described in the following table, which lists descriptions of the Mobility Access Configuration parameters in the mobility_access.xml file, along with their valid values and default values.

    Note: You must provide values for the parameter names that are marked with an asterisk in the table.

    Parameter Name

    *Required

    Default

    Description

    *hostname

     

    Hostname of email server.

    Example:

    imap.mail.hp.com

    You can also specify an IP address for this parameter.

    *enabled

    true

    If set to true, indicates that this email server is enabled for processing emails. Emails are fetched and processed only from the servers for which this parameter is set to true.

    *protocol

    imap

    Mail protocol of the email server. Only IMAP and POP3 protocols are supported. Valid values are as follows:

    • imap

    • pop3

    • imaps

    • pop3s

    *email_address

     

    Email address from which to fetch and process the emails.

    Example: ppm800_email_service@hp.com

    Note: Make sure that no PPM users account specifies this address as the user email address.

    *email_account

     

    Email account from which to fetch and process the emails.The value you specify depends on your server and could be just the account name (with domain name) or the email address.

    Examples:

    ppm800_email_service
    AMERICAS\ppm800_email_service ppm800_email_service@hp.com

    *password

     

    Both plain text password and passwords encrypted using kEncrypt.sh are supported. Passwords must be enclosed between <![CDATA[ and ]]> xml tags to escape special characters.

    Note: All encrypted passwords must be enclosed between #!#.

    Plain text password example:

    <password><![CDATA[Welcome123]]>
    </password>

    Encrypted password example:

    <password><![CDATA[#!#3E7i:C/Vp}lhSN41)L~YLhFk-:w5tzJpR1ua~q `ekTD^ChnJ<>4UNxc51x7ip`6x~4`qZlx^3_18EAhzJtZ(b9O/RE&+{A, 68156ApEcFqQpv9Kg{Rfx^&~ep_VtLPC(:nkk=:<A85x91v(A*(mk3 {$kJcbrjlk@k)L{`|8$)<KPLxI@ 2R13^sL1p)i7#!#]]></password>

    mail_archive_folder

     

    Determines the name of the folder in which incoming mails are to be stored after processing. (Applies only to email servers that support IMAP protocols.)

    Example: PPM_PROCESSED_MAILS

    Note: If a folder does not exist, the Mobility Access Service creates the folder.

    *archive_messages

    Y

    Applies to email servers using the IMAP protocol. If set to Y, all the incoming emails and outgoing feedback emails are logged into the PPM_EMAIL_PROCESSED_MSGS table.

    If the email server supports the IMAP protocol, and if the mail_archive_folder parameter is set to a valid value, then all the incoming emails are moved to the archive folder after processing.

    *days_to_retain_messages

    180

    Applies to email servers using the IMAP protocol. Number of days from the mail received date that email messages are to remain in the PPM_EMAIL_PROCESSED_MSGS table and mail_archive_folder.

    *action_processor

     

    Intended for possible future use, this parameter is set to the following value and must NEVER be changed:

    com.kintana.wf.mobilityaccess. server.WorkflowActionProcessor

    Action Processor Configurations

    notes_logging

    ONLY_EMAIL_MESSAGE

    Determines what gets saved in the notes for requests and packages. The value can be one of the following:

    • ONLY_EMAIL_MESSAGE

      Only the email message is saved in the notes.

    • HEADERS_AND_EMAIL_MESSAGE

      Email message and headers are saved in the notes.

    *send_success_feedback

    N

    Determines whether a feedback message is to be sent to the user if the selected workflow action was completed successfully.

    *send_failure_feedback

    Y

    Determines whether a feedback message is to be sent to the user the selected workflow action failed.

    *send_not_applicable_feedback

    N

    Determines whether a feedback message is to be sent to the user if the selected workflow action was not applicable.

    mobility_access_hide_initial_message

    false

    Controls whether to hide or display the initial text in an Mobility Access email notification. Setting the parameter to true hides the initial text.

  3. Save, and then close the mobility_access.xml file.

Configuring User-Defined Markers

Any markers that PPM Center users define in email responses are added to the named mobility_access.properties resource file, which is located in the <PPM_Home>/conf/custom_resources/mobility_access directory. You can edit this file to customize these markers.

Note: If your PPM Center instance supports multiple languages, note that, while Micro Focus supplies translations for the message content markers it delivers. If you change these marker definitions, then you must create and maintain the translations for them.

The mobility_access.properties file contains the following code:

#A customer-updatable resource file for Mobility Access markers
###########################################
### Non-Translatable Resources ###
###########################################
subjectResponseBeginSuffix=:
subjectResponseEnd=;
notesMarkerPrefix=<
notesMarkerSuffix=>
controlDataResponseBeginSuffix=:
controlDataResponseEnd=~~~
###########################################
### Translatable Resources ###
###########################################
subjectResponseBegin=User Action
userNotesResponseBegin=Notes Begin
userNotesResponseEnd=Notes End
controlDataResponseBegin=PPM Reference