Documentation Index

Fetch the complete documentation index at: https://help.idibilling.com/llms.txt

Use this file to discover all available pages before exploring further.

IDI version 26.8 is now available.  Click here for details: IDI Updates.

Creating an Attribute Object

Prev Next

Attribute Objects contain the fields to be populated for a customer. The fields displayed are the properties listed below the Attribute Object in the Objects list.

Attribute Objects are created and edited in the Administration Console.

  1. Expand the Attributes node.

    (Show picture)

    AdminAttributesNode

  2. Double-click Objects. This opens the Objects list.

    (Show picture)

    AttObjList

    The existing Attribute Objects are lists in the left panel. Click one the objects to see its Properties in the right panel.  

  3. Right-click in the left panel and select Add. This opens the Add Attribute Object window.

    (Show picture)

    AddAttObj

  4. Enter the Name of the Attribute Object.

    (More)

    The Name is the system name for the object. It must be a unique Attribute Object name and cannot contain spaces. For example, ReportsTaxes, ReportsAccountNumber, ReportsAdjustments. To make working with Attributes Objects easier, use a naming convention that clearly identifies its intent.

  5. Enter the Caption. (More) The Caption is the name of the object to be displayed in the list of Attribute Objects and in the drop-down lists (Base Attribute, Attribute Definition) in the Product Catalog or Data Management.

  6. If necessary enter the Validation Script. (More) The Validation Script is the source code associated with this object. This done using InfoScript. Generally, you can leave the Validation Script field empty. If the Attribute Object requires validation, engineering by IDI will be needed.

  7. Click Save. The New Attribute Object is added to the existing list and is displayed in the properties panel.

  8. Right-click the new Attribute Object and Edit Object. This displays the Edit Attribute Property window.

    (Show picture)

    EditAttProperty_Object

  9. Modify the fields as necessary and click Save or Apply.

    (More)

    Attribute Information

    Name The Name is the system name for the object. It must be a unique Attribute Object name and cannot contain spaces. For example, ReportsTaxes, ReportsAccountNumber, ReportsAdjustments. To make working with Attributes Objects easier, use a naming convention that clearly identifies its intent.

    Caption The Caption is the name of the object to be displayed in the list of Attribute Objects and in the drop-down lists (Base Attribute, Attribute Definition) in the Product Catalog or Data Management.

    Type

    Type refers to an Attribute Type. This determines the format the value entries take.

    Click the ellipsis button EllipsisButton. This opens the

    Note

    All Attribute Objects are automatically assigned a type of IDI.Object.

    See also:

    About Attribute Types

    Type Data Length

    The Type Data Length indicates the maximum length a string-based attribute can be. The default value is zero.

    Note

    The Type Data Length for Attribute Objects is set by the system and cannot be changed.

    Display Properties

    Format String

    The method in which the attribute type is formatted. For example, some telephone number fields may be formatted as (xxx)xxx_xxxx.

    Note

    The Format String for Attribute Objects and Reference Objects is a read-only field.

    See also:

    About Format Strings

    Default Value

    The Default Value specifies the value (entry) to be automatically inserted when the item is applied to a customer. This value can be overridden when adding or editing the item in the Customer Management or POS.

    This overrides the Default Value set up on the Default Values tab of the Add/Edit Attribute Property Type window. (See Creating an Attribute Type)

    If this field is left blank, the Default Value set up on Default Values tab of the Add/Edit Attribute Property Type window is used in the the IDI Desktop Client.

    Note

    For the IDI.Object attribute type and referenced objects (such as a Child Referenced Object), this field is blank and read-only. The Default Value of an Attribute Object's Child Attribute overrides the Default Value that of its associated Attribute Type.

    Sort Order

    The Sort Order is used to indicate the sequence of the fields when presented in the IDI Desktop Client.

    Note

    If sort orders are not specified, the system may present the fields in a different order each time they are accessed.

    Required

    The Required check box indicates you must enter information for this attribute field in order to save the record in the IDI Desktop Client checked, an asterisk (*) is displayed next to the required field in the IDI Desktop Client. The default value is unchecked.

    Note

    This field is blank and read-only for the IDI.Object attribute type and referenced objects (such a, a Child Referenced Object).

    Enabled The Enabled check box indicates this field allows data entry in Customer Management or POS. This is checked by default.

    Visible The Visible check box indicates that this attribute field will be visible in Customer Management or POS. This is checked by default.

    Validation Script The Validation Script is the source code associated with this object. This done using InfoScript. Generally, you can leave the Validation Script field empty. If the Attribute Object requires validation, engineering by IDI will be needed.

    The Attribute Object's properties are the custom fields you want added for your company's use. Two methods are available to connect the Attribute Object to its properties: