Screen Designer Overview
The Screen Designer utility is used to set up and configure UDFs (User Defined Fields) and RUDFs (Relational User Defined Fields) on Tour de Force forms.
There are several sections that make up the Screen Designer utility:
The Screen Designer Toolbar
- Manage UDF Picklist
Launches the UDF Picklist Administrator. This utility is outlined in “Technical Bulletin 6515 - UDF Pick List Administration”. - Export
Allows you to export the fields within the selected Profile or Main tab in Screen Designer to an Excel spreadsheet. - Add Profile
Allows you to add an Additional Profile or Main tab to the selected Item or Record. - Edit Profile Tabs
This allows you to make changes to the existing Main or Profile tabs. Changes such as
- Renaming the tabs
- Changing the maximum number of rows
- Whether the tab is visible or not
- The Background color of the tab
- Setting the tab to be UDF enabled
- Setting the tab to be TdFGrid enabled
- Setting the tab to be Custom Control enabled
- Adding/Deleting tabs
- Update Detail Table
This allows you to manually update the detail table, however, when you close the Screen Designer screen it will prompt you to update the detail table. This is usually done whenever you add or remove a field or change the control type of an existing field.
- Item Types
Use the Item Type section to specify the Tour de Force form and tab that needs to be configured.
The fields associated with the Item Types section include:
- Item Type – Use the first field to specify the Tour de Force Item or Record that needs to be configured.
- The second field in Item Types consists of all the available Main or Profile tabs within the Item or Record’s form. Tabs that are not visible will show up in italics.
- Profile Tab Details
Here you can do several things:
- Visible – If checked, this will display the tab on the Record or Item’s form. If unchecked, the tab will not be visible.
- Tab Type – Whether the tab is a Main or Profile tab. The Main Specifications and Profile Summary tab will not allow this value to be changed. All other tabs can be changed back and forth.
- Max Rows – The maximum number of rows displayed on the tab. For example, if the Max Rows field is set to 15 the Control Group or tab labeled in the Frame Caption field will take up 15 rows in the Control Group or tab associated with the Tour de Force form.
Note: As the Max Rows field is changed the Preview tab is updated automatically to reflect the changes made in
the Control Group or tab selected in the Frame Caption field. - Back Color – Use this field to set the background color of the Control Group or tab associated with the Tour de Force form. This option is useful for end users to help identify the different Tour de Force item types.
You can simply drop down the menu and select the color you would like to apply.
You can remove the background color by putting your cursor in the box to highlight the value, and then press the Delete key on your keyboard. - UDF enabled – This means you can add controls to the tab and assign UDFs. This is usually set by default.
- TdFGrid enabled – This adds the TDF grid to the tab (you can add the TDF grid to any tab (except custom control tabs) and to as many tabs as you want). If you add the TDF grid to two or more tabs, it basically moves the grid from tab to tab as you switch tabs. This means if you have an activities grid selected on tab one, when you switch to tab two it will move the grid and the activities grid is still selected)
- Custom Control enabled – This is used for a special purpose tab control (right now the Support\Tickets Notes are the only custom controls). It is the only control allowed on that tab
- Control List / Preview Tab
Control List Tab – This tab is used to display a list of all the UDFs and RUDFs details for the selected Control Group or tab associated with the Tour de Force form. The screen shot below displays the Control List for the Main Specifications tab on the Account Record.
You will notice several colors in the grid, that are identified by the legend above the Control List tab.
- No UDF – This identifies a UDF that has not been mapped to a field in the database.
- Read Only – This identifies a UDF that has been set as “Read Only”.
- Not Visible – This identifies a UDF that is not visible on the Record or Item’s form.
- TDF Field – This identifies a UDF that is a hard-coded TDF field.
Preview Tab – This tab is used to display a preview of the Control Group or tab associated with the related Tour de Force form. The screen shot below displays the Form for the Main Specifications tab on the Account Record.
(You’ll notice the colors from the legend on the Control List tab are not displayed on the Preview tab)
- Control Details
The Control Details section is used to add, configure, update, and delete UDFs and RUDFs.
The fields that are associated with the Controls Details section are:
- Row – Use this field to assign the row number for the selected UDF or RUDF. This value is also displayed in the Control List tab under Row.
- Column – Use this field is used to choose the columns where the selected UDF or RUDF field is located. This value is also displayed in the Control List under Column.
You can see an example of the Row and Column below in the screen shot. The number of rows can vary, however, there are 6 columns available on every form (A-F).
- TdF Field – This field is used to display Tour de Force system fields that the selected UDF is linked to in the Tour de Force database.
- Control Type – Use this field to select the Control Type of the selected field. Details on the available control types can be found in Section J.
- Label Caption – Use this field to create the label that is displayed for the field on the Tour de Force forms. The label on the form can be different than the name of the field in the database.
- Create UDF From Label Caption – Use this button to create a UDF in the Tour de Force database using the label caption as the UDF name.
- Tool Tip – Use this field to enter a brief description about the selected UDF/RUDF field. This field is optional.
If filled out, this will display if the user hovers over the field.
- Alignment – Use this to determine the alignment of the values displayed in the field on the form.
- Value/Label Text Color – Use this value to change the text color of the label or the data displayed within the UDF on the form.
- Value/Label Back Color – Use this value to change the background color of the label or the data displayed within the UDF on the form.
- Control Group – Use this field to change the Control Group of the UDF. Each tab that exists on an Item or Record is a unique Control Group. You can move a UDF from one Control Group (tab) to another, but not from Item or Record to another.
- Visible – Use this field to make UDF fields visible on Tour de Force forms.
- Read Only – Use this field to make UDF fields on Tour de Force forms read only. This would typically be used if you are bringing data over from your ERP system and don’t want to allow users access to manipulate the data.
- Field Tracking – Use this field to enable auditing on a specific UDF. The options are as follows:
- Do Not Track – Do not audit the field
- Number of Changes – Track the changes made
- Number of Days – Track the dates that the changes were made
- All Changes – Track all changes and dates the changes were made.
This information can be found in the “ChangeLog” tab located on any Item or Record where at least one field is being audited.
- UDF Details – This section is used to configure UDF details. There are five properties that make up the UDF Details field:
- UDF Details drop-down list
- UDF Type
- UDF Formula
- RUDF Setup
- UDF Format
- Property Format
- Default Value
- The UDF Details field displays all the UDFs that have been created in the Screen Designer utility and exist in the database. This typically displays the field in the database that the UDF is linked to.
- The UDF Type drop-down list is used to specify the type of UDF. There are 4 types of UDF types available:
- Single - This type is used to create a UDF that does not have any relational data.
- RUDF Master – This type is used to identify the master control in a RUDF
- RUDF Sub – This type is used to identify the subset of the master control in a RUDF.
- UDF Formula – This is used to calculate a value either adding, subtracting, multiplying, or dividing 2 other UDF’s values. You also can create an advanced expression to perform operations on more than 2 fields.
- UDF Formula - If the UDF Formula is selected, an additional box labeled (UDF Formula) will appear that you can click on to create your formula. Refer to Section I on how to create a UDF Formula.
- RUDF Setup
- The UDF Format field is used to select the UDF Format.
There are five UDF Formats available:
- Currency
- Date Time
- Number
- Percent
- Text
- The Property Format field displays the available formats based off the UDF Format selected.
For example:
Dates Numbers Currency
- The Default Value allows you to populate a default value in the UDF every time a new Item or Record of the selected type is created.
- Create a UDF From Label Caption
Use the following procedures to create a new UDF using the Create UDF From Label Caption button:
- Access the Screen Designer utility either from the Admin Utilities menu, or by right clicking on a form and selecting “Edit Screen Design”.
- If accessed from the Admin Utilities menu, you will need to select the Item Type and Control Group.
In the Item Type field, select the appropriate Tour de Force form that needs to be configured.
- In the Control Group field, select the appropriate tab that needs to have the new UDF added.
- At the bottom left corner of your screen, click the Add New button.
- Identify and define the Row and Column where the field will reside.
Note: The field will not display if the Row # is set higher than the number defined in the Max Rows field in the Profile Tab Details section.
- In the Control Type field choose the UDF control type that you would like to use.
- In the Label Caption field, type in the name of the UDF.
The Label Caption can be as long as you would like, but for most Control Types only 16 characters will display.
Here is an example of a field that was labelled as “Longer Label Example”:
- Enter an optional Tool Tip if desired.
- In the Alignment field choose the justification of the UDF.
- Use the Control Group field to choose the location the Control Group or tab associated with the UDF.
Note: This field defaults to the Control Group selected in the Item – Container section.
- Choose whether you will utilize Field Tracking.
- Choose whether the field will be Visible on the form.
- Choose whether the field will be Read Only (this affects both the TDF Form and TDF Grid).
- Click the Create UDF From Label Caption button to create the UDF in the database.
- Choose if you would like to set the visibility of the new UDF within existing grid views. Select NO to make it available for all grid views.
The UDF Details section is automatically updated and the new UDF is added to the UDF Details list.
Make any additional adjustments to the UDF Details section and then click “Update” if any changes are made.
- Delete a UDF
Use the following procedures to delete a UDF from a Control Group:
- Access the Screen Designer utility either from the Admin Utilities menu, or by right clicking on a form and selecting “Edit Screen Design”.
- If accessed from the Admin Utilities menu, you will need to select the Item Type and Control Group.
In the Item Type field, select the appropriate Tour de Force form that needs to be configured.
- In the Control Group field, select the appropriate tab that needs to have the new UDF added.
- From either the Control List or Preview Tab, select the UDF that needs to be deleted.
- In the Control Details section, click the Delete button.
You will be prompted to enter a 4-digit code that is displayed in the window. If you wish to proceed, enter the 4-digit code and click “OK” to delete the field.
-
Creating a UDF Formula
- First, make sure the Control Type of the UDF is set to “UDF Formula”.
- Next, set the UDF Type to “UDF Formula”.
- Click on the UDF Formula button located beside the UDF Type field.
- Select the UDF that you will use in UDF 1.
- Select your Operator (+, -, *, /).
- Select the UDF that you will use in UDF 2.
- You will notice the formula is populated in the field next to the UDF Formula button.
- Click OK to apply the formula.
Please contact our Support Team for assistance with advanced expressions.
- The User-Defined Field Control Types
Administrative users of Tour de Force can edit Tour de Force forms to fit the company’s needs. The Control Type field is the field that is used to define what kind of UDF is used when creating UDFs in the Screen Designer.
There are twenty-nine control types available in the Control Type field. In order of appearance:
- AccountUDF – Allows you to pull info from the Account screen onto another item/record.
- CalcEdit – A calculator that allows a user to calculate a value to enter in that field.
- CheckBox – A simple “yes/no” checkbox that can be selected by the user.
- CheckList – A “user-created” checklist. When values are “checked”, they are time stamped with the word “Completed” and the current date. Users can add/remove/modify values in this field and then check multiple values.
- ComboBox - This control combines the features of a text box and a list box. This control allows users to select an item either by typing into the combo box, or by selecting it from the list. Users can also enter a value that isn’t in the list, however, that value is not added to the list.
- ContactSelector - This control allows users to add an existing Contact record in Tour de Force to the item or record. This control is typically used to link a caterer or event planner to an Event.
- Date
- DateTime
- DropDownList – A list of values that are defined in Pick List Administrator by the Admin. Users can only select one value.
- HyperLink – Allows you to put in a hyperlink. If you right click the “Empty” value that shows up by default, you can link to a Folder/File, link to a website (Manual Edit), or a TDF item. You also have the option to caption the hyperlink, or delete the caption.
- HyperLink Edit – A text box that allows the user to type in a URL. It will convert the URL to a clickable hyperlink.
- Label – A simple label that you can customize with whatever text you would like. This text will be BOLD and UNDERLINE.
- Linked Item Counter – A field that displays a count of linked items that are linked to the current Record or Item.
Once you select “Linked Item Counter”, you can right click on it and select “Edit”.
Here, you can select the Child Item type, and set up additional filters if necessary to determine what is “counted”.
- Linked Item Grid – Adds a small grid to the screen that displays the linked (child) item of your choice.
You can pick the child item, the default view, and a few of the toolbar options.
Once you select it, there’s a blue “i” that shows up that you can right click on to edit the settings.
- ListBox - This control displays a list of items from which the user can select one or more.
- ListBoxWithEdit – Currently this item is not working.
- LookUpEdit – Similar to the drop-down list but gives you the option of having a quick filter so that you can filter through large amounts of options/data.
- MemoBox – This control is used to allow users to add notes in plain text.
- Note – This control is designed for a profile tab and will take up the whole tab. It allows the users to add notes with several formatting options.
- NoteList – Also the full height and width of a profile tab, the NoteList allows you to collect a set of predefined information. The section of information is repeated every time you click the “+” sign.
- Phone Number – Allows the user to enter a phone number. After entering the number, it will automatically format.
- StopWatch – A simple stop watch that allows a user to record time.
- TDFUserList – A multi-select box that allows users to pick multiple values. The values displayed are the users that are configured for access to TDF. In some instances (BYOR, Alerts), there is a known issue where it will display the SID instead of the actual user’s name – even though it shows up ok in the screens). A work around is to create a dropdown list and manually manage the values.
- TDFUserSelector – A drop down list that displays the list of users configured for access to TDF (same known issue as TDFUserList – where it may display SID instead). A work-around is to create a dropdown list and manually manage the values.
- TextBox – A simple text box that allows a user to manually enter values.
- TextBox With Spinner – A text box that allows only numeric entry, but has a spinner to allow the user to adjust the number up or down by clicking the arrows.
- Timestamp – When you click the “Timestamp” button, it stamps the date/time in the field.
- UDFFormula – Allows you to do basic formulas (+, -, *, /) with 2 UDF’s and store the value in a separate UDF.
Technical Bulletin 10513
Comments
0 comments
Article is closed for comments.