Example: Function to control close button label in Change Management

Search for	Example	Results
A single word	`cat`	Topics that contain the word "cat". You will also find its grammatical variations, such as "cats".
A phrase. You can specify that the search results contain a specific phrase.	`"cat food"` (quotation marks)	Topics that contain the literal phrase "cat food" and all its grammatical variations. Without the quotation marks, the query is equivalent to specifying an OR operator, which finds topics with one of the individual words instead of the phrase.

Search for	Operator	Example
Two or more words in the same topic	`AND` `and` `+` (plus symbol) `&` (ampersand)	`cat AND dog` `"cat food"+milk` `"cat food"&"dog food"`
Either word in a topic	`OR` `or` `\|` (pipe)	`cat OR dog` `cat \| dog`
Topics that do not contain a specific word or phrase	`NOT` `not` `!` (exclamation point)	`NOT cat` `! dog`
Topics that contain one string and do not contain another	`^` (caret)	`cat ^ mouse`
A combination of search types	`( )` parentheses	`cat + (dog \| mouse)` `cat \| dog + (! mouse)`

Change Management uses the getCloseLabel() function to control what label to display on the Close button. The labels are Close Task, Close Change, or Close Phase. Included in this function is code to process a special case, Unplanned Changes, in the out-of-box system. This code can serve as an example for Administrators who need to customize the Close button label for other special cases.

The function is getCloseLabel(filename, currentPhase, file) in the ScriptLibrary file changeManagement. The details are as follows:

function getCloseLabel(filename, currentPhase, file)

filename: name of the table we are currently on, cm3r for Change record, cm3t for Task

currentPhase: current phase of the change or task

file: the file record

This function is currently called from the cm.view.display display screen.

Example:

$L.close.label=jscall("changeManagement.getCloseLabel", filename($L.filed), current.phase in $L.file, $L.filed)