Создание файлов изменений предоставления ресурсов пользователям

Файл изменения предоставления ресурсов пользователям - это созданный клиентом текстовый файл в формате CSV, содержащий информацию о предоставлении ресурсов пользователям из локальной системы управления. После включения поддержки сервера интеграции эти текстовые файлы применяются для передачи информации о предоставлении ресурсов пользователям.

В среде с подключенным сервером интеграции можно при каждом добавлении или изменении пользователя создавать вручную или автоматически с помощью пользовательского агента файл изменений предоставления ресурсов пользователям для сбора данных об этих изменениях. Этот текстовый файл применяется для передачи информации о предоставлении ресурсов пользователям.

Здесь приведено описание формата имени и содержимого файла изменений предоставления ресурсов.

В файлах изменений предоставления ресурсов пользователям можно предоставлять ресурсы в форме подписки на службы совместной работы и на почтовые службы для одного рабочего места или пакетной подписки.

Также можно указать вспомогательные подписки, включая IBM® Traveler, IBM Docs, и Archiving Retention Data Feed.

Правила именования файла изменений предоставления ресурсов

Для того чтобы файл изменений предоставления ресурсов был правильно распознан и обработан, он должен иметь определенное имя. При создании пользовательского файла изменений предоставления ресурсов следуйте следующим правилам именования:

customerId_sourceId_prv_seqnum.csv

Табл. 1. Правила именования файла изменений предоставления ресурсов
Тип компонента имени файла	Описание компонента имени файла
`customerId`	Задает внутренний числовой идентификатор клиента. ИД клиента расположен в разделе Учетная запись организации: Параметры пользовательском интерфейсе Администрирование. Укажите в качестве `ИД-клиента` значение, присвоенное вашей учетной записи.
`sourceId`	Задает необязательное имя надежного источника изменений. `sourceId` можно не указывать в имени файла изменений, если в организации используется только один источник идентификационной информации. Например, одно значение `sourceId` можно использовать для исходных данных, полученных из IBM Domino Directory, а другое - для исходных данных, полученных из Active Directory.
`type`	Типом файла предоставления ресурсов пользователю является PRV.
`seqNum`	Задает порядковый номер файла. Он должен представлять собой целое число в диапазоне 0 - 9223372036854775807. Это значение должно быть не меньше порядкового номера последнего обработанного файла. Если последним был обработан (успешно или с ошибкой) файл с номером 9223372036854775807, то следующим будет номер 1 или больше. Такой подход позволяет сбрасывать последний номер последовательности, сохраненный на сервере. В качестве значения рекомендуется использовать время с начала эпохи UNIX. Укажите дату и время UNIX в компоненте `seqNum` имени файла. См. http://www.epochconverter.com (открывается в новом окне). Последовательные номера являются относительными к значениям `customerId` и `sourceId`. Это обеспечивает независимость от системы и региона.
`ext`	Задает расширение файла определяющее тип кодировки данных. Возможны следующие варианты: .ldif - кодировка LDIF; ее необходимо указывать для файлов изменений интеграции .csv - кодировка в виде разделенных запятыми значений, ее необходимо использовать для файлов изменений предоставления ресурсов пользователям

Ниже приведены примеры имен файлов изменений предоставления ресурсов:

30020506_HRDatabase_PRV_1260226223.CSV
30020506_PRV_1260226223.csv

В обоих примерах название организации представлено строкой символов 30020506, файлы являются файлами изменений предоставления ресурсов, порядковый номер равен 1260226223, содержимое файла - значения, разделенные запятыми. В первом примере указан необязательный ИД надежного источника.

Прим.: Поскольку значения sourceId и seqNum выбираются организацией, синхронизация даты и времени не требуется.

Операции в файлах изменений предоставления ресурсов

В файлах изменений предоставления ресурсов пользователям можно указывать коды различных операций.

Прим.: В следующей таблице указаны типы операций. Значения и описания полей указаны в следующей таблице.

Прим.: Если пользователь находится в состоянии HELD, сервер интеграции отклонит данные файла предоставления ресурсов и добавит сообщение об ошибке в связанный файл отчета.

Прим.: Введенный адрес электронной почты обрабатывается без учета регистра; все адреса электронной почты приводятся к нижнему регистру.

Прим.: На странице учетной записи организации можно при необходимости указать, что все пользователи автоматически принимают условия использования.

