SimpleVcs

Этот класс содержит методы для использования системы контроля версий (VCS) SimpleOne.

SimpleVcs()

---

Используйте этот конструктор для создания нового пустого объекта класса SimpleVcs.

Пример:

SimpleVcs()

const vcs = new SimpleVcs();

createTableSnapshot(tableName)

---

Используйте этот метод, чтобы создать актуальную версию записей VCS всех записей в указанной таблице.

Параметры:

Название	Тип	Обязательный	Значение по умолчанию
tableName	String	Да	Нет

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

Тип	Описание
Integer	Метод возвращает количество созданных версий.

Пример:

createTableSnapshot()

const tableName = 'sys_script';
const vcs = new SimpleVcs();
const versionCount = vcs.createTableSnapshot(tableName);
ss.info(versionCount); // 1

exportLocalPackVcsRecords(sysVcsLocalPackId)

---

Используйте этот метод для экспорта записей VCS, привязанных к пакету конфигурации с уникальным ID, в SOP-файле. Этот пакет должен находиться в статусе Завершено.

Параметры:

Название	Тип	Обязательный	Значение по умолчанию
sysVcsLocalPackId	String	Да	Нет

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

Тип	Описание
Object	Метод возвращает SOP-файл для скачивания.

Пример:

exportLocalPackVcsRecords()

const vcsLocalPackId = '156144163704236641';
const vcs = new SimpleVcs();
vcs.exportLocalPackVcsRecords(vcsRetrievedPackId);

importRetrievedPack(retrievedPackId)

---

Используйте этот метод для импорта загруженных в Журнал просмотра VCS (sys_vcs_preview_log) записей, привязанных к импортированному пакету, в таблицу Запись VCS (sys_vcs_record).

Параметры:

Название	Тип	Обязательный	Значение по умолчанию
retrievedPackId	String	Да	Нет

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

Тип	Описание
Boolean	Метод возвращает значение true, если записи импортировались. В случае неудачи метод возвращает false.

Пример:

importRetrievedPack()

const vcsRetrievedPackId = '156144163704236641';
const vcs = new SimpleVcs();
const result = vcs.importRetrievedPack(vcsRetrievedPackId);
ss.addInfoMessage(result);

isLocalPackHasReferences(localPackId)

---

Используйте метод, чтобы проверить записи из таблицы Локальные пакеты (sys_vcs_local_pack) на наличие ссылок на текущие* записи из таблицы Запись VCS (sys_vcs_record).

*у текущих записей установлен флажок Актуальная.

Параметры:

Название	Тип	Обязательный	Значение по умолчанию
localPackId	String	Да	Нет

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

Тип	Описание
Boolean	Метод возвращает true, если записи найдены. В случае неудачи метод возвращает false.

Пример:

isLocalPackHasReferences()

const vcsLocalPackId = '156144163704236641';
const vcs = new SimpleVcs();
if (vcs.isLocalPackHasReferences(vcsLocalPackId)) {
  ss.addInfoMessage('Локальный пакет содержит ссылку на актуальную запись VCS');
}

isRetrievedPackHasReferences(retrievedPackId)

---

Используйте метод, чтобы проверить записи из таблицы Импортированные пакеты (sys_vcs_retrieved_pack) на наличие ссылок на записи из таблицы Запись VCS (sys_vcs_record).

Параметры:

Название	Тип	Обязательный	Значение по умолчанию
retrievedPackId	String	Да	Нет

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

Тип	Описание
Boolean	Метод возвращает значение true при наличии ссылок на записи, в случае их отсутствия метод возвращает false.

Пример:

isRetrievedPackHasReferences()

const vcsRetrievedPackId = '156144163704236641';
const vcs = new SimpleVcs();
if (vcs.isRetrievedPackHasReferences(vcsRetrievedPackId)) {
  ss.addInfoMessage('Импортированный пакет содержит ссылку на актуальную запись VCS');
}

isRetrievedPackHasAttache(vcsRetrievedPackId)

---

предупреждение

Этот метод является устаревшим для версии системы 1.2 и старше и больше не поддерживается. Вместо него используйте метод hasAttachment().

