In this article
...
<To be verified with QA>
Account Settings
Image Added<Insert
image here><Temporary image, will be replaced once the values for the Mail properties fieldset are known>
| Appsplus panel macro confluence macro |
|---|
| data | {"features":["title","icon","rounded","collapsible","border"],"title":"Documenting Fields Based On Data Type/UI Element","titleColor":"#000000","titleColorBG":"#ff5c30","titleSize":"14","titleBold":true,"titleItalic":false,"titleUnderline":false,"lozenge":"Hot stuff","lozengeColor":"#172B4D","lozengeColorBG":"#fff0b3","height":200,"panelPadding":12,"panelColor":"#172B4D","panelColorBG":"#FFFFFF","borderColor":"#ff5c30","borderRadius":3,"borderStyle":"solid","borderWidth":1,"icon":"editor/info","iconPrimary":"#FFFFFF","iconSecondary":"#0052CC","newMacro":false} |
|---|
|
**Delete Before Publishing** Choose from the following sentences to document specific field types. Drop-down lists/Option Buttons (radio buttons): You must list the LoV and describe them if their meaning isn't apparent. In this case, format the LoV in italics, regular font for the LoV's description. In either case, list the LoVs as a bullet list. <State what the should do in this field>. The available options are: <bullet list of LoVs>
Specify the Salesforce API to be used. The available options are:... Select the <category> that you want to use. Available options are...
* Option 1<italicized>. <third person singular form of the verb>
* Option 2<italicized>. <third person singular form of the verb>
Select the API that you want to use. Available options are:
Bulk API. Sends the Snap execution request details as a bulk API call.
REST API. ...
OR
Select one of the three following modes in which the Snap executes:
* Validate & Execute. Performs limited execution of the Snap and generates a data preview during Pipeline validation, then performs full execution of the Snap (unlimited records) during Pipeline runtime.
* Execute only. Performs full execution of the Snap during Pipeline execution without generating preview data.
* Disabled. Disables the Snap and all Snaps downstream from it.
Check boxes: If selected, <Snap behavior>.
If selected, an empty file is written when the incoming document has no data. If selected, <behavior>. If not selected/Otherwise, <behavior>
Use "If not selected" if the first sentence is long.
If selected, the Snap uses the file path value as is. Otherwise, the Snap uses the file path value in the URL.
If selected, an empty file is written when the incoming document has empty data. If there is no incoming document at the input view of the Snap, no file is written regardless of the value of the property. Select to <action>
Use this if the behavior is binary. Either this or that, where the converse behavior is apparent/obvious.
Select to execute the Pipeline during validation.
Text Fields Describe what the user shall specify in this field. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc.
Enter the name for new account.
Specify the account ID to use to log in to the endpoint.
Required if IAM Role is selected.
Do not use this field if you are using batch processing.
Numeric Text Fields Describe what the field represents/contains. Additional details, as applicable, in a separate sentence. Include caveats such as the field being conditionally mandatory, limitations, etc. Include special values that impact the field's behavior as a bullet list.
The number of records in a batch.
The number of seconds for which you want the Snap to wait between retries.
The number of seconds for which the Snap waits between retries.
Use the following special values:
* 0: Disables batching.
* 1: Includes all documents in a single request.
Notes in field descriptions Confluence’s new editor does not allow nesting of most macros inside another macro, especially the Note/Alert/Warning/Info (Panel) macros inside a table macro and Excerpt macros inside Expand or Panel Macro+ macros. So, as a workaround use the Footnotes approach as mentioned below: Assign numbers at the Note locations in the form of follow through phrases like See Note 2 below this table. or such. Add your Notes---an appropriate Note/Alert/Warning/Info (Panel) macro---immediately below the macro (for example, Table macro) beginning the content with the corresponding number assigned.
|
...
Field Name | Field Type | Field Dependency | Description |
|---|
Label* Default Value: ELT Database Account None
Example: ELT RS IMAP Account | String | None. | Enter a unique label for the account. |
Email ID Default Value: None
Example: john@abcd.com | String | None | Enter the email ID to use for this account. |
Password Default Value: None
Example: o8jkll0# | String | None | Enter the the password for the account. |
Server domain* Default Value: None
Example: imap.example.com | String | None | Enter the name of the server domain. |
Port* Default Value: None
Example: 993 | Integer | None | Enter the port number of the email server. | Field setThis will vary depending on your mail provider and the Secure connection selected. |
Secure connection* Default Value: None
Example: SSL | String | None | Select how the secure connection to the email server should be initiated. Options available include: STARTTLS: Connects to the regular SMTP/IMAP/POP3 port and then upgrades the connection to TLS. SSL: If enabled on your server domain, creates a secure connection. NONE: Used if a secure connection is not configured.
|
Attachment password Default Value: None
Example: o8jkll0# | String | None | Enter the password for attachment URL. |
Connection timeout Default Value: 60000
Example: 50000 | Integer | None | Enter the time duration in milliseconds, in the event of a connection error, after which the server will not try reconnecting. |
Read Timeout Default Value: 60000
Example: 50000 | Integer | None | Enter the time duration in milliseconds, in the event of a read error, after which the server will not try to read the data. |
Write Timeout Default Value: 60000
Example: 50000 | Integer | None | Enter the time duration in milliseconds, in the event of a write error, after which the server will not try to write the data. |
Mail properties | <Need information about it> Specify advanced parameters that you want to include in the request. This field set fieldset consists of the following fields: | Field 1*
Mail property name Mail property value
|
Mail property name Default Value:
Example: | String | Debug mode checkbox is not selected. | Field 2None | |
Mail property value Default Value:
Example: | String | None | |
If using Gmail, you may need to turn on the option to allow less secure apps to access your account within Gmail. See https://support.google.com/accounts/answer/6010255?hl=en for more information. Due to the anti-email-hijacking policies of webmail servers, the Email Snaps often fail to perform as expected. It is a trend for webmail servers (e.g. gmail, yahoo, hotmail, etc.) to enforce their security policy increasingly against all email client applications which access email accounts through email API (SMTP, IMAP, etc), other than web browsers, if the client applications access from a geographical location far from usual locations of the web browser logins. The Email Snaps are often classified as suspicious email hijacker since the Snaps try to access the email server from AWS, a location different from usual web browser logins of users. Sometimes, users can find additional information in the emails from the mail servers or in the security page of the account. The Email Snaps function well as expected if their accounts are not from webmail servers. |
Account Encryption
Standard Encryption | If you are using Standard Encryption, the High sensitivity settings under Enhanced Encryption are followed. |
|---|
Enhanced Encryption | If you have the Enhanced Account Encryption feature, the following describes which fields are encrypted for each sensitivity level selected per each account. Account: Email - IMAP High: Password Medium + High: Email ID, Password Low + Medium + High: Email ID, Password, Server domain
|
|---|
Troubleshooting
<To be checked with QA>
Error | Reason | Resolution |
|---|
| | |
Account validation failed. | The Pipeline ended before the batch could complete execution due to a connection error. | Verify that the Refresh token field is configured to handle the inputs properly. If you are not sure when the input data is available, configure this field as zero to keep the connection always open. |
| Insert excerpt |
|---|
| XYZ Snap Pack |
|---|
| XYZ Snap Pack |
|---|
|
...
Related Links
...
Endpoint Doc Link 1
...
Endpoint Doc Link 2
...
