Adding Attachment Questions

Attachment question types enable you to create questions where the expected answers are attachments.

To protect data integrity, you cannot change the question type. For example, you cannot change a Date question into a Text question, after a question has been created.

Task 1: Create a new attachment question in a questionnaire

  1. From your questionnaire, go to Designer tab > Layout tab > Objects panel > click Add new.
  2. Select a field type from the drop-down list and enter a name for the field.
  3. Field name guidelines:

    • If possible, keep names under 20 characters. For example, use Description instead of Description of the Asset.
    • Capitalize the first letter of each word in the field name. For example, use Predicted Impact instead of Predicted impact.
    • Avoid redundant wording in field names. For example, using the word Asset is unnecessary in the following series of fields: Asset Name, Asset Type and Asset Value.
    • Use noun-based field names whenever possible. Avoid verb-based field names, for example, Set Asset Name.
    • Do not use the names: Version, Level ID, or Content ID for fields that you add to an application or questionnaire. Field do not display properly with these names.
  4. In the Question Text field, enter the text for your question, and click OK. The Question Text field in the Question section automatically populates with the text entered in this step after you create the field.
  5. In the General Information section, enter a description.
  6. Note: When you save the field, the system strips any HTML tags <xml>, <form>, <textarea>, <option>, <select>, <meta>, and <body> that you may have inserted in the description because they may constitute vulnerabilities in the system. The following example shows how you can correct the cascading style sheet (CSS) syntax for the <body> tag so that it will function correctly:

    <html>
    <head>
    <style type="text/css">.c0 { font-family: 'Arial' } .c1 { margin: 0px; background-color: #ffe4e1 } </style>
    </head>
    <body class="c0">
    <p class="c1">This is a text field.</p>
    </body>
    </html>

    Note: Do not use absolute positioning in HTML content.

Task 2: Configure options

In the Options section, select all of the following options that apply to this field.

Option

Description

Make this a required field

Designates the field as required and forces users to enter a value when adding or editing a record in the application. An icon indicates required fields to alert users that they must enter a value.

Display last modified data

Displays auditing information next to the field each time that its value is changed. The auditing information includes only the name of the user who made the change and the date and time of the change.

Make this a searchable field

Makes this field available for display in all search results.

Display this field in global search results

Makes this field available for display in global search results. This option is only available if this field is set as searchable.

Enable keyword search for PDF, Text, Word, and Excel documents

Allows users to use this field in a keyword search to find documents attached to the field.

File types supported for document searching include Microsoft Word, Microsoft Excel, PDF, Text, and .CSV. If a user does not have access to the field but the field is configured to allow keyword searching, the field is still searched but not included in the search results.

When an attachment field is encrypted, keyword search is not supported.

Validate this field when any value changes in the record

Designates that a field is validated whenever any value changes in a record.

If this option is not selected, this field validates only when the value in this field has changed.

Encrypt data at rest in this field

See Encrypting Data for instructions.

Task 3: Set configuration options

In the Configuration section, set the following options.

Option

Description

Minimum attachments

Specifies the minimum number of required attachments.

Maximum attachments

Specifies the maximum number of required attachments.

Maximum size

Specifies the maximum size, up to 100 MB, that you want to allow for each file uploaded to the field. This setting does not restrict the total size of all files uploaded to the field.

When determining the maximum file size, also consider the restriction limits set in the web.config file and Microsoft Internet Information Services (IIS). If a file exceeds either restriction, the following occurs during the upload:

  • If the file is larger than the designated file size in IIS, a 404 error appears. The host server, not Archer, generates this message. The IIS setting outranks Archer setting.
  • If the file meets the restrictions in IIS but exceeds the maximum file size of the field, a message appears, stating that the file exceeds the limitations. If this condition occurs, the user must upload a file that is smaller than the maximum file size. If the attachment file includes more than one file and the total size exceeds the maximum file size, the user can upload the files individually, up to the maximum size limitation.

Display fields

Specifies the fields that you want to display along with the attachment file.

Important: The Downloads and History fields require configuration administrator access to view.

Task 4: Add question text

  1. Go to the Question section.
  2. In the Question Text field, modify the question text as needed.
  3. If applicable, in the Format Style field, select a display option.

Task 5: Set question filter properties

You can create and assign any number of filter properties to a question. You can apply the filter properties that you create for one question to any other question in the same questionnaire. However, you cannot share filter properties between questionnaires.

For example, the name of your filter property could be "Customer Data," and the available values could be "Yes" and "No." When you assign the filter property to a question, you will select the filter property and the specific filter property value that applies to the question. For example, you would apply the "Customer Data: Yes" filter property to the following question: "Do you have a documented program in place to dispose of customer data when you no longer need to handle it?"

  1. In the Question Filter Properties section, click Add child to add a new filter:

    Important: Do not click to remove a filter property from the current question. Doing so permanently deletes the filter property for all questions that use it. Instead, in the Values column dropdown of the filter property, clear the checkbox of all filter property values to remove. If the Value column for a filter property is blank, that filter property is not applied to the current question.

  2. Enter a name and description for the filter property.
  3. In the Filter Property Values section, click Add child.
  4. In the Value field, enter the value text.
  5. (Optional) Repeat steps 3 - 4 to add any additional filter values as needed. To remove a filter value, in the Actions column, click .
  6. Click Apply on the Edit Filter Property page to return to the Question section.
  7. In the Values column of the filter property, select the filter property values to apply to the question.

Task 6: Configure help text

Field-level help provides additional guidelines and instructions to ensure users enter appropriate information in the field. This Help text displays for users when they add, edit, and view records in the application where the field resides.

Consider the following general guidelines when writing field-level Help:

  • Use short, concise instructions that direct the user to take a specific action. For example, "Enter your name" is preferable to "This field is used to enter your name."
  • Use complete sentences whenever possible.
  • Avoid jargon (unless terms are critical and are familiar to your users).
  • Consider the technical aptitude of your audience, and author your help text at a corresponding level.
  • Use “you” and “your” as if you are speaking directly to the user.
  • Consider posing Help text in the form of a question, for example, "What is your level of interest?"

In the Help text section, do the following:

  1. Select a display option for both edit and view modes.
  2. Option

    Description

    None

    Help text does not display.

    Tooltip Icon

    Help icon displays beside the field in edit and view modes. Click this icon to display the field Help. The application dynamically sizes of the Help box based on the number of characters in the text.

    Field information on help icon hover

    Below

    Help displays below the field in edit and view modes.

    Field information below field

  3. If you are using help text, enter the text.