Field And Form Rules - Supported JavaScript Functions

By default, script should be written in JavaScript format only. Moreover, jQuery and $CS have been added in global scope, thus allowing the user to write code using jQuery (v 1.8.3) and $CS library. (Note: $ is not supported for accessing elements using jQuery).

JavaScript functions Available in $CS Library 

• $CS.getValue(field) 

• You can get the value of a field by using this function.

1. var statusId=$CS.getValue("STATUS"); 

2. var subject= $CS.getValue("SUBJECT");

3. var created_date=$CS.getValue("CREATEDDATE");  //This will return a JavaScript Date Object

4. var additional_hardware=$CS.getValue("RES_3_QUS_3"); //For checkbox type resource fields returns an array of selected resources

5. var email_id=$CS.getValue("REQUESTER.EMAILID"); 

6. var department=$CS.getValue("REQUESTER.DEPARTMENT"); 

7. var job_title=$CS.getValue("REQUESTER.JOBTITLE"); 

8. var mobile_number=$CS.getValue("REQUESTER.MOBILE"); 

9. var contact_number=$CS.getValue("REQUESTER.CONTACTNUMBER");

• $CS.setValue(field,value) 

• You can set the value of a field by using this function.

• For input text type fields, this function sets the input text.

• For select (Pick List) type fields, this function sets the value of the selected option.

• $CS.getText(field) 

  • You can get the selected option text of a field by using this function.

  • This function should be used only for select (Pick List) type fields.

• $CS.setText(field,text) 

• You can set selected option text of a field by using this function.
• This function should only be used for select (Pick List) type fields.

• $CS.addOptions(field,options)

• You can add options to a field by using this function.

• Here, the options should be an  array  of options.

• This function should be used only for select (Pick List) type fields. 

• $CS.removeOptions(field,options)

• You can remove the existing options of a field by using this function.

• Here, the options should be an array of options.

• This function should be used only for select (Pick List) type fields. 

• $CS.removeAllOptions(fields)

• You can remove all the existing options of one or more select (Pick List) type fields by using this function.

• Here, the fields should be an array of fields whose options need to be removed.

• $CS.enableField(fields)

• You can enable one or more fields by using this function.

• Here, the fields should be an array of fields that you wish to enable.

• $CS.disableField(fields)

• You can disable one or more fields by using this function. This allows the user only to view the fields, but not to edit them.

• Here, the fields should be an array of fields that you wiish to disable.

• $CS.hideField(fields)

• You can hide one or more fields by using this function. This restricts the user from viewing those fields.

• Here, the fields should be an array of fields that you wish to hide.

• $CS.showField(fields)

• You can show one or more hidden fields by using this function. This allows the user to view those fields.

• Here, the fields should be an array of fields that you wish to show.

• $CS.mandateField(fields)

• You can mandate one or more fields by using this function. This restricts the user from submitting the form without filling values for those fields.

• Here, the fields should be an array of fields that you wish to mandate.

• $CS.nonMandateField(fields)

• You can remove mandate from one or more fields by using this function. This allows the user to submit the form without filling values for those fields.       

• $CS.stopFormSubmission()

• You can use this function to stop form submission. 

• This function will work only when applied to "On Form Submit" event.

• $CS.isRequester()

• You can use this function to find if a logged-in user is a Requester or not.

• This function returns the value True, if the logged-in user is a Requester, else returns the value False. 

• $CS.isTechnician()

• You can use this function to find if a logged-in user is a Technician or not.

• This function returns the value True, if the logged-in user is a Technician, else returns the value False.

• $CS.hasRole(role)

• You can use this function to find if a logged-in user has the assigned role.

• This function returns the value True, if the logged-in user possesses the assigned role, else returns the value False.

• $CS.getLoggedInUserId()

• You can use this function to get the User ID of a logged-in user. 

• $CS.getLoggedInUserName()

• You can use this function to get the User Name of a logged-in user.

• $CS.setFieldDependency(dependencyObject)

• You can use this function to set dependency among the fields based on dependency JSON Object. 

• Here, the same function works for both two-field and three-field dependencies.

1. $CS.setTasks(["templateTask1","templateTask2","templateTask3"]);

• $CS.unSetTasks(tasksArray)

• You can set an array of given task ids by using this function.

1. $CS.unSetTasks(["templateTask1","templateTask2","templateTask3"]);

• $CS.setDescription(description)

• You can set content of description field by using this function.

• You can get content of description field by using this function.

1. var descriptionContent=$CS.getDescription();

• $CS.disableOptions(fieldId,options)

• You can disable options of a field by using this function.

• This function should be used only for select (Pick List) type fields. 

• Here, the options should be an array of options.

1. $CS.disableOptions("STATUS",["Open","Closed"]);

• $CS.enableOptions(fieldId,options)

• You can enable the disabled options of a field by using this function.

• This function should be used only for select (Pick List) type fields. 

• Here, the options should be an array of options.

1. $CS.enableOptions("STATUS",["Open","Closed"]);

• $CS.isVisible(field)

• You can check whether a field or resource is currently visible by using this function.

1. var isPriorityFieldVisiable=$CS.isVisible("PRIORITY");

• $CS.isEnabled(field)

• You can check whether a field or resource is currently enabled for editing by using this function.

1. $CS.isEnabled("PRIORITY");

• $CS.isMandated(field)

  • You can check whether a field or resource is currently mandated by using this function.

1. $CS.isMandated("PRIORITY");