Field

From RPM Wiki

Fields are a way to store user defined information. Data fields are defined in process templates and used in process forms. custom field are used for agencies, reps, customers, accounts, and staff.

Table of contents

Type

Standard

Regular data entry fields.

  • Text box. Simple one line text entry.
  • Text area. Larger text entry for descriptions and comments.
  • Link. Like a text box except the value is displayed as a link
    • No formatting is done to the value, the value must be correct as entered for the link to work (Example: web page links must start with "http://" or "https://")
    • Opens in a new window
  • List. A list of options the user can select one of.
  • List (multi select). A list of options the user can select any number of.
  • Yes/No. The user may select "yes" or "no".
  • Date. The user may use text entry or the pop-up calendar tool to select a date.
  • Money. Like the text box, except the user input will be stored as a dollar value.

Formatting

Filled in during setup to format and annotate the other fields.

  • Link (fixed). A link to a website
    • No formatting is done to the value, the value must be correct as entered for the link to work (Example: web page links must start with "http://" or "https://")
    • Opens in a new window
  • Label. Displayed in bold, useful for section titles.
  • Description. Displayed in a smaller font, useful for instructions or comments.
  • Separator line. A simple, horizontal line.

Reference

Points to something in RPM. Data fields only, custom fields can’t be reference types.

  • Supplier, Agency, Rep, Customer, Account, Staff, Account group, Commission group, Product, Commission run, Process, Form. The user selects the value using a drop down list that is automatically populated.
  • Supplier (multi select). The user checks off suppliers from a list of allowed suppliers defined when the field is added.
  • Supplier (fixed). A reference to a specific supplier that can’t be changed. This allows processes to be setup that are limited to one or more suppliers.
  • Commission item. A reference to a commission item. A commission variable map is used to narrow down the list of items the user has to choose from when filling tin the reference.
  • Supplier adjustment, agency adjustment. The user may select an existing adjustment or add a new one.

Permissions

Each field has a separate permission setting for staff and agent users.

  • Hidden. Agent users only.
  • Read only. Agent users only except for formatting fields and fixed supplier references. Those are always read only for staff and read only or hidden for agent users.
  • Read & edit
  • Required to start. Data fields only. The "Start a form" wizard can not be finished until this field is filled in.

Reference hierarchy

Some references require a parent reference. The value of the parent reference limits the options available in the child reference.

  • Example: A rep reference must have a parent agency reference. When filling in the form, the user must first select an agency before they can select a rep. Once the agency is selected the list of reps the user can choose from is limited to reps of that agency.
  • Reference hierarchy:
    • Agency > Rep
    • Supplier (single, fixed, or multi select) > Customer > Account
    • Supplier (single, fixed, or multi select) > Account
    • Supplier (single, fixed, or multi select) > Account group > Account
    • Supplier (single, fixed, or multi select) > Commission group > Product
    • Supplier (single, fixed, or multi select) > Product
    • Customer > Account
    • Commission run > Commission item
    • Process > Form
    • Staff

Reference auto complete

In some situations certain references will be filled in automatically by RPM when a user starts a form. These references will be filled in regardless of their permission settings.

  • Agency rep. When a rep user starts a form any rep references are set to them and any agency references are set to their agency.
  • Agency manager. When an agency manager user starts a form any agency references are set to their agency.
  • Start from reference details. When setting up a reference field of certain types there is an option "Start link on details page". When this option is selected a link to start a form of this process will be shown on details pages of that reference type. Using the link will fill in the reference and any parent references.
    • Example: Selecting that option on an account reference in a "Quote" process will put a link on all account details pages to "Start a quote". When a user clicks that link a form will be started with the account reference filled in. Also, the parent supplier or customer reference will be filled in.
  • Start from commission item details. Commission item links can have the start link option as described above. In addition to the behavior described above, starting a form from an item will also fill in account, account group, customer, rep, agency, supplier, product, and commission group references from the values of the item.

Field group

A field can belong to a field group that controls how the field is displayed. When adding or editing a field you can select the group it belongs to.

Security

Staff users

  • Setting up data fields for a process template or form requires the "Add, edit, delete process templates" privilege
  • Setting up custom fields requires the "Setup custom fields" privilege

Agent users

  • Setting up fields of any kind is hidden from agent users.
  • Individual fields may be set as hidden or read only for agent users.
  • The options available for agency, rep, customer, and account references is limited to options the user is allowed to see.
    • Note: Staff or other agent users may select an option the user isn’t allowed to see for a reference. The user will see the option, but it will not be a link for them.
    • Example: Staff "John" and rep "Bob" are both participants of a form that has an account reference. John selects account "865546" to be referenced, but it is not an account that Bob has sold to. Bob will see the account John has selected, but will not be able to click on it to get more information. Bob would not have been able to select that account on his own.

Modules

  • The field requires the "Process management" module.

Adding a field

  • To add a data field to a template click "Edit" in the "Data" section then click on a field type in the toolbox or drag one into the field table.
  • To add a data field to a form click "Edit" in the top right then click on a field type in the toolbox or drag one into the field table.
  • To add a custom field see Custom field
  • This page was last modified 18:14, 17 Jan 2008.
  • This page has been accessed 1460 times.