Creating a Profile
- Ryan Clifton
Summary
Profiles control how messages from an inbound message source are processed. Per-project configuration is done through Project Mappings inside a Profile.
Creating new Profile
To create a new Profile from scratch you will need to go to Profiles > Create.
This will then show a form which needs to be filled in.
Note: Only Name is a required field, so the other fields can be filled in at a later date.
Once the relevant information has been entered press Create Profile and this will take you back to the Profiles screen where you will see the new profile.
Create Form Fields
Basic Profile Details
Name
This is the name of the Profile.
Description
The Description of the Profile which will be shown within list of Profiles.
API
This enables emails to be submitted to JEMH through REST API. For more info see: Submit emails via public REST /deliver API
Readiness
This is for you to provide a context of what this Profile is used for. This option does not affect the Profile functionality.
Current options are:
Development
SysTest
UAT
Production
Profile Groups
These fields are optional. Profile Groups are a way of aggregating a set of Profiles such that are run as a group by a mail handler. The 'default' in the group always runs last, to provide a last ditch approach to creating an issue, and clearing the message from your mail queue. See Use Profile Groups for full details.
Group Key
This is the unique Group Key that will be common to Profiles within this group.]
Default Profile
If selected, this Profile will be the default Profile within the Group. The Default Profile will run last. There can only be one Default Profile per group.
Group Order
This is used to determine the order of that the Profiles should be processed within. The higher the order, the sooner it runs. Default Profiles are always 0
Creating a new Profile SINCE 4.1.23
Within 4.1.23 we changed the Create Profile button so that it now triggers a Wizard to assist with the configuration. This wizard will assist with creating the Profile, setting a Default Project Mapping and configuring Email Only User support.
To create a new Profile you will need to go to the Profiles section and press Create Profile.
This will then show the Wizard which has a couple of different sections to create the profile. Below goes through each section showing the options that can be set.
1) Create Profile
This is where you define the parameters for the Profile. E.g. Profile name, Catch Email Address (Mailbox Address) and if the Profile is part of a group.
Profile Name
This is the name of the Profile.
Mailbox address
This is the inbound email address that would be handled by this JEMH profile.
Profile Groups
These fields are optional. Profile Groups are a way of aggregating a set of Profiles such that are run as a group by a mail handler. The 'default' in the group always runs last, to provide a last ditch approach to creating an issue, and clearing the message from your mail queue. See Use Profile Groups for full details.
Group Key
This is the unique Group Key that will be common to Profiles within this group.]
Default Profile
If selected, this Profile will be the default Profile within the Group. The Default Profile will run last. There can only be one Default Profile per group.
Group Order
This is used to determine the order of that the Profiles should be processed within. The higher the order, the sooner it runs. Default Profiles are always 0.
2) Create Project Mapping
This section will create a Default Project Mapping within the Profile so that JEMH would be able to create issues using this Profile.
Project
This is the Project that should be used for the default project Mapping within this Profile.
Issue Type
This is the Issue Type that should be used for all issues that are created using that Project Mapping. Note: This option only shows if the selected Project is not a Service Project.
Request Type
This is the Request Type that will be used for all issues that are created using this Project Mapping. Note: This option only shows if the selected Project is a Service project.
Priority
This is the Priority that will be set on the issues that were created using this Project Mapping.
3) Configure Email Only Users
This is configuration options that will allow Email Only Users to create Issues within Jira. If not required then you can press Skip at the bottom of the screen.
Default Reporter
User that will create issues on behalf of the Email Only Users (Senders without a Jira account).
Email Sender Name
This is the Custom Field that will be used to store the name of the email sender when they are not a Jira User.
Email Sender Address
The Custom Field that will be used to store the Email Address of the email sender when they are not a Jira User.
Email Participants
The Custom Field that will be used to store the Email Only Users that are found within the Recipient Email Headers (e.g. To/Cc).
Auto create Custom Fields
This button is used to auto create Custom fields that can be used to store these Email Only User values.
4) Summary
This provides additional information about the next steps that are required to connect the Profile to a Jira configured Mail Server.
Finish Wizard
This button will exit the Wizard and will take you back to Profiles page. Where you can view the newly created Profile.