Routine Index

Page:

abs — Returns the absolute value of a number. The absolute value of a number is the number without its sign.
Page:

addComment — Posts a comment on the specified page or adds a reply to the specified comment.
Page:

addGroupToContentPermission — Adds a selected group to a content permission (usually to a page permission) if the group is not in that permission already.
Page:

addGroupToSpacePermission — Adds a given group to a space permission if the group is not in that permission already.
Page:

addGroupToSpacePermission routine — Adds a given group to a space permission if the group is not in that permission already.
Page:

addLabels — Adds one or multiple labels to a given page.
Page:

addMonths — Adds a number of months to a specified date, preserving the day of month where possible.
Page:

addUserToContentPermission — Adds a single user to a content permission if the user is not already in that permission.
Page:

addUserToGroup — Adds a single user to a group if the user is not in that group already.
Page:

addUserToSpacePermission — Adds a single user to a space permission if the user is not already in that permission.
Page:

addUserToSpacePermission routine — Adds a single user to a space permission if the user is not already in that permission.
Page:

addWebhookResponseHeader — Adds an HTTP header to the response that will be returned to the Webhook caller.
Page:

admActivateUser — Activates a user, setting its active flag to 'true', if the update is allowed.
Page:

admAddSpaceCategory — Adds a category in the space.
Page:

admArchiveSpace — Archives a space (takes a space key as a parameter).
Page:

admClearCache — Clears the internal cache.
Page:

admCloneSpace — Clones space with pages, labels, categories, attachments, permissions and look and feel.
Page:

admCreateGroup — Create a single group to a project role if the group does not already exist.
Page:

admCreateSpace — Creates a new space, optionally offering support for the category of the space.
Page:

admCreateUser — Creates a new user.
Page:

admDeactivateUser — De-activates a user (sets its active flag to 'false' or removes it from all groups associated to global login permissions).
Page:

admDeleteSpace — Permanently deletes a space from Confluence.
Page:

admDeleteSpaceCategory — Deletes a category from the space.
Page:

admGetSpace — Returns an instance of CSpace struct, takes a space key as a parameter.
Page:

admGetSpaceCategories — Returns the space categories (all).
Page:

admGetSpaceCategory — Returns a space category by name (takes a space key and space category as parameters).
Page:

admGetSpaceLayout — Returns a layout - a list of custom decorators defined for a specific space only (does not retrieve global decorators).
Page:

admGetSpaces — Takes a category name and returns an array of spaces (CSpace structs) in that category.
Page:

admGetSpaceStylesheet — Returns the custom stylesheet that has been stored against a space.
Page:

admSetSpaceLayout — Creates a decorator for the given spaceKey with the given name, and saves it.
Page:

admSetSpaceStylesheet — Adds a space stylesheet to customize the look and feel of a single space within Confluence.
Page:

admSpaceExists — Returns 'true' if space with provided key exists and 'false' otherwise.
Page:

admUnarchiveSpace — Unarchives a space (takes a space key as a parameter).
Page:

admUpdateSpace — Updates the space properties (takes space key and an instance of CSpace struct as parameters).
Page:

appendToWebhookResponse — Adds an object to the response that will be returned to the Webhook caller, as the HTTP body.
Page:

arrayAddElement — If elem is an element of the array type, returns a new array that includes the specified element at the end.
Page:

arrayAddElementIfNotExist — If elem is an element of the array type, returns a new array that includes the specified element at the end. The element is added only if it is not already in the array.
Page:

arrayDeleteElement — If elem is an element of the array type, returns a new array without the specified element.
Page:

arrayDeleteElementAt — If index is less than the array size, returns a new array without the element at the specified index.
Page:

arrayDiff — Difference between two arrays. Returns the elements from the first array that do not exist in the second array.
Page:

arrayElementExists — Returns "true" if the element exists in the array and "false" otherwise.
Page:

arrayFind — Finds an element inside the collection and returns its index. If the element is not found, it returns -1.
Page:

arrayFindBinary — Binary search on sorted array. If the element is not found, returns -1.
Page:

