FNP8_SetKeyProperty

Edit online

Sets the update key to a FileNet® document property and its corresponding property value.

Syntax

bool FNP8_SetKeyProperty(StrParam)

Parameters

Strings values identify a FileNet document class property and its corresponding property value. The document class property name and its value must exist on the destination FileNet P8 Object Store. The property value must also be unique because the call to the FNP8_UpdateProperties action returns only one value. Smart parameters are allowed for the second parameter.

Returns

False if either parameter is blank or if the value parameter is invalid. Otherwise, True.

Level

Batch, Document or Page level.

Details

This action sets a key that is used by the UpdateProperties action. The key is a FileNet document property id and its corresponding value. The UpdateProperties action uses the key to search for an existing FileNet document. If the document is found, the properties on the document are updated with the values specified in the SetProperty actions.
Example
FNP8_SetKeyProperty("DCKey,@DCKey")
FNP8_SetProperty("FNProperty,@SomeValue")
FNP8_SetKeyProperty("@FNProperty2,@SomeValue2")
FNP8_UpdateProperties()
FNP8_SetKeyProperty("DCKey,@DCKey")
FNP8_SetProperty("FNProperty,@SomeValue")
FNP8_SetKeyProperty("@FNProperty2,@SomeValue2")
FNP8_UpdateProperties()

This example uses the parameters of FNP8_SetKeyProperty("DCKey,@DCKey") to search for a FileNet document on an object store. If the FileNet document is found, it is assigned the values that are specified in the SetProperty action when the UpdateProperties action is called. The UpdateProperties action performs actions only on the first document that is returned. If more than one document matches the criteria that is specified in the SetKeyProperty action, only the first document is updated.