Работа с приложением

Примеры операций с Репозитарием

Отправка сообщения

Чтобы отправить сообщение, воспользуйтесь командой post. При отправке первого сообщение необходимо предварительно настроить утилиту, подробнее см. раздел Настройка приложения.

Если же при настройке вы не указывали сертификат пользователя, то сообщение необходимо будет предварительно подписать, сделать это можно командой sign.

Получение сообщения со всеми вложениями

Чтобы сохранить или прочитать XML-сообщение, воспользуйтесь командой get-xml. Если вы не знаете идентификатор сообщения, то можно предварительно воспользоваться командой list, которая выводит сообщения указанного тиа за период вместе с их идентификаторами.

Если у сообщения было вложение, то скачать его можно при помощи команды get-attachment. Если вложения у сообщения не было, то эта команда выдаст ошибку.

Доступные команды

help - помощь по использованию команд

rr help [%COMMAND%] или rr ? [%COMMAND%]

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

Параметры: [%COMMAND%] — команда, для которой необходимо вывести подробную информацию.

set - задать параметры по умолчанию

rr set %PARAMETER% %VALUE%

Задает и сохраняет значение для указанного параметра. Например, команда: rr set url %URL% сохраняет URL Репозитария, поэтому нет необходимости указывать параметр -url %URL% при вызове других команд.

Параметры:

  • %PARAMETER% — параметр, который задаётся. Допустимые значения:

    • url — задаёт URL Репозитария;

    • username — задаёт логин пользователя;

    • password — задаёт пароль пользователя;

    • canon_alg — задаёт алгоритм каноникализации XML

    • digest_alg — задаёт алгоритм расчёта дайджеста XML

  • %VALUE% — значение, которое сохраняется для указанного параметра.

use - задать сертификат ЭЦП

rr use %THUMBPRINT% [-sl %STORE_LOCATION%] [-sn %STORE_NAME%]

Задает активный сертификат для ЭЦП.

Параметры:

  • %THUMBPRINT% — отпечаток сертификата.

  • [-sl %STORE_LOCATION%] — Допустимые значения: AddressBook, AuthRoot, CertificateAuthority, Disallowed, My, Root, TrustedPeople, TrustedPublisher. По умолчанию "My

  • [-sn %STORE_NAME%] — Хранилище сертификатов. Допустимые значения: CurrentUser, LocalMachine.

info - отобразить информацию об учетной записи

rr info [-url %URL%] [-username %USERNAME%] [-password %PASSWORD] [-verbose]

Загружает и отображает краткую информацию об учетной записи и об организации.

Параметры:

settings - посмотреть параметры по умолчанию

rr settings

Выводит список всех сохранённых значений по умолчанию.

list - получить список сообщений

rr list %TYPE% [-since %SINCE%] [-max %MAX%] [-url %URL%] [-username %USERNAME%] [-password %PASSWORD] [-verbose]

Выводит список всех сообщений указанного типа и информацию о них.

Параметры:

  • %TYPE% — тип сообщений. Допустимые значения:

    • in — входящие (для Репозитария) сообщения

    • out — исходящие (для Репозитария) сообщения

    • ma — генеральные соглашения

    • mar — отчеты о маржевых суммах

    • fvr — отчеты о справедливой стоимости

    • tr — зарегистрированные отчеты о сделках

  • [-since %SINCE%] — номер ревизии, начиная с которой запрашиваются сообщения. Поумолчанию 0.

  • [-max %MAX%] — максимальное количество запрашиваемых сообщений.

  • [-url %URL%], [-username %USERNAME%], [-password %PASSWORD%], [-verbose] — общие параметры, подробнее см. Настройки соединения и общие параметры

history - получить историю статусов сообщения

rr history %TYPE% %ID% [-url %URL%] [-username %USERNAME%] [-password %PASSWORD] [-verbose]

Выводит историю статусов сообщения указанного типа с указанным идентификатором.

Параметры:

  • %TYPE% — тип сообщений. Допустимые значения:

    • in — входящие (для Репозитария) сообщения

    • out — исходящие (для Репозитария) сообщения

    • ma — генеральные соглашения

    • mar — отчеты о маржевых суммах

    • fvr — отчеты о справедливой стоимости

    • tr — зарегистрированные отчеты о сделках

  • %ID% — идентификатор сообщения в Репозитарии.

  • [-url %URL%], [-username %USERNAME%], [-password %PASSWORD%], [-verbose] — общие параметры, подробнее см. Настройки соединения и общие параметры

get-xml - получить сообщение

rr get-xml %TYPE% %ID% [%FILE%] [-print] [-pretty] [-history %HISTORY_REVISION%] [-url %URL%] [-username %USERNAME%] [-password %PASSWORD] [-verbose]

Запрашивает сообщение. XML-сообщение будет записано в файл, указанный в параметре -file %FILENAME%. Если имя файла не указано и не указан параметр -print, то имя файла будет сформировано автоматически. Если имя файла не указано и указан параметр -print, то XML не будет записан в файл, а будет выведен на экран. Если указать параметр -pretty, то файл будет отформатирован.

