ServiceProperties Interface

The number of seconds the message should be displayed before being closed automatically. Ignored if non-positive.

The CSS class to be added to the top level HTML presentation element for the message.

The delivery method for the message. See AlertDelivery

The interval, in seconds, between pings to check for new alerts. If less than 5, no ping is performed and alert delivery (but not message deliver) is disabled.

The Blaze API authorization key.

The base URL for Blaze API requests.

The Blaze partner key.

The Braintree environment - live or sandbox

If true, fail if a duplicate card is added.

The optional master merchant account to use.

The optional Merchant ID value.

How to handle the expiration date when adding a payment method. See PaymentExpirationType

Which parts of a card to include when adding a payment method. See PaymentIncludeAttributes

The API Private Key

The API Public Key

Development comments about this service.

The name of the field in the mapper that indicates if a document download should be audited.

The field to use when storing the document content.

The field to use when storing the document description.

The field to use when storing the document type.

The field to use when storing the document filename.

The mapper to use when storing documents.

The name of the field specifying the mime type of the content. If not specified, application/octet-stream is assumed.

A semi-colon separate list of logical paths to images to use when a missing file image is desired.

The field to use when storing the ID of the document's owner.

The Uploadcare private API key.

The Uploadcare public API key.

The generated ProductKey to use in the DynamSoft environment.

base64 encoded string in the form of USERNAME:PASSWORD.USERNAME must be the master user of FleetLocate account.

Created and named in GoCardless dashboard (token only displayed once when created). API calls must contain access token.

Base URL for API calls

Required GoCardless-Version HTTP header

Created with a webhook in GoCardless dashboard. Should be changed once in a while. Used when ensuring valid signature of incoming notification.

The application name

Semi-colon separted string of emails to share new docs with

Name of the function in the Google Apps script for find/replace for templated documents.

API ID of the Google Apps script used for find/replace for templated documents.

The email of the person that the service account should impersonate. The service account must be part of the same GSuite as this person.

The json string version of the key to be used for making service account credentials

ID of the Google Drive folder that holds templates. Must be shared with the service account user.

The version of the Google maps API to use. If omitted no version will be specified when using the API.

Used to track usage across different applications using the same client ID. Must be an ASCII alphanumeric string and may include ".", "_", and "-" characters. May be overridden at the page level.

The Client ID provided by google for the business maps API.

Custom parameters/values to be added to the Google map request. Will be merged with any CustomParams specified on the page.

The private key provided by Google for a business map API.

Use an API Key to authenticate with the Google Maps API instead of a Client ID / Private Key combo. API Key should be stored in the PrivateKey property.

Use the GoogleMaps public API. The public API is only appopriate for developer testing, prototyping and very light usage.

Shared secret key

JWT Authorization endpoint URL

The ApiKey value from the Mailgun domain

The document storage service to use when storing email attachments.

Attributes that modify the behavior of the email manager. See EmailManagerAttributes

The datasource to use when logging email.

The type of external email being managed. See EmailManagerType

The password (api_key) for the mail manager account.

The api user for the mail manager account.

Base URL for OR Tools service.

First solution strategy type See FirstSolutionStrategyType

Local Search Metaheuristic Type See LocalSearchMetaheuristicType

Max capacity per vehicle

Max distance per vehicle in miles.

Time limit in ms. Used if UseGuidedLocalSearch is true.

If set true, Local Search Metahuristic Type and Time Limit parameters must be provided.

The URL where the payer is redirected after he or she cancels the payment.

The PayPal environment to use, e.g. "sandbox".

The URL for the image to be displayed at the top left of the payment page. Should be an https path with an image no more than 750 x 90px. The business name is displayed if omitted.

The customer session identification token used as an additional means to detect possible fraud.

Your URL for receiving Instant Payment Notification (IPN) about this transaction.

The PayPal account password.

The URL for express checkouts using PayPal for payment rather than a credit card.

The API signature for the Username and Password.

The PayPal account username.

Default Author for document options

The LicenseKey for PDFTechLib

Determines where Temp files will be saved as part of the PDF Generation process. By default, this is the HTTPContext's root\~UserFiles, but in some cases this needs to be set manually.

Provide the path where email attachments will be saved. (For virus checking)

