Creating panel sources

Related videos

Panel sources are user-defined or system-provided data sources that store the information collected in a panel and define the data properties or fields. When you create a new panel source, a new business object is saved to the iMIS database for use throughout the system.

You can define panel sources from one of the following locations:

  • The Panel sources window (RiSE > Panel Designer > Panel sources) allows you to create panel sources and properties without the need to edit a panel.
  • When editing panels from RiSE > Panel Designer > Panel definitions or from the Panel Editor content item.

Once you have created a source, the steps for adding properties to sources are the same from both locations.

Creating sources from the Panel sources window

To create a new panel source from the Panel sources window, do the following:

  1. Go to RiSE > Panel Designer > Panel sources.
  2. Select Add new panel source.

    3. Adding a panel source

  3. Enter a Source name for each new source. The Source name must meet the following criteria:
    • Starts with a letter.
    • Contains only letters, numbers, and underscores.
    • Is unique across iMIS. The Source name cannot match any existing iMIS data or SQL Reserved Words.

      • Note: We recommend that you use an organizational prefix (such as ABC_) so that your sources are unique, sort together in the tree view, and are easy to identify as sources that you created.

  4. Select the Parent type of the source. The source will be available for all panels of the same parent type:
    • Contact – Associates the data with a specific contact.
    • Event - Associates the data with a specific event.
    • Standalone - Does not associate data with a specific contact. Standalone sources are multi-instance only. These sources are useful for anonymously tracking information or creating a multi-instance form. Only staff users and system administrators can create, edit, view, and delete standalone panels. See Creating standalone panels for more information.
  5. Enable Multi instance to allow multiple entries for each property. Leave this option disabled to create a single-instance source, which only allows one entry per panel property. The source will only be available to panels with the same single or multi-instance designation. For more information, see Creating a panel that allows multiple entries.
  6. Click Save. The panel source is immediately available to panels of the same Parent type. The following properties are automatically generated for the data source based on the Parent type and whether the source is multi-instance:
    • ID – Generated for contact panel sources. The ID is a unique value used to join the business object to other data sources in IQA. It represents the iMIS ID for each contact.
    • EventKey – Generated for event panel sources. An EventKey used to join a business object to other panel data sources and business objects in IQA that represent events.
    • Ordinal – Generated for multi-instance panel sources. Key value for the multi-instance source. This property is read-only.
  7. To begin adding properties, select Add new property. Proceed to Adding properties to panel sources for the next steps.

    8. Adding a new property

Creating sources from within panel definitions

When adding or editing panel definitions, each new source you create is available for immediate use in the current panel. When you Save the panel, that new business object is saved to the iMIS database for use throughout the system.

Managing properties from the Panel definition page

Do the following to create panel sources while working within a panel:

  1. Add a new panel or edit an existing panel.
  2. From the Panel definition window, click Create source. The source inherits the Parent type and single or multi-instance designation from the panel definition. For more information, see Creating panels.

    3. Creating sources

  3. Enter a Source name, then click OK. The Source name must meet the following criteria:
    • Starts with a letter.
    • Contains only letters, numbers, and underscores.
    • Is unique across iMIS. The Source name cannot match any existing iMIS data or SQL Reserved Words.

      • Note: We recommend that you use an organizational prefix (such as ABC_) so that your sources are unique, sort together in the tree view, and are easy to identify as sources that you created.

  4. Before saving, it is recommended to add all necessary properties to the source. This way, you can view them as a set of properties and improve your naming convention before it is finalized. To add properties, proceed to Adding properties to panel sources.
  5. Once you finish adding properties, Save and Publish the panel. When you save the panel, the new business object property is saved in the iMIS database for use throughout the system.

Adding properties to panel sources

