topic How to Schedule a Custom Action? in Alfresco Archive

How to Schedule a Custom Action?

drphoton — Mon, 02 May 2011 16:26:05 GMT

Hi,I have a custom action defined which works well through the user interface. The action in question is the antivirus action found here http://wiki.alfresco.com/wiki/Antivirus.I'm now trying to schedule this action to execute every week, but without any luck. The scheduler seems to run, but the act

Re: How to Schedule a Custom Action?

mikemars — Mon, 16 May 2011 16:07:13 GMT

Hi,

I seem to remember when I set up a scheduled action that the action template bean definition had to include the 'parameterTemplates' property (even if your action doesn't take a parameter).

i.e:


<bean id="antivirusScan" class="org.alfresco.repo.action.scheduled.SimpleTemplateActionDefinition">
        <property name="actionName">
            <value>antivirus-action</value>
        </property>
        <property name="parameterTemplates">
            <map>
                <entry>
                    <key>
                        <value>a-parameter</value>
                    </key>
                    <value>a-value</value>
                </entry>              
            </map>
        </property>
        <property name="templateActionModelFactory">
            <ref bean="templateActionModelFactory"/>
        </property>
        <property name="dictionaryService">
            <ref bean="DictionaryService"/>
        </property>
        <property name="actionService">
            <ref bean="ActionService"/>
        </property>
        <property name="templateService">
            <ref bean="TemplateService"/>
        </property>
    </bean>
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

It may be worth just putting in a dummy parameter and giving it a go.

Hope that helps.

Re: How to Schedule a Custom Action?

drphoton — Mon, 16 May 2011 16:42:15 GMT

Hi,

Thank you for the suggestion, but I have already tested that and unfortunately it doesn't work.

Have any other ideas?

Re: How to Schedule a Custom Action?

mikemars — Tue, 17 May 2011 10:07:20 GMT

I was able to replicate your issue.

To do this I gave the "actionName" property an invalid value.

So i'd suggest checking your following property for a typo:

<property name="actionName">
<value>antivirus-action</value>
</property>

and make sure that "antivirus-action" exactly matches the bean id you assigned to the action you trying to execute.

Re: How to Schedule a Custom Action?

mikemars — Tue, 17 May 2011 10:14:49 GMT

I can see from the wiki that the bean is named "antivirus-action".

Your config file looks fine, from the log it appears that it's unable to find the action bean. I'm not sure why that should be I'm afraid.

Sorry I couldn't be more help.

Re: How to Schedule a Custom Action?

drphoton — Thu, 19 May 2011 13:47:41 GMT

After doing some more tests, it looks like the only actions that can be scheduled are the built-in actions. Can anyone confirm this? Is this the intended behavior or is it a bug? Is there a workaround to this issue?

Any help will be appreciated.

Re: How to Schedule a Custom Action?

mikemars — Fri, 20 May 2011 15:12:52 GMT

You can schedule custom actions, I am running one.

The only other thing I can think of is to confirm with you that when you added the 'parameterTemplates' tag; that you also added the code to your action to accept the parameter.

e.g in your scheduled-action-services-context.xml:

<bean id="antivirusScan" class="org.alfresco.repo.action.scheduled.SimpleTemplateActionDefinition">
        <property name="actionName">
            <value>antivirus-action</value>
        </property>
        <property name="parameterTemplates">
            <map>
                <entry>
                    <key>
                        <value>a-parameter</value>
                    </key>
                    <value>a-value</value>
                </entry>             
            </map>
        </property>
        <property name="templateActionModelFactory">
            <ref bean="templateActionModelFactory"/>
        </property>
        <property name="dictionaryService">
            <ref bean="DictionaryService"/>
        </property>
        <property name="actionService">
            <ref bean="ActionService"/>
        </property>
        <property name="templateService">
            <ref bean="TemplateService"/>
        </property>
    </bean>‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

And in your Action class (AntivirusActionExecuter.java):

@Override
   protected void addParameterDefinitions(List<ParameterDefinition> paramList) {
      paramList.add(new ParameterDefinitionImpl("a-parameter", DataTypeDefinition.TEXT, false, getParamDisplayLabel("a-parameter")));      
   }‍‍‍‍

The fact you are doing nothing with the parameter doesn't matter, but you will need to add this to AntivirusActionExecuter.java.

Re: How to Schedule a Custom Action?

drphoton — Tue, 31 May 2011 14:07:38 GMT

Thank you mikemars!

I finally found some time to try with a dummy parameter and it worked