If not specified, email attachments are saved to xot_email_attachments. This table must have same schema definition as xot_email_attachments.. If this is the same table as CustomEmailTable the table must have all the schema of both the xot_email_data and xot_email_attachments.

If not specified, email attachments are saved to xot_email_data. This table must have same schema definition as xot_email_data. If this is the same table as CustomAttachmentTable the table must have all the schema of both the xot_email_data and xot_email_attachments.

Copy of email will be left on server after reading.

(Required for link) The mop for the navigation link.

(Optional for link) The column in LinkDataView that would provide the user's organization name.

(Required for link) The column in LinkDataView that would provide the primary key value for the navigation link.

The datasource to use when determining the link information.

(Required for link) The column in the LinkDataView to filter the LinkDataView to retrieve the users link data.

(Optional for link) The column in LinkDataView that would provide the user's name.

(Required for link) The view from which the link information can be looked up by the email senders user id.

If true, generates a link on notification email that navigates to the specified mop showing pertinent data to the email sender.

The datasource to use when logging email.

The datasource to use when looking up owner information.

(Required for owner notify) The column in the LookupView which is used to retrieve an owner email address.

(Required for owner notify) The column in the LookupView which provides the email address of the owner of the inbound email.

(Required for owner notify) The column in the LookupView which provides the user id matched to the inbound email.

(Required for owner notify) The view in data database that provides link between email address and owner.

Select the mail manager service that defines how we map incoming email to managed mail messages.

The header name to look for on an email that controls whether an email will not be mapped after loading. The default header is X-NQ-MAP.

Attempt to map the retrieved mail to the managed mail log

Send email to the owner of the person sending the inbound email.

A semi colon delimited list of email addresses to copy on matched notification emails.

Send email to a user if the owner of the email cannot be determined.

Password for user's mailbox on POP3 server.

Port to connect to POP3 server. Defaults to 110 for regular connection, 995 for secure.

Save attachments from emails

The path where messages are to be saved.

If true, messages are saved to database and service will honor the EmailLinkMeta and Notification properties.

If true, messages are saved to disk and service will honor the File properties.

Name or IP address of POP3 server.

(Required for any notify) The SMTP Service to use for mail notification.

(Required for any notify) The email address to send notifications when email owner is not known.

Name of user's mailbox on POP3 server.

Determines if connection should use SSL.

For srevices with a 3rd-party provider, the provider account used by this service.

The ID of the primary user for the ProvicerAccount.

Gets or sets a value that indicates the time, in seconds, before asynchronous postbacks time out if no response is received.

The domain name for the user/password for the SSRS web service.

Specifies whether or not to enable partial rendering on the reports page.

Password for the reporting user for SSRS.

Indicates whether the Back button is visible on the control.

Controls the default visibility of the reporting parameter bar.

Controls the default visibility of the reporting toolbar.

The user name for validation.

The URI for the SSRS web service

The name of the field in the mapper that indicates if a document download should be audited.

The name of the Bucket, as exists on S3, to which documents should be stored / retrieved.

The name of the DateTime field on the mapper that will store the Cache-until Date value.

The field on the ConfigMapper that holds the S3 Bucket Name.

The field on the ConfigMapper that holds the enabled/disabled bit value.

The field on the ConfigMapper that holds the Service Health value for each S3 bucket.

The mapper that points to the S3 Bucket configuration data for this service.

The field on the ConfigMapper that holds the order value for each bucket.

The field on the ConfigMapper that holds the Region value for the S3 bucket.

The field on the ConfigMapper that holds the User ID value for the S3 bucket.

The field on the ConfigMapper that holds the User Key for the S3 bucket.

The field on the mapper that stores the file's binary data.

The field on the mapper that stores the file's description.

The field to use when storing the document type.

Turns on cacheing for the S3 service. By default, once the document is uploaded to S3, the document will never exist again locally (in the DB).

The field on the mapper that stores the file's name.

The name of the field on the Document storage mapper that will hold the bit value for if the item is deleted or not. Only used if UseLogicalDelete is set.

The mapper for the documents table.

The maximum time allowed, in minutes, for the background task to run before it is shut off.

The field that stores the file's MIME type

The AWS region in S3 where the bucket is located.

The field on the mapper that stores the document's related ID value.

Optional values that can be used as Tags on the S3 document upon upload. See S3DocTagOptions