arrayGetElement — Returns the element at the specified index.
Page:

arrayIntersect — Intersect between two arrays.
Page:

arrayKeys — Returns the keys of the array.
Page:

arrayKeySort — Sorts the elements from an array by their keys. Works with keyed arrays only.
Page:

arraysConcat — Adds the elements of the second array to the first one.
Page:

arraySetElement — If elem is an element of the array type, returns a new array with the specified element on position index1.
Page:

arraySize — Returns the size of the given array.
Page:

arraySort — Sorts the elements from an array.
Page:

arrayStructMap — Returns an indexed array of structs mapped to a given field name.
Page:

arrayStructSort — Sorts the elements from an array by their specified field. Works only with arrays that contain structures.
Page:

arrayToSet — Converts an array to a set of unique elements.
Page:

arrayUnion — Union between two arrays.
Page:

attachFile — Adds an attachment to a selected page.
Page:

attachFileFromURL — Adds an attachment located on an URL path to a selected page.
Page:

base64Decode — Decodes from Base64. This is useful when transferring data like retrieving images stored in a database.
Page:

base64Encode — Encodes text in Base64.
Page:

bitwise_and — Takes two numbers as operands and does AND on every bit of two numbers.
Page:

bitwise_lshift — Takes two numbers, left shifts the bits of the first operand, the second operand decides the number of places to shift.
Page:

bitwise_not — Takes one number and inverts all bits of it.
Page:

bitwise_or — Takes two numbers as operands and does OR on every bit of two numbers.
Page:

bitwise_rshift — Takes two numbers, right shifts the bits of the first operand, the second operand decides the number of places to shift.
Page:

bitwise_rushift — Takes two numbers, right shifts the bits of the first operand.The vacant leftmost position is filled with 0 instead of the sign bit.
Page:

bitwise_xor — Takes two numbers as operands and does XOR on every bit of two numbers.
Page:

blogExists — Verifies whether a given blog is a registered Confluence blog.
Page:

call
Page:

ceiling
Page:

chop — Returns nmb characters from str, starting with the leftmost character.
Page:

clonePage — Clones the page and returns the id of the cloned page.
Page:

clonePageTree — Clones the page tree with its permissions.
Page:

comalaActivateSpaceWorkflow — Activate workflow in space.
Page:

comalaDeactivateSpaceWorkflow
Page:

comalaGetPageWorkflow — Returns the workflow that is set on a specified page.
Page:

comalaGetSpaceWorkflows — Returns a list of workflows that exist in the selected space.
Page:

comalaGetState — Gets the workflow state of the page from the Comala Document Management add-on.
Page:

comalaLoadWorkflowToPage — Sets workflows to the page according to a given markup.
Page:

comalaLoadWorkflowToSpace — Sets workflows to the space according to a given markup.
Page:

comalaRemoveAllWorkflowsFromSpace — Removes all workflows that exist in the selected space.
Page:

comalaRemoveWorkflowFromPage — Removes workflow of the selected page.
Page:

comalaRemoveWorkflowFromSpace — Removes the selected workflow that exists in the specified space.
Page:

comalaSetState — Sets the workflow state of the page using the Comala Document Management add-on.
Page:

contains — Returns true if character expression str2 is in character expression str1.
Page:

copyAttachment — Copies an attachment from one page to another.
Page:

copyAttachmentById — Copies the attachment for the provided id from one page to another.
Page:

copyPageContent — Copies page content from one page to another.
Page:

cos
Page:

countBlogs — Returns the number of blogs contained in the selected space.
Page:

countPages — Returns the number of pages that matched the CQL search query.
Page:

createBlog — Creates a blog based on the provided arguments.
Page:

createDirectory — Returns "true" if the directory was created successfully and "false" otherwise.
Page:

createFile — Creates an empty file.
Page:

createPage — Creates an issue based on the provided arguments.
Page:

currentDate — Returns the current date.
Page:

currentUser — Returns the key for the user that invoked the script.
Page:

