RemoveNotification

You can use the RemoveNotification function to remove a specific notification from a field or property of an Optiva object.

When to use

You can use this function to:

  • Remove notification indicators from specific fields after issues are resolved or corrections are made.
  • Clear notifications when validation passes or required data is provided in workflows.

When not to use

You cannot use this function to clear all notifications. Use ClearNotifications for bulk notification removal.

Syntax

long RemoveNotification(string propertyName, string objSymbol = "", string objectKey = "", string detailCode = "", string rowKey = "");

Parameters

Parameter Type Required Description
objSymbol string Yes

The symbol of the object.

Note: You can use empty quotation marks ("") for the current workflow symbol.
objKey string Yes

The key of the object.

Note: You can use empty quotation marks ("") for the current workflow symbol.
propertyName string Yes The property name or field name that has the notification.
DetailCode string Yes The system detail code used to return the DataSet.
rowKey string No Reserved for future use.

Return Value

The application returns a value greater than zero (0) if the operation is successful.

Impact

  • The application immediately persists changes.
  • The changes cannot be undone.

Prerequisites

You can remove only notifications that exist on the specified field.

RemoveNotification vs ClearNotifications

Feature RemoveNotification ClearNotifications
Scope Single field/property All notifications on object.
Granularity Specific field Entire object.
Use Case Clear one notification Clear all notifications.
Parameters Requires property name Requires object identification.

Examples

Example 1
Remove Notification from Current Object. 
RemoveNotification("DESCRIPTION");
return 111;
Description
In this example, The following line of code will remove this specific Notification from the current object.
Related topics