loadDataFromAttachment(sysVcsRetrievedPackId)

---

Используйте этот метод для загрузки данных из пакета конфигурации, добавленного к записи таблицы Импортированные пакеты (sys_vcs_retrieved_pack) как вложение для предварительного просмотра.

Параметры:

Название	Тип	Обязательный	Значение по умолчанию
sysVcsRetrievedPackId	String	Да	Нет

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

Тип	Описание
Boolean	Метод возвращает true, если загрузка данных прошла успешно. В случае неудачи метод возвращает false.

Пример:

loadDataFromAttachment()

const vcs = new SimpleVcs();
const message = new SimpleMessage();
if (!vcs.loadDataFromAttachment(current.sys_id)) {
  ss.addErrorMessage('Ошибка загрузки');
  return;
}
ss.setRedirect();

mergeLocalPacks(rowIds, name, description)

---

Используйте этот метод для объединения нескольких локальных пакетов в один. Исходные локальные пакеты удаляются безвозвратно.

Параметры:

Название	Тип	Обязательный	Значение по умолчанию
rowIds	Array of Strings	Да	Нет
name	String	N	merge pack
description	String	N	N

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

Тип	Описание
String	Метод возвращает ID объединенного локального пакета. В случае неудачи метод возвращает null.

Пример:

mergeLocalPacks()

const vcsLocalPackId = [
  '157666651911972694',
  '157665759017038346',
  '157665742419415102'
];
const mergedName = 'Объединенный пакет 1';
const mergedDesc = 'Описание объединенного пакета 1';
const vcs = new SimpleVcs();
const mergedId = vcs.mergeLocalPacks(vcsLocalPackId, mergedName, mergedDesc);
if (mergedId) {
  ss.info(' ID объединенного локального пакета ' + mergedId);
} else {
  ss.info('Возникли проблемы с объединением пакетов');
}

moveVcsRecordsToDefault(versionIds)

---

Используйте этот метод, чтобы перемещать большое количество записей VCS в локальный пакет по умолчанию.

Параметры:

Название	Тип	Обязательный	Значение по умолчанию
versionIds	Array of Strings	Да	Нет

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

Тип	Описание
Boolean	Метод возвращает true, при успешном перемещении записей. В случае ошибки метод возвращает false.

Пример:

moveVcsRecordsToDefault()

const vcs = new SimpleVcs();
const result = vcs.moveVcsRecordsToDefault([current.sys_id]);
ss.info(result);

preview(sysVcsRetrievedPackId)

---

Используйте метод для извлечения записей, связанных с конфигурацией, из таблицы Извлеченные записи (sys_vcs_retrieved_record) и выполнения предварительного просмотр пакета.

Параметры:

Название	Тип	Обязательный	Значение по умолчанию
retrievedPackId	String	Да	Нет

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

Тип	Описание
Boolean	Метод возвращает true, если предварительный просмотр был успешным. В случае неудачи метод возвращает false.

Пример:

preview()

const vcs = new SimpleVcs();
if (!vcs.preview(current.sys_id)) {
    ss.addErrorMessage('Ошибка просмотра данных');
    return;
}
ss.setRedirect();

rollback(packId)

---

Используйте этот метод для отката локального пакета. Откат возможен, только когда локальный пакет находится в статусе Откат подготовлен.

Параметры:

Название	Тип	Обязательный	Значение по умолчанию
packId	String	Да	Нет

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

Тип	Описание
Void	Метод не возвращает значение.

Пример:

rollback()

const vcsLocalPackId = '156144163704236641';
const vcs = new SimpleVcs();
vcs.rollBack(vcsLocalPackId);

rollBackPreview(packId)

---

Используйте данный метод для предварительного просмотра результатов отката.

Параметры:

Название	Тип	Обязательный	Значение по умолчанию
packId	String	Да	Нет

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

Тип	Описание
Void	Метод не возвращает значение.

Пример:

rollBackPreview()

const vcsLocalPackId = '156144163704236641';
const vcs = new SimpleVcs();
vcs.rollBackPreview(vcsLocalPackId);