Personal tools

Log in

Changes

From All n One's bxp software Wixi

Jump to: navigation, search

BEmail Content Retrieval

3,222 bytes added, 11:11, 9 February 2018
no edit summary
= Overview =
{| class="wikitable"
! style="width:16%" | Setup
! style="width:16%" | Content Continue
! style="width:16%" | Content Retrieval
! style="width:16%" | Content Replacement
! style="width:16%" | onArrival
! style="width:16%" | SPAM
|-
|| [[BEmail_(_Email-2-Campaign_)|Link]]
|| [[BEmail_Content_Continue|Link]]
|| [[BEmail_Content_Retrieval|Link]]
|| [[BEmail_Content_Replacement|Link]]
|| [[BEMail_onArrival_matching_engine|Link]]
|| [[BEmail_SPAM_Management|Link]]
|-
|}
bxp software (bxp) has the ability to retrieve emails from an email box and turn them into data records (CDAs) for processing.
Content Retrieval allows the bxp engine, when it is hoovering in emails, to check the content of the emails for information. If the information is found, the contents can be placed in another field in the form. This allows for detailed extraction of data from a form.
As the emails are retrieved it is possible to apply rules to these emails.
The engine has two parts
* Content Retrieval - Suppress Blanks
* Content Retrieval - Rules
Content Retrieval Rules are the set of rules used to interrogate the data in an email and strip out what is required from that content. You can have as many rules as you like and trial and error usually dictate how effective your rules are.
These settings are in the "Inbox - Content" section of the "Advanced Settings" of a Form.
The rules can be managed through ''Main Menu > Form Management > Form - Primary Management > Form - Email Rule Management > Choose the Form > ''
[[File:content_retrieval_001.png|800px]]
"Content Retrieval - Suppress Blanks" provides two options. If a rule is checked for in the incoming email and '''no''' data is found:
* False : the field will be blanked and will be included in the update.
* True : the field for this record will not be included in the update.
 "Content Retrieval - Rules" are the rules to be applied. They can be typed in by hand or you can use the very easy to follow rule creator. ''Main Menu > Form Management > Form - Primary Management > Form - Email Rule Management > Choose the Form > ''  Testing the rules can be complicated so there is a tool to help you test rules and also to update historical records if the rules wern't right in the first place. Details on the tool are available here [[BEmail_Content_Retrieval_Rules_Testing]]   = Understanding the Rules =  == Rule Type 1 - Straight Content Retrieval = Format =
StartCharacters#EndCharacters#DestinationField#Location~
 
File vmail_0811111111_1401_20120912125202
</syntaxhighlight>
 
we want to extract the duration data.
The result of this rule will extract 00:00:23 and put it in the field strCDA_X_field_0_0
 
 
Please note that if multiple matches are made the solution will only take the first match made.
 
 
 
== Rule Type 2 - Conditional Status Flag ==
 
 
Each rule is in the format
 
 
TypeOfCondition[ [ [ [SEP]]]]CustomNewStatus#ValueToMatch#SecondaryFieldToUpdate#Location~
 
 
Take an example email
 
<syntaxhighlight lang="html4strict">
You have received an email from - CheapMedicalSupplies@doc.ie
 
Sender:CheapMedicalSupplies@doc.ie
Message: We have cheap medical supplies
 
</syntaxhighlight>
 
 
We don't want to see this message in our list of live emails as it's spam.
 
We need to create a rule that will flag any email received from ''CheapMedicalSupplies@doc.ie'' as spam
 
 
The rule would look like:
<syntaxhighlight lang="html4strict">
Update_Status_Equal[[SEP]]Spam Contact#CheapMedicalSupplies@doc.ie#strCDA_X_Status#From~
</syntaxhighlight>
 
 
We have a few options that we can use when using the Conditional Status Flag rules, these are:
 
 
'''1) Exact matching - Update_Status_Equal'''
 
This will update the Current Status field to be '''Spam Contact''' if the sender is '''EQUAL TO''' CheapMedicalSupplies@doc.ie
<syntaxhighlight lang="html4strict">
Update_Status_Equal[[SEP]]Spam Contact#CheapMedicalSupplies@doc.ie#strCDA_X_Status#From~
</syntaxhighlight>
 
 
'''2) Not Matching - Update_Status_Not'''
 
This will update the Current Status field to be '''Spam Contact''' if the sender is '''NOT''' CheapMedicalSupplies@doc.ie
<syntaxhighlight lang="html4strict">
Update_Status_Not[[SEP]]Spam Contact#CheapMedicalSupplies@doc.ie#strCDA_X_Status#From~
</syntaxhighlight>
 
 
'''3) Like Matching - Update_Status_Contains'''
 
This will update the Current Status field to be '''Spam Contact''' if the sender is '''LIKE''' CheapMedicalSupplies@doc.ie
<syntaxhighlight lang="html4strict">
Update_Status_Contains[[SEP]]Spam Contact#CheapMedicalSupplies@doc.ie#strCDA_X_Status#From~
</syntaxhighlight>
By adding a simple flag field, the identified contents if in this field, mean the record is to be occluded from the calling stack.
7,528
edits