Portal Connector Fields and Widgets Technical Documentation

Transcription

1 Portal Connector Fields and Widgets Technical Documentation

2 1 Form Fields 1.1 Content CRM Form Configuration The CRM Form Configuration manages all the fields on the form and defines how the fields will operate and which entity they will use. The CRM Form Configuration can have sub-crm Form Configurations which relate fields to each other. Any relations to the top most CRM Form Configuration are submitted on the form submission. In order to set this up the child CRM Form Configurations must configure the CRM Relationship in relation to the parent CRM Form Configuration appropriately. CRM Entity Query string Key Id CRM Relationship The entity logical name of the entity you want the form to be configured for The query string key name that will provide the record id to be updated This field defines the relationship that the current CRM Form Configuration has with its parent CRM Form Configuration. Entities that show up here are entities that have been updated with metadata through the Sitefinity backend Must be unique to all other query string keys Must not contain any spaces Alpha numeric Only relevant if the CRM Form Configuration has a relatable parent CRM Form Configuration CRM Text Field The CRM Text Field is used for displaying strings, numeric or masked data. Title The title of the text field, displayed on top of the textbox CRM Field Maximum Length The field that the text field data will come from The maximum length (in characters) of the text field Depending on the field type, different properties will be available in the designer. Minimum Value: 1 Maximum Value: 32767

3 Converts the textbox to a label so that the user cannot add or modify any data Make Required Empty Message Field Width Text Mode Rows Masked Adds validation to the text field to ensure that a value exists in the field before submitting The value of the gray text that is displayed in the text field when there is no data The width of the textbox in pixels The text mode of the text field, determines the format of the data that can be entered into the textbox. If the text mode is multi line, this value determines how many rows of text are displayed when editing the field ReadOnly fields are not submitted back to Dynamics CRM A width of 0 means 100% width One of two values: Single Line Multi Line Minimum Value: 1 Maximum Value: Mask Type Display Prompt Char Save Formatted Values Determines the type of mask used in this field. Whether or not to display a character in place of your mask Whether or not to save the formatted values to Dynamics CRM or to save just the raw value without any formatting No mask provides no input validation A custom mask can be specified using the formatting elements listed here. Numeric Display Type One of three values: The display type of the numeric value. Each value Number corresponds to what character is displayed before Currency ($) the value Percent (%) Show Spin Buttons Whether or not to show spin buttons for incrementing numbers No Formatting Removes all formatting on the numeric value when checked. Advanced PromptChar The character used in place of your mask s white space. MinValue The minimum value accepted in a numeric text box Visible when Display Prompt Char is selected

4 MaxValue The maximum value accepted in a numeric text box InterceptArrowKeys Allows the use of arrow keys to step up and down the numeric value InterceptMouseWheel Allows the use of the mouse wheel to step up and down the numeric value The step at which to increment when Step incrementing by arrow keys, mouse wheel or spin buttons Precision The number of decimal places the numeric value is displayed and stored at True or False True or False CRM DateTime Field The CRM DateTime Field displays date and/or time values on your form. Title The title of the field, displayed on top of the input field CRM Field The field that the date field data will come from Make Required Format Use Blackout Dates Include Weekends as Blackout Dates Allow User to Select Blackout Dates Converts the field to a label so that the user cannot add or modify any data Adds validation to the field to ensure that a value exists in the field before submitting The format to display date/time field Whether or not to apply the blackout dates stored in Sitefinity to the date time picker. Whether or not to make weekend s behave as a blackout date Allows the user to select blackout dates Only shows available date/time fields on the current entity ReadOnly fields are not submitted back to Dynamics CRM The time selector button will be hidden if the date format contains no time element The date selector button will be hidden if the date format contains no date element Custom formatting details can be found here Blackout dates can be added in the Sitefinity backend