currentUserFullName — Returns the full name (firstname, lastname) of the user that triggered the script.
Page:

currentUserName — Returns the user name (login) for the user that invoked the script containing currentUserName.
Page:

databaseAvailable
Page:

day — Returns a number representing the day of month: 1-31.
Page:

dayOfWeek — Returns the day of week.
Page:

decrypt — Decrypts text with AES Decryption using a 16, 32, 64, or 128 bit cipher.
Page:

degrees
Page:

deleteAttachment — Deletes the attachment for a given id or for a specified page and file name.
Page:

deleteAttachmentVersion — Deletes the attachment version.
Page:

deleteBlog — Places the selected blog in the trash.
Page:

deleteComment — Deletes a comment with the specified id, deletes the latest comment or deletes all comments from a given page.
Page:

deleteFile — Deletes a file. It also returns "true" if the file was deleted successfully and "false" otherwise.
Page:

deletePage — Deletes the selected page.
Page:

deletePageTree — Deletes the selected page and all its child pages.
Page:

directoryExists — Returns "true" if the directory exists and "false" otherwise.
Page:

e number
Page:

editComment — Edits a comment with the specified id and text. Returns the comment representation after the edit.
Page:

encrypt — Encrypts text with AES encryption using a 16, 32, 64, or 128 bit cipher.
Page:

endOfMonth — Returns a date set on the last day of the month for the given date.
Page:

endsWith — Returns true if str1 ends with str2.
Page:

escapeHtml — Escapes the given html removing traces of offending characters that could be wrongfully interpreted as markup.
Page:

excludeSubarray — Returns an array excluding the array that starts at index 'start' and ends at index 'end'.
Page:

executeTemplate — Executes a template. All variables already defined in the script are passed to that template.
Page:

exp
Page:

fact
Page:

fileClose — Closes a previously opened file and removes it from memory.
Page:

fileContains — Returns "true" if the file contains any string that matches the specified regex.
Page:

fileCopy — Copy a file from one location to another.
Page:

fileExists — Returns 'true' if the file exists and 'false' otherwise.
Page:

fileInfo — Returns basic file information about a file such as the date it was created.
Page:

fileMove — Moves a file from one location to another.
Page:

fileOpen — Opens a file in memory so that it may be read from.
Page:

fileRead — Reads a byte array from a file until it reaches the specified length or until the EOF is reached.
Page:

fileReadByte — Reads a byte from an open file.
Page:

fileReadLine — Reads a line of text from an open file until it reaches the end of the line (\n or \r\n). Stops also on EOF (end of file).
Page:

fileSeek — Moves the file pointer to a specific spot in an already open file. If the position is negative, moves the file pointer at the end of the file. If the position is 0 (zero) it moves the pointer at the beginning of the file.
Page:

fileSHA256Checksum — Returns the SHA256 checksum of the file.
Page:

fileSize — Returns the size for a given file.
Page:

fileTruncate — Clears the content of the specified file. Creates a new file if the one you want to clear content for doesn’t exist.
Page:

fileWrite — Writes text or byte data to an open file.
Page:

findDirectories — Searches for directories that match the given regex in the specified folder.
Page:

findFiles — Searches for files that match the given regex in the specified folder.
Page:

floor
Page:

formatDate — Formats the given date into a date/time string accordingly to the given format expression.
Page:

formatNumber
Page:

fromJson
Page:

getAllCommentIds — Gets all the comment IDs that are already entered on a page.
Page:

getAllGroups — Gets a list of all groups in Confluence.
Page:

getAllSpaces — Returns a string array with the keys of all spaces in Confluence.
Page:

getAttachment — Returns CAttachment with the following fields: id, pageId, spaceKey, version, creationDate, lastModificationDate, size, name.
Page:

getBlog — Retrieves a blog ID by searching for space key, blog title and posting date.
Page:

getBlogs — Returns all blogss of a space, by space key.
Page:

getBlogsInPeriod — Returns blogs of a space, by space key, date and period.
Page:

