CSM 10.4 Documentation

Home

Configure Merge Actions for Form Arrangements and Tabs

The Add Business Object to mApp Wizard is the primary method of defining merge actions for Form Arrangements. However, you can use the mApp Options window in the Form Arrangement Editor to override these selections.

You can also configure separate merge actions for individual tabs in a Form Arrangement using the following tools in the Form Arrangement Editor:

  • mApp Action context menu
  • Tab Properties window

When you make selections in one tool, they will be reflected in the other tools.

To configure merge actions for Form Arrangements:

  1. Add a Business Object to a mApp Solution using the Add Business Object to mApp Wizard.
  2. In the Object Manager within the mApp Editor, click the Business Object from the Object tree, and then click the Edit Form Arrangement task in the Appearance area.

    The Form Arrangement Editor opens.

    Tip: You can also click the Form Arrangement button Form Arrangement Button in the mApp Editor toolbar to open the Form Arrangement Editor.

  3. Configure merge actions for the Form Arrangement:
    1. Click the mApp Options button Add to mApp Solution Button in the mApp Editor toolbar.

      mApp Solution Options for Form Arrangement

    2. Define general mApp Solution properties for the Form Arrangement:
      • Include in mApp: Select this check box to include the Form Arrangement in the mApp Solution. Clear this check box to leave the existing definition in the target system unchanged (the Form Arrangement is not imported into the target system when the mApp Solution is applied).

        Note: This check box is automatically selected if some or all of the tabs in the Form Arrangement were set to overwrite when you added the Business Object to the mApp Solution (using the Add Business Object to mApp Wizard).

      • References: Select this button to open the References window and view all of the other definitions being used by the Form Arrangement
    3. Define options (merge actions) for how the Form Arrangement will be merged into a target system:

      Note: These options are only available if Include in mApp is checked.

      • Import to target system: Select this radio button to import the Form Arrangement definition into a target system. Then, select a merge action based on whether or not the definition is already present in the target system:

        If already present: In the drop-down, select a merge action to define how the definition is imported if it already exists in a target system:

        • Overwrite: Select this option to have the mApp Solution definition overwrite the existing definition in the target system.
        • Don't Import: Select this option to leave the existing definition in the target system unchanged (the mApp Solution definition is not imported into the target system when the mApp Solution is applied).
        • Merge: Select this option to define separate merge actions for each Tab of a Form Arrangement definition.

        If not present: In the drop-down, select a merge action to define whether the definition is imported if it does not currently exist in the target system:

        • Import: Select this option to import the mApp Solution definition into the target system if does not already exist.
        • Don't Import: Select this option to skip importing the mApp Solution definition into the target system if it does not already exist (the mApp Solution definition will not be added to the target system).
      • Remove from Target System: Select this radio button to remove the Form Arrangement definition from a target system.
      • For Reference Only: Select this radio button to include the Form Arrangement definition in the mApp Solution for informational purposes only (the definition is not imported into the target system when the mApp Solution is applied).
      • Import/Remove Based on Condition: Select this check box to import or remove the Form Arrangement definition based on a condition. Then, click the Ellipses button Ellipses Button to open the mApp Conditions window and define mApp Solution conditions.
    4. Select OK.

    The mApp Options button shows an indicator based on the selected merge action (example: mApp Solution Options Button - Overwritefor Overwrite).

  4. Configure separate merge actions for individual tabs in the Form Arrangement (using the mApp Action context menu):
    1. In the mApp Options window for the Form Arrangement, select Import to Target System.
    2. Select Merge as the merge action for the Form Arrangement (from the If Already Present drop-down).

      Each tab shows an indicator based on the merge action for each tab (default is Overwrite).

    3. Right-click a tab, and then hover over mApp Action to open a context menu.
    4. Select a merge action from the context menu.
      • Make no changes to Tab (Default): Select this option to leave the existing definition in the target system unchanged (the mApp Solution definition is not imported into the target system when the mApp Solution is applied).
      • Import Tab if not already there: Select this option to import the Tab if it does not already exist in the target system. If it already exists, the Tab will not be imported when the mApp Solution is applied.
      • Overwrite Tab: Select this option to have the mApp Solution definition overwrite the existing definition in the target system.
      • Remove Tab from target system: Select this option to have the Tab removed from the target system.
  5. Configure separate merge actions for individual tabs in the Form Arrangement (using the Tab Properties window):
    1. Right-click a tab, and then click Properties.
    2. Click the mApp Solution button mApp Solution Merge Actions (on any page), and then select a merge action for the tab:

      Note: The down arrow is only active if the Form Arrangement was set to Merge in the mApp Options window.

      • Make no changes to tab (Default): Select this option to leave the existing tab definition (if found) unchanged in the target system (the mApp Solution definition is not imported into the target system when the mApp Solution is applied).
      • Overwrite tab: Select this option to have the tab definition in the mApp Solution overwrite the existing tab definition (if found) in the target system. If the tab definition is not found in the target system, it is added to the system when the mApp Solution is applied.
      • Remove tab if found: Select this option to have the mApp Solution remove the existing tab definition in the target system (if found).

        Note: The merge action selected in the Add Business Object to mApp Wizard for the tab in the Form Arrangement is automatically checked.

    3. Select OK.

    Each tab shows an indicator based on the action selected in the mApp Solution Action context menu or the Tab Properties window.

  6. Prepare the mApp Solution for Distribution (File>Prepare mApp for distribution), or save the mApp Solution (File>Save mApp to Disk) to continue making other changes.
    Note: Even if a tab is set to be added or merged into a target system, it will not be added or merged if the necessary target Relationship does not exist.

Was this article useful?