5 1.1.4 CRM Lookup The CRM Lookup Field allows you to edit or view any 1:1 relationship on the current entity. If a Customer field is selected, more options are available to customize fetches for Contacts and Accounts, the properties in these options are the same as the properties for non-customer fields. Title The title of the field, displayed on top of the input field CRM Field The field that the EntityReference data will come from Make Required Value Field Display Field Fetch Xml Data Source Filters Converts the field to a label so that the user cannot add or modify any data Adds validation to the text field to ensure that a value exists in the field before submitting The value field in the fetch, used to uniquely identify the record The field in the fetch that is used to display to the end user The fetch xml that contains all the desired attributes for the entity selected in the CRM Field Filters are used to replace the text in the Fetch Xml before it is executed. Only shows applicable EntityReference fields on the current entity ReadOnly fields are not submitted back to Dynamics CRM Usually the primary key field of the entity If a Customer CRM Field is selected, you must specify a fetch for both Account and Contact Case sensitive Advanced PassValueToQuerystring True or False QuerystringIdForPassedValue PostbackUrl CRM Picklist The CRM Picklist Field displays an editable drop-down list of items based on the selected Dynamics CRM picklist selected in the CRM Field property. Title The title of the field, displayed on top of the input field

6 CRM Field The Picklist field to display and save data to Make Required Converts the field to a label so that the user cannot add or modify any data Adds validation to the field to ensure that a value exists in the field before submitting Only shows applicable Picklist fields Read only fields are not submitted back to Dynamics CRM CRM Yes/No The CRM Yes/No displays an editable Boolean value. Title The title of the field, displayed on top of the input field CRM Field The Yes/No field to display and save data to Only shows applicable Yes/No fields One of four values: Display Type Drop down list How the Boolean selection will be represented Radio buttons on the form Check box Horizontal slider Read only fields are not Converts the field to a label so that the user submitted back to cannot add or modify any data Dynamics CRM CRM Rating Field The CRM Rating field allows the user to specify a rating with their submission. The style of the rating field depends on the currently active skin using the Form Decorator. The title of the field, displayed on top of the Title input field CRM Field The numeric field to save the data to Only shows decimal fields Minimum Value: 1 Max # of Items The maximum amount of rating items displayed Maximum Value: 20 One of three values: Item Selection Mode The selection mode of the rating items Half Exact

7 Converts the field to a label so that the user cannot add or modify any data Read only fields are not submitted back to Dynamics CRM CRM Status Field The CRM Status field displays the status field of the working entity. Title The title of the field, displayed on top of the input field Filter Status by State Converts the field to a label so that the user cannot add or modify any data Read only fields are not submitted back to Dynamics CRM CRM Static Value The CRM Static Value field is a hidden field, used to set any field on the current entity to a desired value during submit. Different input methods will appear depending on the type of the field. Static Value Field The field to change data on submit Value The value to set the field Use logged in user s contact id When selected, instead of submitting the value stored in the value field, it submits the contact id of the current user. Value must not contain any formatting. Integers must only be numeric. The Static Value Field property must be of type Lookup CRM System Value The CRM System Value field is a read only field that displays system level fields that are common to every entity.

8 The title of the field, displayed on top of the Title read only field Including: Created By Created By (Delegate) Created On CRM Field The system level field to view Modified By Modified By (Delegate) Modified On Record Created On Format Specifies the format that the DateTime field will Custom formatting details be displayed like can be found here CRM QueryString Value The CRM QueryString Value field is a special hidden field that allows the use of query string values passed in from the URL as form field values QueryString Key The key value of the query string pair Target CRM Field Use logged in user s contact id This is the field name that the specified query string value will be saved to CRM on form submit If selected, the field will submit the logged in user's contact ID in place of the query string value. Must not contain spaces Must not conflict with any other query string values on the form CRM Notes The CRM Notes field is a field used to add, edit and delete notes from entitites. The CRM Notes field requires that the current form configuration s selected entity has the SupportsNotes property set to true in the metadata. This property is retrieved automatically. Title The title of the field, displayed on top of the notes field Ensures the user cannot add, edit or delete any notes. Notes are just viewable