getBlogURL — Retrieves a blog URL by blog ID.
Page:

getChildPages — Get the list of child pages (direct children) for a selected page.
Page:

getCommentById — Gets all the comment properties for a given id.
Page:

getComments — Returns comments for a given page.
Page:

getConfluenceBaseUrl — This routine returns Confluence base url where the SIL script is called.
Page:

getLastComment — Gets all the comment properties for the last page comment.
Page:

getNewestBlog — Retrieves a newest blog ID for space, by space key.
Page:

getPage — Retrieves a page ID by searching for space key and page title. The routine will return a -1 if the page is not found.
Page:

getPages — Returns all descendants of a page (all levels, not only direct children) or a set of pages matching space key and title.
Page:

getPageURL — Returns the URL of the page.
Page:

getPersistentVar — Gets the persistent var, as a string
Page:

getScheduledJobKeys — Returns the list of scheduled jobs keys.
Page:

getScheduledJobKeysByScript — Returns the list of scheduled jobs keys by the path of the script they use and the optional parameter args.
Page:

getSpaceKeyByName — Retrieves the key for the space with the given name.
Page:

getUser — Gets the user by username or key.
Page:

getUserByEmail — Gets the user by email address.
Page:

getUserByFullName — Gets the user by their full name.
Page:

getUserDirectoryName — Returns the directory name the user belongs to (takes user name or key as a parameter).
Page:

getUserKeysFromEmails — Finds the corresponding user keys for a list of email addresses.
Page:

getUserProperty — Gets the specified user property.
Page:

getWebhookPayload — Gets the Webhook payload from the calling client.
Page:

groupContentPermissions — Returns the permissions of the provided group for the specified content.
Page:

groupExists — Verifies if the selected group is a registered Confluence group.
Page:

groupHasContentPermission — Checks if a group has the specified content permission.
Page:

groupHasSpacePermission — Checks if a group has the specified space permission.
Page:

groupHasSpacePermission routine — Checks if a group has the specified space permission.
Page:

groupSpacePermissions — Returns the permissions of the provided group in the space.
Page:

groupSpacePermissions routine — Returns the permissions of the provided group in the space.

Page:

hashString — Returns a consistent hash to be used across systems.
Page:

hasUserProperty — Checks if the user has the given property set.
Page:

hour — Returns the hour of the provided date: 0-23.
Page:

httpBasicAuthHeader — Creates an HttpHeader object to be used as Authorization header for a Basic authentication of a user.
Page:

httpCreateCookie — Creates an HttpCookie object.
Page:

httpCreateHeader — Creates an HttpHeader object.
Page:

httpCreateParameter — Creates an HttpQueryParam object.
Page:

httpDelete — Executes an HTTP DELETE for a given URL using the specified HttpRequest object.
Page:

httpGet — Executes an HTTP GET for the given URL using the specified HttpRequest object.
Page:

httpGetCookie
Page:

httpGetErrorMessage
Page:

httpGetHeader
Page:

httpGetReasonPhrase
Page:

httpGetResponseInfo — Retrieves the complete response information (if existing) from the latest HTTP routine call.
Page:

httpGetStatusCode
Page:

httpOptions — Executes an HTTP OPTIONS for the given URL using the specified HttpRequest object.
Page:

httpPatch — Executes an HTTP PATCH for the given URL using the specified HttpRequest object.
Page:

httpPost — Executes an HTTP POST for the given URL using the specified HttpRequest object.
Page:

httpPut — Executes an HTTP PUT for the given URL using the specified HttpRequest object.
Page:

i18nText — Returns the i18n text if the key can be resolved. Otherwise, the key itself will be returned.
Page:

indexOf — Returns the index of the first match of the str2 in str1 or -1 if str2 is nowhere to be found in str1.
Page:

isAlpha — Returns "true" if the provided argument str is a string containing only letters.
Page:

isAlphaNumeric — Returns "true" if the provided argument str is a string containing only letters and digits.
Page:

isAnyUserAuthenticated — Verifies if there is a logged in user.
Page:

