Page History

This server-side class is necessary for using SimpleOne version control system (VCS).

SimpleVcs()

Instantiates a new empty SimpleVcs class object.

Example:

Code Block

language	js
theme	Eclipse
title	SimpleVcs
linenumbers	true

const vcs = new SimpleVcs();

createTableSnapshot(tableName)

This method creates initial versions of all the records of the specified table.

Parameter(s):

Name	Type	Mandatory	Default Value
tableName	String	Y	N

Return:

Type	Description
BooleanInteger	This method returns TRUE if the snapshot was successful; otherwise, it returns FALSEnumber of versions created after the script has executed.

Example:

Code Block

language	js
theme	Eclipse
title	createTableSnapshot
linenumbers	true

const tableName = 'sys_script';
const vcs = new SimpleVcs();
const snapshotStateversionCount = vcs.createTableSnapshot(tableName);
if (snapshotState) {
	ss.info('Success'versionCount);
} else {
	ss.info('Houston we have a problem with creating snapshots');
}// 1

exportLocalPackVcsRecords(sysVcsLocalPackId)

This method performs VCS records export that were bound to the configuration pack with the unique ID as a .SOP file. This pack must be in the Completed state.

Parameter(s):

Name	Type	Mandatory	Default Value
sysVcsLocalPackId	Integer	Y	N

Return:

Type	Description
Object	Returns a .SOP file for downloading.

Example:

Code Block

language	js
theme	Eclipse
title	exportLocalPackVcsRecords
linenumbers	true

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

importRetrievedPack(retrievedPackId)

This method imports the last containing in the VCS preview log (sys_vcs_preview_log) table previewed retrieved pack to the VCS Record (sys_vcs_record) table.

Parameter(s):

Name	Type	Mandatory	Default Value
retrievedPackId	Integer	Y	N

Return:

Type	Description
String	Returns string containing the import results.

Example:

Code Block

language	js
theme	Eclipse
title	importRetrievedPack
linenumbers	true

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

isLocalPackHasReferences(localPackId)

This method checks the record from the sys_vcs_local_pack table if it has referenced current* records from the the VCS records (sys_vcs_record) table.

*the current records have the is_current attribute equal to TRUE.

Parameter(s):

Name	Type	Mandatory	Default Value
localPackId	Integer	Y	N

Return:

Type	Description
Boolean	The method returns TRUE if it 'true' if it finds records of such kind; otherwise, it returns FALSE'false'.

Example:

Code Block

language	js
theme	Eclipse
title	isLocalPackHasReferences
linenumbers	true

const vcsLocalPackId = '156144163704236641';
const vcs = new SimpleVcs();
if (vcs.isLocalPackHasReferences(vcsLocalPackId)) {
  ss.addInfoMessage('Local Pack has current VCS records');
}

isRetrievedPackHasReferences(retrievedPackId)

This method checks the record from the the VCS Retrieved pack (sys_vcs_retrieved_pack) table if it has referenced records from the records from the VCS Records (sys_vcs_record) table.

Parameter(s):

Name	Type	Mandatory	Default Value
retrievedPackId	Integer	Y	N

Return:

Type	Description
Boolean	This method returns TRUE 'true' if there are any referenced records; otherwise, it returns FALSE'false'.

Example:

Code Block

language	js
theme	Eclipse
title	isRetrievedPackHasReferences
linenumbers	true

const vcsRetrievedPackId = '156144163704236641';
const vcs = new SimpleVcs();
if (vcs.isRetrievedPackHasReferences(vcsRetrievedPackId)) {
  ss.addInfoMessage('Retrieved Pack has current VCS records');
}

isRetrievedPackHasAttache(vcsRetrievedPackId)

Warning
This method has been deprecated since version 1.2 and no longer supported. Please use the hasAttachment() method instead.

loadDataFromAttachment(sysVcsRetrievedPackId)

This method loads configuration pack data from attachment provided to the Retrieved Records (sys_vcs_retrieved_record) table for the preview purposes.

Name	Type	Parameter	Default Value
sysVcsRetrievedPackId	Integer	Y	N

Return:

Type	Description
Boolean	This method returns TRUE 'true' if data loading was successful; otherwise, it returns FALSE'false'.

Example:

Code Block

language	js
theme	Eclipse
title	loadDataFromAttachment
linenumbers	true