9 Allow Adding Notes Allows the user to add new notes to the current entity Allow Editing Notes Allows the user to edit existing notes on the current entity Allow Deleting Notes Allows the user to delete existing notes on the current entity Max Notes Height Allow Uploading Attachments Allow Downloading Attachments Allowed Extensions The maximum amount of notes that can be displayed at once The max height of the notes field in pixels Allows the user to upload new attachments to Dynamics CRM Allows the user to download existing attachments from Dynamics CRM A semi-colon delimited field that specifies all the extensions allowed to be uploaded 0 means unlimited If there are more notes than the maximum number of allowed notes to be displayed, the notes field will be ordered by last modified. The notes field will automatically expand until it reaches this height before it applies scrollbars to the list If nothing is specified, the user cannot upload any attachments CRM Sub-Grid View The CRM Sub-Grid view is used for displaying a grid of related entities on a form Disables all adding, editing and deleting of records in the grid, making it only viewable Allow Adding Allows the user to add a new related record Allow Editing Allow Deleting Allow Exporting CRM Relationship Allows the user to edit existing related records Allows the user to delete existing related records Allows the user to export the grid into an excel spreadsheet format The specified relationship between both related entities used to populate the grid The selected add record page must support the entity relationship The selected edit record page must support the entity relationship The value in brackets is the related field name

10 Fetch Xml Data Source The fetch xml that contains all the attributes that you want to display in the grid view. Primary fetch entity must match the related entity The relationship link is automatically added for you Advanced ColumnWidths A semi-colon delimited field that specifies how wide each column is on the grid. ColumnHeaders A semi-colon delimited field that specifies the headers of each column on the grid. This overwrites any data returned by the fetch. Empty delimiters are ignored and use the default auto column size. Empty delimiters are ignored and use the original column name 1.2 Layout CRM Form Layout The CRM Form Layout provides a container for all of the CRM Form Configurations on a form. All CRM Form Configurations and must be inside a CRM Form Layout. CRM Form Layouts are designed this way to easily manage the submission of multiple entities on a single form or page. 2 Page Widgets 2.1 Content CRM Filtered View Allow Adding Allow Editing Allow Deleting Allow Exporting

11 CRM Entity Fetch Xml Data Source Filter Form Filters Filters are used to replace the text in the Fetch Xml before it is executed. Case sensitive CRM Form Manager The CRM Form Manager is used to display forms that you create, allowing the user to add, edit or delete data directly from Dynamics CRM This property defines if the whole form is read only or not. A read only form means that all fields on the form that are editable cannot be modified. If Form Submission occurs, no data would be submitted back to CRM. Use Logged in User Contact Id This property overwrites the query string id with the current users contact id, allowing for Profile forms to be displayed without needing a grid to get the record If there is no user logged in, or the contact id is empty, this option reverts back to standard use. Form must be a form with a form configuration configured to work with Contacts from CRM CRM Data View The CRM Data View is used to display a grid of read only data using a fetch or a saved query. Paging Required A Boolean field that determines if the control should enable paging: having multiple pages on the grid to display the data instead of just one large page. Page Size The number of records that are displayed in Minimum Value: 1 each page of data. Maximum Value: 100

12 Query Type Filters Determines the type of data source used for the grid. Can be either fetch xml or a Dynamics CRM saved query. Filters are used to replace the text in the Fetch Xml before it is executed. A saved query type must refer to a system level view stored in the savedquery entity. The saved query field refers to the name attribute of the saved query entity. The name must be unique. The saved query does not apply any filters Case sensitive Only applies to fetch xml query type CRM Chart View The CRM Chart View is an advanced and powerful widget used for creating dashboard like interfaces and displaying data from aggregate fetches in a chart format. Requirements 1. An HTML 5 compatible browser that supports SVG elements Series The CRM Chart View can have a maximum of 10 series. Each series has its own properties and settings so that you may display multiple sets of data on one chart. Adding a series adds a series to the end of the series list. Removing a series removes the last series in the list. If you add a series and modify the series data and then remove the series, all data will be lost for that series. Series data is only saved when you save the designer itself. Series Fetch Xml Data Source The aggregate fetch that contains all data for all series. Including field names if required. Series Name The name of the series of data, displayed in the legend of the chart. Series Color The color that the series will be on the chart X-Axis Data Field Y-Axis Data Field The data field used for the x-axis. Adding a new series automatically changes the color Only used in charts that require both X and Y data The data field used for the y-axis. Required for all series data

