enhancements_patch_cass_ncoa {civis}R Documentation

Update some attributes of this CASS/NCOA Enhancement

Description

Update some attributes of this CASS/NCOA Enhancement

Usage

enhancements_patch_cass_ncoa(
  id,
  name = NULL,
  schedule = NULL,
  parent_id = NULL,
  notifications = NULL,
  source = NULL,
  destination = NULL,
  column_mapping = NULL,
  use_default_column_mapping = NULL,
  perform_ncoa = NULL,
  ncoa_credential_id = NULL,
  output_level = NULL,
  limiting_sql = NULL,
  batch_size = NULL
)

Arguments

id

integer required. The ID for the enhancement.

name

string optional. The name of the enhancement job.

schedule

list optional. A list containing the following elements:

  • scheduled boolean, If the item is scheduled.

  • scheduledDays array, Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth

  • scheduledHours array, Hours of the day it is scheduled on.

  • scheduledMinutes array, Minutes of the day it is scheduled on.

  • scheduledRunsPerHour integer, Deprecated in favor of scheduled minutes.

  • scheduledDaysOfMonth array, Days of the month it is scheduled on, mutually exclusive with scheduledDays.

parent_id

integer optional. Parent ID that triggers this enhancement.

notifications

list optional. A list containing the following elements:

  • urls array, URLs to receive a POST request at job completion

  • successEmailSubject string, Custom subject line for success e-mail.

  • successEmailBody string, Custom body text for success e-mail, written in Markdown.

  • successEmailAddresses array, Addresses to notify by e-mail when the job completes successfully.

  • successEmailFromName string, Name from which success emails are sent; defaults to "Civis."

  • successEmailReplyTo string, Address for replies to success emails; defaults to the author of the job.

  • failureEmailAddresses array, Addresses to notify by e-mail when the job fails.

  • stallWarningMinutes integer, Stall warning emails will be sent after this amount of minutes.

  • successOn boolean, If success email notifications are on.

  • failureOn boolean, If failure email notifications are on.

source

list optional. A list containing the following elements:

  • databaseTable list . A list containing the following elements:

    • schema string, The schema name of the source table.

    • table string, The name of the source table.

    • remoteHostId integer, The ID of the database host for the table.

    • credentialId integer, The id of the credentials to be used when performing the enhancement.

    • multipartKey array, The source table primary key.

destination

list optional. A list containing the following elements:

  • databaseTable list . A list containing the following elements:

    • schema string, The schema name for the output data.

    • table string, The table name for the output data.

column_mapping

list optional. A list containing the following elements:

  • address1 string, The first address line.

  • address2 string, The second address line.

  • city string, The city of an address.

  • state string, The state of an address.

  • zip string, The zip code of an address.

  • name string, The full name of the resident at this address. If needed, separate multiple columns with '+', e.g. 'first_name+last_name'

  • company string, The name of the company located at this address.

use_default_column_mapping

boolean optional. Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.

perform_ncoa

boolean optional. Whether to update addresses for records matching the National Change of Address (NCOA) database.

ncoa_credential_id

integer optional. Credential to use when performing NCOA updates. Required if 'performNcoa' is true.

output_level

string optional. The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.

limiting_sql

string optional. The limiting SQL for the source table. "WHERE" should be omitted (e.g. state='IL').

batch_size

integer optional. The maximum number of records processed at a time. Note that this parameter is not available to all users.

Value

A list containing the following elements:

id

integer, The ID for the enhancement.

name

string, The name of the enhancement job.

type

string, The type of the enhancement (e.g CASS-NCOA)

createdAt

string, The time this enhancement was created.

updatedAt

string, The time the enhancement was last updated.

author

list, A list containing the following elements:

  • id integer, The ID of this user.

  • name string, This user's name.

  • username string, This user's username.

  • initials string, This user's initials.

  • online boolean, Whether this user is online.

state

string, The status of the enhancement's last run

schedule

list, A list containing the following elements:

  • scheduled boolean, If the item is scheduled.

  • scheduledDays array, Days of the week, based on numeric value starting at 0 for Sunday. Mutually exclusive with scheduledDaysOfMonth

  • scheduledHours array, Hours of the day it is scheduled on.

  • scheduledMinutes array, Minutes of the day it is scheduled on.

  • scheduledRunsPerHour integer, Deprecated in favor of scheduled minutes.

  • scheduledDaysOfMonth array, Days of the month it is scheduled on, mutually exclusive with scheduledDays.

parentId

integer, Parent ID that triggers this enhancement.

notifications

list, A list containing the following elements:

  • urls array, URLs to receive a POST request at job completion

  • successEmailSubject string, Custom subject line for success e-mail.

  • successEmailBody string, Custom body text for success e-mail, written in Markdown.

  • successEmailAddresses array, Addresses to notify by e-mail when the job completes successfully.

  • successEmailFromName string, Name from which success emails are sent; defaults to "Civis."

  • successEmailReplyTo string, Address for replies to success emails; defaults to the author of the job.

  • failureEmailAddresses array, Addresses to notify by e-mail when the job fails.

  • stallWarningMinutes integer, Stall warning emails will be sent after this amount of minutes.

  • successOn boolean, If success email notifications are on.

  • failureOn boolean, If failure email notifications are on.

runningAs

list, A list containing the following elements:

  • id integer, The ID of this user.

  • name string, This user's name.

  • username string, This user's username.

  • initials string, This user's initials.

  • online boolean, Whether this user is online.

myPermissionLevel

string, Your permission level on the object. One of "read", "write", or "manage".

source

list, A list containing the following elements:

  • databaseTable list . A list containing the following elements:

    • schema string, The schema name of the source table.

    • table string, The name of the source table.

    • remoteHostId integer, The ID of the database host for the table.

    • credentialId integer, The id of the credentials to be used when performing the enhancement.

    • multipartKey array, The source table primary key.

destination

list, A list containing the following elements:

  • databaseTable list . A list containing the following elements:

    • schema string, The schema name for the output data.

    • table string, The table name for the output data.

columnMapping

list, A list containing the following elements:

  • address1 string, The first address line.

  • address2 string, The second address line.

  • city string, The city of an address.

  • state string, The state of an address.

  • zip string, The zip code of an address.

  • name string, The full name of the resident at this address. If needed, separate multiple columns with '+', e.g. 'first_name+last_name'

  • company string, The name of the company located at this address.

useDefaultColumnMapping

boolean, Defaults to true, where the existing column mapping on the input table will be used. If false, a custom column mapping must be provided.

performNcoa

boolean, Whether to update addresses for records matching the National Change of Address (NCOA) database.

ncoaCredentialId

integer, Credential to use when performing NCOA updates. Required if 'performNcoa' is true.

outputLevel

string, The set of fields persisted by a CASS or NCOA enhancement.For CASS enhancements, one of 'cass' or 'all.'For NCOA enhancements, one of 'cass', 'ncoa' , 'coalesced' or 'all'.By default, all fields will be returned.

limitingSQL

string, The limiting SQL for the source table. "WHERE" should be omitted (e.g. state='IL').

batchSize

integer, The maximum number of records processed at a time. Note that this parameter is not available to all users.

archived

string, The archival status of the requested item(s).

[Package civis version 3.1.2 Index]