Табл. 2. Типы операций в файле изменений предоставления ресурсов
Операция предоставления ресурсов	Описание
`Add`	Создает запись подписчика. При выполнении операции `Add` подписчику отправляется сообщение электронной почты, в котором ему предлагается задать пароль, принять условия использования и начать работу со службами, доступ к которым был предоставлен. Подписчику предоставляется учетная запись для входа в систему и профайл, доступный для самостоятельной настройки. Также может быть предоставлен одноразовый пароль, который потребуется изменить при первом обращении. Прим.: Нефедеративные и изменяемые федеративные пользователи должны пройти процедуру регистрации с помощью полученного по почте приглашения, даже если их учетная запись была создана в домене, принадлежащем клиенту. Федеративные пользователи обрабатываются автоматически и не получают приглашение по электронной почте.
`Update`	Позволяет обновить информацию о подписчике, например адрес электронной почты или почтовый шаблон. Это единственное допустимое значение `operation`, если для параметра `type` указано значение PROFILES.
`Suspend`	Блокирует доступ подписчика к службам. Подписчик не удаляется, а присвоенные ему подписки не аннулируются.
`Resume`	Возобновляет доступ блокированного подписчика к службам.
`Remove`	Удаляет подписчика и аннулирует все права доступа. Кроме того, удаляет все данные, связанные с текущей подпиской пользователя на службы совместной работы, либо передает их другому подписчику. Прим.: Передача почты не поддерживается. Если удаляемый пользователь подписан на электронную почту, то все связанные с этой подпиской данные удаляются без возможности восстановления. Дополнительная информация о данных, удаляемых вместе с учетной записью, приведена в разделе Удаление учетной записи пользователя навсегда.
`AssignSeat`	Присваивает подписчику рабочее место и предоставляет все права доступа, определенные в подписке. Рабочее место предоставляет подписчику права доступа ко всем функциям определенного предложения. Каждому подписчику можно предоставить не более одной подписки на службы совместной работы в дополнение к подписке на электронную почту.
`ChangeSeat`	Изменяет рабочее место в подписке на службы совместной работы на рабочее место в другой подписке. Задает новое значение `subscriptionId` для служб совместной работы и изменяет текущую подписку на новую подписку. Прим.: Текущая и целевая подписки должны быть совместимыми. Список совместимых подписок можно получить у специалиста по контактам с клиентами. С помощью ключевых слов `DELETECOLLAB` и `DELETEMAIL` можно поменять у пользователя пакетную подписку на подписку на почтовую службу или на службы совместной работы для одного рабочего места.
`RevokeSeat`	Аннулирует существующие подписки на рабочее место и удаляет все связанные с ними права доступа. Прим.: Вместо конкретного значения `subscriptionId` укажите в поле `subscriptionId` ключевое слово `COLLAB`, `MAIL`, `BUNDLE`, `TRAVELER`, `IBM_DOCS` или `RETENTION` в качестве обозначения аннулируемого рабочего места. Прим.: Информация о том, как удалить все данные, связанные с подпиской, или передать их другому подписчику, приведена в описании поля `AssignTo` в следующей таблице. У подписок на рабочее место для совместной работы данные служб Файлы и Операции могут быть переданы другому пользователю. Все остальные данные пользователя удаляются. Почту передавать нельзя.
`Rename`	Изменяет значение `EmailAddress`, однозначно идентифицирующее пользователя и используемое для входа в систему. Эта операция доступна пользователям с подпиской на совместную работу и почту. Для переименования пользователя, у которого нет гибридной подписки на IBM SmartCloud Notes, можно просто поменять его адрес электронной почты операцией `Rename`. Несмотря на то что операция `Rename` доступна пользователям с гибридной подпиской на SmartCloud Notes, для такого пользователя необходимо последовательно выполнить следующие действия: Локальный администратор домена заказчика должен изменить адрес электронной почты пользователя в каталоге Domino. Локальный каталог Domino синхронизируется с SmartCloud Notes, чтобы обновить адрес электронной почты пользователя в SmartCloud Notes. После этого администратор может указать операцию `Rename` в файле изменений предоставления ресурсов с помощью обычных процедур сервера интеграции (или переименовать отдельного пользователя прямо в облачной учетной записи). Прим.: Операции должны в первую очередь выполняться в локальном каталоге Domino заказчика (совет: оставьте ссылку на прежний адрес электронной почты в поле `краткое имя` записи пользователя) и затем синхронизироваться с SmartCloud Notes перед внесением изменений в облачной учетной записи, чтобы не нарушить маршрутизацию уведомлений по электронной почте. Если адрес электронной почты меняется с помощью операции `Rename` сервера интеграции (или непосредственно в облачной учетной записи) до синхронизации изменений локального каталога с SmartCloud Notes, уведомления по электронной почте не будут доставляться на новый адрес, поскольку этот адрес не считается допустимым в SmartCloud Notes. Прим.: Для федеративных и изменяемых федеративных пользователей операция `Rename` выполняется немедленно. При выполнении операции для федеративного пользователя происходит сбой, если новый адрес электронной почты содержит домен, не принадлежащий клиенту.
`ResendInvitation`	Отправляет письмо с приглашением, позволяющим пользователю активировать подписку, в которой ему было присвоено рабочее место. Обычно эта возможность используется в том случае, если исходное приглашение не было доставлено, либо было утеряно или удалено. Эту операцию также можно использовать вместе с операцией `Add` или `AssignSeat`, которая задает `SUPPRESS_ALL` в поле `SupressInvitation`. Это позволяет предоставить ресурсы пользователю (без отправки приглашения), а позднее отправить приглашение для активации подписки.
`ChangeStorage`	Задает объем дополнительной памяти для основной подписки пользователя. Основная пакетная подписка, подписка на службу электронной почты или совместной работы указывается в поле `SubscriptionId`. Объем дополнительной памяти задается полями `collabExtraStorage` и `mailExtraStorage`. Требуется подписка на дополнительную память достаточного объема.