13 Label Format String Tooltip Format String The format of the string used to display formatted data on the chart element The format string used to display formatted data when hovering over a chart element. {0} denotes where the data will be placed. More details on formatting types here. {0} denotes where the data will be placed. More details on formatting types here. Chart Title The text that will appear as the title of the chart. Chart Type The display format of the chart. Different types of charts require certain types of data input from the fetch xml. The letter in the square brackets represents how many dimensions of data the chart will display. [Y] means the chart will only plot data on the y axis. [XY] means the chart will plot data in the x and y axis. Plot Background Color Determines the background color of the entire plot area. Axis Title The title that is displayed on the axis. {0} denotes where the data Axis Label will be placed. The way the axis label field is formatted. Format String More details on formatting types here. Minimum Value Can be positive or negative The minimum value the axis will display on the Must be less than the chart maximum value Maximum Value Can be positive or negative The maximum value the axis will display on the Must be greater than the chart minimum value Step The step at which the axis labels display Must not be 0 Axis Color The color of the labels and border for the axis Major grid lines appear once Major Grid The color of the major grid lines every Step and once for each Lines Color column of data in the series Minor grid lines appear Minor Grid The color of the minor grid lines evenly between major grid Lines Color lines Filters Case sensitive Filters are used to replace the text in the Fetch Xml Only applies to fetch xml before it is executed. query type.