isDigit — Returns "true" if the provided argument str is a string containing only digits.
Page:

isLower — Returns "true" if the provided argument stris a string containing only lowercase letters.
Page:

isNotNull — Checks if the provided variable is not null or has a value associated and returns true. Otherwise returns false.
Page:

isNull — Checks if the provided variable is null or has no value associated then returns "true", otherwise returns "false".
Page:

isNumeric — Returns "true" if the provided argument stris actually a number.
Page:

isUpper — Returns "true" if the provided argument str is a string containing only upper letters.
Page:

join — Returns the string obtained by concatenating all the strings from the array using the provided delimiter.
Page:

lastExceptionClass — Returns the class of a Java class exception when an error is thrown.
Page:

lastExceptionMessage — Returns the message of a Java class exception when an error is thrown.
Page:

lastIndexOf — Returns the index within a string of the last occurrence of the specified substring.
Page:

ldapUserAttr — Returns an array of the requested attribute.
Page:

ldapUserList — Returns an array of the requested attributes for all users matching the query.
Page:

ldapUserStruct — Returns an array of JLdapUserStruct representing all users matched by the query.
Page:

length — Returns the length of the provided string, 0 if the string is null or has no chars.
Page:

ln
Page:

log
Page:

logPrint — Prints a message in the configured Jira logs on the specified level: TRACE, DEBUG, INFO, WARN, ERROR, FATAL.
Page:

matchEnd — Returns the position where the match ends or -1 if it doesn't match.
Page:

matches — Returns "true" if character expression string matches the regular expression regex.
Page:

matchReplace — Uses a regex expression to find and replace text within a string.
Page:

matchStart — Returns the position where the match starts or -1 if it doesn't match.
Page:

matchText — Returns the text matched or empty string if it doesn't match.
Page:

millisToDate — Converts milliseconds to a date.
Page:

millisToInterval — Converts milliseconds to a time interval.
Page:

minute — Returns the minutes of the provided date: 0-59.
Page:

month — Returns a number representing the month of the provided date (1-12).
Page:

monthName — Returns the month name of the provided date.
Page:

moveBlog — Moves the selected blog to a new space.
Page:

movePage — Moves the selected page to a new parent page.
Page:

pageExists — Verifies whether a given page is a registered Confluence page.
Page:

parseDate — Returns the parsed date according to the format you provided. If parse fails, it will return a null date.
Page:

permanentDeleteBlog — Permanently delete a given blog.
Page:

pi
Page:

power
Page:

print — Returns the printable string in the application log.
Page:

printInFile — Prints in the specified file the provided value.
Page:

radians
Page:

rand
Page:

random
Page:

readFromBinaryFile — Read the text of a binary file.
Page:

readFromCSVFile — Reads the values from the CSV file, returning them to an array, of N rows * M columns values.
Page:

readFromTextFile — Read the text of the file.
Page:

removeAllGroupRestrictionsFromContent — Removes all group restrictions on the page for the selected group
Page:

removeAllUserRestrictionsFromContent — Removes all user restrictions on the page for the user
Page:

removeGroupFromContentPermission — Removes a single group from a content permission if the group is in that permission.
Page:

removeGroupFromSpacePermission — Removes a single group from a space permission if the group is in that permission.
Page:

removeGroupFromSpacePermission routine — Removes a single group from a space permission if the group is in that permission.
Page:

removeUserFromContentPermission — Removes a single user from a content permission if the user is in that permission.
Page:

removeUserFromGroup — Removes a single user from a group if the user is in that group.
Page:

removeUserFromSpacePermission — Removes a single user from a space permission if the user is in that permission.
Page:

removeUserFromSpacePermission routine — Removes a single user from a space permission if the user is in that permission.
Page:

renameFile — Renames a file.
Page:

replace — Replaces the search_str string with replacement_str in str and returns the resulting string.
Page:

roman
Page:

round
Page:

runJobAt — Runs a job at the specified date.
Page:

runJobByCron — Runs the job according to the specified cron schedule.
Page:

