{"id":23951,"date":"2024-02-15T14:53:34","date_gmt":"2024-02-15T22:53:34","guid":{"rendered":"https:\/\/docs.extraview.com\/v25\/book\/related-issue-layouts-1\/"},"modified":"2025-02-26T15:26:30","modified_gmt":"2025-02-26T23:26:30","slug":"related-issue-layouts-1","status":"publish","type":"page","link":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/","title":{"rendered":"Related Issue Layouts"},"content":{"rendered":"

Related issues are displayed with layouts that use the naming convention RELATED_XXXXX<\/strong>. To create a new related issue layout, you first create a layout type where the name begins with RELATED_<\/strong> Note that the usage of related issue displays must be Report<\/em>. In the normal way for layouts, these may be inherited by any Business Area or Project which will use them. These are used to display the related records within add, edit<\/em> and report layouts. The layout contains the fields you want to display when viewing the related issues. There is a single default related issue display layout within a new ExtraView installation, named RELATED_ISSUE_DISPLAY<\/strong>. The default fields on this layout are VIEW_BUTTON, QUICKEDIT_BUTTON, EDIT_BUTTON, RELATIONSHIP_GROUP_REMOVE_BTN, ID, STATUS, ASSIGNED_TO and SHORT_DESCR. You may change any of these fields to meet your requirements.<\/p>\n

When you configure a related issue display layout to allow the creation of new related issues, you are able to place a button on a header to the display. This button may have any text, and when pressed will open a modal window where you can add the issue you are creating into the relationship with the current issue on the screen. On reports all related issues are displayed, allowing you to print the results clearly.<\/p>\n

On add<\/em> and edit<\/em> screens, the related issues are placed within a scroll box whose dimensions are controlled by the layout cell attributes named SIZE and HEIGHT. If you do not provide a layout cell attribute for SIZE, then the default is 125 characters. Within the layout, you can also use a SIZE layout cell attribute on the individual fields to control their width. If you do not use a SIZE attribute on individual fields, then the width of each field floats and the user’s browser will decide on the optimal width. The height of the related issue display is calculated automatically, to display all the records in the group unless a HEIGHT layout cell attribute is added to the related issue display, to provide a maximum height.<\/p>\n

You can fix the position of the column titles of the related issue display with the layout cell attribute named RID FIX TITLES.\u00a0 When you set this attribute, it is not recommended that you use the SIZE attribute on fields within the related issue display layout.<\/p>\n

Sample Rendering of Related Issue Display Layouts<\/h3>\n

Some sample layouts rendered on Add<\/em> and Edit<\/em> screens are:<\/p>\n

<\/p>\n

Related issues on a report<\/cite><\/p>\n

<\/cite><\/p>\n

Editing related issues on an add or edit screen<\/cite><\/p>\n

<\/cite><\/p>\n

Adding new related issues on an add or edit screen<\/cite><\/p>\n

<\/p>\n

The modal popup to add a related issue<\/cite><\/p>\n

Related Issue Display Layouts<\/h3>\n

You may create any number of additional related issue display layouts, but you must begin the name of the layouts you create with RELATED_. For example, as well as RELATED_ISSUE_DISPLAY, and as an example, you may create another related issue layout named RELATED_SUPPLIERS. All the layouts to be used as related issue displays must be created with a display type of Report<\/strong>, even if they are to be embedded within an Add<\/em> or Edit<\/em> layout. Once you have created the layout type, you then include the layout on the Add<\/em>, Edit<\/em> or Detailed Report layouts.<\/p>\n

For the above example, you would include LAYOUT.RELATED_SUPPLIERS on the layout. When you create a related issue layout, a new field is created automatically in the data dictionary, with the same name as your layout. In our example, the field RELATED_SUPPLIERS is created. The field has the usual PR_ADD_PROBLEM and PR_RESOLUTION permission keys, and these control visibility to the related issue display layout on the add<\/em> and edit<\/em> layouts for the different roles in your installation.<\/p>\n

The field RELATIONSHIP_GROUP_REMOVE_BTN is an inbuilt field with special treatment. It is defined in the data dictionary with a type of LABEL and a display type of BUTTON. Although it is placed on RELATED_ISSUE_DISPLAY layouts, it will only appear when the layout is rendered within an Add<\/em> or Edit<\/em> screen. It is ignored on report layouts and on the POST_EDIT_UPDATE layout. There is a security permission key named PR_RESOLUTION.RELATIONSHIP_GROUP_REMOVE_BTN to control the appearance of the Remove? <\/strong>checkboxes on the Add<\/em> and Edit<\/em> screens. Its function is to allow the end user to remove a related issue from the relationship group. The user may check any number of related issues, and the checked issues will be removed from the relationship when the current issue is updated. Removing an issue from a relationship does not delete the issue.<\/p>\n

Embedding Related Issue Display Layouts Within a Layout<\/h3>\n

As stated above, related issue display layouts are designed to be embedded within add, edit<\/em>, report and other layouts which are then embedded within add, edit<\/em> and report layouts. This screenshot shows a related issue display layout embedded within an edit<\/em> layout:<\/p>\n

<\/p>\n

Buttons on Related Issue Display Layouts<\/h3>\n

The following buttons may be placed on Related Issue Displays.\u00a0 Note that within both Add <\/em>and Edit <\/em>screens the PR_RESOLUTION permission keys are used to control the presence of the buttons, as the information within the displays is always read-only.<\/p>\n

    \n
  • Edit Button – EDIT_BUTTON<\/li>\n
  • Quickedit Button – QUICKEDIT_BUTTON<\/li>\n
  • View Button – VIEW_BUTTON<\/li>\n<\/ul>\n

    Layout Cell Attributes for Related Issue Display Layouts<\/h3>\n

    Over and above the standard layout cell attributes that can be applied to all cells on layouts, the following attributes allow configuration of embedded related issue display layouts.<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n
    Cell Attribute<\/td>\nPurpose<\/td>\n<\/tr>\n
    BUTTON ACTION<\/td>\nThe RID BUTTON ACTION<\/strong> attribute is applied as a cell attribute to the RID PREHEADER ADD BUTTON<\/strong>. The action defines what happens when the user presses the add button. This attribute is applied directly to the field’s global attributes, defined within the data dictionary, as opposed to being set as a layout cell attribute on the related issue display layout.<\/p>\n
      \n
    • Target Business Area<\/strong> – This defines the Business Area that will be used for the add<\/em> screen displayed when the button is pressed<\/li>\n
    • Target Project<\/strong> – This defines the Project that will be used for the add<\/em> screen displayed when the button is pressed<\/li>\n
    • Check Required Fields<\/strong> – If you check this option, then all required fields on the parent issue that will be required by the child issue, are checked that values are filled in, before the child window is displayed. This can be extremely useful if you are going to push down field values from the parent to the child issue, and you want to ensure that the child window is always initiated with a value within a field<\/li>\n
    • Push Selected Attachments<\/strong> – When the button is pressed, attachments already selected will be copied to the new child issue being created<\/li>\n
    • Action after Submitting the Child Issue<\/strong> – This option allows you to select the action after the child issue is created. You can either have only the related issue display that contains the newly added issue updated, or you can have the parent issue updated, and the entire screen updated. The latter is only required when there are some business rules that triggered changes to the parent issue when the child issue was submitted<\/li>\n
    • Push Down Field List<\/strong> – Double click on the fields whose values you want to push down from the parent issue to the child issue. The selected fields are displayed in the right-hand list<\/li>\n
    • Map a Push Down Field<\/strong> – There are some occasions when you want to push down a field from the parent issue to a different field on the child issue.\u00a0 This can be accomplished by first selecting the field to push down, as described in the previous step and then right-clicking on the red button on the selected field.\u00a0 This brings up a window where you can type in the name of the child field to which you want to map the parent field value<\/li>\n
    • Show Generate Script<\/strong> – This button is provided for advanced usage. It is possible to configure button actions that are more complex than can be done with the BUTTON ACTION<\/strong> utility. This option allows you to generate the JavaScript that is close to what you require. You can then copy this JavaScript into the RID ONCLICK_JS<\/strong> attribute and modify it for your requirement. You should not save the BUTTON ACTION<\/strong> if you are using RID ONCLICK_JS<\/strong> and vice versa.<\/li>\n<\/ul>\n

      Note that you may define more than one BUTTON_ACTION on a single related issue display.<\/td>\n<\/tr>\n

    DRILLDOWN<\/td>\nThis attribute should only be applied to a field that contains the ID of the related issue. You can choose to set the drilldown to either a value of View<\/strong> or Edit<\/strong> according to the type of drilldown window you wish to open<\/td>\n<\/tr>\n
    HEIGHT<\/td>\nThis defines the maximum height of the related issue display when it is rendered within an add<\/em> or edit<\/em> layout. The height is input in rows, where each row is estimated to be 20 pixels. If the height required to render the issues is less than this value, then the related issue display is resized to only take the height required. If the height required is more than this value, a vertical scroll bar is placed on the related issue display. \u00a0The titles to the fields are always fixed in position, so that when the user scrolls the list of related issues, the titles remain visible. The setting has no effect on reports where the entire contents of the related issue display will be rendered.<\/td>\n<\/tr>\n
    RID ACT ON FIELD CHANGE<\/td>\nThis attribute is not applied to a relationship layout but is applied to the field (the RID LINK FIELD NAME above) that is used to link the result set from a search to a relationship issue display. When this attribute is present on the RID LINK FIELD NAME, along with an HTML modifier to trigger the action, a related issue display is refreshed, creating links from each issue ID within the RID LINK FIELD NAME, and displaying these issues in the related issue display. A full example of the use of this feature is provided in Example 4.<\/a>This attribute is triggered only upon an onchange <\/em>event within a screen and is not triggered when the add<\/em> or edit<\/em> screen is submitted for an update.\u00a0 A consequence of this is that you should not expect this attribute to work within API calls nor within the File Import process which do not respond to screen events.<\/td>\n<\/tr>\n
    RID FILTERS<\/td>\nThis cell attribute allows the administrator to specify a set of filters to apply to the selection of the related issues to display. This filter is applied to only the related issue records so the user will only\u00a0see a subset of the related issues. For example, this screenshot shows the administrator about to select values for filters for the Business Area<\/strong> and Status <\/strong>fields:Note that beyond the selection of specific values to use for filters, there are several other possibilities:<\/p>\n
      \n
    • * Any *<\/strong> – This value is not used.\u00a0 Setting it is the same as not using the filter<\/li>\n
    • * Ask at runtime * <\/strong>– The user will be prompted when the related issue display is being generated, to provide a value for the filter<\/li>\n
    • * Value from issue *<\/strong> – The value to be used\u00a0within the\u00a0filter for the Related Issue Display will be taken from the current value for the field of the same name that is displayed to the user on the screen at the time the filters are applied to create the Related Issue Display.\u00a0 This is effective for fields for fields with display types of List, User and Popup.\u00a0 When you select this special value for other field display types, you may enter the name of a field as a value.\u00a0 For example, if your field name to reference is\u00a0ddName<\/strong><\/em>, enter\u00a0$$ddName$$<\/em><\/strong><\/li>\n
    • * Mapped Field Value From Issue *<\/strong> – the value will be taken from a different field when generating the Related Issue Display.\u00a0 When this option is selected, a new field appears allowing you to enter the name of the field to map the value from, in the format $$ddName$$<\/strong><\/em>.\u00a0 This only works for fields with enumerated list types of User and List fields<\/li>\n
    • $$SYSDAY$$ or $$SYSDATE$$ <\/strong>– These may be used within day or date display type fields to filter on the current day or date.\u00a0 It is not too practical to filter on a field being equal to $$SYSDATE$$, as the date includes time to the millisecond, and it’s unlikely that issues will match this.\u00a0 Using operators of less than or greater than with date type fields is more useful.<\/li>\n<\/ul>\n<\/td>\n<\/tr>\n
    RID FIX TITLES<\/td>\nThis attribute may only be set on Related Issue Display layouts within Add<\/em>, Edit<\/em> layouts, or sublayouts of these.\u00a0 When this attribute is used in conjunction with the HEIGHT attribute, and a scroll bar appears after issues have been added, the title to the Related Issue Display is fixed as the user scrolls. It is not recommended that you place SIZE layout cell attributes on the fields contained within the Related Issue Display layout when you use this attribute.\u00a0 Likewise, it is not recommended that you use this option if you expect that the user will see text that wraps within the Related Issue Display.\u00a0 The best results are obtained when the browser sizes all the columns and column titles.<\/td>\n<\/tr>\n
    RID GROUP REFERENCE FIELD<\/td>\nThe default for this attribute is the ID field. This attribute may be set to provide a different field for the relationship to be formed between the issues. The field must exist on both the layouts that are being related<\/td>\n<\/tr>\n
    RID LINK FIELD NAME<\/td>\nThis attribute is used when you are using a search layout on an add<\/em> or edit<\/em> layout to return one or more issues to relate them to the current issue. RID LINK FIELD NAME must be a field with a display type of text field<\/em> or text area<\/em> and the field is typically hidden within the add<\/em> or edit<\/em> layout and is used to transition the list of issued from the search results into the list of issues to be related. The list is a series of issue ID values, delimited by semi-colons. If the RID SINGLE SELECT attribute in this table is set, then there can only ever be a single-issue ID in the list. Text fields<\/em> are capable of storing 255 characters. The link field stores the IDs of all issues selected within the results, plus an extra character as a separator between each ID. They therefore store approximately 40 – 60 ID’s. If you are likely to link more than this number of issues, make sure the RID LINK FIELD NAME has a display type of text area<\/em>. These are highly scalable for this purpose.<\/p>\n

    Linking a Single Result to Populate Fields within the Current Issue<\/h3>\n

    If you are using the RID LINK FIELD NAME to link the search results to a single issue and you then want to take fields within that issue and place their values within the current issue, you are likely to also configure a link<\/em> and a refresh<\/em> business rule to retrieve the field values you require from the search result. See Example 3<\/a>.<\/p>\n

    Linking Multiple Search Results to Populate a Related Issue Display<\/h3>\n

    If you are using the RID LINK FIELD NAME to link the search results to multiple issues that you want to relate to the current issue, and place these issues within a related issue display on the current layout, you are likely to also configure RID LINK FIELD NAME with these attributes:<\/p>\n

    RID ONCLICK_JS<\/td>\nRID ONCLICK_JS<\/strong> is the JavaScript that is executed when the RID PREHEADER ADD BUTTON<\/strong> button is clicked. For most purposes, the script that is executed is created by the RID BUTTON ACTION<\/strong> cell attribute and you do not require to use the RID ONCLICK_JS<\/strong> attribute. The RID ONCLICK_JS<\/strong> attribute is provided for advanced configurations where the administrator wants to create JavaScript that goes beyond the capability of the RID BUTTON ACTION<\/strong> attribute. You must not configure both the RID BUTTON ACTION<\/strong> and the RID ONCLICK_JS<\/strong> attributes on the same button, as they will conflict with each other. The JavaScript for RID ONCLICK_JS<\/strong> should be carefully constructed, and there may be differences when wanting to use the JavaScript to initiate a popup to add a new issue when on the add<\/em> and on the edit<\/em> screens. If you want to add related issues on both the add<\/em> and edit<\/em> screens, you may need to configure a different INCLUDE ADD BUTTON<\/strong> in the data dictionary for each screen, each with the appropriate RID ONCLICK_JS<\/strong> value. It is possible to configure and place multiple buttons to add different types of issues on a single related issue display.<\/p>\n

    Basic Syntax<\/h3>\n

    Substitutable values are possible in this string value. To create a modal popup window the basic JavaScript you use will be:<\/p>\n

    doEditAEActions(window.parent.extraview_app_home_url , '__SESSION_ID__', \nnew Array('POPUP_MODAL_ADD', 'add_confirm_page=NO' + rgParameters(), \n'RELATIONSHIP_GROUP_REFRESH', '__LAYOUT_TYPE_ID__' ));<\/code><\/pre>\n
    Note the two substitutable variables SESSION_ID and LAYOUT_TYPE_ID. They must be surrounded by double underlines. This provides the mechanism for ExtraView to substitute the variable at runtime. You set a value of YES or NO to the add_confirm_page parameter, depending on whether you want to display or suppress the verification layout or the ADD_CONFIRMATION<\/strong> layout that is typically shown to users after submitting a new issue. If you set NO, then the verification screen is never shown. There is a built-in method that generates the necessary relationship group parameters for the ADD operation. These are needed to force the insertion of the child issue into the correct Relationship Issue Display relationship group using the relation type of the Related Issue Display. This is rgParameters() and it is in scope from the button when the button is inserted into the header of the Related Issue Display.<\/p>\n
    Updating and Refreshing the Underlying Issue<\/h3>\n
    There are use cases where you might want to update and refresh the parent Add<\/em> or Edit<\/em> screen, after you add a child issue. For example, while adding a child issue, Business Rules might execute that update the parent issue. If you want this behavior, there is an UPDATE_MAIN<\/strong> parameter. The workflow might be to go from an Add<\/em> or Edit<\/em> screen, add a child record in a modal popup window, submit the child issue within the modal popup (this executes Business Rules that update the parent issue), then close the modal popup and finally redisplay the updated parent issue, you will include the UPDATE_MAIN<\/strong> parameter as follows:<\/p>\n
    doEditAEActions(window.parent.extraview_app_home_url , '__SESSION_ID__',\nnew Array('UPDATE_MAIN','POPUP_MODAL_ADD', 'add_confirm_page=NO\n&p_rg_relate_this_to=' + getValueFromParent('p_id') + rgParameters(),\n'REFRESH_ID', getValueFromParent('p_id')));<\/code><\/pre>\n
    Note that you do not require the RELATIONSHIP_GROUP_REFRESH<\/strong> and accompanying LAYOUT_TYPE_ID<\/strong> parameters, as the REFRESH_ID<\/strong> takes care of refreshing the entire parent issue. If this is executed from an Add<\/em> screen, the parent issue is displayed within an Edit<\/em> screen, as the underlying Business Rules submitted the parent issue to the database, thus meaning it is no longer in the add state, but it is now in a state where it can be updated. The p_rg_relate_this_to parameter and its value are used on the Add<\/em> screen to identify the parent issue to which you want to relate the child issue you are adding, when you are including the UPDATE_MAIN<\/strong> parameter. It has no effect otherwise on Add<\/em> screens or Edit<\/em> screens and may be omitted in these cases.<\/p>\n
    Setting Additional Parameters to Push Values from the Parent to the New Issue<\/h3>\n
    Other parameters may be added to the array value immediately following the POPUP_MODAL_ADD entry. An example is to set the Business Area and Project of the issue to be added. \u00a0With rgParameters(), the example becomes:<\/p>\n
    doEditAEActions(window.parent.extraview_app_home_url, '__SESSION_ID__',\nnew Array('POPUP_MODAL_ADD', 'p_area=$$MY_AREA$$&p_project=$$MY_PROJECT$$&add_confirm_page=NO &p_rg_relate_this_to=' + getValueFromParent('p_id') + rgParameters(), 'RELATIONSHIP_GROUP_REFRESH', '__LAYOUT_TYPE_ID__' ));<\/code><\/pre>\n
    Note that the values for the p_area and the p_project parameters must correspond to the AREA_ID and PROJECT_ID into which you will add the related issue. Another possibility is that you might want to pass the values of one or more fields from the parent issue to the child issue you are creating. To achieve this, you may use either the pushDownFields(‘p_fld1;p_fld2;p_fld3;…’) function to pass several fields at once or use the getValueFromParent() function to pass individual fields. For example, let’s say that you want to pass the FIRST_NAME and LAST_NAME fields from the parent to the child. The string then becomes either:<\/p>\n
    doEditAEActions(window.parent.extraview_app_home_url , '__SESSION_ID__',\nnew Array('POPUP_MODAL_ADD', 'p_area=$$MY_AREA$$&p_project=$$MY_PROJECT$$&p_rg_relate_this_to=' + getValueFromParent('p_id') + pushDownFields('p_first_name;p_last_name') + '&add_confirm_page=NO' + rgParameters(), 'RELATIONSHIP_GROUP_REFRESH', '__LAYOUT_TYPE_ID__' ));<\/code><\/pre>\n
    or using individual parameters:<\/p>\n
    doEditAEActions(window.parent.extraview_app_home_url , '__SESSION_ID__', \nnew Array('POPUP_MODAL_ADD', 'p_area=$$MY_AREA$$&p_project=$$$MY_PROJECT$$&p_rg_relate_this_to=' + getValueFromParent('p_id') + '&p_first_name=' + getValueFromParent('p_first_name') + '&p_last_name=' + getValueFromParent('p_last_name') + '&add_confirm_page=NO' + rgParameters(), 'RELATIONSHIP_GROUP_REFRESH', '__LAYOUT_TYPE_ID__' ));<\/code><\/pre>\n
    Note that if a field name that you pass within the pushDownFields() or the getValueFromParent() function does not exist, it will be ignored when the user presses the button to add the issue, and no error will be generated. This can be used to advantage in configurations where you want to use a single button for multiple purposes on different forms.<\/p>\n
    In the above examples, note that you may use the actual values for MY_AREA and MY_PROJECT by looking at the administration screens for the AREA and PROJECT fields to find the values.\u00a0 However, this is not recommended as hard-coded actual values may change within a metadata migration\u00a0but the hard-coded values in these expressions do not change in a metadata migration exercise.<\/p>\n
    Other assignment examples:<\/p>\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
    p_area=$$MY_AREA$$<\/code><\/td>\nThe AREA <\/code>field is assigned the value of the current Business Area<\/td>\n<\/tr>\n
    p_area=HELPDESK<\/code><\/td>\nThe AREA <\/code>field is assigned the value of the Business Area with the name of HELPDESK<\/code><\/td>\n<\/tr>\n
    p_area=$$Helpdesk$$<\/code><\/td>\nThe AREA <\/code>field is assigned the value of the Business Area with the title of Helpdesk<\/code><\/td>\n<\/tr>\n
    p_list_field=$$'Ben & Jerry'$$<\/code><\/td>\nIn this example, a list field with the name LIST_FIELD <\/code>is assigned the value of Ben&Jerry.\u00a0 The single quote marks are used when the value contains special characters such as &, # or spaces<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Opening the Modal Popup Window in Edit Mode<\/h3>\n
    There is a feature within ExtraView that allows the user to open up a new issue in Edit mode, as opposed to the Add mode.\u00a0 This configuration assigns an ID and \/ or an ALT_ID and saves the initial issue within the database before then placing the user within Edit mode on the screen.\u00a0 This can be configured within the modal popup window, by altering the POPUP_MODAL_ADD<\/code> parameter to POPUP_MODAL_OPEN_IN_EDIT<\/code>.<\/p>\n
    Repeating Rows Fields<\/h3>\n
    The function getValueFromParent may be modified to access repeating row field values. Repeating rows are indexed, beginning with zero, therefore, to access the first repeating row, the call will look like:<\/p>\n
    getValueFromParent('p_fieldname', 0)<\/code><\/pre>\n
    To access the third repeating row, the call will look like:<\/p>\n
    getValueFromParent('p_fieldname', 2)<\/code><\/pre>\n
    Although you may target any repeating row to obtain a value from a field, the value will always be placed in the field on the first row of the child record. The following technique will allow you to get values from successive repeating row fields, and populate these into successive repeating rows within child records:<\/p>\n
    getValueFromParent('p_fieldname', 2); getValueFromParent('p_fieldname', 3)<\/code><\/pre>\n
    This example gets the field value from the third repeating row and places the result in the first repeating row child record, and then gets the value in the fourth repeating row field and places its value in the second repeating row child record<\/p>\n
    Multiple Add Buttons<\/h3>\n
    Multiple Add buttons on the preheader are supported.\u00a0 Under rare circumstances, you might want to create a specific sort order for these buttons.\u00a0 There is not a place on the user interface to define the sort order of these buttons, but please contact ExtraView Support who will guide you through the process.<\/td>\n<\/tr>\n
    RID PREHEADER<\/td>\nThis attribute adds a title to a related issue display header to contain an Add<\/strong> or other buttons. No title is added to the related issue display if this attribute is not defined. There is one special property of this field. If you use the value of TITLE<\/strong> in the value, then the description of the related issue display layout will be used as the title in the pre-header. The reason why you might want to do this is solely if you need to provide a localized equivalent for the title in languages other than the base language of your system. The related issue display title may be localized, while layout cell attributes (with the exception of the ALTERNATIVE TITLE) may not be localized.<\/td>\n<\/tr>\n
    RID PREHEADER ADD BUTTON<\/td>\nThis attribute adds a button to the pre-header. This button is used to add new issues to a relationship. The button is a field that must already be created in the data dictionary. The button must be created on the Label<\/em> tab within the data dictionary and must have a display type of Button<\/em>. The title to the field will be used as the title to the button when it appears on the pre-header of the related issue display. You may add any number of Add buttons to a single Related Issue Display. The attributes PREHEADER ADD BUTTON, RID PREHEADER SUBMIT BUTTON and RID PREHEADER REFRESH BUTTON each have the ability to set a Sort Order as part of their definition.\u00a0 The sort order works across all the buttons defined on a single Related Issue Display.<\/td>\n<\/tr>\n
    RID PREHEADER REFRESH BUTTON<\/td>\nThis attribute is used when you are using a search layout on an add<\/em> or edit<\/em> layout to return one or more issues to relate them to the current issue. This places a button onto the related issue display pre-header bar that allows the user to refresh the list of results from the current set of search filters. The button has a default title of Get Filtered Results<\/strong>, but you can optionally provide a value to the attribute which will then appear as the label on the button. The attributes PREHEADER ADD BUTTON, RID PREHEADER SUBMIT BUTTON and RID PREHEADER REFRESH BUTTON each have the ability to set a Sort Order as part of their definition.\u00a0 The sort order works across all the buttons defined on a single Related Issue Display.<\/td>\n<\/tr>\n
    RID PREHEADER SUBMIT BUTTON<\/td>\nThis attribute is used when you are using a search layout on an add<\/em> or edit<\/em> layout to return one or more issues to relate them to the current issue. This places a button onto the related issue display pre-header bar that allows the user to submit the list of results from the current set of search filters. The button has a default title of Fetch Selected Record(s)<\/strong>, but you can optionally provide a value to the attribute which will then appear as the label on the button.The attributes PREHEADER ADD BUTTON, RID PREHEADER SUBMIT BUTTON and\u00a0RID PREHEADER REFRESH BUTTON each have the ability to set a Sort Order as part of their definition.\u00a0 The sort order works across all the buttons defined on a single Related Issue Display.<\/p>\n
    Multiple Submit Buttons<\/h4>\n
    Multiple Submit buttons on the preheader are supported, typically to allow different types of issue submissions.\u00a0 Under rare circumstances, you might want to create a specific sort order for these buttons.\u00a0 There is not a place on the user interface to define the sort order of these buttons, but please contact ExtraView Support who will guide you through the process.<\/td>\n<\/tr>\n
    RID RELATIONSHIP NAME<\/td>\nThis is the name of the relationship group to which the related issues will be added. The relationship group must be created before you add the name to the cell attribute. If you do not set a value for this attribute, then the value in the behavior setting named RELATION_GROUP_DEFAULT will be used<\/td>\n<\/tr>\n
    RID RELATION TYPE<\/td>\nThis should be set to one of the following values:<\/p>\n
      \n
    • MEMBERS<\/strong> – This is the default value for this attribute if you do not override it with one of the other values. In this case the related issue display will show all the members of the group(s), containing the reference issue, i.e. the reference issues parents, children, and other issues not directly related to the reference issues in the group(s).<\/li>\n
    • CHILDREN<\/strong> – The related issue display will only contain issues that are the children of the reference issue<\/li>\n
    • PARENTS<\/strong> – The related issue display will only contain issues that are the parents of the reference issue. Note that in the ExtraView data model it is possible to define more than one parent issue for a specific issue. See the section on Relationship Groups for more information.<\/li>\n
    • RELATED<\/strong> – In this instance ExtraView will display the parents and the children of the reference issue within the specified group(s), within the related issue display. The parents and children of these related issues will not be displayed.<\/li>\n
    • SIBLINGS<\/strong> – ExtraView will display all the issues at the same level in the hierarchy. For example, if a parent record has five children, and you create a related issue display with all the children, using a relationship group relation type of SIBLINGS, then you will see the four siblings to the current one.<\/li>\n
    • GRANDPARENTS<\/strong> – This allows the display of the grand-parents to the current level in the hierarchy<\/li>\n
    • GREATGRANDPARENTS<\/strong> – This allows the display of the parents of the grand-parents in the hierarchy<\/li>\n
    • GREATGREATGRANDPARENTS<\/strong> – This allows the display of the parents of the great-grand-parents in the hierarchy<\/li>\n
    • GRANDCHILDREN<\/strong> – This allows the display of the grand-children to the current level in the hierarchy<\/li>\n
    • GREATGRANDCHILDREN<\/strong> – This allows the display of the children of the grand-children in the hierarchy<\/li>\n
    • GREATGREATGRANDCHILDREN<\/strong> – This allows the display of the children of the great-grand-children in the hierarchy<\/li>\n
    • LINKED<\/strong> – This type does not use a relationship type per se but relies on the Related Issue Display filters to retrieve the associated issues. For example, you might have a filter that selects all the open issues for a particular product, and display these on a related issue display of each issue that you call up.<\/li>\n<\/ul>\n
      If you are using the related issue display to add new issues, the value should be CHILDREN or PARENTS. If you choose another relationship type then the issue will be added, but will not be displayed as the relationship is indeterminate<\/td>\n<\/tr>\n
    RID SEARCH FILTER LAYOUT<\/td>\nThis attribute is used when you are using a search layout on an add<\/em> or edit<\/em> layout to return one or more issues to relate them to the current issue. This field holds the name of the search layout that is being embedded on the same layout as the related issue display. Typically, you will embed this search layout just above the related issue display layout<\/td>\n<\/tr>\n
    RID SEARCH ON NO FILTERS<\/td>\nThe layout element attribute RID SEARCH ON NO FILTERS allows an embedded search report to be created even when there are no filters added in the embedded layout. Normally, at least one such filter must be present for the search to occur to prevent the potential return of a huge numbers of issues. By putting this attribute on a Related layout element that references a RID SEARCH FILTER LAYOUT a search may be done even when no filters are set.<\/td>\n<\/tr>\n
    RID SINGLE SELECT<\/td>\nThis attribute is used when you are using a search layout on an add<\/em> or edit<\/em> layout to return one or more issues to relate them to the current issue. The default is that the search will allow you to return all the issues the user selects from the results. If you set this attribute, then the user will only allow a single issue to be selected to return the results into the related issue display<\/td>\n<\/tr>\n
    RID SORT ORDER<\/td>\nThis attribute determines a sort order, based on a field that is displayed on the related issue display. You can set the value to ASCENDING or DESCENDING<\/td>\n<\/tr>\n
    RID TRANSPOSE LAYOUT<\/td>\nThe default is that the related issues will be presented on the display by row. If you select this attribute, then the issues will be presented by column<\/td>\n<\/tr>\n
    SIZE<\/td>\nThis controls the width of the related issue display on add<\/em> and edit<\/em> screens. The size is an estimate of the number of characters to be displayed. If you do not provide a layout cell attribute for SIZE, then the default is 125 characters. Beginning with version 10, you can no longer use a SIZE layout cell attribute on the individual fields within the related issue display to control their width. This allows the enabling of a new feature, to freeze the titles of the related issue display. \u00a0This is very beneficial when you have a significant number of related issues within the display, as the titles always remain visible.<\/td>\n<\/tr>\n
    VISIBLE IF<\/td>\nThis allows you to make the entire related issue display visible or not visible depending on the value of another field on the layout within which the related issue display is embedded<\/td>\n<\/tr>\n<\/tbody>\n<\/table>\n
    Refresh Button on a Related Issue Display<\/h3>\n
    There are occasions when it is useful to have a refresh button on the related issue display preheader.\u00a0 This can be accomplished with the following steps:<\/p>\n
      \n
    1. Within the Labels tab of the data dictionary create a field with a suitable name, e.g. MY_REFRESH,<\/strong> with a display type of Button <\/strong>and a title of Refresh<\/strong><\/li>\n
    2. Edit the field you have just created within the data dictionary, and add a Global Attribute of RID ONCLICK_JS<\/strong>.\u00a0 This should have a value of:doMyRGRefresh(__LAYOUT_TYPE_ID__);return false;<\/code><\/li>\n
    3. Navigate to the layout that contains the related issue display where you want the button<\/li>\n
    4. Add a new layout cell attribute of RID PREHEADER ADD BUTTON<\/strong>, and select the MY_REFRESH<\/strong> button to display<\/li>\n
    5. Save the layout.<\/li>\n<\/ol>\n
      Order of Precedence on Related Issue Display Operations<\/h3>\n
      Given that the end user may carry out a combination of operations on several, and sometimes independent, related issue displays with an add<\/em> or edit<\/em> screen, there might be some conflict in these operations, with records that might appear in more than a single related issue display. For example, what happens if you update an issue in one relationship, but remove the same issue in another relationship? The RELATIONSHIP_GROUP_REMOVE_BTN is given precedence over other transactions. Transactions are processed in the following order: removes, inserts, deletes (where the deletes are relationship group remove button transactions).<\/p>\n","protected":false},"excerpt":{"rendered":"
      Related issues are displayed with layouts that use the naming convention RELATED_XXXXX. To create a new related issue layout, you first create a layout type where the name begins with RELATED_ Note that the usage of related issue displays must be Report. In the normal way for layouts, these may be inherited by any Business…<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":23950,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"_acf_changed":false,"_lmt_disableupdate":"no","_lmt_disable":"","_kad_blocks_custom_css":"","_kad_blocks_head_custom_js":"","_kad_blocks_body_custom_js":"","_kad_blocks_footer_custom_js":"","_kad_post_transparent":"","_kad_post_title":"","_kad_post_layout":"","_kad_post_sidebar_id":"","_kad_post_content_style":"","_kad_post_vertical_padding":"","_kad_post_feature":"","_kad_post_feature_position":"","_kad_post_header":false,"_kad_post_footer":false,"footnotes":""},"class_list":["post-23951","page","type-page","status-publish","hentry"],"acf":[],"yoast_head":"\nRelated Issue Layouts - Product Documentation<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"Related Issue Layouts - Product Documentation\" \/>\n<meta property=\"og:description\" content=\"Related issues are displayed with layouts that use the naming convention RELATED_XXXXX. To create a new related issue layout, you first create a layout type where the name begins with RELATED_ Note that the usage of related issue displays must be Report. In the normal way for layouts, these may be inherited by any Business...\" \/>\n<meta property=\"og:url\" content=\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/\" \/>\n<meta property=\"og:site_name\" content=\"Product Documentation\" \/>\n<meta property=\"article:modified_time\" content=\"2025-02-26T23:26:30+00:00\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data1\" content=\"26 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"WebPage\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/\",\"url\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/\",\"name\":\"Related Issue Layouts - Product Documentation\",\"isPartOf\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\"},\"datePublished\":\"2024-02-15T22:53:34+00:00\",\"dateModified\":\"2025-02-26T23:26:30+00:00\",\"breadcrumb\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/#breadcrumb\"},\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/\"]}]},{\"@type\":\"BreadcrumbList\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Home\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"ExtraView 25\",\"item\":\"https:\/\/docs.extraview.com\/v25\/\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Administration Guide\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"Site Configuration Menu\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/\"},{\"@type\":\"ListItem\",\"position\":5,\"name\":\"Design Center\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/\"},{\"@type\":\"ListItem\",\"position\":6,\"name\":\"Relationship Layouts\",\"item\":\"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/\"},{\"@type\":\"ListItem\",\"position\":7,\"name\":\"Related Issue Layouts\"}]},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#website\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"name\":\"ExtraView Product Documentation\",\"description\":\"ExtraView Documentation\",\"publisher\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":\"Organization\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#organization\",\"name\":\"ExtraView Corporation\",\"url\":\"https:\/\/docs.extraview.com\/v25\/\",\"logo\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\",\"url\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"contentUrl\":\"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png\",\"width\":512,\"height\":512,\"caption\":\"ExtraView Corporation\"},\"image\":{\"@id\":\"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/\"}}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"Related Issue Layouts - Product Documentation","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/","og_locale":"en_US","og_type":"article","og_title":"Related Issue Layouts - Product Documentation","og_description":"Related issues are displayed with layouts that use the naming convention RELATED_XXXXX. To create a new related issue layout, you first create a layout type where the name begins with RELATED_ Note that the usage of related issue displays must be Report. In the normal way for layouts, these may be inherited by any Business...","og_url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/","og_site_name":"Product Documentation","article_modified_time":"2025-02-26T23:26:30+00:00","twitter_card":"summary_large_image","twitter_misc":{"Est. reading time":"26 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"WebPage","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/","url":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/","name":"Related Issue Layouts - Product Documentation","isPartOf":{"@id":"https:\/\/docs.extraview.com\/v25\/#website"},"datePublished":"2024-02-15T22:53:34+00:00","dateModified":"2025-02-26T23:26:30+00:00","breadcrumb":{"@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/#breadcrumb"},"inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/"]}]},{"@type":"BreadcrumbList","@id":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/related-issue-layouts-1\/#breadcrumb","itemListElement":[{"@type":"ListItem","position":1,"name":"Home","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":2,"name":"ExtraView 25","item":"https:\/\/docs.extraview.com\/v25\/"},{"@type":"ListItem","position":3,"name":"Administration Guide","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/"},{"@type":"ListItem","position":4,"name":"Site Configuration Menu","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/"},{"@type":"ListItem","position":5,"name":"Design Center","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/"},{"@type":"ListItem","position":6,"name":"Relationship Layouts","item":"https:\/\/docs.extraview.com\/v25\/extraview-25\/administration-guide-1\/site-configuration-menu-1\/design-center-4\/relationship-layouts-1\/"},{"@type":"ListItem","position":7,"name":"Related Issue Layouts"}]},{"@type":"WebSite","@id":"https:\/\/docs.extraview.com\/v25\/#website","url":"https:\/\/docs.extraview.com\/v25\/","name":"ExtraView Product Documentation","description":"ExtraView Documentation","publisher":{"@id":"https:\/\/docs.extraview.com\/v25\/#organization"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/docs.extraview.com\/v25\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":"Organization","@id":"https:\/\/docs.extraview.com\/v25\/#organization","name":"ExtraView Corporation","url":"https:\/\/docs.extraview.com\/v25\/","logo":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/","url":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","contentUrl":"https:\/\/docs-stg.extraview.com\/wp-content\/uploads\/2024\/03\/favicon.png","width":512,"height":512,"caption":"ExtraView Corporation"},"image":{"@id":"https:\/\/docs.extraview.com\/v25\/#\/schema\/logo\/image\/"}}]}},"taxonomy_info":[],"featured_image_src_large":false,"author_info":{"display_name":"carl.koppel","author_link":"https:\/\/docs.extraview.com\/v25\/author\/carl-koppel\/"},"comment_info":0,"_links":{"self":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/23951","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/comments?post=23951"}],"version-history":[{"count":0,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/23951\/revisions"}],"up":[{"embeddable":true,"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/pages\/23950"}],"wp:attachment":[{"href":"https:\/\/docs.extraview.com\/v25\/wp-json\/wp\/v2\/media?parent=23951"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}