Документация для разработчиков
Документация для разработчиков Документация по D7 Документация по REST Пользовательская документация
Темная тема

Add

Описание и параметры

integer
CCrmActivity::Add(
	array arFields,
	bool checkPerms = true, 
	bool regEvent = true, 
	array options
);

Метод служит для добавления нового Дела. Метод статический.

Параметры вызова

ПараметрОписаниеС версии
arFieldsМассив параметров Дела, содержит следующие поля:
  • TYPE_ID - числовой идентификатор типа дела.
    В классе-справочнике \CCrmActivityType описаны 4 стандартных типа дела, которые были ранее (Встреча, Звонок, Задача, Email). Для новых дел необходимо проставлять тип \CCrmActivityType::Custom.
  • PROVIDER_ID - строковый идентификатор провайдера.
    ID зарегистрированного провайдера. Должен состоять из названия модуля и сущности, например VOXIMPLANT_CALL.
  • PROVIDER_TYPE_ID - cтроковый идентификатор типа дела провайдера.
    Идентификатор типа дела в рамках провайдера дела. (Когда один провайдер генерирует свои подтипы дел).
  • BINDINGS - массив привязки к сущностям CRM.
    Должна быть как минимум одна привязка к сущности CRM. 
    $arFields['BINDINGS'][] = array(
	'OWNER_ID' => $crmEntity['ENTITY_ID'],
	'OWNER_TYPE_ID' => $crmEntity['ENTITY_TYPE']
);
  • ASSOCIATED_ENTITY_ID - ID сущности, которое порождает дело (если есть). Число.
    Например, для дел типа Задача - здесь хранится ID задачи.
  • SUBJECT - тема (Название) дела.
    "Исходящий звонок с Владимиром".
  • COMPLETED - флаг завершенности дела (Y/N).
    Используется, когда дело имеет понятие "дело выполнено", "дело не выполнено".
  • RESPONSIBLE_ID - ID ответственного пользователя.
    ID пользователя, который назначен ответственным за выполение дела.
  • PRIORITY - числовой идентификатор приоритета дела.
    Значение берется из класса-справочника \CCrmActivityPriority. В новом планировщике останется только пометка "Важное дело", поэтому имеет смысл использовать, либо \CCrmActivityPriority::Medium либо \CCrmActivityPriority::High.
  • NOTIFY_TYPE - числовой идентификатор типа напоминания.
    Значения берутся из \CCrmActivityNotifyType. Минуты, часы, дни.
  • NOTIFY_VALUE - числовое значение напоминания.
    За сколько минут (часов, дней) необходимо напомнить о деле.
  • DESCRIPTION - описание, текст.
    Поле "Описание дела".
  • DESCRIPTION_TYPE - тип описания.
    Значения из справочника \CCrmContentType (PlainText, BBCode, Html).
  • DIRECTION - направление.
    Справочник \CCrmActivityDirection. Бывают входящие и исходящие дела.
  • LOCATION - место проведения, текст.
    На данный момент используется в деле типа Встреча.
  • START_TIME - дата начала дела (datetime).
  • END_TIME - дата завершения дела (datetime).
    Устанавливается для дел с продолжительностью выполнения.
  • STORAGE_TYPE_ID - тип хранилища для вложений.
    Хранилище по умолчанию CCrmActivity::GetDefaultStorageTypeID().
  • STORAGE_ELEMENT_IDS - массив ID вложений.
    Массив с ID объектов указанного типа хранилища.
  • PARENT_ID - ID дела-родителя.
    На данный момент используется в типе дела Email. Будет использовано для построения цепочки дел.
  • AUTHOR_ID - ID cоздателя.
    ID пользователя, создавшего дело.
  • ORIGINATOR_ID - идентификатор внешней информационной базы.
    Используется для связи с внешними сущностями (1C).
  • ORIGIN_ID - идентификатор сущности во внешней информационной базе.
    Используется для связи с внешними сущностями (1C, Voximplant).
  • PROVIDER_PARAMS - массив параметров провайдера.
    Зарезервированное текстовое поле для параметров провайдера. Принимает только массив.
  • PROVIDER_DATA - данные провайдера в произвольном виде (longtext).
    Зарезервированное текстовое поле для данных провайдера.
  • RESULT_VALUE - число (формат 18.4).
    Коэффициент "важности" дела, для расчета коммуникационной нагрузки. У каждого типа дел может быть свой. Например, для звонков - продолжительность звонка.
  • RESULT_SUM - число (формат 18.4).
    Сумма вырученных денег.
  • RESULT_CURRENCY_ID - строка (3 символа).
    Код валюты вырученных денег.
checkPermsПараметр проверяет права на Дело. Может принимать значения true или false.
regEvent Параметр указывает, регистрировать ли Дело в Истории CRM. Может принимать значения true или false.
optionsМассив дополнительных параметров, содержит следующие поля:
  • SKIP_CALENDAR_EVENT - не добавлять запись в Календарь.
    true или false.
  • REGISTER_SONET_EVENT - создавать запись в Живой ленте.
    true или false.
с версии 12.0.7

Возвращаемые значения

Возвращает идентификатор ID созданного Дела.

Примеры использования

$ID = CCrmActivity::Add($arFields, false, true, array('REGISTER_SONET_EVENT' => true));
if($ID > 0)
{
	CCrmActivity::SaveCommunications($ID, $arComms, $arFields, true, false);
}


© «Битрикс», 2001-2024, «1С-Битрикс», 2024