Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
This server-side class allows collecting attachments from a remote instance when performing a migration from some third-party system to Этот серверный класс позволяет собирать вложения с удаленного экземпляра при выполнении миграции из какой-либо сторонней системы в SimpleOne.
SimpleAttachmentService()
Instantiates a new empty SimpleAttachmentService objectЭтот конструктор класса предназначен для создания объекта SimpleAttachmentService, необходимого для работы с нижеперечисленными методами.
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const attach = new SimpleAttachmentService(); |
createAttachmentByUrl(url,
SimpleRecordIdrecordDocId, fileName)
Use this method to get a file from a remote instance by a URL provided.
Parameter(s):
Используйте этот метод, чтобы создать копию вложения из удаленного экземпляра по указанному URL-адресу и прикрепить её к записи по указанному DocumentID в параметре recordDocId.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию | Name | Type | Mandatory | Default Value |
---|---|---|---|---|---|---|---|
url | String | YДа | NНет | ||||
SimpleRecordIdrecordDocId | String | YДа | NНет | ||||
fileName | String | YДа | NНет |
ReturnВозвращаемое значение:
TypeТип | DescriptionОписание | ||
---|---|---|---|
String or NULL |
| Метод возвращает ID созданного вложения. |
ПримерExample:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const attach = new SimpleAttachmentService(); attach.setUsername('john.doe'); // PutУкажите upнастоящее aимя realпользователя usernameперед beforeиспользованием usingэтого this methodметода. attach.setPassword('123456'); // PutУкажите upнастоящий aпароль realперед passwordиспользованием before using this methodэтого метода. const docID = ss.getDocIdByIds('155931135900000084', '155931135900000001'); const attachId = attach.createAttachmentByUrl('http://simple.instance.com/v1/attachments/download/159229954513242397', docID, 'test.sop'); |
setUrl(url)
This method sets a URL of the remote instance to access when calling the getAttachmentSN method.
Parameter(s):
Используйте этот метод, чтобы указать URL-адрес удаленного экземпляра, к которому нужно настроить доступ для работы с файлами.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию | Name | Type | Mandatory | Default Value |
---|---|---|---|---|---|---|---|
url | String | YДа | NНет |
ReturnВозвращаемое значение:
TypeТип | DescriptionОписание |
---|---|
Void | This method does not return a valueМетод не возвращает значение. |
ExampleПример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
attach.setUrl('https://simple.instance.com:8443'); |
setUsername(username)
This method sets a user of a remote instance whose security context is used when establishing a connection.
Info |
---|
The user whose username is passed to the method must have sufficient access rights to the source file. |
Parameter(s):
Используйте метод задает логин (username) для пользователя при установке соединения с удалённым экземпляром.
Info |
---|
Пользователь, чей логин передается в метод, должен иметь необходимые права для доступа к файлу. |
Параметры:
Название | Тип | Обязательный | Значение по умолчанию | Name | Type | Mandatory | Default Value |
---|---|---|---|---|---|---|---|
username | String | YДа | NНет |
Return Возвращаемое значение:
TypeТип | DescriptionОписание |
---|---|
Void | This method does not return a valueМетод не возвращает значение. |
ExampleПример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
attach.setUsername('john.doe'); |
setPassword(password)
This method allows setting a password for a user whose security context is used when establishing a connection to a remote instance.
Parameter(s):
Используйте этот метод, чтобы установить пароль для пользователя, чей контекст безопасности используется при установлении соединения с удаленным экземпляром.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию | Name | Type | Mandatory | Default Value |
---|---|---|---|---|---|---|---|
password | String | YДа | NНет |
ReturnВозвращаемое значение:
TypeТип | DescriptionОписание |
---|---|
Void | This method does not return a valueМетод не возвращает значение. |
ExampleПример:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
attach.setPassword('123456'); |
getAttachmentSN(
SourceSysIdsourceDocId,
SimpleRecordId)This method allows getting a file from a remote instance by the ID of the record on that instance.
Parameter(s):
SimpleRecordId
Return:
Type
Description
- Success: returns the attachment ID in the cloud storage;
- Failure: returns NULL.
targetDocdId)
Используйте метод для получения файла с удаленного экземпляра. Укажите DocumentID необходимой записи и записи текущего экземпляра, к которой необходимо прикрепить вложение. Для указания и авторизации на удалённом экземпляре, воспользуйтесь методами setUrl(), setUsername() и setPassword(), описанными выше.
Параметры:
Название | Тип | Обязательный | Значение по умолчанию |
---|---|---|---|
sourceDocId | String | Да | Нет |
targetDocId | String | Да | Нет |
Возвращаемое значение:
Тип | Описание |
---|---|
String | Метод возвращает ID созданного вложения. |
ПримерExample:
Code Block | ||||||||
---|---|---|---|---|---|---|---|---|
| ||||||||
const attach = new SimpleAttachmentService(); attach.setUrl('https://source-now.instance.com:8443'); // AЦелевой target instanceэкземпляр. PlaceУкажите aнастоящий real URL-адрес thereздесь beforeперед usingиспользованием thisэтого methodметода. attach.setUsername('john.doe'); // PutУкажите upнастоящее aимя realпользователя usernameперед beforeиспользованием usingэтого this methodметода. attach.setPassword('123456'); // PutУкажите upнастоящий aпароль realперед passwordиспользованием before using this methodэтого метода. const docID = ss.getDocIdByIds('155931135900000084', '155931135900000001'); const attachId = attach.getAttachmentSN('f91d84fe7cff58d4db91f2e9c2dc02fb', docID); |
Table of Contents | ||||
---|---|---|---|---|
|