Поля операций в файлах изменений предоставления ресурсов

В первой строке файла изменений предоставления ресурсов содержится обязательная информация заголовка; в последующих строках содержатся значения полей описанных в следующей таблице. При кодировании содержимого файла изменений предоставления ресурсов пользователю добавьте поля с данными о пользователе для требуемых операций предоставления ресурсов. Каждая строка должна оканчиваться правильным символом перевода строки или возврата каретки, чтобы обеспечить правильную обработку окончаний строк при передаче по FTP. Дополнительные сведения приведены в разделе Примеры: файлы изменений предоставления ресурсов пользователям.

Табл. 3. Имена и описания полей операций из файла предоставления ресурсов
Имя поля	Описание значения поля	Обязательность для операции
`EmailAddress`	Задает адрес электронной почты, который должен применяться пользователем при входе в систему.	Это поле обязательно для всех операций. Ограничение на длину составляет 254 символа.
`Action`	Задает выполняемую операцию: имена и описания операций приведены в предыдущей таблице.	Это поле обязательно для всех операций.
`SubscriptionId`	Задает подписку, на которую пользователю предоставляются права. Ключевые слова `COLLAB`, `MAIL`, `BUNDLE`, `TRAVELER`, `IBM_DOCS` и `RETENTION` можно указывать только в операции `RevokeSeat` для ссылки на вспомогательную подписку, пакетную подписку, подписку на службу электронной почты или совместной работы, которая уже есть у пользователя. Ключевые слова `DELETECOLLAB` и `DELETEMAIL` подписки можно указывать только в операции `ChangeSeat` (используются при переходе с пакетной подписки на одиночную). ИД подписки расположен в разделе Учетная запись организации: Подписка пользовательском интерфейсе Администрирование. Выберите имя подписки и используйте значение, присвоенное подписке для значения `SubscriptionId`.	Это поле обязательно для операций `AssignSeat` и `ChangeSeat` и необязательно для операций `Add`, `AddStorage` и `RevokeSeat`.
`SubscriptionId2`	Задает второй внутренний идентификатор подписки, которая предоставляется пользователю для операции `Add`.	Это поле необязательно для операций `Add` и `ChangeSeat`. Поле `Password` или `AltEmailAddress` требуется при переходе на рабочее место SmartCloud Notes с рабочего места другого типа.
`GivenName`	Задает имя пользователя.	Это поле обязательно для операции `Add` и необязательно для операции `Update`. Ограничение на длину составляет 120 символов.
`FamilyName`	Задает фамилию пользователя.	Это поле обязательно для операции `Add` и необязательно для операции `Update`. Ограничение на длину составляет 120 символов.
`Language`	Задает предпочитаемый язык пользователя.	Это поле необязательно для операций `Add` и `Update`. Ограничение на длину составляет 5 символов. Прим.: Если язык не указан, применяется контактный язык компании. Администратор указывает контактный язык компании на странице Параметры моей учетной записи в полях Локализация и Язык.
`TimeZone`	Задает часовой пояс пользователя. Официальные значения приведены в разделе `Значения часовых поясов для файлов изменений`.	Это поле необязательно для операций `Add` и `Update`. Ограничение на длину составляет 30 символов.
`Password`	Если идентификационные данные учетной записи еще окончательно не заданы, применяется этот одноразовый пароль. При первом входе в систему ему пользователю предлагается задать новый пароль. Значение пароля должно быть задано в соответствии со стандартами.	Это поле необязательно для операции `Add`. Прим.: Для операции `Add` это поле обязательное, если подписка почтовая (вне зависимости от типа федеративной идентификации пользователя). Ограничение на длину составляет 50 символов.
`AltEmailAddress`	Этот параметр имеет свое значение в каждой из следующих операций предоставления ресурсов: `Add` - если указан, то отправляется сообщение электронной почты с приглашением на этот адрес, чтобы пользователь завершил настройку идентификационных данных учетной записи. Перейдя по указанной ссылке, пользователь может настроить пароль своей учетной записи. Адрес в этом параметре также используется для уведомления об изменении учетной записи пользователя. `AssignSeat` - адрес в этом параметре также используется для уведомления об изменении учетной записи пользователя. `Rename` - задает новый адрес электронной почты.	Это поле необязательно для операции `Add`. Прим.: Для операции `Add` это поле обязательное, если подписка почтовая (вне зависимости от типа федеративной идентификации пользователя). Это поле является обязательным для операций SmartCloud Notes `AssignSeat` и `Rename`. Ограничение на длину составляет 254 символа.
`NotesTemplate`	Задает почтовый шаблон Notes, который будет присвоен подписчику на электронную почту SmartCloud Notes либо в гибридной среде, либо в среде только служб. Это поле применимо только для операций со ссылками на подписки на электронную почту SmartCloud Notes. Указанное имя должно точно соответствовать имени выбранного почтового шаблона, например StdR85Mail. Прим.: Если доступно несколько почтовых шаблонов, то для определения нужного имени шаблона для присвоения операции используйте следующую процедуру: Перейдите на страницу Почтовые шаблоны в интерфейсе администрирования SmartCloud Notes. Выберите Настраиваемые почтовые шаблоны или Стандартные почтовые шаблоны. Найдите строку, соответствующую имени, расположению и версии для пользователя, которому предоставляются ресурсы. Укажите имя нужного почтового шаблона в файле изменений предоставления ресурсов: Скопируйте значение Имя точно как показано в столбце Имя, после которого укажите запятую. Скопируйте последнюю информацию Версия точно так же, как указано в столбце Версия, после чего укажите запятую. Добавьте информацию о локали в формате `xx_XX`. Для получения информации о локали обратитесь к разделу Коды стран и языков для файлов изменений. Кроме этого, файл формы расширения для поддерживаемых шаблонов Notes предоставляет пользовательский интерфейс для веб-пользователей SmartCloud Notes. Файлы форм расширений применяются как предоставление ресурсов текущим или новым пользователям с помощью опции `extension_forms_file` (формат "`имя,версия,локаль,файл-форм-расширения`"). Для возможности применения файл формы расширений должен быть утвержден и загружен в службу. Более подробная информация находится в разделе Использование файлов форм расширения для настройки внешнего вида веб-клиента. Примеры и способы указания этих необязательных значений приведены в разделе Примеры: файлы изменений предоставления ресурсов пользователям.	Это поле необязательно для операций `Add`, `AssignSeat` и `Update`. Ограничение на длину составляет 255 символов.
`NotesDN`	Задает отличительное имя (DN), которое следует присвоить подписчику на электронную почту SmartCloud Notes. Это поле применимо только для операций со ссылками на подписки SmartCloud Notes. Прим.: Для подписок SmartCloud Notes требуется уникальное имя пользователя, которое определяется как заданное значение `NotesDN`. Если значение `NotesDN` не указано, оно будет создано на основе указанных уникальных значений `GivenName` и `FamilyName`. После того как гибридному пользователю SmartCloud Notes предоставлены ресурсы операциями `Add` и `AssignSeat` сервера, его имя нельзя изменить ни операцией `Rename` сервера интеграции, ни вручную в облачной учетной записи пользователя. Вместо этого необходимо изменять имя пользователя SmartCloud Notes в локальной среде (значение отличительного имени (DN)).	Это поле необязательно для операций `Add` и `AssignSeat`. Ограничение на длину составляет 255 символов.
`NotesMigration`	Если в этом поле указано значение `true` или `1`, то проверяется доступность данных миграции почты и миграция почтового файла выполняется в фоновом режиме. Если данные миграции недоступны или указано недопустимое значение, то возникает ошибка.	Это поле необязательно для операций `Add` и `AssignSeat`. Допустимы следующие значения: `true` `false` `1` `0` Значение по умолчанию - `false`.
`AssignTo`	Задает нового (целевого) подписчика, которому передаются ресурсы исходного пользователя. Прим.: Передача ресурсов поддерживается только для подписок на службы совместной работы.	Это поле необязательно для операций `RevokeSeat` и `Remove`. Ограничение на длину составляет 254 символа.
`Department`	Задает подразделение, к которому относится пользователь.	Это поле необязательно для операций `Add` и `Update`. Ограничение на длину составляет 255 символов.
`JobTitle`	Задает значение поля `Должность` в профайле пользователя.	Это поле необязательно для операций `Add` и `Update`. Ограничение на длину составляет 100 символов.
`Country`	Задает значение поля `Страна` в профайле пользователя в формате двухсимвольного кода ISO.	Это поле необязательно для операций `Add` и `Update`. Ограничение на длину составляет 2 символа.
`Telephone`	Задает значение поля `Телефон` в профайле пользователя.	Это поле необязательно для операций `Add` и `Update`. Ограничение на длину составляет 20 символов.
`Mobile`	Задает значение поля `Мобильный телефон` в профайле пользователя.	Это поле необязательно для операций `Add` и `Update`. Ограничение на длину составляет 20 символов.
`Fax`	Задает значение поля `Факс` в профайле пользователя.	Это поле необязательно для операций `Add` и `Update`. Ограничение на длину составляет 20 символов.
`Address`	Задает значение поля `Адрес` в профайле пользователя.	Это поле необязательно для операций `Add` и `Update`. Ограничение на длину составляет 254 символа.
`SuppressInvitation`	В сочетании со значением `SUPPRESS_ALL` запрещает отправку приглашения или уведомления по электронной почте. Приглашение можно отправить позднее с помощью операции `ResendInvitation`. Если это поле не задано, либо в нем указано значение `SUPPRESS_NONE`, то приглашение или уведомление отправляется (действие по умолчанию).	Это необязательное поле. Это поле применимо только к операциям `Add`, `Update` и `AssignSeat`.
`FederationType`	Задает тип федеративной идентификации пользователя. Допустимы следующие значения: Если в качестве типа федеративной идентификации организации задано значение Нефедеративный, то укажите для `FederationType` пользователя значение `NON_FEDERATED`. Если в качестве типа федеративной идентификации организации задано значение Федеративный, то укажите для `FederationType` пользователя значение `FEDERATED`. Если в качестве типа федеративной идентификации организации задано значение Изменяемый, то укажите для `FederationType` пользователя значение `MODIFIED_FEDERATED`. Если в качестве типа федеративной идентификации организации задано значение Частичный, то укажите для `FederationType` пользователя значение `NON_FEDERATED`, `FEDERATED` или `MODIFIED_FEDERATED`. Если значение не соответствует указанными правилами или недопустимо, то на сервере интеграции возникает ошибка. Если значение не задано, то используется тип федеративной идентификации компании. Если в качестве типа федеративной идентификации организации выбрано значение Частичный, то применяется значение `NON_FEDERATED`.	Это поле необязательно для операций `Add` и `Update`.
`CollabExtraStorage`	Объем дополнительной памяти в гигабайтах из квоты службы Файлы для ИД подписки на службы совместной работы или ИД пакетной подписки, указанной в поле `subscriptionID`. Введите неотрицательное целое число.	Это поле необязательно для операции `ChangeStorage`.
`MailExtraStorage`	Объем дополнительной памяти в гигабайтах из квоты службы Почта для ИД подписки на службу электронной почты или ИД пакетной подписки, указанной в поле `subscriptionID`. Введите неотрицательное целое число.	Это поле необязательно для операции `ChangeStorage`.
`Activation`	Добавляет указанного пользователя, выполняет точную проверку и активирует пользователя в рамках одной операции. Ключевое слово: `FORCE_ACTIVATION`. Эта операция прекрасно подходит для активации пользователей, не имеющих веб-доступа, таких как подписчики SmartCloud Notes. Возможно применение для объединенных пользователей, для которых требуется провести точную проверку и автоматическую активацию.	Это поле необязательно для операции `Add`. Операция допустима только в том случае, если для пользователя задано значение `FEDERATED`, а в организации отключена проверка электронной почты. Проверка выполняется принудительно. Прим.: Поскольку проверка электронной почты должна быть отключена, необходимо убедиться, что пользователь является допустимым участником почтового домена, управляемого организацией.