Settings and conventions for Agents

Attribute(s)

  • Documentation
  • General Settings

    Description

    An agent has several standard default settings and conventions which should be adhered to.

    Motivation

    These standard settings facilitate trouble shooting and ease of recognition for developers and administrators alike.

    Example / Details

    All agents should conform to the following standard general conventions:

    Category
    Setting
    Value/Remarks
    Name
    Agent name
    See standard Agents -> Naming Conventions for information regarding the correct
    name for an agent.
    Action
    Mail-In
    Background
    See standard Agents -> Alias for naming convention for agent alias.
    Options
    Show in search bar menu
    Off.

    Store highlights in documents
    Off.

    Available to Public Access users
    Off.

    Comments (Documentation)
    Place a short description as to the function of the agent here. If the agent is
    activated via an action (see naming conventions for action activated agents),
    add the following text to the agent comments:
    Action Name (Design Element).