8 votes

AutoNode

NOTE: For Umbraco v10/v13, use the Discipline package: 

https://marketplace.umbraco.com/package/dotsee.discipline

which provides the functionality of the AutoNode, NodeRestrict, VirtualNodes, and VariantsHider packages together. 

 

This is a simple plugin that automatically creates new child nodes in the Umbraco back end upon publishing a node, based on a set of user-defined rules.

Usage:

In your /App_Plugins/DotSee.AutoNode folder, you will find autoNode-sample.json with a commented example of a rule.

Copy this to a file named autoNode.json and edit it to your liking to load the actual configuration.

Here's an example configuration

 "settings": {
   "logLevel": "Verbose",
   "republishExistingNodes": "false"
 },
 "rule": [
   {
     "createdDocTypeAlias": "sampleParentPage",
     "docTypeAliasToCreate": "sampleChildPage",
     "nodeName": "MyAutoGeneratedPage",
     "bringNewNodeFirst": "true",
     "onlyCreateIfNoChildren": "false",
     "createIfExistsWithDifferentName": "false",
     "dictionaryItemForName": "",
     "blueprint": ""
   }
 ]

Here's an explanation of global attributes:

  • logLevel: Set this to "verbose" to get as detailed logging as possible. Leave it empty for default logging.
  • republishExistingNodes: Set it to "true" to force republishing of any child nodes that are specified in rules but are already there (may be slow).

 

Here's an explanation of rule-specific attributes:

  • createdDocTypeAlias: The document type alias of the document being published. IF the document being published has the specified doctype alias, then the rule will execute.
  • docTypeAliasToCreate: The document type alias of the document that will be automatically created as a child document.
  • nodeName: The name of the newly created node.
  • bringNodeFirst: If set to true, will bring the newly created node first in the Umbraco back-end.
  • onlyCreateIfNoChildren (optional): This, naturally, regards republishing. If set to true, then republishing a node that already has child nodes (including any already automatically created nodes) will NOT run the rule. If set to false, the rule will run even if the node being published already has children. Note: If this setting is set to false and there are already automatically created nodes under the node being published, then they won't be created again. (The check is performed on both doctype and node name as defined in rules - if such a node is found, it will not be created again)
  • createIfExistsWithDifferentName (optional): This is true by default - it means that if you rename the automatically created node and republish its parent, a new node will be created. If you need to restrict node creation even more, then you can set this to False and it will not create a new node when a node of the same doctype is found.
  • dictionaryItemForName (optional): The key for a dictionary item which will specify what the name of the new node will be in a multilingual Umbraco installation. This means that new nodes will take their names according to the value of this dictionary entry and names will be different for each language. (The createIfExistsWithDifferentName setting also takes multilingual names under consideration).If the dictionary key is not found or the corresponding dictionary entry contains no value, then it falls back to the default new node name as defined in the rule.
  • blueprint (optional): The name of a blueprint (aka "content template") that will be used to populate the newly created node with content.

Limitations / Warnings

You should not specify circular rules (i.e. one rule for creating doc B when A is published and one rule for creating doc A when B is published - this will cause an endless loop and leave you with a huge tree if you don't stop it on time! You can, however, create multiple rules for the same document type. That is, you may want docs B, C, and D to be automatically created when A is published, so you will have to create 3 rules.

The plugin creates the subnode only if there isn't any child node of the same doctype (by default it checks whether the existing node has the same name as defined in the rule, but you can override that and check only for doctype).

The plugin works for new nodes as well as existing nodes (if they are published and there is a rule in place and no subnode of the given doctype already exists).

This plugin works only with doctypes, so it's not possible at the moment to have any other criteria for automatic document creation. IF you need this, I'll be happy to add more logic.

This plugin was made to cover very specific, simple needs, like having a "Files" grouping node created automatically under each new "Article" node. It doesn't do miracles, so don't expect any 😃

Screenshots

NuGet install instructions for Umbraco 9+

dotnet add package DotSee.AutoNode

Package owner

Sotiris Filippidis

Sotiris Filippidis

Sotiris has 1501 karma points

Package Compatibility

This package is compatible with the following versions as reported by community members who have downloaded this package:
Untested or doesn't work on Umbraco Cloud
Version 8.18.x (untested)

You must login before you can report on package compatibility.

Previously reported to work on versions: 8.13.x, 8.9.x, 8.8.x, 8.7.x, 8.6.x, 8.5.x, 8.2.x, 7.7.x, 7.6.x, 7.5.x, 7.4.x, 7.3.x, 7.2.x

Package Information

  • Package owner: Sotiris Filippidis
  • Created: 09/05/2016
  • Current version 3.0.2
  • License MIT
  • Downloads on Our: 2.2K
  • Downloads on NuGet: 21K
  • Total downloads : 23.2K

External resources