Organization
The Org domain object captures the mapping from the Engage view of the world to the client. For example, if your company (NuclearOne) has three distinct lines of business (Collections, Marketing, and Customer Care) which should be managed separately then Engage may map this as a single organization (externalId="NuclearOne", type="Enterprise") with three separate organizations (type="Account", parent=<enterprise>) one for each line of business.
Many of the attributes on the organization object are sensitive to the type of the organization. Example attributes on the Account (Org type="Account") object include the time constraints for contact outreach as well as the TimeZone that the account is in.
These entities are normally created ahead of time, but can be created dynamically if required.
Org
Field | Type | Description | Since |
---|---|---|---|
internalId | string | Platform Identifier | 7.3.3 |
externalId | string | External (user-defined) identity | 7.5.0 |
parent | Org (K) | Abbreviated parent entity | 7.3.3 |
type | orgType | Type of organization, e.g. SuperEnterprise, Enterprise, Account or ScheduleGroup | 7.3.3 |
preferences | Attribute[] | Persistent Org context as set of name/value pairs | 7.7.0 |
attributes | Attribute[] | Enumerated other attributes of an Org | 7.3.3 |
createdDate | dateTime | Entity created date | 7.3.3 |
updatedDate | dateTime | Entity last modified date | 7.3.3 |
createdBy | User (K) | Abbreviated creator | U |
modifiedBy | User (K) | Abbreviated modifier | U |
Attributes
Attribute | Type | Type qualifier | Description | Since |
---|---|---|---|---|
enabled | Boolean | Enterprise/Account | Is this Org currently enabled? | 9.1 |
defaultCallerID | string | Account | Optional | 8.4.0 |
firstContactTime | time | Account | Time of first contact (local) | 7.5.0 |
lastContactTime | time | Account | Time of last contact | 7.5.0 |
emulateOutreach | Boolean | Account | All outreach is emulated | XXX |
accountManagerUIVersion | UIVersion | Account | Version of the UI for the Account Manager | 9.1 |
applicationName | string | Enterprise | Optional (defaults to ‘SoundBite’) | 8.5.0 |
billingFirstName | string | Enterprise/Account | First name for billing | 8.5.0 |
billingLastName | string | Enterprise/Account | Last name for billing | 8.5.0 |
billingAddressLine1 | string | Enterprise/Account | Address (Line 1) for billing | 8.5.0 |
billingAddressLine2 | string | Enterprise/Account | Address (Line 2) for billing | 8.5.0 |
billingCity | string | Enterprise/Account | City for billing | 8.5.0 |
billingPostalCode | string | Enterprise/Account | PostalCode/ZipCode for billing | 8.5.0 |
billingState | string | Enterprise/Account | State/Province for billing | 8.5.0 |
billingCountry | string | Enterprise/Account | Country for billing | 8.5.0 |
billingEmail | string | Enterprise/Account | Email address for billing contact | 8.5.0 |
newsURL | string | Enterprise | URL for updated News page | 8.5.0 |
newsStartDate | dateTime | Enterprise | Effective start date for News page | 8.5.0 |
newsEndDate | dateTime | Enterprise | Effective end date for News page | 8.5.0 |
newsMaxViews | Integer | Enterprise | Maximum number of views of News page | 8.5.0 |
secMinPasswordLength | Integer | Enterprise | Minimum length of password | 8.5.0 |
secPGPEncryption | Boolean | Enterprise | Is PGP encryption enabled? | 8.5.0 |
secAllowedEmail | string | Enterprise | List of valid email addresses | 8.5.0 |
secAllowedFTP | string | Enterprise | List of valid FTP outbound domains | 8.5.0 |
secLoginWhiteList | string | Enterprise | Semicolon separated list of IP addresses for Login. Wildcard (‘*’) allowed for final two octets. | 9.1 |
secDataWhiteList | string | Account | Semicolon separated list of valid IP addresses ranges for Data review. Wildcard (‘*’) allowed for final two octets. | 9.1 |
secReviewSecureData | Boolean | Account | Enable Agent review of secure contact data | 9.1 |
secAutoLogoutMins | Integer | Account | Automatic sign out after inactivity (mins) | XXXX |
secSignInExpiresMins | Integer | Enterprise | Sign in links expiration period (minutes) | 8.5.0 |
secMaxLoginAttempts | Integer | Enterprise | Maximum number of bad login attempts | 8.5.0 |
costDataInformation | costDataInformation | Enterprise | What cost data should be available? | 9.1 |
partnerEnabled | Boolean | Enterprise | Partner – is support enabled | 9.1 |
partnerDomainName | string | Enterprise | Partner – domain name | 8.5.0 |
partnerSupportNumber | string | Enterprise | Partner – number for support | 8.5.0 |
partnerHomeURL | string | Enterprise | Partner – URL of home page | 8.5.0 |
partnerReportEmail | string | Enterprise | Partner – email address for reports | 8.5.0 |
partnerSupportEmail | string | Enterprise | Partner – email address for support | 8.5.0 |
partnerSalesEmail | string | Enterprise | Partner – email address for sales | 8.5.0 |
partnerHelpURL | string | Enterprise | Partner – URL for application Help | 8.5.0 |
partnerPrimaryMenuColor | string | Enterprise | Partner – Color of Primary menus | 9.1 |
partnerSecondaryMenuColor | string | Enterprise | Partner – Color of Secondary menus | 9.1 |
partnerPrimaryTextColor | string | Enterprise | Partner – Color of Primary text | 9.1 |
partnerSecondaryTextColor | string | Enterprise | Partner – Color of Secondary text | 9.1 |
partnerSecondaryTextHoverColor | string | Enterprise | Partner – Color of Secondary text upon hover | 9.1 |
partnerPrimaryLogoFilename | string | Enterprise | Partner – Filename of Primary OEM logo | 9.1 |
partnerSecondaryLogoFilename | string | Enterprise | Partner – Filename of Secondary OEM logo (replaces ‘Account Manager’) | 9.1 |
partnerPrimaryLogoURL | string | Enterprise | Partner – URL target of Primary OEM logo | 9.1 |
partnerStylesheetURL | string | Enterprise | Partner – URL of OEM Stylesheet | 9.1 |
partnerEnterpriseSecondaryLogoFilename | string | Enterprise | Partner – Filename of Secondary OEM logo (replaces ‘Enterprise Manager’) | 10.2.5 |
isSecure | Boolean | Enterprise | Is this organization secure? | 7.3.3 |
charset | string | Enterprise/Account | Charset for this org – see RFC 2278 | 8.5.0 |
locale | string | Enterprise/Account | Locale information (See Other Types) | 8.5.0 |
countryCode | string | Enterprise/Account | ISO 3166 two letter country code | 7.5.0 |
emailNotification | string | Enterprise/Account | Optional on Account | 7.5.0 |
emailSummary | string | Enterprise/Account | Optional on Account | 7.5.0 |
timeZone | string | Enterprise/Account | Account’s time zone | 7.3.3 |
timeZoneOffset | Integer | Enterprise/Account | MS to add to UTC for org time (read-only) | 8.1.0 |
reportTimeZone | string | Enterprise/Account | Account’s report time zone | XXX |
dayBoundary | time | Enterprise/Account | Time of day deemed to be when day commences (null = none) | U |
expireAfterHoursList | Integer | Enterprise/Account | Hours before autoexpiring (-1 = never). Optional on Account. | 9.6 |
expireAfterHoursScript | Integer | Enterprise/Account | Hours before autoexpiring (-1 = never). Optional on Account. | 9.6 |
expireAfterHoursReport | Integer | Enterprise/Account | Hours before autoexpiring (-1 = never). Optional on Account. | U |
expireAfterHoursAgentRecording | Integer | Enterprise/Account | Hours before autoexpiring (-1 = maximum allowed). Agent-based. | 8.10 |
expireAfterHoursScriptRecording | Integer | Enterprise/Account | Hours before autoexpiring (-1 = maximum allowed). Script-based. | 8.10 |
agentRecordingSuspendAllowed | Boolean | Enterprise/Account | Is the Agent allowed to pause/resume recording? | 8.10 |
agentRecordingDeleteAllowed | Boolean | Enterprise/Account | Is the Agent allowed to delete recording? | 8.10 |
supervisorRecordingDeleteAllowed | Boolean | Enterprise/Account | Is the Supervisor allowed to delete recording? | 8.10 |
agentRecordingPercentage | Integer | Enterprise/Account | Percentage of agent interactions to start recording (0 – 100) | 8.10 |
agentRecordingMinDuration | shortDuration | Enterprise/Account | If recording agent interactions less than this duration then do not keep | 8.10 |
agentRecordingEnabled | Boolean | Enterprise/Account | Is Agent recording enabled for this Org? | 8.10 |
internalTransferEnabled | Boolean | Enterprise/Account | Is Internal Transfer enabled? | 9.0 |
internalTransferGroupOnly | Boolean | Enterprise/Account | If true (and InternalTransferEnabled true) then allow only transfers to Agent Groups not to individual agents. | 10.5 |
externalTransferEnabled | Boolean | Enterprise/Account | Is External Transfer enabled? | 9.0 |
manualExternalTransferEnabled | Boolean | Enterprise/Account | Is manual external transfer enabled? | 9.0 |
accountManagerRecordingSettingsEditAllowed | Boolean | Enterprise | Is the AccountManager allowed to edit the Recording Settings? | 9.1 |
accountManagerTransferSettingsEditAllowed | Boolean | Enterprise | Is the AccountManager allowed to edit the Transfer Settings? | 9.1 |
accountManagerPreviewSettingsEditAllowed | Boolean | Enterprise | Is the AccountManager allowed to edit the Preview Settings? | 9.1 |
accountManagerManualSettingsEditAllowed | Boolean | Enterprise | Is the AccountManager allowed to edit the Manual Settings? | 10.1 |
monitoringEnabled | Boolean | Enterprise/Account | Is Monitoring (includes Coach and Barge) enabled? | XXX |
timeZoneSourceDevice | Boolean | Enterprise/Account | TimeZone determined from Device | 9.1 |
timeZoneSourceContact | Boolean | Enterprise/Account | TimeZone determined from Contact | 9.1 |
timeZoneSourceContactThenDevice | Boolean | Enterprise/Account | TimeZone determined from Contact then Device | 9.1 |
timeZoneSourceContactAndDevice | Boolean | Enterprise/Account | TimeZone determined from Contact and Device | 9.1 |
previewSkipEnabled | Boolean | Enterprise/Account | Whether or not Agents are allowed to skip preview calls | 9.1 |
previewTimerDuration | shortDuration | Enterprise/Account | Number of milliseconds for timed preview before auto-launching call | 9.1 |
abandonRatePacing | Boolean | Enterprise/Account | Is Abandon Rate pacing enabled for this pass | 9.2 |
abandonRateDefinition | ShortDuration | Enterprise/Account | Number of milliseconds that constitutes an abandoned call | 9.2 |
abandonRateTarget | Integer | Enterprise/Account | The Abandon Rate target in 1/10s of a percent | 9.2 |
freeformNumberEntryAllowed | Boolean | Enterprise/Account | Is free-form entry of devices allowed? | 10.1 |
manualDialEnabled | Boolean | Enterprise/Account | Is Manual Dialing enabled? | 10.1 |
followUpEnabled | Boolean | Enterprise/Account | Is call Follow-Up enabled? | 10.1 |
followUpMaxHours | Integer | Enterprise/Account | Maximum number of hours into the future that a follow-up can be scheduled | 10.X |
scheduledFollowUpEnabled | Boolean | Enterprise/Account | Is Scheduled Followup enabled? | 10.6 |
scheduledFollowUpMaxHours | Integer | Enterprise/Account | Maximum number of hours into the future that a followup can be scheduled | 10.6 |
clientIDRegex | string | Enterprise/Account | Regular expression to be used for validating clientIDs manually entered by an Agent | 10.1 |
maxVoiceContactsPerMinute | Integer | Account | Maximum number of voice contact attempts per minute | 9.2.9 |
maxTextContactsPerMinute | Integer | Account | Maximum number of text contact attempts per minute | 9.2.9 |
maxEmailContactsPerMinute | Integer | Account | Maximum number of email contact attempts per minute | 9.2.9 |
useAccountDateCompliance | Boolean | Account | Account will utilize Date Compliance settings from the Account and ignore Enterprise Date Compliance settings | 10.3.0 |
defaultRecordingFormat | string | Account | Recording Format (Audio & Container) for all recordings. Allowable values WavMulaw (default) or OggVorbis. | 10.4.0 |
attemptsIncludeBusy | boolean | Account | Include Busy attempts. | 10.7 |
attemptsIncludeNotConnected | boolean | Account | Include Not Connected attempts. | 10.7 |
attemptsIncludeFailedSMS | boolean | Account | Include Failed SMS attempts. | 10.7 |
attemptsIncludeFailedEmail | boolean | Account | Include Failed Email attempt. | 10.7 |
partnerWhitelabelIconFilename | string | Account | Partner – White label filename | 10.8.0 |
ocsManaged | boolean | Account | Check if account is ocsManaged | 11.7.0 |
requiredDispatchType | string | Enterprise | Special dispatch type for calling plan of ocsManaged account | 11.9.0 |
passwordResetEnabled | boolean | Enterprise | Is password reset enabled? | 11.8 |
numberOfSecurityQuestions | integer | Enterprise | Number of security questions user should set. | 11.8 |
recordDuringConference | string | Enterprise/Account | Record during conference? | 11.11 |
forceSelectBreakReasonCode | boolean | Account | Force agent to select a reason code. | 12.0 |
skipClientIdInputForAgentManaulCall | boolean | Account | Skip input of client id when agents are manually dialing. | 12.3 |
adminMcbEnabled | boolean | Enterprise | Enable Monitor, coach and barge feature for client admin users (can be set only by sysops users). | 13.3 |
wirelessEnabled | boolean | Account | Is wireless toggle enabled on compliance page? | 13.5 |
dncEnabled | boolean | Account | Is DNC toggle enabled on compliance page? | 13.5 |