runJobIn — Runs a job in a specified interval.
Page:

runJobInAndRepeat — Runs a job every specified interval.
Page:

runnerLog — Puts the 'message' on the console of a runner gadget.
Page:

runSILInline
Page:

saveURLToFile
Page:

second — Returns the seconds of the provided date: 0-59.
Page:

selectPages — Returns an array with the IDs of the pages that match the search query.
Page:

sendEmail
Page:

sendHtmlEmail
Page:

sendIntegrationMessage
Page:

sendSMS
Page:

serverInfo — Returns some basic information about the Jira server.
Page:

setPersistentVar — Sets the persistent var, as a string
Page:

setUserProperty — Sets properties of users.
Page:

sign
Page:

silEnv — Returns the variable as presented in the environment.
Page:

sin
Page:

split — Returns the array of strings computed by splitting this string around matches of the given regular expression.
Page:

sql — Executes the SQL phrase over the defined datasource.
Page:

sqlCallStoredProcedure
Page:

sqlCallStoredProcedureWithOutParams
Page:

sqrt
Page:

startOfDay — Returns a date, but strips off the hours, minutes and seconds.
Page:

startOfMonth — Returns a date set on the first day of the month for the given date. Also sets hours/minutes/seconds to 0.
Page:

startsWith — Returns "true" if str1 starts with str2.
Page:

subarray — Returns an array starting with index 'start' and ending at index 'end'.
Page:

substring — Returns substring is starting at index start and stop at index stop.
Page:

system
Page:

tan
Page:

toDate — Creates a date value from the specified parameters.
Page:

toJiraDateFormat — Displays the given date using Jira format.
Page:

toJson — Converts any given struct, array or primitive parameter to a JSON string.
Page:

toLower — Returns the string only with lower case letters.
Page:

toRawWorkingInterval — Returns a date interval converted to the specified number of hours per day.
Page:

toTimeZone — Converts a date to the specified time zone.
Page:

toUpper — Returns the string only with upper case letters.
Page:

trim — Returns a trimmed copy of the string passed as parameter with the leading and trailing whitespaces removed.
Page:

trunc
Page:

unscheduleJob — Un-schedules a job.
Page:

updateUsername — Change the username for a user.
Page:

urlDecode — Decodes text from URL format. This is useful when parsing a URL address used by a REST command.
Page:

urlEncode — Encodes text in URL format.
Page:

userContentPermissions — Returns the permissions of the provided user for the specified content.
Page:

userEmailAddress — Returns email address of the selected user. The email address may be needed to supply it to the various external systems.
Page:

userExists — Checks whether the specified user is a registered Confluence user.
Page:

userFullName — Returns the full name (firstname and lastname) of the specified user.
Page:

userGroups — Returns the groups where the selected user belongs.
Page:

userHasAccessToComment — Verifies whether a comment is visible for a user.
Page:

userHasContentPermission — Checks if a user has the specified content permission.
Page:

userHasSpacePermission — Checks if a user has the specified space permission.
Page:

userHasSpacePermission routine — Checks if a user has the specified space permission.
Page:

userInGroup — Verifies whether the selected user is in the selected group(s).
Page:

userKeyToUserName — Returns user name of the user with the provided user key.
Page:

userLanguage — Returns the language for a user.
Page:

userNameToUserKey — Returns the user key for the provided user name.
Page:

usersInGroups — Returns a list of users common to all the specified groups.
Page:

usersInSpacePermission — Returns users that correspond to a certain permission in the specified space.
Page:

usersInSpacePermission routine — Returns users that correspond to a certain permission in the specified space.
Page:

userSpacePermissions — Returns the permissions of the provided user in the space.
Page:

userSpacePermissions routine — Returns the permissions of the provided user in the space.
Page:

week — Returns the week number in the year of the provided date.
Page:

writeToBinaryFile — Prints bytes to a specified file. The file can be overwritten or appended to.
Page:

year — Returns the year of the provided date.
Page:

zipFiles — Adds a file or an array of files to a zip file.