The amount of time, in hours, that a document should be cached on the internal documents table before being uploaded to S3 and data removed from the documents table.

The field key on the Upload Mapper that holds the document_id value

The mapper to use when determining which files to upload / cache on S3.

Turns on logical delete for the Document storage mapper. This can allow the system to start migrating an existing document storage solution to S3 without the need for deleting the local data.

The AWS user key that will be used to access S3.

The AWS user name value that will be used to access S3.

The authentication type to use when connecting to the SMTP server. See SmtpAuthenticationType

If true, the SMTP service will check the mail recipinet against a no send list. If there is a match, the recipient will not receive the email.

The list of addresses to add to BCC for a copy of every email. (Most for debug purposes)

The default address to use when sending email.

Disables SMTP mail delivery. For debugging purposes, all logic up to the actual SMTP send is performed.

Attributes that control send behavior. See EmailSendAttrs

The mail manager service to use.

The duration in minutes that elapse between when the service checks for new email addresses in the no send list.

The password for validation.

The port. (Typically 25)

The default reply-to email address to use.

If set to true, the mail is sent asynchronously via the built-in thread pool.

The name of the SMTP server.

MOP to navigate to when the SMTP settings are required but not setup.

The user name for validation.

True if the SMTP server uses SSL.

Specifies which email validation service to use.

Tookan API Key

Base URL

Shared secret to verify webhook request comes from Tookan site.

Attributes that modify the behavior of the Tookan service. See TookanAttributes

The Twilio Account SID

A unique identifier generated by Twilio that can be used in place of your AccountSID for many API calls and for token generation. Tokens generated with an ApiKey will be revoked when the ApiKey is revoked whereas tokens generated with an AccountSID can never be revoked.

The secret associated with the ApiKey. This is used in place of an AuthToken whenever the ApiKey is used in place of the AccountSID.

The application key to use in the callback for twilio.

The notification application SID to use when buying numbers.

The Twilio account token.

The callback endpoint for replies. Default value is the RootURL.

Relative URI to which call center agent browsers will be redirected when they start a call with an identified caller. Include a forward slash at the beginning. Basic field expressions (open square bracket field name closed square bracket) can be included. At the time of this writing, the only fields available are people_id and call_sid

Relative URI to which call center agent browsers will be redirected when they start a call with an unidentified caller. Include a forward slash at the beginning. Basic field expressions (open square bracket field name closed square bracket) can be included. At the time of this writing, the only field available is call_sid

When set, inbound calls forward to this number.

Whether or not, TwilioClient's are allowed to make outbound calls. With the TwilioClientApplicationSID you can limit what phone numbers or what category of phone numbers can be called. If that property isn't set then this property will do nothing.

If true, messages will ONLY be sent from +15005550006 (valid Twilio test number).

The SID for the Twilio Message Service.

Attributes specifying Twilio Phone Service behaviour. See PhoneServiceAttrs

The duration in seconds to wait before setting the agent to Idle. This timer is started the call ends and the agent has been set to Post Call. Zero means no timeout.

The maximum length of a recording in seconds. For a Twilio client the maximum recording length is 600 seconds.

The number of seconds of silence tha must pass before a recording ends.

Set to true to send the message as a MMS message. The default is false.

If true, sends the message asynchronously.

The service token used to create an application context during a reply.

The supervisor specific TwiML Application that Twilio Client's will connect to when attempting to make outbound phone calls.

The time, in seconds, for which a TaskRouter worker's token is valid.

Number to use in non-production environments.

The default TwiML Application that Twilio Client's will connect to when attempting to make outbound phone calls.

The time, in seconds, for which a TwilioClient token is valid.

The URL that will be passed to Twilio for callbacks about completed call recordings. This endpoint is not built in to the IVR application because it is expected that users will want to store their recordings in Amazon S3 and use EC2 or Lambda to respond to these call backs and kick off the transfer of recordings from Twilio to S3

The meta-data-specified portion of the whitelist to use when EnforceWhitelist is set. Any operationally configured whitelist will be merged in.

The TaskRouter workspace that owns the workers for which we will generate tokens.

The account-specific XVerify API key.

The pre-registered domain for the verification.

Base URL for API calls

Instant message chat history token assigned by Zoom

API Key assigned by Zoom

API secret assigned by Zoom

Use this verification token to validate an event notification request from zoom.us for this app.