> ## Documentation Index
> Fetch the complete documentation index at: https://docs.arc.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Notify Connector

> The Notify connector sends simple notification emails to recipients defined in the application Alerts settings, with support for macros and ArcScript in message content.

The Notify connector sends simple notification emails to the recipients defined on the application [Alerts](https://docs.arc.cdata.com/26.4/cloud/en/getting-started/administration/settings/alerts.md) page.

## Key Capabilities

* Simple email notification system using application-wide alert settings
* Configurable subject lines and message bodies with macro and ArcScript support
* Automatic email sending to predefined recipients from the Alerts configuration
* Support for file attachments and both synchronous and asynchronous delivery

## Connector Configuration

This section contains all of the configurable connector properties.

### Settings Tab

#### Configuration

*Settings related to the core configuration of the connector.*

| Setting | Description |
| - | - |
| **Connector Id** | The static, unique identifier for the connector. |
| **Connector Type** | Displays the connector name and a description of what it does. |
| **Connector Description** | An optional field to provide a free-form description of the connector and its role in the flow. |
| **Subject** | The subject line of the outgoing email message. |
| **Message** | The body of the outgoing email message. ArcScript is supported, as are the following macros: %MessageId%, %ConnectorID%, %Filename%, %FilenameNoExt%, %EXT%, %ShortDate%, %LongDate%, %RegexFilename:\[regex]%, %DateFormat:\[format]%, %Header:\[headerName]% |

> [!TIP]
>
> If you have not already specified notification settings on the [Alerts](https://docs.arc.cdata.com/26.4/cloud/en/getting-started/administration/settings/alerts.md) page, click **Configure Notification Settings** to set them up.

### Advanced Tab

| Setting | Description |
| - | - |
| **Processing Delay** | The amount of time (in seconds) by which the processing of files placed in the **Transactions** tab is delayed. This is a legacy setting. Best practice is to [use a File connector](https://docs.arc.cdata.com/26.4/cloud/en/flows/designing-a-flow.md#interacting-with-the-local-file-system) to manage local file systems instead of this setting. |

#### Logging

*Settings that govern the creation and storage of logs.*

<table><thead><tr><th>Setting</th>
<th>Description</th></tr></thead>
<tbody><tr><td>**Log Level**</td>
<td>The verbosity of logs generated by the connector. When you request support, set this to **Debug**.</td></tr>
<tr><td>**Log Subfolder Scheme**</td>
<td>Instructs the connector to group files in the Logs folder according to the selected interval. The **Weekly** option (which is the default) instructs the connector to create a new subfolder each week and store all logs for the week in that folder. Leaving this setting blank tells the connector to save all logs directly in the Logs folder. For connectors that process many transactions, using subfolders helps keep logs organized and improves performance.</td></tr>
<tr><td>**Log Messages**</td>
<td>Check this to have the log entry for a processed file include a copy of the file itself. If you disable this, you might not be able to download a copy of the file from the **Transactions** tab.</td></tr></tbody></table>

#### Other Settings

| Setting | Description |
| - | - |
| **Processing Delay** | The amount of time (in seconds) by which the processing of files placed in the **Transactions** tab is delayed. This is a legacy setting. Best practice is to [use a File connector](https://docs.arc.cdata.com/26.4/cloud/en/flows/designing-a-flow.md#interacting-with-the-local-file-system) to manage local file systems instead of this setting. |

#### Miscellaneous

*Miscellaneous settings are for specific use cases.*

<table><thead><tr><th>Setting</th>
<th>Description</th></tr></thead>
<tbody><tr><td>**Other Settings**</td>
<td>Enables you to configure hidden connector settings in a semicolon-separated list (for example, `setting1=value1;setting2=value2`). Normal connector use cases and functionality should not require the use of these settings.</td></tr></tbody></table>

### Automation Tab

#### Automation Settings

*Settings related to the automatic processing of files by the connector.*

| Setting | Description |
| - | - |
| **Send** | Whether messages arriving at the connector are automatically processed. |

#### Performance

*Settings related to the allocation of resources to the connector.*

<table><thead><tr><th>Setting</th>
<th>Description</th></tr></thead>
<tbody><tr><td>**Max Workers**</td>
<td>The maximum number of worker threads consumed from the threadpool to process files on this connector. If set, this overrides the default setting on the [Performance Settings](https://docs.arc.cdata.com/26.4/cloud/en/getting-started/administration/settings/performance-settings.md) portion of the [Advanced Settings](https://docs.arc.cdata.com/26.4/cloud/en/getting-started/administration/settings/advanced-settings.md) page.</td></tr>
<tr><td>**Max Files**</td>
<td>The maximum number of files sent by each thread assigned to the connector. If set, this overrides the default setting on the [Performance Settings](https://docs.arc.cdata.com/26.4/cloud/en/getting-started/administration/settings/performance-settings.md) portion of the [Advanced Settings](https://docs.arc.cdata.com/26.4/cloud/en/getting-started/administration/settings/advanced-settings.md) page.</td></tr></tbody></table>

### Alerts Tab

*Settings related to configuring alerts.*

Before you can execute Service Level Agreements (SLAs), you need to set up email alerts for notifications. By default, Arc uses the global settings on the [Alerts](https://docs.arc.cdata.com/26.4/cloud/en/getting-started/administration/settings/alerts.md) tab. To use other settings for this connector, toggle **Override global setting** on.

By default, error alerts are enabled, which means that emails are sent whenever there is an error. To turn them off, uncheck the **Enable** checkbox.

Enter a **Subject** (mandatory). Check **Allow ArcScript in Subject** to use ArcScript in the **Subject** field. When you select this, the **ArcScript Editor** button appears (![arcscript editor button](https://docs.arc.cdata.com/26.4/images/rest_arcscript_editor.png)).

Optionally, enter a comma-separated list of **Recipient** emails.

### SLAs Tab

*Settings related to configuring Service Level Agreements (SLAs).*

SLAs enable you to configure the volume you expect connectors in your flow to send or receive, and to set the time frame in which you expect that volume to be met. CData Arc sends emails to warn the user when an SLA is not met, and marks the SLA as *At Risk*, which means that if the SLA is not met soon, it will be marked as *Violated*. This gives the user an opportunity to step in and determine the reasons the SLA is not being met, and to take appropriate actions. If the SLA is still not met at the end of the at-risk time period, the SLA is marked as violated, and the user is notified again.

SLA transitions to *At Risk* or *Violated* are also written to the [application log](https://docs.arc.cdata.com/26.4/cloud/en/getting-started/administration/activity.md#application-logs), which means that Application Performance Monitoring (APM) and log-ingestion tools can also alert on them.

To define an SLA, toggle **Expected Volume** on, then click the **Settings** tab.

![SLA Empty](https://docs.arc.cdata.com/26.4/images/sla_empty.png)
<ul><li>If your connector has separate send and receive actions, use the radio buttons to specify which direction the SLA pertains to.</li>
<li>In the **Expect at least** portion of the window:
<ul><li>Set the minimum number of transactions you expect to be processed (the volume)</li>
<li>Use the **Every** fields to specify the time frame</li>
<li>Indicate when the SLA should go into effect. If you choose **Starting on**, complete the date and time fields.</li>
<li>Check the boxes for the days of the week that you want the SLA to be in effect. Use the dropdown to choose **Everyday** if necessary.</li></ul></li>
<li>In the **Set status to 'At Risk'** portion of the window, specify when the SLA should be marked as at risk.
<ul><li>By default, notifications are not sent until an SLA is in violation. To change that, check **Send an 'At Risk' notification**.</li></ul></li></ul>

The following example shows an SLA configured for a connector that expects to receive 1000 files every day Monday-Friday. An at-risk notification is sent 1 hour before the end of the time period if the 1000 files have not been received.

![SLA Configuration Example](https://docs.arc.cdata.com/26.4/images/sla_defined.png)

> [!NOTE]
>
> You can turn off SLA alerts if necessary. This can be useful during maintenance windows. Click **Settings** on the navbar, then navigate to **Alerts > General Alerts**. Click the tablet and pencil icon to edit, and uncheck the **SLA Alerts** setting.

## Notify Operations

In addition to the Operations provided with Arc, connectors can provide operations that extend functionality into ArcScript.

These connector operations can be called just like any other ArcScript operation, except for two details:

1. They must be called through the `connector.rsc` endpoint.
2. They must include an auth token.

For example, calling a connector operation using both of these rules might look something like this:

```xml theme={null}
<arc:set attr="in.myInput" value="myvalue" />
<arc:call op="connector.rsc/opName" authtoken="admin:1j9P8v8b9K0x6g5R5t7k" in="in" out="out">
  <!-- handle output from the op here -->
</arc:call>
```

The operation specific to the functionality of the Notify connector is listed below.

### notifySendEmail

Sends email notifications.

#### Required Parameters

* **Message**: The message to send.

#### Optional Parameters

* **To**: A comma separated list of addresses for destinations.
* **Subject**: The message subject.
* **Attachment#**: File(s) to attach to the message.
* **Async**: Send asynchronously. The allowed values are `true` or `false`. The default value is `true`.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.