Table 9. Inbound Email Manager Methods and Input Arguments
Method
|
Input Argument
|
Description
|
AddAttachments
|
|
Creates attachment records for the attachments in EventFields.
|
Business Component
|
Business component in which attachment records are created.
|
Business Object
|
Business object in which attachment records are created.
|
EventFields
|
Hierarchy that contains file properties, such as FileName0, FilePath0, FileName1, FilePath1, and so on.
|
AddCategories
|
|
Associates categories with an activity record.
|
ActivityId
|
ID of activity record with which categories are associated.
|
BusComp
|
Business component in which category associations are created.
|
BusObj
|
Business object in which category associations are created.
|
Catalog
|
Catalog in which the system looks up categories.
|
Categories
|
List of categories and corresponding scores.
|
DeleteTempFiles
|
|
Deletes temporary files specified in EventFields.
|
EventFields
|
Hierarchy that contains file properties, such as FilePath0, FilePath1, and so on.
|
GetCategories
|
|
Gets the list of categories and scores associated with an activity.
|
ActivityId
|
ID of activity record from which categories are obtained.
|
BusComp
|
Business component of the associated categories.
|
BusObj
|
Business object of the associated categories.
|
Categories
|
List of categories and corresponding scores.
|
GetEventCategories
|
|
Enumerates the categories in EventFields and returns them in a hierarchy.
|
Categories
|
List of categories extracted from EventFields.
|
EventFields
|
EventFields that contain category properties prefixed by CATEGORY.
|
GetPreference
|
|
Gets the value of a user preference.
|
Category
|
Category of preference.
|
Preference
|
Name of preference.
|
Value
|
Value of preference.
|
GetResponseText
|
|
Gets the auto-suggest/response text for a set of categories based on their scores and thresholds.
|
Catalog Id
|
The ID of the catalog in which your categories are stored. If the Catalog Id input argument contains a value, the Catalog Id is used to locate the catalog.
|
Categories
|
List of categories and corresponding scores.
|
CheckThreshold
|
If Y, checks category scores against the threshold to determine whether response text for a category is used. If N, gets the response text based on scores alone.
|
Catalog Name
|
The name of the catalog in which your categories are stored. If the Catalog Id input argument contains a value, the Catalog Name input argument is ignored.
|
MaximumSections
|
Maximum number of categories for which response text will be returned.
|
ResponseText
|
Response text for the set of categories.
|
GetSearchSpec
|
[Name of a business component field, such as Area or Extract]
|
Creates a search specification based on the fields included as input arguments. For example, if Abstract and Area were input arguments, the search specification named [Area] = "Installation" AND [Abstract] = "Production" would be called the SRSearchSpec output argument.
|
GetTokens
|
|
Gets a specified number of tokens from a string. The tokens are returned in output properties such as Token 1, Token 2, and so on.
|
Delimiter
|
One or more characters that set off a token from surrounding characters. Default is the space character.
|
NumTokens
|
The number of tokens to obtain. Default is 1.
|
Text
|
The text from which the tokens are obtained.
|
GetUQCategories
|
|
Creates a WorkItemDataProperty hierarchy required by UQ. Every input property will be added to the output hierarchy.
|
Categories
|
List of categories and corresponding scores. The category with the highest score is extracted and added to the WorkItemDataProperty hierarchy.
|
WorkItemDataProperty
|
Hierarchy with the highest scored category and all input properties.
|
ParseText
|
|
Extracts response properties from the email. The input arguments of this method include a fixed argument called Text, which contains the text to parse and one additional argument for each response property to extract. The types of these additional arguments are Literal and the values indicate the patterns to match and are in the following format:
["Last("] {prefix} "%s" [{suffix} | "\n"] [")"]
- The text
"Last(" at the beginning and the text ")" at the end are optional. They indicate that the last occurrence of the pattern should be used if there are multiple occurrences. If they are not specified, the first occurrence will be used.
{prefix} represents any literal that marks the beginning of the pattern and is required."%s" marks the value to be extracted and is required.{suffix} represents any literal that marks the end of the pattern. Alternatively, "\n" can be specified as a suffix to indicate that the pattern ends at the end of the line.
The extracted response properties are used in the workflow process.
|
Text
|
The string to parse.
|
ReturnPropSet
|
|
Returns a hierarchy that contains the input properties and properties from the input hierarchy.
|
PropSetType
|
The type of the output hierarchy.
|
SetResponseFields
|
|
Constructs To, CC, and BCC lines for outbound email based on corresponding lines from inbound email.
|
InputEmailBccLine
|
BCC line in inbound email.
|
InputEmailCcLine
|
CC line in inbound email.
|
InputEmailToLine
|
To line in inbound email.
|
InputMsgReceiveAddress
|
Receiver address in inbound email.
|
InputMsgSenderAddress
|
Sender address in inbound email.
|
InputResponseType
|
Reply, Reply to All, or Forward.
|
OutputEmailBccLine
|
BCC line for outbound email.
|
OutputEmailCcLine
|
CC line for outbound email.
|
OutputEmailToLine
|
To line for outbound email.
|