const vcs = new SimpleVcs();
const message = new SimpleMessage();
if (!vcs.loadDataFromAttachment(current.sys_id)) {
    const localizedMessage = message.getMessagess.addErrorMessage('Error loading data');
    ss.addErrorMessage(localizedMessage);
    return;
}
ss.setRedirect();

mergeLocalPacks(rowIds, name, description)

This method implements merging multiple localpacks into one. Herewith, initial localpack are being removed irrevocably.

Parameter(s):

Name	Type	Mandatory	Default Value
rowIds	Array	Y	N
name	String	N	'merged pack'
description	String	N	'merged pack description'N

Return:

Type	Description
String	Returns ID of the resulting merged localpack if successful; otherwise, it returns NULL'null'.

Example:

Code Block

language	js
theme	Eclipse
title	mergeLocalPacks
linenumbers	true

const vcsRetrievedPackIdvcsLocalPackId = [
  '157666651911972694',
  '157665759017038346',
  '157665742419415102'
];
const mergedName = 'Merged Pack 1';
const mergedDesc = 'Merged Pack description 1';
const vcs = new SimpleVcs();
const mergedId = vcs.mergeLocalPacks(vcsRetrievedPackIdvcsLocalPackId, mergedName, mergedDesc);
if (mergedId != null) {
  ss.info('Merged Local Pack has Id ' + mergedId);
} else {
  ss.info('Houston we have a problem with merging Packs');
}

moveVcsRecordsToDefault(versionIds)

This method allows bulk moving VCS records to the default local pack.

Parameter(s):

Name	Type	Mandatory	Default Value
versionIds	Array	Y	N

Return:

Type	Description
Boolean	This method returns 'true' if moving was successful; otherwise, it returns 'false'.

Code Block

language	js
theme	Eclipse
title	moveVcsRecordsToDefault
linenumbers	true

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

preview(sysVcsRetrievedPackId)

This method extracts records related to the configuration from the Retrieved Records (sys_vcs_retrieved_record) table and performs a pack preview.

Parameter(s):

Name	Type	Mandatory	Default Value
retrievedPackId	Integer	Y	N

Return:

Type	Description
Boolean	This method returns TRUE 'true' if preview was successful; otherwise, it returns FALSE'false'.

Example:

Code Block

language	js
theme	Eclipse
title	preview
linenumbers	true

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 localpack. The localpack can be rollbacked only when it in the RollBack-Previewed state.

Parameter(s):

Name	Type	Mandatory	Default Value
packId	Integer	Y	N

Return:

Type	Description
String	Returns TRUE 'true' if rollback was successful; otherwise; throws an exception.

Example:

Code Block

language	js
theme	Eclipse
title	rollback
linenumbers	true

const vcsLocalPackId = '156144163704236641';
const vcs = new SimpleVcs();
if (vcs.rollBack(vcsLocalPackId)) {
  ss.addInfoMessage('RollBack of Local Pack was successful');
}

rollBackPreview(packId)

Parameter(s):

Name	Type	Mandatory	Default Value
packId	Integer	Y	N

Return:

Type	Description
Boolean	Returns TRUE 'true' if the rollback preview was successful; otherwise, returns FALSE'false'.

Example:

Code Block

language	js
theme	Eclipse
title	rollBackPreview
linenumbers	true

const vcsLocalPackId = '156144163704236641';
const vcs = new SimpleVcs();
if (vcs.rollBackPreview(vcsLocalPackId)) {
  ss.addInfoMessage('RollBack preview of Local Pack was successful');
}

Table of Contents

absoluteUrl	true
class	fixedPosition

Page tree

Versions Compared

Old Version 25

New Version Current

Key

SimpleVcs()

createTableSnapshot(tableName)

exportLocalPackVcsRecords(sysVcsLocalPackId)

importRetrievedPack(retrievedPackId)

isLocalPackHasReferences(localPackId)

isRetrievedPackHasReferences(retrievedPackId)

isRetrievedPackHasAttache(vcsRetrievedPackId)

loadDataFromAttachment(sysVcsRetrievedPackId)

mergeLocalPacks(rowIds, name, description)

moveVcsRecordsToDefault(versionIds)

preview(sysVcsRetrievedPackId)

rollback(packId)

rollBackPreview(packId)