IObjectPropertyAutoAction

By implementing the IObjectPropertyAutoAction interface in a application script, you can define custom actions that are automatically performed when the user manually modifies the value of an object property.

Note:

Interface methods are also called in both variants of the Alvao.API.AM.ObjectProperty.Update method.
The AM Console command - Properties tab - Generate Value does not call the OnObjectPropertyModifying method. It only calls the OnObjectPropertyModified method.

Tip:

To store properties and action settings, we recommend defining the Settings class in a separate script that you create from the Class Library template.

Tip:

A prerequisite for creating a working automated action is a good knowledge of the Alvao database, Service Desk WebService API and Alvao.API.

Caution:

If you want to use only some of the methods of the implemented interface in the automatic action, leave an exception in the body of the other methods from the interface: throw new NotImplementedException();.

Interface Methods

Method	Description
OnObjectPropertyModifying	The value of the property will be changed.
OnObjectPropertyModified	The value of the property has been changed.

OnObjectPropertyModifying

This method is called before saving the modified property value to the database, e.g. within the Modify (property) statement.

Syntax: Tuple<bool, string> OnObjectPropertyModifying(SqlConnection con, int propertyId, int personId, string newValue)
Parameters:
- con - SqlConnection to the database.
- propertyId - ID of the property (tblProperty.intPropertyId) that is being modified.
- personId - the ID of the user (tPerson.iPersonId) who invoked the action.
- newValue - new value of the property.
Return values:
- bool - if the method returns true, the new value is written to the database. If the method returns false, the operation is not performed and the upcoming property value change is canceled.
- string - the message that is displayed to the user if the return value is false.

For an example, see the CheckPhoneNumberFormat application template.

OnObjectPropertyModified

This method is called after writing a new property value to the database, e.g. by the Modify (property) statement.

Syntax: void OnPropertyModified(SqlConnection con, int propertyId, int personId)
Parameters:
- con - SqlConnection to the database.
- propertyId - ID of the property (tblProperty.intPropertyId) that has been changed.
- personId - the ID of the user (tPerson.iPersonId) who invoked the action.
Return value: none.

For an example use case, see the CopyNewPropertyValueToAnotherProperty application template.

Did not find what you were looking for? Ask our technical support team.