Page History

This server class provides methods that allow operating with attachments.

SimpleAttachment()

Instantiates a new empty SimpleAttachment object.

Code Block

language	js
theme	Eclipse
title	SimpleAttachment
linenumbers	true

const attach = new SimpleAttachment();

base64Decode(data)

This method returns an ASCII string decoded from the base64 string specified.

Name	Type	Mandatory	Default Value
data	String	Y	N

Return:

Type	Description
String	The decoded string.

Example:

Code Block

language	js
theme	Eclipse
title	base64Decode
linenumbers	true

const attach = new SimpleAttachment();
const result =
  attach.base64Decode('TG9yZW0gaXBzdW0gZG9sb3Igc2l0IGFtZXQ=');
ss.info(result);

base64Encode(data)

This method returns a Base64 string from the string specified.

Name	Type	Mandatory	Default Value
data	String	Y	N

Return:

Type	Description
String	The encoded Base64 string.

Example:

Code Block

language	js
theme	Eclipse
title	base64Encode
linenumbers	true

const attach = new SimpleAttachment();
const result =
  attach.base64Encode('Lorem ipsum dolor sit amet');
ss.info(result);

copy(sourceTableName, sourceID, targetTableName, targetID)

This method copies attachments from the source record to the target record.

Parameter(s):

Name	Type	Mandatory	Default Value
sourceTableName	String	Y	N
sourceID	String	Y	N
targetTableName	String	Y	N
targetID	String	Y	N

Return:

Type	Description
Boolean	This method returns TRUE if attachments copied successfully; otherwise, it returns FALSE.

Example:

Code Block

language	js
theme	Eclipse
title	copy
linenumbers	true

const attach = new SimpleAttachment();
attach.copy('sys_email', '155964310500000059', 'task', current.sys_id);

deleteAttachment(attachmentID)

This method deletes the specified attachment.

Parameter(s):

Name	Type	Mandatory	Default Value
attachmentID	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	deleteAttachment

const attach = new SimpleAttachment();
attach.deleteAttachment('157052637119478714');

getAttachmentUrlById(attachmentId)

This method allows to get the URL of the specified attachment at the cloud storage.

Name	Type	Mandatory	Default Value
attachmentId	string	Y	N

Return:

Type	Description
String	This method returns the attachment URL in the cloud storage.

Example:

Code Block

language	js
theme	Eclipse
title	getAttachmentUrlById
linenumbers	true

const current = new SimpleRecord('sys_attachment');
current.get('163553718313772587');
const ATTACH_ID = current.sys_id; // sys_attachment sys_id

const simpleAttach = new SimpleAttachment();
const attachUrl = simpleAttach.getAttachmentUrlById(ATTACH_ID);
ss.info(attachUrl);
//Info: https://s3-{your-instance-url:9000}/public-attachment/15/3432/r8ox123459bnc2pcb3axyfatgtc6lsi7...

getContent(sysAttachment)

This method gets attachment content as a string.

Name	Type	Mandatory	Default Value
sysAttachment	SimpleRecord	Y	N

Return:

Type	Description
String	The attachment content as a string.

Example)

Code Block

language	js
theme	Eclipse
title	getContent
linenumbers	true

const attach = new SimpleAttachment();
const content = attach.getContent('157052637119478714');

readBase64(attachmentId)

This method allows to get a encoded string from the specified attachment.

Note
The attachment size is limited up to 10 Mb; otherwise, the method throws an exception.

Parameter(s):

Name	Type	Mandatory	Default value
attachmentId	String	Y	N

Return:

Type	Description
String	The base64-encoded string.

Code Block

language	js
theme	Eclipse
title	readBase64
linenumbers	true

const read = new SimpleAttachment();
ss.info(read.readBase64('159050716911764097'));

rename(attachmentId, fileName)

This method renames the specified attachment.

Parameter(s):

Name	Type	Mandatory	Default Value
attachmentId	String	Y	N
fileName	String	Y	N

Return:

Type	Description
Void	This method does not return a value.

Example:

Code Block

language	js
theme	Eclipse
title	rename
linenumbers	true

const DOC_ID = ss.getDocIdByIds(current.sys_db_table_id, current.sys_id);
const simpleAttach = new SimpleAttachment();
const attachRecord = new SimpleRecord('sys_attachment');
attachRecord.addQuery('record_document_id', DOC_ID);
attachRecord.addQuery('mime_content_type', 'application/json');
attachRecord.selectAttributes('sys_id');
attachRecord.query();
attachRecord.next();
simpleAttach.rename(attachRecord.sys_id, `${current.number} - ${current.subject}.json`);

write(documentId, fileName, content, contentType)

This method inserts the attachment to the record specified.

Name	Type	Mandatory	Default Value
documentId	String	Y	N
filename	String	Y	N
content	String	Y	N
contentType	String	Y	N

Return

Type	Description
String	The attachment's sys ID; in case of error; returns NULL.

Example:

Code Block

language	js
theme	Eclipse
title	write
linenumbers	true

const simpleAttach = new SimpleAttachment();
const attachID =
    simpleAttach.write(
        ss.getDocIdByIds(current.sys_db_table_id, current.sys_id),
        'readme.json',
        JSON.stringify(current.getAttributes(), null, '\t'),
        'application/json'
    );

writeBase64(documentId, fileName, base64, contentType)

This method inserts the attachment to the record specified using Base64 encoding.

Name	Type	Mandatory	Default Value
documentID	String	Y	N
fileName	String	Y	N
base64	String	Y	N
contentType	String	Y	N

Return

Type	Description
String or NULL	The attachment's sys ID; in case of error; returns NULL.

Example:

Code Block

language	js
theme	Eclipse
title	writeBase64
linenumbers	true

const CURRENT_USER_DOC_ID = ss.getDocIdByIds(ss.getUser().sys_db_table_id, ss.getUserID());
const simpleAttach = new SimpleAttachment();
const base64Value = 'R0lGODlhAQABAIAAAP///wAAACwAAAAAAQABAAACAkQBADs=';
const attachId = simpleAttach.writeBase64(
    CURRENT_USER_DOC_ID,
  	'file_example.gif',
    base64Value,
    'image/gif'
);
ss.info(attachId);
//Info: 162245472311776172

Table of Contents

absoluteUrl	true
class	fixedPosition

Page tree

Versions Compared

Old Version 53

New Version 54

Key

SimpleAttachment()

base64Decode(data)

base64Encode(data)

copy(sourceTableName, sourceID, targetTableName, targetID)

deleteAttachment(attachmentID)

getAttachmentUrlById(attachmentId)

getContent(sysAttachment)

readBase64(attachmentId)

rename(attachmentId, fileName)

write(documentId, fileName, content, contentType)

writeBase64(documentId, fileName, base64, contentType)