Literal Text

The Literal-Text is a table (md_locale_text) in the Metadata Administration module of iTopia. This table allows you to modify the text that displays on menu items as well as view and column titles. For more information about changing literal text, click here. Note: Once the text is modified, you must run the 'Refresh Data Dictionary & Literals' module; for more information on this module, click here.

• This table defines the actual literal text seen on the menu item, column title and/or view title for the system by locale.

• The Locale Key identifies the language preference for the user. Every client is given a specific Locale Key to identify the language used. Currently, the only Locale Key supported is en_CLIENT.

• The Literal Key, along with the user's Locale Key that is assigned in the Literal Text module, determines the actual Text that is seen on the menu system, column names in views and view titles.

The following fields are available on the Literal-Text view and are based on the order in which they appear in the grid on the search page:

• Text - the actual text that appears on the menu item, column title and view title. You can edit this field directly in the grid by double clicking on the cell; once you have modified the text, click on the check mark to update the field or click on the 'x' to cancel the change request.
  • Note: If the resource associated with the literal you are currently working with has an 'Overridden Description' entered in the Resource Master view, then the 'Overridden Description' will still display on all menu items, column titles and view titles. For more information on the Resource Master, click here.

• Literal Key - the unique identifier for the literal.

• Locale Key - the code for the language preference for the user. Currently, iTopia supports en_CLIENT.

• Type - a classification of literal. There are many options available, however the following two types relate to menu items, column titles and view titles:
  • 16-Title: describes entities such as resources, resource groups, views, tables, subviews, sub-sections, windows, pages and tabs in dialog boxes.

  • 17-Label: describes columns, domains, arguments, preference descriptions, and parameters in a report.

The following table outlines the functionality of each button on the Literal-Text Search/Grid page:

Button Label	Icon	Functionality
Search		Initiates the search and returns records as per the entered criteria.
Clear		Clears the entered search criteria.
Export to Excel		Opens a spread sheet that contains all of the records retrieved by the search. Note: The information on this spread sheet cannot be edited and saved back into the current module.
Use Selected Records As Criteria for Action		(On top of the grid in the Header section) Caution: When using any of the following options, you may inadvertently delete or modify records that you did not mean to change. The records can only be recovered to their original state from a backup of the system. The following 4 options are available: Edit All Records with Excel – opens an editable Excel spread sheet that contains all of the records retrieved from the search up to the quantity entered in the ‘Maximum Search Results Records to Display’ field for this user. Note: This option is only available if Excel is installed on your PC and the user has been assigned the Web Services license. The following options work with the ‘Select or Deselect all Rows’ check box in the Header section and with the selected check boxes on the detail lines in the grid. Edit with Excel – opens an editable Excel spread sheet that contains all of the records selected from the grid. Note: This option is only available if Excel is installed on your PC and the user has been assigned the Web Services license. Delete – displays the following message: “Are you sure you want to delete these records? Yes/No”. You can only delete records that are NOT in use anywhere else in the system. Update Field – a window opens with the following message: “Updating x Records in Literal-Text”. The window includes a Field drop list that allows you to select the field you want to update. An input field automatically opens allowing you to enter the new information. Click Submit to update the record or click Close to cancel the request.
Use Record as Criteria for Action		Only the record to the right of this icon is affected by the actions selected. The following 4 options are available: Link To – displays quick links to various Meta and System Monitoring modules that are related to the current resource. ‘Recent Views’ will be available if you have previously selected any of the options from the Link To menu (a maximum of 5 recent views will display). ‘Related Resource Group’ will be available if there are Related Resources assigned to the Details page for this record. Edit with Excel – opens an editable Excel spread sheet that contains the current record. This option is only available if Excel is installed on your PC and the user has been assigned the Web Services license. Delete - displays the following message: “Are you sure you want to delete these records? Yes/No”. You can only delete records that are NOT in use anywhere else in the system. Update Field – a window opens with the following message: “Updating 1 Records in Literal-Text”. The window includes a Field drop list that allows you to select the field you want to update. An input field automatically opens allowing you to enter the new information. Click Submit to update the record or click Close to cancel the request.
View Record Details		Opens the Details page for the current record.

Literal-Text Details Page

The following list defines every field on the Details page:

• Text – the actual text that appears on the menu item, column title and view title. Enter or edit the information in this field.
  • Note: If the resource associated with the literal you are currently working with has an 'Overridden Description' entered in the Resource Master view, then the 'Overridden Description' will still display on all menu items, column titles and view titles. For more information on the Resource Master, click here.

• Modification Counter – displays the number of times this record has been modified.

• Type - displays the classification of the selected Literal Key/Locale Key combination. There are many options available, however the following two types relate to menu items, column titles and view titles:
  • 16-Title: describes entities such as resources, resource groups, views, tables, subviews, sub-sections, windows, pages and tabs in dialog boxes.

  • 17-Label: describes columns, domains, arguments, preference descriptions, and parameters in a report.

The Related section at the bottom of the page contains links to related resources for the current record. There are currently no related links for the Literal-Text module.

The following table outlines the functionality of each button on the Literal-Text Details page:

Button Label	Icon	Functionality
Submit		Saves the changes made on the Details page and returns you to the Search Criteria page.
Save		Saves the changes made on the Details page and you remain on the Details page.
More Actions		Offers 2 options: Link To – displays quick links to various Meta and System Monitoring modules that are related to the current resource. ‘Recent Views’ will be available if you have previously selected any of the options from the Link To menu (a maximum of 5 recent views will display). ‘Related Resource Group’ will be available if there are Related Resources assigned on the Details page for this record. Show References – opens a new page that displays a list of all views related to the current view. The number beside each link represents the number of records in the view. If there are no views related to the current view, the following message displays: "No records match your selection." From this page you have several options. You may: Select the Return to Search Page icon to return to the Search Criteria/Grid page. Select Close to close the Literal-Text session. Select the More Actions button that contains 2 options: The Link To options provide the same options as the Link To from the More Action button on the Details page. The Show Details option takes you back to the Details page for the selected record.
Delete		Deletes the current record. The following message displays: “Are you sure you want to delete this record? OK/Cancel”. Only records that are not in use anywhere else in the system can be deleted.
Copy		Initiates the creation of a new record that contains the same information as the current record, i.e. many of the fields for the new record are pre-populated with data from the current record.
Go to Previous Record		Moves you to the previous record. This icon only displays if the current record is not the first record from the search.
Return to Search Page		Closes the Details page and returns you to the Search Criteria/Grid page. If you have made changes to the current page that have not been saved, the following message displays: "Are you sure you want to navigate away from this page? Any changes will be discarded. Click OK to continue or Cancel to stay on the current page. OK/Cancel".
Go to Next Record		Moves you to the next record. This icon only displays if the current record is not the last record from the search.