Do the following to add properties to a panel source:

  1. Do one of the following:
    • Open the panel source from RiSE > Panel Designer > Panel sources and select Add new property.

      • Adding a new properties

    • Open the desired panel from RiSE > Panel Designer > Panel definitions and select Add property under the source.

      • Adding properties

  2. Enter a Property name that:
    • Starts with a letter.
    • Contains only letters, numbers, and underscores.
    • Is unique within its source.

      • Important! Do not name a panel source property “MarkedForDeleteOn” because it is a reserved name. When data is populated for a given row in a source named “MarkForDeleteOn”, the row is excluded from queries and panels.

    Note: You can configure your panel source to auto-populate the date and time an entry is updated. Refer to Auto-populating the date and time a panel source is updated.

  3. (Panel sources window only) Enter an IQA display name. This value updates the Prompt for field value in the related Business Object, which appears as the property name when the business object is used in a query. For more information, see Business object designer field reference.

    4. Entering IQA display names

  4. Choose a property type that best fits your purpose:
    • Currency: 19 total digits (precision), with four digits to the right of the decimal point (scale). The default masking displays two decimal places.
    • Date, Date and Time, Time: January 1st, 1753, through December 31st, 9999.
    • Decimal: 28 total digits (precision), with 12 digits to the right of the decimal point (scale). The default masking displays two decimal places.
    • Email: Creates a mailto link, which launches the user’s default mail application when selected.
    • File upload: Allows contacts to associate a file with their record. After a file is uploaded, it can be downloaded by anyone who can view the panel. By default, all file types are accepted. Enter specific Allowed file types to restrict the type of files that can be uploaded. The maximum file size allowed is 10 MB.

      • Note: For security reasons, we recommend that you do not allow .exe files.

    • Integer: –2,147,483,648 to 2,147,483,647 (±2 billion).
      • When left blank, the default value is 0.
    • Text:
      • The maximum character limit for single and multi-line Text fields depends on when the original table was created. Older tables will have a maximum of 400 characters, while newer tables will have a maximum of 3,999 characters.
      • HTML tags are not supported in single- or multi-line textboxes. If there is HTML in the textbox, users must manually delete the tags before saving.
      • Pre-defined values from a query, source table (general lookup table), or explicit list that display as a drop-down:
        • Query – Lists the results from a query, such as a list of countries. Click Browse to select a query. Click Remove to remove a previously selected query.
        • Source table - Choose a general lookup table from the Source drop-down. The values defined in the general lookup table are what display as the values in the drop-down. See General lookup tables for more information.
        • Explicit list – Lists specific terms that you define, such as industry type or regions.

        Note: Panel Editor properties with a pre-defined list of values are displayed as drop-down lists so users can select a desired value.  If this pre-defined list is generated by an IQA query, any sorting criteria specified in the query is respected, and the order of the values presented in the drop-down is the same as the order specified by the query. Edit your IQA query as necessary to update the ordering on your drop-down.

      • Allow multi-selections – Allows users to select multiple values for a single property.

        Note: HTML tags are not supported in single- or multi-line textboxes. If there is HTML in the textbox, users must manually delete the tags before saving.

    • URL: Creates a live hyperlink. When selected, a new browser is opened.
    • Yes/No: Provides a checkbox for the user to select if Yes, or to leave blank if No.
  5. (Does not apply to Standalone panel sources) Enable Log all changes if you want to track any data change made to the property. 

    6. Note: Add the Change History Display content item to a content record if you want to display data changes made in the Name and Name_Fin tables, as well business objects.

  6. (Text Property type only) Enable Pre-defined values to display additional Text options:
    • Enable the Allow multi-selections option to allow users to select multiple values for a single property. This option stores multiple values in a comma separated list.

      • Note: To retrieve the data with one row per value in order to filter or join on the values, use the DistinctUserDefinedMultiSelectProperties business object. This business object returns one row per person per value.

    • The Defined by query option provides validation-type properties based on the query results. For example, instead of typing out a list of countries, you could select a query that displays country values.
      • Enable the Pre-defined values checkbox and select the Defined by query option.
      • Click Browse, select a query, and click OK.
      • Two additional fields are displayed:
        • Data Value - The field you want saved in the database.

          • Note: If Allow multi-selections is enabled, the Data Value properties cannot contain any commas. If the Data Value contains a comma, the properties will not properly display in the drop-down.

        • Display Value - The field you want displayed in the list presented as a selection on the panel.

        While these values can be the same, you might want to choose a different value to display on the panel. For example, the country code might not be as clear as the country name.

      • Select the fields from the drop-down in the Data Value and Display Value fields.
      • Click OK.

        • Adding data values and display values

    • The Defined by explicit list option allows you to create a list to display on the panel:
      1. Enable the Pre-defined values checkbox and select the Defined by explicit list option. A table grid is displayed.
      2. Click the plus icon (+) to add a data row. The data row contains two icons: Insert and Cancel, and two fields: Data Value and Display Value. The Data Value is the field saved in the database. The Display Value is the field displayed in the list presented as a selection on the panel. While these values can be same, you might want to choose a different value to display on the panel.
      3. Enter the appropriate values in the Data Value and Display Value fields.
      4. Click the Insert icon located to the left of the data row.
      5. Click the plus icon (+) to add additional data rows.
      6. Click OK.

        7. Adding additional data rows

      Note: The number you define in the Length field will be the total number of characters that can be used in the Data Value column. For example, if you enter 80 in the Length field, you can only enter values in the Data Value fields that have a total of 80 characters combined. The maximum number of characters for this field is 4000, however, indexing will be disabled if the number of characters exceeds 400.

      Note: To learn how to edit an explicit value list, see Editing a panel with an explicit value list.

  7. (Does not apply to File upload or large Text fields of 400 characters or more) (optional) Expand the Advanced section and enable Index this property for improved query performance to index the panel property.

    8. It is recommended that property indexes be used sparingly. Enabling property indexes increase the speed of lookups and reports but could decrease the speed of adding or updating data in the source. It is recommended that this option be used for ID properties, such as codes in reference tables, fields aggregated in reports, or fields used in lookups.

    Note: The index is immediately rebuilt after the panel is saved. Rebuilding the index slows down the speed of a website, so it is recommended that indexes are added to existing panel properties during non-business hours.

  8. To save the property, do one of the following:
    • If you are working directly from the panel source, click Save and Close.
    • If you are working from a panel definition, do the following:
      1. Click Add & Close or Add & Continue to add more properties.
      2. Continue adding properties as needed. Do not Save the panel until you create all the properties. This way, you can view them as a set of properties and improve your naming convention before it is finalized.
      3. Save the panel. Note that the sources will alphabetize properly on reopening.

    9. Note: After you save a property, you cannot rename it.

The new business object property is saved in the iMIS database for use throughout the system. To begin collecting data for the property, add the property to a panel definition (RiSE > Panel Designer > Panel Definitions), then display the panel on your site using the Panel Editor content item. For more information, see Creating panels.

Adding properties to the panel area