This server-side class allows for collecting attachments from a remote instance when performing a migration from some third-party system to SimpleOne.
Instantiates a new empty SimpleAttachmentService object.
const attach = new SimpleAttachmentService(); |
This method allows for getting a file from a remote instance by a URL provided.
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
url | String | Y | N |
SimpleRecordId | String | Y | N |
fileName | String | Y | N |
Return:
Type | Description |
---|---|
String or NULL |
|
const attach = SimpleAttachmentService(); attach.setUsername('admin'); // Put up a real admin username before using this method. attach.setPassword('admin'); // Put up a real admin 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'); |
This method sets a URL of the remote instance that will be accessed when the getAttachmentSN method is called.
Name | Type | Mandatory | Default Value |
---|---|---|---|
url | String | Y | N |
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
attach.setUrl('https://simple.instance.com:8443'); |
This method sets a user of a remote instance whose security context is used when establishing a connection.
The user whose username is passed to the method must have sufficient access rights to the source file. |
Parameter(s):
Name | Type | Mandatory | Default Value |
---|---|---|---|
username | String | Y | N |
Return value:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
attach.setUsername('admin'); |
This method allows for setting 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 value:
Type | Description |
---|---|
Void | This method does not return a value. |
Example:
attach.setPassword('admin'); |
This method allows for getting a file from a remote instance by the ID of the record on that instance.
Parameter(s):
Name | Type | Mandatory | Default value |
---|---|---|---|
SourceSysId | String | Y | N |
SimpleRecordId | String | Y | N |
Return value:
Type | Description |
---|---|
String or NULL |
|
Example:
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('admin'); // Put up a real admin username before using this method. attach.setPassword('admin'); // // Put up a real admin password before using this method. const docID = ss.getDocIdByIds('155931135900000084', '155931135900000001'); const attachId = attach.getAttachmentSN('f91d84fe7cff58d4db91f2e9c2dc02fb', docID); |