Параметры:

  • %TYPE% — тип сообщений. Допустимые значения:

    • in — входящие (для Репозитария) сообщения

    • out — исходящие (для Репозитария) сообщения

    • ma — генеральные соглашения

    • mar — отчеты о маржевых суммах

    • fvr — отчеты о справедливой стоимости

    • tr — зарегистрированные отчеты о сделках

  • %ID% — идентификатор сообщения в Репозитарии.

  • [%FILE%] — путь к файлу, в который будет записано XML-сообщение.

  • [-print] — вывод содержимого XML-сообщения в консоль.

  • [-pretty] — отформатировать содержимое XML-сообщения.

  • [-history %HISTORY_REVISION%] — номер ревизии в истории статусов сообщения. По умолчанию берётся последняя ревизия.

  • [-url %URL%], [-username %USERNAME%], [-password %PASSWORD%], [-verbose] — общие параметры, подробнее см. Настройки соединения и общие параметры

get - получить информацию о сообщении

rr get %TYPE% %ID% [-since %SINCE%] [-history %HISTORY_REVISION%] [-url %URL%] [-username %USERNAME%] [-password %PASSWORD] [-verbose]

Запрашивает сообщение. Если указан номер ревизии и сообщение не было изменено с указанной ревизии, то выводится сообщение об отсутствии изменений. Если указывается номер ревизии в истории статусов сообщения, то отображается указанная ревизия сообщения.

Параметры:

  • %TYPE% — тип сообщений. Допустимые значения:

    • in — входящие (для Репозитария) сообщения

    • out — исходящие (для Репозитария) сообщения

    • ma — генеральные соглашения

    • mar — отчеты о маржевых суммах

    • fvr — отчеты о справедливой стоимости

    • tr — зарегистрированные отчеты о сделках

  • %ID% — идентификатор сообщения в Репозитарии.

  • [-since %SINCE%] — номер ревизии, начиная с которой запрашиваются сообщения. Поумолчанию 0.

  • [-history %HISTORY_REVISION%] — номер ревизии в истории статусов сообщения. По умолчанию берётся последняя ревизия.

  • [-url %URL%], [-username %USERNAME%], [-password %PASSWORD%], [-verbose] — общие параметры, подробнее см. Настройки соединения и общие параметры

get-attachment - получить вложения

rr get-attachment %TYPE% %ID% [%FILE%] [-history %HISTORY_REVISION%] [-url %URL%] [-username %USERNAME%] [-password %PASSWORD] [-verbose]

Запрашивает вложение сообщения. XML будет записан в файл, указанный в параметре -file %FILENAME%. Если имя файла не указано, то имя файла будет сформировано автоматически. Если у сообщения нет вложения, то будет выведена ошибка.

Параметры:

  • %TYPE% — тип сообщений. Допустимые значения:

    • in — входящие (для Репозитария) сообщения

    • out — исходящие (для Репозитария) сообщения

    • ma — генеральные соглашения

    • mar — отчеты о маржевых суммах

    • fvr — отчеты о справедливой стоимости

    • tr — зарегистрированные отчеты о сделках

  • %ID% — идентификатор сообщения в Репозитарии.

  • %FILE% — путь к файлу, в который будет записаны вложения к XML-сообщению.

  • [-history %HISTORY_REVISION%] — номер ревизии в истории статусов сообщения. По умолчанию берётся последняя ревизия.

  • [-url %URL%], [-username %USERNAME%], [-password %PASSWORD%], [-verbose] — общие параметры, подробнее см. Настройки соединения и общие параметры

post - отправить сообщение

rr post %XML% [%ATTACHMENT%] [-sign] [-url %URL%] [-username %USERNAME%] [-password %PASSWORD] [-verbose]

Отправка сообщения в Репозитарий.

Параметры:

  • %XML% — путь к файлу в формате XML.

  • [%ATTACHMENT%] — путь к zip-архиву с дополнительными вложенями.

  • [-sign] — Подписать сообщение. Если не указан, то сообщение должно содержать ЭЦП. Если указан, то сообщение будет подписано сертификатом, выбранным ранее с помощью команды use.

  • [-url %URL%], [-username %USERNAME%], [-password %PASSWORD%], [-verbose] — общие параметры, подробнее см. Настройки соединения и общие параметры

sign - подписать сообщение

rr sign %XML% [-out %OUTPUT%] [-url %URL%] [-username %USERNAME%] [-password %PASSWORD] [-verbose]

Подписывает сообщение сертификатом, выбранным ранее с помощью команды use.

Параметры:

  • %XML% — путь к файлу в формате XML.

  • [-out %OUTPUT%] — путь к файлу с результатами. Если не указан, то файл будет сформирован автоматически.

  • [-url %URL%], [-username %USERNAME%], [-password %PASSWORD%], [-verbose] — общие параметры, подробнее см. Настройки соединения и общие параметры

Пред.     
  Начало