14 Advanced One of three values: Left ChartTitleAlignment The alignment of the title on the chart Center Right One of two values: ChartTitlePosition The position of the title on the chart Top Bottom ChartTitleBackgroundColor One of four values: Top The position of the legend on the ChartLegendPosition Bottom chart. Left Right LegendBackgroundColor Whether or not to use transitions UseTransitions when loading the chart and interacting True or False with the chart Bar and Column Chart Values: Center InsideEnd InsideBase OutsideEnd Line and Scatter Chart Values: The position of the labels on the chart Above LabelsPosition in relation to the data being displayed. Right This can differ for each chart type. Below Left Pie and Donut Values: Center InsideEnd OutsideEnd Stacks the series items next to each Stacked other. Applies only to Scatter and ScatterLine charts This property determines what the One of three values: MissingValuesBehavior chart will do when data is missing from Gap the series. Zero Interpolate Applies only to Scatter and LineWidth The width of the line in pixels ScatterLine charts The minor grid lines for axis x. Can One of two values: AxisXMinorTickType either be drawn outside, or not drawn Outside at all. None The background color for the chart The background color for the chart Must be in web hex color Must be in web hex color title. legend. format (ex. #FF00FF) format (ex. #FF00FF)

15 This is the length of the line in pixels AxisXMinorTickSize that is drawn to indicate the tick on the chart. The major grid lines for axis x. Can One of two values: AxisXMajorTickType either be drawn outside, or not drawn Outside at all. None AxisXMajorTickSize This is the length of the line in pixels that is drawn to indicate the tick on the chart. AxisXReversed Whether or not this axis should be reversed. True or False AxisXCrossing Index/value at which the first perpendicular axis crosses this axis AxisXLabelRotationAngle The rotation angle of the axis label Rotation in degrees AxisXLabelSkip Defines that the first n axis labels will not be displayed AxisXLabelStep Defines that every n-th axis label will be rendered. The minor grid lines for axis y. Can One of two values: AxisYMinorTickType either be drawn outside, or not drawn Outside at all. None AxisYMinorTickSize This is the length of the line in pixels that is drawn to indicate the tick on the chart. The major grid lines for axis y. Can One of two values: AxisYMajorTickType either be drawn outside, or not drawn Outside at all. None AxisYMajorTickSize This is the length of the line in pixels that is drawn to indicate the tick on the chart. AxisYReversed Whether or not this axis should be reversed. True or False AxisYCrossing Index/value at which the first perpendicular axis crosses this axis AxisYLabelRotationAngle The rotation angle of the axis label Rotation in degrees AxisYLabelSkip Defines that the first n axis labels will not be displayed AxisYLabelStep Defines that every n-th axis label will be rendered. ExplodedField The data field holding bool value which determines whether the sector should Applies only to pie and donut charts be exploded Not implemented StartAngle Specifies the start angle of the first Applies only to pie and donut segment. charts HoleSize The size of the hole in the donut chart Applies only to donut charts CRM Grid View

16 The CRM Grid View is used to display data in a grid that you can interact with. The grid is populated using a fetch xml that executes directly from Dynamics CRM. The CRM Grid View requires pages with forms to redirect to in order add or edit records. These pages must have forms that are set up to work with the Grid View s entity Allow Adding Enables an add button on the grid which allows the user to add records. Allow Editing Allow Deleting Allow Filtering Allow Exporting CRM Entity Fetch Xml Data Source Filters Enables an edit button on the grid which allows the user to edit the chosen record Enables a Delete button on the grid which enables the user to delete records in CRM. Enables a filtered control that allows you to filter the grid results Enables an export button that exports the grid data to an excel spreadsheet. The working entity on the grid. All forms linked to this grid must share the same entity. The fetch xml that contains all the attributes that you want to display in the grid view. Filters are used to replace the text in the fetch xml data source before it is executed. Must select an Add Record page that has a form with the same working entity Must select an Edit Record page that has a form with the same working entity. Fetch supports linked entities Primary fetch entity must match the CRM Entity field Case sensitive Advanced ColumnWidths ColumnHeaders AppendCurrentURL A semi-colon delimited field that specifies how wide each column is on the grid. A semi-colon delimited field that specifies the headers of each column on the grid. This overwrites any data returned by the fetch. Appends the current URL to the query string so that the user is redirected back to the current page after they complete the form Empty delimiters are ignored and use the default auto column size. If all columns have a fixed pixel width, then the sum of all widths must match the grid width, otherwise the columns expand to fill up the available space. In such cases it is good to leave one column without a width (e.g. the last one), so that it can adjust automatically. Empty delimiters are ignored and use the original column name True or False

17 2.1.6 CRM Add/Edit Grid View The CRM Add/Edit Grid View is very similar to the CRM Grid View. The CRM Add/Edit Grid View allows you to select Forms for editing and adding your data, as opposed to Pages. For brevity, only properties differing from the CRM Grid View are listed below. Allow Adding Enables an add button on the grid which allows the user to add records. Allow Editing Enables an edit button on the grid which allows the user to edit the chosen record Must select an Add Record form that is set up to work with the selected CRM Entity. Must select an Edit Record form that is set up to work with the selected CRM Entity. Advanced ColumnWidths ColumnHeaders AppendCurrentURL A semi-colon delimited field that specifies how wide each column is on the grid. A semi-colon delimited field that specifies the headers of each column on the grid. This overwrites any data returned by the fetch. Appends the current URL to the query string so that the user is redirected back to the current page after they complete the form Empty delimiters are ignored and use the default auto column size. If all columns have a fixed pixel width, then the sum of all widths must match the grid width, otherwise the columns expand to fill up the available space. In such cases it is good to leave one column without a width (e.g. the last one), so that it can adjust automatically. Empty delimiters are ignored and use the original column name True or False

18 2.1.7 Form Decorator The Form Decorator control applies a specified theme to all Sitefinity controls on a page. This control only applies to Pages or Templates, undefined behavior will occur when more than one Form Decorator is added to a page or template. The last Form Decorator added to the Template-Page hierarchy will be the form decorator that is selected for skinning the page, this allows for a different skin on each page. Skin Determines the skin that the Form Decorator will use on the current page or template. Advanced ShowSkinSelector Shows a ComboBox on the page that gives the user control of what theme they want to use. 2.2 Layout CRM Form Layout The CRM Form Layout is not applicable to Pages 3 Appendix 3.1 Mask Formatting Mask Element # Digit or space (optional). If this position is blank in the mask, it is rendered as a prompt character. L Uppercase letter (required). Restricts input to the ASCII letters A-Z. l Lowercase letter (required). Restricts input to the ASCII letters a-z. a Accepts any character. If this position is blank in the mask, it is rendered as a prompt character. <n..m> Restricts the user to an integer in the declared numeric range. Numeric range mask parts can occupy multiple positions. <n...m> Restricts the user to an integer in the declared numeric range. For the internal representation of the value is used Int64(Long) type. <Option1 Option Restricts the user to one of a fixed set of options. The pipe(" ") serves as a separator 2 Option3> between the option values. \ Escape character, allowing the following character to act as literal text. For example "\a" is the character "a" rather than including a free mask part. "\\" is the literal back slash character. Any other All non-mask elements appear as themselves. Literals always occupy a static position in the characters mask at run time, and cannot be moved or deleted by the user.

19