Organising rules in an application

Certified Associate Developer

Hi all

I want to hear some of the ways you guys organise the rules in an application in general or as a best practice.

For example, an application involving a couple of hundred rules would be hard to manage and understand for someone new to it. I've thought of organising rules in their dedicated folders by their feature/record type. I want to know what other patterns the community follows for better organising their rules?

  Discussion posts and replies are publicly visible

Parents
  • Certified Lead Developer

    You can also organize by functions.  Dashboards get their own folder, forms get their own folder, utility expressions get a folder, query entity expressions almost definitely get their own folder, reusable ui components could get their own folder.

    It's really a matter of personal preference.  Some get by with naming conventions and all lumped into the same few folders.

    In general, at a minimum, I like to do Constants, Expressions, Queries, and SAIL.  "Interface" has two meanings, so I like to be explicit.

  • Certified Associate Developer
    in reply to Dave Lewis

    Yes.. I'm all for organising using folders. That would automatically be a better laid out project. If Appian could also include which folder a rule came from during object search and code prompts, I guess that would make a difference in developer experience.

  • What I'd like to have rather than organization by folders would be the ability to tag, or add metadata to objects.  Foldering is too restrictive, being that objects can only reside in one folder, and browsing folder by folder can be cumbersome.  If you've seen technology like SharePoint grow over the years, best practice there is to nix the old way of massive folder structures for documents and flatten things out, adding metadata to objects, making organization and searching much, much cleaner.

  • Following on from this...having (and enforcing) naming standards for your objects would help a lot...having a pattern such as:

    <APP_PREFIX><OBJECT_SUB_TYPE><OBJECT_NAME>

    e.g. for a top-level Interface object for an Application that has a Prefix of ABC and is the Summary view on the Customner record:

    ABC_IF_summaryViewCustomer

    ...so having a scheme that works left-to-right from the broadest to the most specific context will go a long way to helping you find the thing you're looking for...

Reply
  • Following on from this...having (and enforcing) naming standards for your objects would help a lot...having a pattern such as:

    <APP_PREFIX><OBJECT_SUB_TYPE><OBJECT_NAME>

    e.g. for a top-level Interface object for an Application that has a Prefix of ABC and is the Summary view on the Customner record:

    ABC_IF_summaryViewCustomer

    ...so having a scheme that works left-to-right from the broadest to the most specific context will go a long way to helping you find the thing you're looking for...

Children
  • Certified Associate Developer
    in reply to Stewart Burchell
    Following on from this...having (and enforcing) naming standards for your objects would help a lot

    Agree.

    Taking this a bit further, "rule!" can be further divided into "decision!", "interface!", "integration!" etc. That way, we know what we are calling and smart prompt can be a bit more relevant in what it shows.

    Also, object search (I do not know if this is supported yet) can include rule type in the search as well.

    E.g. "Interface car" can show all the interface rules that has the keyword car in it.