topic Re: Create / Edit Rule with Script? in Alfresco Archive

Create / Edit Rule with Script?

e-manuel — Fri, 03 Oct 2008 07:12:23 GMT

Hi,is it possible to create a script (Javascript/Webscript/…) to create Space-Rules or to edit them?I have many many spaces (about 200 - 250) and i want to apply "notification-email-rules" to all these spaces.I also want to edit other rules, there are already in some spaces (also rules, that sends e

Re: Create / Edit Rule with Script?

skontopo — Mon, 29 Jun 2009 10:25:21 GMT

Hi there!

Did you manage to find a solution to this problem?
Because I am also interested in this topic and I found your post while browsing the forum.

Thanks a lot in advance.

Re: Create / Edit Rule with Script?

e-manuel — Mon, 29 Jun 2009 11:24:10 GMT

Hi,
unfortunately i haven't get any ideas how this is possible yet.

regards

Re: Create / Edit Rule with Script?

lista — Mon, 29 Jun 2009 11:45:43 GMT

If those spaces have a hierarchy, then you can add a rule to the top one, and apply it to all the children too.
Presumably, your spaces are not related to each other?

Cheers,
Lista.

Re: Create / Edit Rule with Script?

mcook — Tue, 20 Oct 2009 12:48:02 GMT

I have found a javascript api for creating rules; however, how to use it is currently beyond me. Im working on it as we speak because I need this functionality to programmatically create rules on the fly for spaces that are created by scripts for documents that are scanned in.

http://wiki.alfresco.com/wiki/3.0_JavaScript_API_for_Rules_and_Actions

Matt

Re: Create / Edit Rule with Script?

gabriele — Wed, 28 Oct 2009 10:45:13 GMT

I have the same problem and I also tried to follow the javascript API, though the "rules" host object doesn't seem to exists, like the Rule class itself.
Please let us know if you succeed.

I'm using Alfresco 3.2.

Re: Create / Edit Rule with Script?

hyperation — Thu, 10 Dec 2009 00:46:14 GMT

Any luck?

Re: Create / Edit Rule with Script?

benarrayx — Tue, 25 May 2010 15:42:22 GMT

It's also a requirement for me to create rules that apply to sub-folders I'm creating in code. I note that the Wiki page referred to above doesn't exist any more - can anyone else help out with any references on this?

AHA, Ben

Re: Create / Edit Rule with Script?

unknown-user — Fri, 28 May 2010 15:33:55 GMT

Can someone clarify if this is possible through Web Scripts?
Thank you.

Re: Create / Edit Rule with Script?

sanket — Sat, 29 May 2010 07:06:13 GMT

You can create rules programatically by using the following java code.
I don't know how to do it wid javascript.
For ex: If u want to create rule which converts the arriving document to pdf, u can do it programmatically as follows.


private void setupSpaceRuleConvToPDF(NodeRef data){
      
      Rule rule=new Rule();
      
       rule.setRuleType("inbound");
       rule.setTitle("Transform to PDF n copy to Data-PDF");
       rule.setDescription("Transform to PDF n copy to Data-PDF");
            rule.applyToChildren(false);
          // rule.setExecuteAsynchronously(true);
        System.out.println("Rule creation started…Part-II");
        CompositeAction compositeAction = getActionService().createCompositeAction();
        rule.setAction(compositeAction);
        ActionCondition actionCondition = getActionService().createActionCondition("no-condition");
        actionCondition.setParameterValues(new HashMap());
        compositeAction.addActionCondition(actionCondition);
        IHandler handler=null;
        Map repoActionParams = new HashMap();
        Map actionParams=new HashMap();
        
        NodeRef destination = new NodeRef(Repository.getStoreRef(),(String)getNodeService().getProperty(data, ContentModel.ASPECT_COPIEDFROM));
        
        
        
        actionParams.put("actionName", "transform");
        actionParams.put("transformer", "application/pdf");
        actionParams.put("destinationLocation",destination); // prntDestinationNodeRef
      actionParams.put("actionSummary", "Transform and copy content to a specific space");
      try {
          handler=(IHandler)Class.forName("org.alfresco.web.bean.actions.handlers.TransformHandler").newInstance();
      } catch (Exception e) {
         System.out.println("Class Generation Exception:"+e);
      }
      if(handler != null){
         handler.prepareForSave(actionParams, repoActionParams);
      }
       //System.out.println("B4 saving action");
      Action action = getActionService().createAction("transform");
      action.setParameterValues(repoActionParams);
        compositeAction.addAction(action);
        getRuleService().saveRule(data, rule);
   }
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Re: Create / Edit Rule with Script?

dc_noze — Fri, 08 Oct 2010 08:20:01 GMT

Hi guys,
i was looking for a solution and i finally came up with this one. I hope could help.


var jsonRule = {
   title: "Sample Rule",
   description: "Sample rule creation",
   ruleType: ["inbound"],
   applyToChildren: true,
   executeAsynchronously: false,
   disabled: false,
   action :
   {
      actionDefinitionName: "composite-action",
      actions:
      [
         {
            actionDefinitionName: "script",
            parameterValues:
            {
               'script-ref': "workspace://SpacesStore/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
            }
         }
      ],
      conditions:
      [
         {
            conditionDefinitionName: "no-condition",
            parameterValues: {}
         }
      ]
   }
};

var jsonRuleBody = jsonUtils.toJSONString(jsonRule);


var uri = '/api/node/workspace/SpacesStore/xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx/ruleset/rules';
uri += '?alf_ticket=' + session.getTicket();

var rsp = remote.connect('alfresco').post(uri, jsonRuleBody, 'application/json');
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

To have this to work you have to configure the remote object to works with the repository.You can find information here: http://forums.alfresco.com/en/viewtopic.php?f=36&t=27962&p=101380

I have tested this solution on Alfresco3.3g, but this should work either on 3.0.
Here you can find reference to remote object: http://wiki.alfresco.com/wiki/Surf_Platform_-_Freemarker_Template_and_JavaScript_API#remote
Here reference about rule object: http://wiki.alfresco.com/wiki/Rule_REST_API_Design_Notes

Happy coding!

Re: Create / Edit Rule with Script?

sjeandroz — Wed, 27 Jul 2011 09:16:32 GMT

Hi,
I want to create a rule on a node, from a java backed web script…
I tried the code below in my script but some function are undefined (eg getActionService())
Can someone help me please, I'm a noob on alfresco's java developpment,


private void setupSpaceRuleConvToPDF(NodeRef data){
      
      Rule rule=new Rule();
      
       rule.setRuleType("inbound");
       rule.setTitle("Transform to PDF n copy to Data-PDF");
       rule.setDescription("Transform to PDF n copy to Data-PDF");
            rule.applyToChildren(false);
          // rule.setExecuteAsynchronously(true);
        System.out.println("Rule creation started…Part-II");
        CompositeAction compositeAction = getActionService().createCompositeAction();
        rule.setAction(compositeAction);
        ActionCondition actionCondition = getActionService().createActionCondition("no-condition");
        actionCondition.setParameterValues(new HashMap());
        compositeAction.addActionCondition(actionCondition);
        IHandler handler=null;
        Map repoActionParams = new HashMap();
        Map actionParams=new HashMap();
        
        NodeRef destination = new NodeRef(Repository.getStoreRef(),(String)getNodeService().getProperty(data, ContentModel.ASPECT_COPIEDFROM));
        
        
        
        actionParams.put("actionName", "transform");
        actionParams.put("transformer", "application/pdf");
        actionParams.put("destinationLocation",destination); // prntDestinationNodeRef
      actionParams.put("actionSummary", "Transform and copy content to a specific space");
      try {
          handler=(IHandler)Class.forName("org.alfresco.web.bean.actions.handlers.TransformHandler").newInstance();
      } catch (Exception e) {
         System.out.println("Class Generation Exception:"+e);
      }
      if(handler != null){
         handler.prepareForSave(actionParams, repoActionParams);
      }
       //System.out.println("B4 saving action");
      Action action = getActionService().createAction("transform");
      action.setParameterValues(repoActionParams);
        compositeAction.addAction(action);
        getRuleService().saveRule(data, rule);
   }
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Thanks!

Re: Create / Edit Rule with Script?

wass — Mon, 22 Aug 2011 19:01:24 GMT

i'm with sjeandroz's same problem

anyone can help?

thanks.

Will.


private void setupSpaceRuleConvToPDF(NodeRef data){
      
      Rule rule=new Rule();
      
       rule.setRuleType("inbound");
       rule.setTitle("Transform to PDF n copy to Data-PDF");
       rule.setDescription("Transform to PDF n copy to Data-PDF");
            rule.applyToChildren(false);
          // rule.setExecuteAsynchronously(true);
        System.out.println("Rule creation started…Part-II");
        CompositeAction compositeAction = getActionService().createCompositeAction();
        rule.setAction(compositeAction);
        ActionCondition actionCondition = getActionService().createActionCondition("no-condition");
        actionCondition.setParameterValues(new HashMap());
        compositeAction.addActionCondition(actionCondition);
        IHandler handler=null;
        Map repoActionParams = new HashMap();
        Map actionParams=new HashMap();
        
        NodeRef destination = new NodeRef(Repository.getStoreRef(),(String)getNodeService().getProperty(data, ContentModel.ASPECT_COPIEDFROM));
        
        
        
        actionParams.put("actionName", "transform");
        actionParams.put("transformer", "application/pdf");
        actionParams.put("destinationLocation",destination); // prntDestinationNodeRef
      actionParams.put("actionSummary", "Transform and copy content to a specific space");
      try {
          handler=(IHandler)Class.forName("org.alfresco.web.bean.actions.handlers.TransformHandler").newInstance();
      } catch (Exception e) {
         System.out.println("Class Generation Exception:"+e);
      }
      if(handler != null){
         handler.prepareForSave(actionParams, repoActionParams);
      }
       //System.out.println("B4 saving action");
      Action action = getActionService().createAction("transform");
      action.setParameterValues(repoActionParams);
        compositeAction.addAction(action);
        getRuleService().saveRule(data, rule);
   }
‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍‍

Thanks!

Re: Create / Edit Rule with Script?

acarpine — Tue, 15 May 2012 13:37:46 GMT

The snippet use the getActionService() method of Repository class to obtain AstionService, RuleService…
For example in my case I injected services using Spring. In your cases you could use

Repository.getActionService()‍

and all should work correctly.

I hope this help
Andrea

Re: Create / Edit Rule with Script?

nickburch — Sun, 02 Aug 2015 21:17:00 GMT

A few hours ago, I thought I'd knock up a quick script to create some rules for me, while dinner cooked. Turned out to not be nearly as easy as I'd thought, as others here have found. However…. Not out of the box, but you can do it with some tweaks. You really really shouldn't, would be my advice after those hours, but you can…

First up, you need to inject the

ServiceRegistry‍

to your JavaScript somehow, and you need to use the <a href="https://github.com/share-extras/js-console">JavaScript Console</a>. I would advise against injecting the

ServiceRegistry‍

as a root object, as that opens up a huge can of security worms. Injecting your own bean, which does some security checks (eg admin only) is less bad, but still a little evil. Take care, and/or don't go there to start with… Or just inject in the action and rules services securely. Next up, you need to work out the action parameters and condition parameters. These are not fun to do by hand, best bet is to set up a rule much like you want with the UI, then use the node browser to see how that gets turned into composites and name/values.

Assuming you've safely injected in the service registry, and you (say) want to create a folder based on this month in a site + add a rule to it which will run a script if a non-zero sized file with a name that starts "Completed" is uploaded/created there, you can do so with a JS Console script like this:

<javascript>
var sitename = "my-rules-test";
var rulesSite = siteService.getSite("sitename");
if (rulesSite == null) {
 throw "No rules site found: " + sitename;
}
var doclib = rulesSite.getContainer("documentLibrary");

// TODO Inject in the service registry *securely* here
var services = myExtension.securelyGetServices();
// Get the services we need
var ruleService = services.getRuleService();
var actionService = services.getActionService();

// When are we running for? This month, or next?
var whenFor = new Date();
if (whenFor.getDate() >= 15) {
 whenFor.setMonth(whenFor.getMonth()+1);
}
whenFor.setDate(1);
// Get the friendly date names
var nameFmt = new java.text.SimpleDateFormat("YYYY-MM");
var monthFmt = new java.text.SimpleDateFormat("MMMM");
var monthName = monthFmt.format(whenFor);

// To find the NodeRef of a Data Dictionary script
function getScriptNodeRef(name) {
 var scriptsHome = companyhome.childByNamePath("Data Dictionary/Scripts");
 var script = scriptsHome.childByNamePath(name);
 if (script == null) {
 throw "Script not found in Data Dictionary '" + name + "'";
 }
 return script.getNodeRef();
}
// To make a QName
function makeQName(qname) {
 if (qname.indexOf("{") > -1 && qname.indexOf("}") > -1) {
 return Packages.org.alfresco.service.namespace.QName.createQName(qname);
 }
 return Packages.org.alfresco.service.namespace.QName.createQName(qname, services.getNamespaceService());
}

// Create the year folder if needed
var yearFolder = doclib.childByNamePath(year);
if (yearFolder == null) {
 logger.log("Creating year folder " + year);
 yearFolder = doclib.createFolder(year);
} else {
 logger.log(year + " available as " + yearFolder.getNodeRef());
}

// Is the month folder already there?
var folderName = nameFmt.format(whenFor);
var monthFolder = yearFolder.childByNamePath(folderName);
if (monthFolder == null) {
 logger.log("Creating folder for month " + folderName);
 monthFolder = yearFolder.createFolder(folderName);
 monthFolder.properties["cm:title"] = monthName + " " + year + " Reports";
 monthFolder.save();

 // Setup the rule on it, for when it's "complete"
 var rule = new Packages.org.alfresco.service.cmr.rule.Rule();
 rule.setTitle("Remove Permissions When Complete");
 rule.setDescription("When the Complete file is created, remove the permissions");
 rule.applyToChildren(false);
 rule.setRuleType("inbound");

 // Create our conditions
 var condition1 = actionService.createActionCondition("compare-property-value");
 var condition2 = actionService.createActionCondition("compare-property-value");
 condition1.setParameterValue("operation","BEGINS");
 condition1.setParameterValue("value","Complete");
 condition1.setParameterValue("property",makeQName("cm:name"));
 condition2.setParameterValue("operation","GREATER_THAN");
 condition2.setParameterValue("content-property","SIZE");
 condition2.setParameterValue("value",0);
 condition2.setParameterValue("property",makeQName("cm:content"));

 // For all files, we'd use this instead
 var noCondition = actionService.createActionCondition("no-condition");
 noCondition.setParameterValues(Packages.java.util.Collections.emptyMap());

 // Setup the action
 var action = actionService.createCompositeAction();
 action.addActionCondition(condition1);
 action.addActionCondition(condition2);
 var saction = actionService.createAction("script");
 saction.setParameterValue("script-ref", getScriptNodeRef("do-restrict-permissions.js"));
 action.addAction(saction);

 rule.setAction(action);
 ruleService.saveRule(folderName.getNodeRef(), rule);
} else {
 logger.log(folderName + " available as " + monthFolder.getNodeRef());
}
</javascript>

Run that today, and it'll create a 2015/August 2015 Reports folder, run it after the 15th for 2015/September 2015 Reports, tweak logic as needed! It'll apply the rule to it. Injecting the services (safely!) is the hard bit, so it won't work out of the box, but can be done. But probably shouldn't…!