Technical
      Back to home
      1. EBMS Knowledge Base
      2. EBMS Main Documentation
      3. Technical

      Customization Designer

      Using the Customization Designer, a manager or administrator can extend or customize EBMS by adding custom fields, or display a standard EBMS field in a new location.  For example, a user may wish to add certification information into a customer record that is read by a report or customization, or display the Purchasing Agent field on the Expense Invoice header rather than having to go to Advanced Settings dialog to view and edit it.

      The following definitions are important to understand to use the Customization Designer:

      • Standard field: a property or segment of information within a record or entity added by EBMS developers.  For example, standard fields in a customer entity include first name, last name, city, and terms.
      • Custom field: a property that has been added by the user or custom developer.  For example, to add certification information.  If the field was created by a developer, its definition cannot be edited or deleted.
      • Document: a collection of fields or information for a single record.  For example, a customer's fields or information is stored in a customer document.
      • Table: a collection of records or documents.

      Warning: Adding fields to the EBMS database often requires exclusive access to data to apply.  Exclusive access requires all users to exit EBMS while the system adds the information.  The time required varies based on the size of the tables being altered.

      Review Server Manager > Optional EBMS Modules for instructions to install optional modules such as Customization Designer.

      Create a Customization

      1. Select File > System Options from the main EBMS menu, and click on the Customizations tab.

      2. Click New to choose the document and location where the new fields will be added.

      3. Select the existing document where the custom fields are shown.

      4. Select the field display location and click OK.

      5. Highlight the customization and click properties.

      6. If it is a page-oriented location rather than an existing tab, enter the Page Name.
        customization-properties

      7. Enter the Label that will show on the page.  The label can be used to describe the field, page, or some instructional text.  The  label can alternatively represent a CodeBase expression if it is surrounded by square brackets. Example: [IIF(cust_id='ZURMIK', 'http://www.koblesystems.com/zurmik','http://www.koblesystems.com/other')].  Review Database Expressions for information on Codebase Expressions.

        1. If this field will be used to display a filesystem folder or web page (see step 8), the label will specify the folder or page:

          1. Folder: the filesystem path of the folder, for example:
            1. C:\documents\customers\{ID}
            2. \\server01\documents\customers\{ID}
          2. Website: The URL of the initial page, for example:
            1. http://mypay.com/login?cid={ID}
        2. Notice that the label may include optional data field placeholders enclosed with {}. Each data field should have its own placeholder. The data fields available are the same as those listed in the drop-down of the Data Fields column.
      8. Select the existing Data Field.  Click New Field to add a new field to the table.  Review EBMS Tables and Fields for instructions to locate the file and field names.  Review the Create a New Custom Field section below for field details.
        1. The following non-data fields are shown at the top of the drop-down menu:
          1. [Folder] - Display an embedded Windows File Explorer pointing to the file configured in Step 7
          2. [Label] - Display the Label text with no associated EBMS data
          3. [Website] - Display an embedded Microsoft Edge web browser pointing to the URL configured in Step 7
        2. Folder and Website are only supported on page-oriented locations, with a maximum of one per custom page.
          The folder or website will be sized to fill all available space on the custom page.
      9. Click Edit Field to change field attributes
      10. Repeat steps 6-9 for any additional fields
      11. Click Apply to implement the changes, or OK to apply and exit.
      12. Review the customizations within the EBMS document. For example: open the customer's general tab and click on Certification page.  The <?Label?> indicator indicates that the fields have not been created within the table. These changes are active immediately for all users, but all users must exit EBMS before new and redefined custom fields can be applied to the database.
      13. The Update process must be used to apply the changes to EBMS data.  Review the Apply Changes section below to complete the customization of EBMS.

      Apply Changes

      The process to apply changes to the EBMS database often requires exclusive access.  Schedule a time to run the following process when all users have logged out of EBMS.  An extended amount of time of exclusive access may be required to apply changes. The time required varies based on the size of the tables being altered.

      To apply changes, complete the following steps:

      1. Verify that all users have exited EBMS.  See Active User count within the data pane.

      2. Launch the Update process to create the fields.  Review Server Manager > Overview for instructions for running the update process.

          Create a New Custom Field

          1. Field Name needs to be ten or less characters long.

          2. Select one of the following data types:

            1. Character: a description, text, and other alphanumeric information

            2. Date: a calendar date formatted as mm/dd/yyyy

            3. Logical: to enable or disable

            4. Number: any numeric value, including currency

            5. Memo: a lengthy, multiline text

            6. Sales > Customer: a customer ID, including a customer lookup option

            7. Sales > Invoice: invoice number

            8. Inventory > Serialized Item: a serial number of an inventory item

            9. And many others as shown below:

          3. Maximum Characters applies to Character and Number field data types.

          4. Number of Decimal Digits can be set for Numeric fields.

          5. Enable the Requires a Value for some standard EBMS data types.

          6. Enable the To be Deleted to remove existing custom fields.  Note that the fields will not be deleted until step the EBMS tables are update using EBMS Server Manager.

          7. Only enable Always editable when security allows for fields that should be editable even when a document is processed or closed.
            New-Field-Always-editable

          8. Select List of Values data type to show a drop down of values.

          9. Enable Sort Values to sort the list of values.

          Show Additional Fields in MyEBMS

          Additional fields can be added to a MyEBMS app.  Field options include existing EBMS fields and custom user-defined fields.  For this example, custom fields were added to MyCustomers using a custom Route tab.

          Note that the same customer fields are added to the custom Route tab within EBMS.

          Refer to the beginning of this section for instructions to configure this custom tab (Page Name) within the Customer dialog.

          Review EBMS Tables and Fields for instructions to locate the file and field names.