You are viewing an old version of this page. View the current version.
Compare with Current View Page History
« Previous Version 2 Next »
Этот серверный класс необходим для использования системы контроля версий (VCS) SimpleOne.
SimpleVcs()
Используйте этот метод для создания нового пустого объекта класса SimpleVcs.
Пример:
const vcs = new SimpleVcs();
createTableSnapshot(tableName)
Используйте этот метод, чтобы создать первую версию всех записей в указанной таблице.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
tableName | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Integer | Метод возвращает количество версий, созданных после выполнения скрипта. |
Пример:
const tableName = 'sys_script'; const vcs = new SimpleVcs(); const versionCount = vcs.createTableSnapshot(tableName); ss.info(versionCount); // 1
exportLocalPackVcsRecords(sysVcsLocalPackId)
Используйте этот метод для экспорта записей системы контроля версий, привязанных к пакету конфигурации с уникальным ID, в .SOP файле. Этот пакет должен находиться в состоянии «Завершено».
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
sysVcsLocalPackId | Integer | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Object | .SOP файл для загрузки |
Пример:
const vcsLocalPackId = '156144163704236641'; const vcs = new SimpleVcs(); vcs.exportLocalPackVcsRecords(vcsRetrievedPackId);
importRetrievedPack(retrievedPackId)
Используйте этот метод для импорта последнего предпросмотренного извлеченного пакета из Журнала просмотра VCS (sys_vcs_preview_log) в таблицу Запись VCS (sys_vcs_record).
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
retrievedPackId | Integer | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
String | Строка, содержащая результаты импорта |
Пример:
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).
*у текущих записей атрибут is_current равен true.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
localPackId | Integer | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Boolean | Метод возвращает "true", если записи найдены. В случае неудачи метод возвращает "false". |
Пример:
const vcsLocalPackId = '156144163704236641'; const vcs = new SimpleVcs(); if (vcs.isLocalPackHasReferences(vcsLocalPackId)) { ss.addInfoMessage('Local Pack has current VCS records'); }
isRetrievedPackHasReferences(retrievedPackId)
Этот метод предназначен для проверки записи из таблицы Импортированные пакеты (sys_vcs_retrieved_pack) на наличие ссылок на записи из таблицы Запись VCS (sys_vcs_record).
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
retrievedPackId | Integer | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Boolean | Метод возвращает значение "true" при наличии ссылок на записи, в случае их отсутствия метод возвращает "false". |
Пример:
const vcsRetrievedPackId = '156144163704236641'; const vcs = new SimpleVcs(); if (vcs.isRetrievedPackHasReferences(vcsRetrievedPackId)) { ss.addInfoMessage('Retrieved Pack has current VCS records'); }
isRetrievedPackHasAttache(vcsRetrievedPackId)
Этот метод является устаревшим для версии системы 1.2 и старше и больше не поддерживается. Вместо него используйте метод hasAttachment().
loadDataFromAttachment(sysVcsRetrievedPackId)
Используйте этот метод для загрузки данных из пакета конфигурации, добавленного к таблице Импортированные пакеты (sys_vcs_retrieved_pack), как вложение для предварительного просмотра.
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
sysVcsRetrievedPackId | Integer | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Boolean | Метод возвращает "true", если загрузка данных прошла успешно. В случае неудачи метод возвращает "false". |
Пример:
const vcs = new SimpleVcs(); const message = new SimpleMessage(); if (!vcs.loadDataFromAttachment(current.sys_id)) { ss.addErrorMessage('Error loading data'); return; } ss.setRedirect();
mergeLocalPacks(rowIds, name, description)
Используйте этот метод для объединения нескольких локальных пакетов в один. Исходные локальные пакеты удаляются безвозвратно.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
rowIds | Array | Да | Нет |
name | String | Нет | 'merged pack' |
description | String | Нет | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
String | ID объединенного локального пакета. В случае неудачи метод возвращает "null". |
Пример:
const vcsLocalPackId = [ '157666651911972694', '157665759017038346', '157665742419415102' ]; const mergedName = 'Merged Pack 1'; const mergedDesc = 'Merged Pack description 1'; const vcs = new SimpleVcs(); const mergedId = vcs.mergeLocalPacks(vcsLocalPackId, mergedName, mergedDesc); if (mergedId != null) { ss.info(' ID объединенного локального пакета ' + mergedId); } else { ss.info('Возникли проблемы с объединением пакетов'); }
moveVcsRecordsToDefault(versionIds)
Используйте этот метод, чтобы перемещать большое количество записей системы контроля версий в локальный пакет по умолчанию.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
versionIds | Array | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Boolean | Метод возвращает "true", при успешном перемещении записей. В случае ошибки метод возвращает "false". |
Пример:
const vcs = new SimpleVcs(); const result = vcs.moveVcsRecordsToDefault([current.sys_id]); ss.info(result);
preview(sysVcsRetrievedPackId)
This method extracts the records related to the configuration from the Retrieved Records (sys_vcs_retrieved_record) table and performs a pack preview.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
retrievedPackId | Integer | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
Boolean | This method returns true if preview was successful; otherwise, it returns false. |
Пример:
const vcs = new SimpleVcs(); const message = new SimpleMessage(); if (!vcs.preview(current.sys_id)) { const localizedMessage = message.getMessage('Error previewing data'); ss.addErrorMessage(localizedMessage); return; } ss.setRedirect();
rollback(packId)
This method rollbacks a local pack. The local pack can be rollbacked only when it in the RollBack-Previewed state.
Параметры:
Name | Type | Обязательный | Значение по умолчанию |
---|---|---|---|
packId | Integer | Y | N |
Возвращаемое значение:
Type | Описание |
---|---|
String | The method returns true if the rollback was successful; otherwise, it returns an exception. |
Пример:
const vcsLocalPackId = '156144163704236641'; const vcs = new SimpleVcs(); if (vcs.rollBack(vcsLocalPackId)) { ss.addInfoMessage('RollBack of Local Pack was successful'); }
rollBackPreview(packId)
Use this method to preview the rollback results.
Параметры:
Name | Type | Обязательный | Значение по умолчанию |
---|---|---|---|
packId | Integer | Y | N |
Возвращаемое значение:
Type | Описание |
---|---|
Boolean | The method returns true if the rollback preview was successful; otherwise, it returns false. |
Пример:
const vcsLocalPackId = '156144163704236641'; const vcs = new SimpleVcs(); if (vcs.rollBackPreview(vcsLocalPackId)) { ss.addInfoMessage('RollBack preview of Local Pack was successful'); }
- No labels