How Can We Help?

Extension Methods

Use power, features and UI of Extension Kit to execute custom code of issues that are not solved by Extension Kit.

Configuration

After you have successfully installed the application, you should configure Extended Methods.

  1. Open M-Files Admin
  2. In the left-side tree view, expand the desired connection to M-Files Server.
  3. In the left-side tree view, expand the Document Vaults node.
  4. Still, in the left-side tree view, expand the vault where you installed the connector and select Configurations.
  5. Expand Other Applications
  6. Expand Extension Kit
  7. Click on Extension Methods

Field description

FieldValueDescription
EnabledYes/NoSpecifies whether the module is in use.
Configuration modeSimple/AdvancedDisplay simple or advanced configuration options for module.
Rule groups [n] > Group [n]
NameTextSpecifies the name of rule group.
Rule groups [n] > Group [n] > Rules [n] > Rule [n]
NameTextSpecifies the name of the rule.
DescriptionTextOptional rule description.
EnabledYes/NoSpecifies whether the rule is in use.
Configuration modeSimple/AdvancedDisplay simple or advanced options for rule.
Trigger typeOne of the following:
·        ObjectCreated
·        ObjectChanged
·       ObjectEnteredState
·        OnComment
·        Scheduled
·        RunOnce
Type of event that triggers the execution of this rule.
ObjectCreated. If this option is selected, rule will be executed when the source object is created.
ObjectChanged. If this option is selected, rule will be executed when any change is made to the source object
ObjectEnteredState. If this option is selected, rule will be executed when the source object has entered a new state.
OnComment. If this option is selected, rule will be executed when the source object has new comment.
RunOnce. If this option is selected, rule will be run only once and on all matching objects in vault. NOTE: On vault restart, all enabled rules with Run once trigger will be run immediately.
Rule groups [n] > Group [n] > Rules [n] > Rule [n] > Monitored properties
Property definitionProperty definitionProperty definition that needs to change in order for rule to be executed. Multiple properties are combined with OR operator, meaning that at least one of the properties has to change for rule to be executed.
Rule groups [n] > Group [n] > Rules [n] > Rule [n] > Trigger source
Object typeObject typeObject type of source object.
ClassClassClass of source object.
WorkflowWorkflowWorkflow of source object.
StateStateWorkflow state of source object
Rule groups [n] > Group [n] > Rules [n] > Rule [n] > Trigger source > Search filters [n] > Filter [n]
Search conditionsSearchConditionsOptional additional conditions that source object needs to satisfy.
Conditions inside a single filter are combined with AND, while multiple filters are combined with OR operator.
Rule groups [n] > Group [n] > Rules [n] > Rule [n] > Trigger source > Search filters [n]
Look inOne of the following:
·        LatestObjVersion
·        AllObjVersion
When trying to matching the above source
conditions, look in all object versions, or only the latest one.
Latest obj version. If this option is selected, the
current object version must match the specified conditions for an object to be treated as a source for this rule.
All obj versions. If this option is selected, any object version must match the specified conditions for object to be treated as source for this rule.
Rule groups [n] > Group [n] > Rules [n] > Rule [n] > Vault search [n] > Search [n] > Status field conditions [n] > Status field condition
FieldOne of the following:
·        ID
·        Type
·        Version
Status field.
OperatorOne of the
following:
·        =
·        =!
·        < 
·        > 
·        <=
·        · >=
Operator to use for comparing actual and expected property value.
ValueStatus field valueExpected status field value.
Rule groups [n] > Group [n] > Rules [n] > Rule [n] > [Advanced] Vault search [n] > Search [n] > Property conditions [n] > Property condition [n]
PropertyProperty definitionSpecifies the property whose value will be checked
OperatorOne of the
following:
·        =
·        =!
·        < 
·        > 
·        <=
·        >=
·        Contains
·        Does not
·        contain
·        Starts with
·        Does not start with
Operator to use for comparing actual and expected property value.
ValueStatus field valueExpected status field value.
Rule groups [n] > Group [n] > Rules [n] > Rule [n] > [Advanced] Vault search [n] > Search [n] > Property conditions [n] > Property condition [n]
PropertyProperty definitionSpecifies the property whose value will be checked
OperatorOne of the
following:
·        =
·        =!
·        < 
·        > 
·        <=
·        >=
·        Contains
·        Does not
·        contain
·        Starts with
·        Does not start with
Operator to use for comparing actual and expected property value.
Rule groups [n] > Group [n] > Rules [n] > Rule [n] > [Advanced] Vault search sort
Sort byProperty definitionSort search results by property.
Sort directionOne of the following:
Ascending
Descending
Specifies in which direction results can be shown.
Rule groups [n] > Group [n] > Rules [n] > Rule [n]
Search timeout (seconds)IntegerSearch timeout in seconds.
Rule groups [n] > Group [n] > Rules [n] > Rule [n] > Extension method
NamePlaceholder TextExtension method name.
InputPlaceholder TextExtension method input.
Value fromOne of the following:
·        VaultSearch
·        Source
Specifies whether to resolve placeholder expressions from trigger source or from vault search.
Result typeOne of the following:
·        None
·        SimpleValue
·        ObjectID
·        ObjectName
·        ValueListItemID
·        ValueListItemName
Specifies what the result represents.
Rule groups [n] > Group [n] > Rules [n] > Rule [n]
Target propertyProperty definitionOptional save Extension method returns value to selected property.
Target objectOne of the following:
·        TriggerObject
·        VaultSearch
Specify whether extension method result will update property on trigger source object, or vault search result object.
Advanced settings
Time to wait (milliseconds)IntegerNumber of milliseconds to wait before executing any rule in background.
Number of retriesIntegerMaximum numbers of times COM errors are retried.

Use Cases

Migrate your legacy code

Customer was using M-Files for over 8 years and his internal development was using different approaches when developing M-Files actions. They have used VAF application and VB scripts. All legacy VAF methods are executed with Extension methods and now have all their processes supported in one place.

Expand what M-Files and Extension kit can’t

Customer has use-cases and calculations that can’t be solved using Extension Kit. They have developed methods and are executing them in certain events using Extension Methods.

Table of Contents
FREE WEBINAR

Unlock the full potential of M-Files

No coding, faster configuration and better quality for your clients. See Extension Kit in action!