CalculateUserRatingAvg

Returns the average feedback rating for a knowledge article.

Syntax

CalculateUserRatingAvg()

Enabled For

For a description of the business object categories, see Notes on "Enabled For".

Business Object Category Yes/No
Business Rules: Before-Save Rules Yes1
Business Rules: Calculation Rules (After Save, with or without Also Recalculate on Load) Yes1
Business Rules: Calculation Rules (Before Save or Always, without Also Recalculate On Load) Yes1
Business Rules: Calculation Rules (Before Save or Always, with Recalculate On Load) Yes1
Business Rules: Editing Rules Yes2
Business Rules: Initialization Rules Yes1
Business Rules: Read Only Rules No
Business Rules: Required Rules Yes2
Business Rules: Validation Rules Yes1
Client Expressions No
Object Permissions Yes
Services Yes
LDAP Yes
Mobile Yes
Quick Actions (except UI Quick Actions) Yes1
UI Quick Actions No
Reports Yes1
Search/Dashboard without field references Yes1
Search/Dashboard with field references Yes1
1. Except in services.
2. Except in services and when this field appears on a form or is triggered by such a field.

Parameters

none

Return Value

Text value.

Example

$(CalculateUserRatingAvg())

In the above example, the application retrieves all the feedback records related to the current knowledge article and returns the average of rating numbers in the feedback.