Creating a Calendar DataPage
Calendar DataPages are multi-page applications that provide the following high-level capabilities:
- An interactive search form or pre-defined criteria
- A results screen where matching records are displayed in a calendar format
- An optional details page where one record is displayed and some or all fields may be editable
Creating a Calendar with Interactive Search
Calendars are created easily through DataPage Wizards. Here is the process for creating a Calendar that lets users perform ad-hoc queries.
- Ensure that you already have a table or view for this Calendar.
- From the File menu select New DataPage or in the DataPages view click
on the toolbar. This brings up the DataPage Wizard.
1. DataPage Properties
Click on the Calendars icon on the left and on the Monthly or Weekly icon on the right to select the DataPage type.
Click Next.
2. DataPage DataSource
Select your table or view as data source and enter a name for your DataPage.
Select a Style and a Localization to apply.
Advanced Options
Check Enable Advanced Options to access field layout options and set up external associations and defaults.Check Enable parameters to enable your DataPage to pass and receive parameters.
Click Next.
3. Search Type
Continue with the default choice of Search Form. Creating a Calendar with Pre-defined Criteria is outlined below.
To allow automatic focus of cursor on the first field of the search form, check the Automatically focus cursor on first field option.
Click Next.
4. Select Search Fields
Select the fields that are going to be elements of your search form.
For most scenarios the Boolean operator must remain at its default Results that match all criteria (AND) state.
Click Next.
5. Configure Search Fields
The fields you selected are listed on the left. Select each field, one at a time, and configure its properties on the right. For a description of available comparison types and form elements, click the corresponding link.
Click the Insert button
to add multiple criteria per field, a section, a virtual field, an HTML block, CAPTCHA or header and footer.
Use the Move up
and Move down
buttons to change the display order of the sections, fields and blocks.
Advanced Options
Click the Advanced tab to configure the following:
Layout Options
- By default, every form field starts on a new line. Check Continue next element on same line to place multiple fields on one line.
- The Label Position radio buttons are useful when you want to override the section's label position for this particular field.
External Associations and Defaults
- By default, form fields are blank on load. You can either Assign a static value to provide a default value for the field or Receive parameter from another DataPage or from an external application.
- On exit, the form can Pass field value to next page as a parameter.
Insert Special to filter data by user IP or DataPage host:
- User IP Address – The search only returns records which are equal to the User IP Address.
- DataPage Host – The search only returns records which are equal to the DataPage Host. Select host type as Complete URL (including parameters), Page URL (no parameters), or Domain name.
Note that you can only insert special for hidden text fields.
Click Next.
6. Select Results Page Fields
Select the fields you want to display in the results page.
Click Next.
7. Configure Results Page Fields
Select each of the fields from the list on the left, and on the right configure labels and formatting and rendering options. Add HTML blocks and header and footer as desired.
Click Next.
8. Search Results Options
Configure Results Page display options:
- Date field – Select the column in your table which will be used to place results within your Calendar.
- Calendar view – Choose between a monthly and weekly view.
- Date displayed by default – Select the date that should be visible on the default view of your Calendar.
- Today - The current date is shown on your Calendar.
- Specific date - The date you select is shown on your Calendar.
- Days relative to today - This option will show a Calendar in the past or in the future based on the number of days you select.
- Date of first matching record – The Calendar shows the earliest entry in your resultset.
- Date of latest matching record – The Calendar shows the most recent entry in your resultset.
- Enable date navigation buttons – These buttons allow your users to navigate to previous and future dates from your Calendar. In the monthly view, you can navigate by month and year. In the weekly view, you can navigate by week and month.
Configure Calendar options:
- Sort order – Select the sort fields of your Results Page and choose Ascending or Descending options through the toggle buttons. Up to three fields can be used for sorting. You have the option to sort search results by fields that are not chosen to display on the Results page.
9. Details Page
Choose whether you want a details screen to be linked to each search result.
When Details Page is enabled, Caspio Bridge adds a link after each record the user must click to view details. Instead of the action link used by default, you can designate a Specific data field in search results to be used as a link.
Click Next or Finish.
10. Select Details Page Fields
This and the following steps are skipped if you did not enable Details Page.
Select the desired fields for your Calendar's details screen.
Click Next.
11. Configure Details Page Fields
Select each field and configure its properties. Add sections, virtual fields, HTML blocks, and header and footer as desired.
Advanced Options
Use the Insert button
beside the Label text box to insert any of the table field values into the label. Field values can be formatted as described under Advanced Options here.
Click the Advanced tab to configure the following:
Layout Options
- By default, every form field starts on a new line. Check Continue next element on same line to place multiple fields on one line.
- The Label Position radio buttons are useful when you want to override the section's label position for this particular field.
External Associations and Defaults
- By default, form fields are blank on load. You can either Assign a static value to provide a default value for the field or Receive parameter from another DataPage or from an external application.
- On exit, the form can Pass field value to next page as a parameter.
Use the Insert button
beside the Label text box to insert any of the table field values into the label. Field values can be formatted as described under Advanced Options.
Click the Advanced tab to configure the following:
Layout Options
- By default, every form field starts on a new line. Check Continue next element on same line to place multiple fields on one line.
- The Label Position radio buttons are useful when you want to override the section's label position for this particular field.
External Associations and Defaults
- By default, form fields are blank on load. You can either Assign a static value to provide a default value for the field or Receive parameter from another DataPage or from an external application.
- On exit, the form can Pass field value to next page as a parameter.
Click Next or Finish.
12. Finish
A confirmation that your DataPage has been created is displayed. Click Close.
Creating a Calendar with Pre-defined Criteria
To create a Calendar to filter data without end user interaction, begin as described above. When you reach step 3, Search Type, select the Pre-defined Criteria option and click Next.
Advanced Options
Check Enable parameters in criteria to filter data based on parameters passed from other pages.Select if you wish to enable Caspio Bridge parameters only or both Bridge and external parameters.
4. Select Filtering Fields
Select the fields that you are going to use in filtering data.
For most scenarios the Boolean operator // must remain at its default AND state.
Click Next.
5. Configure Filtering Fields
The fields you selected are listed on the left. Select each field, one at a time, and configure its filtering criteria on the right. Consult the description of available comparison types if needed.
Click the Insert button
to configure multiple criteria per field.
Click the Advanced tab to configure external association and defaults for each filtering field:
- Assign valuefrom Standard Tab to provide a fixed criteria for the field.
- Receive parameter from a preceding page or external application to perform filtering based on dynamic criteria. Define filtering behavior with empty or missing parameters:
- Value required – If the parameter is missing or empty, the search does not return any records.
- If empty, match blank values only – The search returns any records where this particular field is empty. AutoNumber and Yes/No fields do not have this option.
- If empty, ignore criteria – The search ignores this criteria.
- If empty, match all records – The search returns all records from the table, no matter what their values are.
Note that the distinction between the 3rd and 4th criteria definitions is only visible when multiple criteria are used for one field. When only one criteria is defined for a field, both criteria definitions return the same results.
- Insert Special to filter data by user IP or DataPage host:
- User IP Address – The search returns only the records that are equal to the User IP Address.
- DataPage Host – The search returns only the records that are equal to the DataPage Host. Select desired host type: Complete URL (including parameters), Page URL (no parameters), or Domain name.
Note that the Insert Special option is only available for text fields.
Click Next.
Now, proceed as described beginning with step 6, Select Results Page Fields above.
What's next?
- Previewing your DataPage.
- Deploy your DataPage on your site.
- Control access with Web User Authentication and Record Level Security.
- Customize DataPage look and feel through DataPage Styles.
- Localize your DataPage into any language with country-specific formatting.
