DNN Custom Forms by OnyakTech
OnyakTech Custom Forms DNN Module
by OnyakTech

Custom Forms DNN Extension: Display Setup

Display Setup is where you define the Form should be displayed and how it is displayed. This includes but is not limited to what happens before the Form is loaded, how the Form is presented, what happens when the user submits the Form and where the information in the form is stored.

  • Form Load Options
    • The Form Load options control how your form is loaded onto the page. You can load your form directly on the page, into a Pop-Up, slide onto the page or displayed as a popup after the user clicks a hyperlink.

      You can also lock the form to being displayed only to users with a specific user profile value by checking the option "Only load form if selected user profile value matches" and then enter the DNN User Profile Field name and value that the user must have in order to see the form.

  • Mobile Device and Responsive Options
    • These options are specific to how your form is displayed on small devices. Some of these options may conflict with your skin, please test and review before using these options in production. If you need help with these options or if you would like to see additional options added please contact support@onyaktech.com.

      Convert all HTML Tables to Responsive mobile enabled visuals option will make your standard HTML Tables responsive so they are easier to view on mobile devices.

      Enable Mobile Device Control Support (Forms must also have the [MOBILEME] token) option will import the jQuery Mobile library

      Use smaller versions of the mobile controls to conserve space option will use the smaller version of the controls in the jQuery Mobile library

      Show Only Form (Full Screen Mode). The form becomes the entire web page. Great for Mobile Only Pages or for Digital Signs. option will display only the OnyakTech Forms module in your DNN web page, all other modules and DNN features will be disabled.

  • Form Data Options
    • These options are specific to loading data into your controls when the Form is loaded onto the page. These can also be set in your Form Template using tokens. Setting the options here will overide the tokens on your Form Template.

      If you check the option to "Save to Database" and leave all other options to their default then the Forms module will generate a Table in your database named after the Form and create columns for each control to store the data when the users submit your form. If you don't care about the table name, primary key or other specifics this is the only option you need to check to have your data saved to the database when your forms are submitted.

      Table: If you want your table name to be specific or if you want the data to be saved to a table that already exist you will enter the name of that table into this option.

      Primary Key: Enter the primary key column name for the Table associated with your form. You can ignore this option if you are loading your form data manually and if you are using a stored procedure or other TSQL to save your data to multiple tables. This is the same as using the token TABLEPRIMARYKEY-PRIMARYKEYNAME]. Note that you would not enter a token here, just the name of the primary key.

      Connection String: by default, your DNN Connection string will be used for all database processing. To use a different connection string you can enter it into this option.

      PK LookUp: You can use this option to to have more control over how the primary key value is set that is used to load the data for your form against the table you have specified above. You can ignore this option if you are loading your form data manuall and if you are using a stored procedure or other TSQL to save the data to multiple tables. This is the same as using the token [TABLEPRIMARYKEYVALUEFROMLOOKUP-SELECT ...WHERE SOMECOLUMN=`YOURQUERYSTRINGPARMATER`]

      Form Load SQL Override:: Enter custom SQL here to override the default method for loading data into your controls when the Form is loaded. All data columns will be mapped to matching Controls by name. For example, if you have a column named "Address" then you should also have a control named Address with the token [TEXTBOX-ADDRESS].

      TSQL Execute After Submit:: The TSQL Execute After Submit feature will execute the TSQL you enter into this option after a form is submitted. In the TSQL you can use value tokens to pass the form values submitted in your TSQL. For example, if you have a control on your form indicated as [TEXTBOX-MYNAME] and you want to pass that to a stored procedure after the form is submitted your TSQL would look something like the following: exec MyStoredProcedure @UserName=[MYNAME]; To pass the IDENTITY of the database transaction from Form Submit use the token [IDENTITY]

  • Form Search Options
    • The Search Plugin uses the values entered into your form to search the data you define and display the results in a data grid with an optional popup displayed for row details and Google Map information. The Search Plugin also includes an optional Export feature to download the results to the users computer.

      Direct Main Search Table/View : Table or View that contains the data you will search on. Column names must match control names in your Form.

      Direct PopUp Table/View : Enter the table name or View that contains the data to be displayed when a user clicks the "View Details" button for a specific row in the search results.

      Direct Export Table/View : Enter the table name or view that contains the data to be exported when the user clicks the button to download the results. The data is filtered based on the search.

      Direct Primary Key: Enter the primary key or unique value for the data that will be searched. :

      Connection String : Leave empty to use the DNN database connection or if you will be referencing the database objects through code (ex: select * from asmn.dbo.vsASMNMainSearchView). If you leave the connection string empty then the solution will use the existing DNN connection string.

      Display Columns : Indicate the column names to be displayed delimited by a semi-colon. Example: Column1;Column2;

      Pop-Up Columns : Indicate the column names to be displayed delimited by a semi-colon. Example: Column1;Column2;

      Export Columns : Indicate the columns names to be exported to Excel delimited by a semi-colon. Example: Column1;Column2;

      Detail Template : Template content to use when rendering the detailed view of the data on row click. Surround data column names with brackets (as tokens) to indicate where information should be displayed.

      Alternate Search : Alternate Search will execute a different SQL statement if the control name you specify here is a checkbox and is checked when the user submits the search query on your form.

      Alternate Search Table : When Alternate Search is enabled this is the Table or View that will be searched.

      Alternate Search Columns : Indicate the column names to be displayed for the alternate execution delimited by a semi-colon. Example: Column1;Column2;

      Search Result Limit : Set to -1 to return all results. Set to a positive value to limit the number of records returned from search.

      Map Location : Location is set by using tokens from your data. Example: [Address] [City], [State]

      Map Title: This is the text to be displayed in the title of the marker when clicked. You can use data tokens in this value.

      Map Content: This is the content of the marker when clicked. You can use data tokens in this value. [OWNER] - [CITY] [STATEPROVINCE], [COUNTRY]

  • Form Value Filter Plug-Ins
    • Form Value Filters are plug-ins that provide the ability to apply different data conversions and formatting during specific stages of your forms lifecycle (Load, Save, Data Storage, Email Rendering, etc). Each stage has a canvas that contains it's own copy of the data that is populated from the "Master Form Canvas" and the data (Form Values) are passed through the filters you enable below before executing the actions for the stage. This allows you to do format data differently during each stage of your forms lifecycle.

      Replace Values: When a controls value is set (from the database, querystring, etc) you can use this to replace the value. This is the same as the REPLACEVALUE token you can use in your Form. The difference between the REPLACEVALUE token and this option is that you can use both upper and lower case characters with this option and at different stages of the form submission. Example: EMP=Employee;STD=Student; TIP: This is a great plugin to use when you want to have a drop down control that may have "Support", "Sales" and you want the users selection converted to an email address for the value selected before saving the form or sending emails. Simply add the following: Support=support@yourcompany.com;Sales=sales@yourcompanye.com;

  • Additional Form Values
    • This section includes additional fields you can add to the data collected with your forms. They are not visible in your form as controls but are saved with your form data.
  • eCommerce Settings
    • These settings are used for the eCommerce features of OnyakTech Forms. If you are not collecting payments with your form you may ignore these options.

      There are two ways to turn your Form into a purchase. You can an enable the "Is Product" purchase options in the Control Panel for a control on your Form or you can use the [SUBMITPURCHASE] Submit button control and complete the options below to indicate the details of the product to be purchased when users submit your Form. When using the [SUBMITPURCHASE] token you can only include the purchase of a single product or service. When using the Control Panel you can add multiple product purchases to a single Form by enabling the "Is Product" option for one ore more controls on your Form. If you want to add a specific product to the users shopping cart when they check a CheckBox or when they enter a positive value into a TextBox then you will use the Control Panel. When you want to add a single product or service to the users shopping cart after they submit your Form then you will want to use the [SUBMITPURCHASE] Submit Button Token.

       

      You should not use both purchase options in a single form. Use either the purchase options you can set in the Control Panel for the controls on your form or add the [SUBMITPURCHASE] token to your form (as the submit button) to submit an AuthorizeNet Subscription.

       

      Enabled Store: This options is disabled by default, checking this option engages the eCommerce settings in the OnyakTech Forms module. If this option is not checked, all eCommerce options throughout all of the OnyakTech Form modules and apps are disabled.

      Store Email: This is the primary email address for the store. All emails sent for the store will be sent from this address.

      Style Sheet: This defines the main style shee to use for the store. These are located in the portal root folder in the folder "OnyakTechStore"

      Secure Cookie: Check this option to encrypt the values stored in the cookie for the store.

      Manage Orders: Select the DNN Role that will be responsible for managing orders.

      Manage Catalog: Select the DNN Role that will be responsible for managing the catalog.

      Enabled Gateways: These are the current enabled payment gateways. If you select just one the user will only see the display options for that gateway. If you select more than one the user will be able to choose the payment gateway during checkout.

      Payment Gateway: Select the payment gateway to set the options. Once you select a gateway the current settings will appear so you can modify them as needed.

      Enable Recurring Payments: If you enable recurring payments you will need to add the [SUBMITPURCHASE] button token to your form. Make sure you have not setup product options in the Control Panel for controls on your form, those are used for the standard Forms Store purchases.

      Product/Subscription Name: This is the name of the subscription that will appear on the order Line Items.

      Product/Subscription Price: This is the price the customer will be charged

      Interval Type: This is the period type for the recurring payments.

      Subscription Interval: This is the interval for the Interval Type selected. If you selected Monthly for the Interval Type and set the Subscription Interval for 12 then the customer will be charged once every month for 12 months.

      Add Roles:Select the role to add the customer to once they complete the payment for the subscription.

  • Email Options
    • Thes options control how the Forms module sends emails. You can set the TO address dynamically or using fixed email addresses.

      Email Server Settings: If you want to use specific settings for the email server to send emails through then provide them in this section. Otherwise leave these options empty to use the default SMTP settings in DNN.

      Set Email Options from Controls: In this section you tell the Forms module to set the TO addresses based on the values entered into your form. Enter the Control Name to match with the Email Recipient Field. For example, if you have the token [TEXTBOX-MYEMAIL] and you want the value entered into that control to set the TO in the outgoing email then enter MYEMAIL into the TO field below.

      Other Email Options: In these options you can set the fixed email addresses, email subject, body and the options for alternate emails and templates to be sent from the OnyakTech Forms module for DNN.

       

      Note: You can't use control tokens in the Email To, BCC and From fields below. They must be set to actual email addresses or set from the Form (via querystring or a control). To use Control Tokens for email addresses, use the "Set Email Options from Controls" above. To add multiple email addresses use a semicolon between them. Example: you@yoursite.com;someoneelse@yoursite.com;

       

  • Email Validation and Opt-Out
    • The Email Validation Options give you granular control over the email processing allowing you to stop the form from being processed if the current user exists in a table you define. You can also have the OnyakTech Forms module for DNN check an opt-out list you have stored in your database before sending the email, if the address is found the email will not be sent. You must enable these features for them to be engaged.

  • Form Submission Actions
    • Redirect To URL: To have the user redirected to a specific page or web address after they submit the form enter the URL to that page here. se token: [IDENTITY] to pass the primary key value created from the DB transactions on Form Submit. You can also pass Custom User Profile Field values if the user is logged into your site by wrapping the field name in brackets and with all upper case characters. For example, to show the "Company" Custom User Profile Field that you may have setup in DNN you can use the token [COMPANY] in the Redirect URL. Here is a full example: http://www.mysite.com/home.aspx?mycompany=[COMPANY]. Leave this option empty to display the standard or custom message once the form has been submitted. All Form features are processed before the user is redirected.

      Forced Redirect: This option requires the use of the [SUBMITREDIRECT::Text=GOBACK] token for this feature. It redirects to the URL with form values, no other features implemented.

      Include All form Values in Redirect: Check this option to include the values entered into the form in the Redirect URL. Note that if your form contains a lot of controls and your query string length is limited you may encounter errors while submitting a form due to the length of the URL exceeding the query string length you have allowed (this is set in your web.config). If your Form contains too many controls to pass over the querystring then you should leave this option unchecked and use tokens in the Redirect To URL for the controls values you must pass instead of passing all values.

      Do not include empty values in redirects: Check this option to prevent the OnyakTech Custom Forms module from passing values for controls that do not have a value in the query string. This option can be useful to shorten the query string length and when using the OnyakTech Forms module with the OnyakTech Data Viewer module as a Search Form. If you enable the "Dynamic Searching" in the Data Viewer DNN Module all query strings passed will be used in the SQL as stored procedure parameters for the WHERE clause to execute the search for data; if you are passing empty values from controls the user does not wish to search on you will not get results you are looking for so you will check this option to resolve the search based on how the user is using your form.

      Do not include False values in redirects: This is the save as not including empty values in redirects but is specific to Checkbox, Radio and other boolean value based controls.

      Custom Message: To display a custom message when the form is submitted you will enter that message in this option. Note this is ignored if you have set a Redirect URL.

      Add user to Role on Form Submit: Check this option to grant the user access to a DNN Role after the form submission completes successfully. This also includes adding users to a role during user registration if the registration in DNN completes without issues.

      Add Custom User Profile Value: If the user is currently logged in you can set a custom user defined profile field value to a value entered into a control on your form by selecting the user profile field from the and entering a value to add to the users profile. If you leave the "Control Value To Add" empty this option will be disabled.

      NOTE: This is specific to one control on your form. The Forms module can process multiple profile field values automatically and update the users profile custom values by checking the option "Auto Profiling" in Other options

       

  • User Registration Options
    •  

      These options are specific to creating your own custom user registration for DNN. For complete details and examples see the page on User Registration.

       

      If the user already exists, then log them in: Check this option to automatically log the user in if they have entered a user name of a user that already exists and the password match is correct.

    • Send DNN Default User Registration Emails: Check this option to send the default user registration emails defined in DNN. You may use these DNN email settings as well as your own by using the options in the Email Options in Display Setup.

    • Allow just the [TEXTBOX-USERNAME] control: Checking this option will register the user using just the USERNAME. This allows quick user registration and uses the options setup in DNN to set the password and email delivery of the users password.

    • User Already Exists Message: To display a custom message when the user name being registered already exists you can enter that message in this option. Leave it empty to use the default message.

    • Enable Pre-Authorized User Registration: These options make it possible to require the user registration to be on a list of pre-authorized users. This list must exist in a table in your database.

  • Document Generation Options
    • This section enables the documentation generation features of the OnyakTech Forms module for DNN. You can have the values entered into your form generate a Microsoft Word Document or PDF document. PDF documents can be generated using a standard default generation style or by providing your own custom PDF with Fields that will be used to merge the data entered into the form to the PDF.

      When creating your own PDF Template to use for merging form values into new PDF documents it is recommended to use Adobe Acrobat to create the PDF Templates. There are applications that claim to create PDF files with Form Fields but they cannot be used as actual PDF Form Templates because they are just XML with a PDF wrapper and cannot use the standard PDF Form Template features in standard PDF Template products.

      If you don't have access to Adobe Acrobat or graphics design artists to create your PDF Templates you can request to have your templates created for you by OnyakTech. For a quote submit a new support ticket or email support@onyaktech.com. If you just need an existing PDF modified to a PDF Form Template the charge is only $75 per page.

    • Standard PDF: If you don't care about the styling of the PDF check the option "Download (Simple PDF)". You are not required to provide a PDF Template when using this option.

    • Enable PDF Form Template Merging: Use this option to upload your own PDF Template for a professional looking PDF to merge with the values entered into your form. If you check this option you must also upload your PDF Template to this section of Display Setup.

    • If you using a PDF Template the values entered into your form are automatically mapped to the fields in your PDF Template using the name of the control. You can override this by setting the name of the field to populate in the PDF by opening the Control Panel for the control and typing the name of the field in the PDF Merge field.
  • File Upload Locations
    • File Path: By default files uploaded using the File Upload control to your form are saved to the "OnyakTechFormFiles" folder in the root of the current portal directory of your DNN web site. You can change this by changing the "File Path".

    • Uncompress files after upload: Check this option to unzip Zip files uploaded to your form after the form is submitted.

    • Display File Manager to Users: The File Manager is always visible to you if are in Edit mode on the page. To have the File Manager displayed to all users you can check this option. The File Manager displays all files uploaded for the current record.

  • Metrics
    • The Metrics options enable the form counters for your form and allow you to disable the form if the form has been displayed a specified number of times. Metrics stored include total view counts, views by anonymous users, views by registered users, views for the current year and views for the current month.

      You can reset the metrics back to zero by clicking "Reset Metrics" for the current form.

  • External Module Integration
    • The External Module Integration options define how the OnyakTech Forms module for DNN integrate with other DNN modules. For details on using these options see the pages for these specific modules that integrate with the OnyakTech Forms module or the user manual for the DNN module integrating with the Forms module.

  • Signature Control Options
    • The Signature Control can be used to accept a signature from a user completing the form. Users can use their mouse on desktop computers to sign your form or their finger when completing the form using a tablet or mobile device. The options in this section define how the Signature control saves the information and how it is displayed per DNN module instance.

    • Convert signature to an image and save to web server: Checking this option will save the users signature to an image on your web server. If you are storing the form to a database the path to the image will be stored in the table. You will not need to add a column for this, the DNN Forms module will add this for you.

    • Convert Signature to an image and save to the database: Checking this option will create an image of the users signature, save the path to the image in your database along with the codes to regenerate the signature.

  • Advanced Features
    • Smooth Image Scroll: Enable this option to use the features detailed in the Scrolling Images Form sample.

    • Secure Uploaded Files: Checking this option will add the ".Resource" file extention to the files uploaded to your form. This prevents people from accessing the files directly.

    • Check to require data loaded into the form to have origianlly been saved to this portal: Check this option if you have the same form used on multiple DNN portals and want to make sure people are unable to access records created on one portal are not accessible in another portal.

    • Enable Google Map Features: Check this option to enable the Google Map Features of the OnyakTech Custom Forms DNN module. Then enter the controls on your form that will contain the location details to generate the location on the Google Map.

  • Logs and Debug Options
    • Show All Controls in Control Panel: Check this option to show all Controls that have been defined in the current portal. The default displays only control for the current form.

    • Display Cookie Details in the Debug Log: Check this option to display the users cookie details in the debug log. This can be useful when displaying and saving information to cookies with the OnyakTech Forms module. Note that you must be in Edit mode on the current DNN page to see the Debug Log.

    • Display Session Details in Debug Log: Check this option to display the users session values in the debug log. This can be useful when displaying and saving information to sessions with the OnyakTech Forms module. Note that you must be in Edit mode on the current page to see the Debug Log.

    • Enable Debug Mode: Check this to enable the Debug Log that is displayed below the Forms module while in Edit mode on the page. This is only visible to users with Edit access to the module. You can also have this information collected for every form submission and saved to the database by checking the option "Store Form and Submit Logs".

    • Enable Ajax Debug Mode: Check this option to enable the debugging of client side ajax calls used in the OnyakTech Forms module. With this option enabled, all ajax issues will be displayed on the page as they occur.

    • Store Form and Submit Logs: Check this option store complete details of all form submissions to the OnyakTech Logs table

    • Display ReCaptcha Log in Debug Output: Check this option to display detailed information about the Google ReCaptcha control int the Debug Log.

  • Other Options
    • CSS Class to add to all controls:You can apply custom CSS classes to all controls by entering the class name into this option. To have controls styled using BootStrap enter "form-control" into this option.

    • Date Format: To override the globalization features set in DNN and for the user profile you can force the date controls to use a specific format by setting that format into this option. Example: mm/dd/yyyy

    • Min. Date for Calendars: This sets the minimum date for all date controls using in the OnyakTech Forms DNN module.

    • Require Users to Select Values from List Controls: Check this option to add required field validation to all list type controls on your form. This option adds a default "Select Value" entry to these controls.

    • Execute Control Events on Postback: Checking this option will force all events you have defined in the Event Manager to execute when the user interacts with the form that causes a postback to your server. You would use this option when you need events to fire after a postback using the values currently entered for each control to change how your form is displayed and the values in the controls based on the current values for each control.

    • Style Checkbox and Radio Controls: Check this option to add the OnyakTech Forms checkbox and radio button control styling to the controls on your form. This option will make your form appear strange if you are not using the Bootstrap styling for your form.

    • Convert List Items to Title Case: This option is only necessary if you have entered the values for your list controls into the control tokens in your form template. If you have entered values into the Control Panel or you are dynamically loading the values using SQL you can ignore this option. Checking this option applies title casing to the values in the list controls

    • Show OnyakTech Forms Toolbar: Check this option to display the main toolbar at the top of the DNN module while in Edit mode on the page.

    • Auto Profiling: Check this option to enable auto-profiling. Controls named after user profile fields will be displayed and update the users DNN profile

    • Save Form Values to users Sessions: Check this option to save the values entered into your form into the users session. The name of the session is based on the name of the control

    • Save Form Values to Cookies: Check this option to save values entered into your form into the users cookies. The name is based on the name of the control on your form.

    • Load Form Values from Cookie: Check this option to enable the use of the users cookies in your form, you must have this checked if you want to load the values to the controls on your form.

    • Load Control Values: Checking this option will load values stored in cookies with names matching controls on your form to the current form when displayed.

    • Convert Yes/No values to 1/0: Check this option to convert Yes and No values entered into your form to the boolean value

    • When using Labels or hyperlink controls, if the value is "True" (a boolean or bit from your database) then show the control name otherwise show nothing: This can be useful when you want to display the name of the column on a form if the value for the column is a bit/boolean only if the value is true. For example, if you have columns that represent categories and you only want to display the categories that are true for the current record and you want the name of the category (the column in this case) displayed instead of "True/False" then you would check this option to have the Forms module handle this for you.

    • Convert True/False to Yes/No: Check this option to convert bit and boolean values to Yes and No

    • Force SSL: Check this option if your site uses SSL and your web server is using a proxy for the SSL certificates.

    • Disable All CSS and Scripts: Check this option to prevent the Forms module from loading the CSS and Script files. For example, if you are using the OnyakTech Forms DNN module on a page that you are generating emails from using the OnyakTech Axon Email module and the content you are rendering in your form is simple data with some HTML styling then you will want to check this option to prevent Axon from including all of the CSS and scripts in the emails it sends.

    • Allow Source Editor: Check this option if you wish to add your own custom styling and JavaScripts to your form. This option provides a checkbox in the Form Editor that will display a Textbox where you can add your scripts to. It's necessary to use this due to the DNN HTML Editors removing these scripts before you postback to the server. Note that this should only be enabled if you trust the people editing the Form Templates.