Kontakt

Ansicht
Dokumentation

SMUD_CUSTOMER_ATTRIBUTES_TOOL - Add customer attribute type to element types

SMUD_CUSTOMER_ATTRIBUTES_TOOL - Add customer attribute type to element types

PERFORM Short Reference   BAL_S_LOG - Application Log: Log header data  
This documentation is copyright by SAP AG.
SAP E-Book

Purpose

This application helps you to enhance the model of the Solution Documentation.

In case you need additional attribute types on your element types of the Solution Documentation Model, you can add these attribute types here.

You can create a customer attribute type or use a given customer attribute type and add it to a specific number of element types. Only attribute types in the customer namespace (starting with "Y" or "Z" or with a specific customer namespace starting with '/') can be added to the model. You can choose where the attribute type is added:

  • Add the attribute type to all element types:
  • In this case, the attribute type is added to all element types

  • Add the attribute type to all structure element types
  • In this case, the attribute type is only added to those element types that are classified as "structure element types", this means they are shown in the column browser, which is located in the upper part of the UI. Examples for these element types are folders, scenarios and processes.

  • Add the attribute type to all non-structure element types (assignments)
  • In this case, the attribute type is only added to those element types that are classified as "assignments", this means they are shown in the column browser view in that part of the UI that is displayed below the column browser, in the assignment list. Examples for these element types are the executables or development objects, e.g. transactions, reports and also documentation.

  • Add the attribute type to all element types of a specific assignment group
  • In this case, the attribute type is only added to the element types of a specific assignment group. You know the assignment groups from the settings of the solution documentation UI, as they can be used to filter the UI. If you proceed with this option, you can choose one or several assignment groups and the system will add the attribute type to all element types of the selected assignment groups.

This application helps you to create a model extension and an attribute type if needed. You can see the extension and all its relations in the "Advanced Model Settings".

The property "Scope Definition Relevance" defines how the attribute entries are relevant for the scope definition. You can choose that the values down in the hierarchy can only be a subset of the values up in the hierarchy ("Reduce (from top to bottom)"). As default, the attribute type is not relevant for scope definition.

Activation of your extension and search model regeneration

The new attribute type is only visible in your UI, if the corresponding extension is active. If you create a new extension, you can choose that it is activated automatically and that the search model is regenerated.

  • Once your extension is active, all changes to the extension will appear in the model directly, without any further activation step. The extension only needs to be activated once. If you want to deactivate an extension, you can do so in the view maintenance dialog that you find behind the button "Activate Extensions". You have to check the checkbox "Inactive" and save the corresponding dialog to deactivate an extension.
  • After the search model regeneration, the search connectors for the Solution Documentation have to be updated. You do this in transaction ESH_COCKPIT. For the search connectors of the Solution Documentation that have the flag “Modified” checked, you have to execute the action “Actions -> Update”. After executing the action, you have to reindex the content of the search connectors that have status “Prepared” (as described in the SOLMAN_SETUP activity “Process Management” -> “Configure Embedded Search” -> “Schedule Initial Indexing”). Take into consideration that depending on the amount of data of your system, the reindexing operation can take a long time. During this time, the search functionality of the Solution Documentation will not be available. You must therefore plan a suitable point in time before performing the update of the search connectors.

Integration

Prerequisites

Features

Note concerning transport of development objects

The model extension and the attribute type definition are both development objects. They are client independent and need an object directory entry, which implies that you assign a package during the creation process. Depending on this package assignment, you will need a transport request to transport these development objects.

Note concerning the transport of client dependent customizing

If you enter an entry in the field "Attribute Group" in this application, if you choose a UI element that is different from "Input Field" or if you choose to automatically activate your extension, you might need an additional transport request to transport client dependent customizing. This will be the case if automatic recording of client dependent customizing is set for your client.

If you leave the field for the attribute group empty and do not activate your extension automatically, you will not need such a transport request for client dependent customizing in this UI. However, in this case it will not be possible to choose a UI setting for your new attribute type. The default setting "Input Field" will be chosen instead.

Note concerning customer attributes that should be used to store business partner IDs

In case you want to store business partners in customer attributes, use the reference data element "SMUD_BU_PARTNER_EXT". This has the correct technical properties and search help, so that the name of the business partner is automatically shown next to the business partner number.

Selection

Standard Variants

Output

Activities

Further activities:

From this application, you can also start the expert mode applications to enhance the model. There are three applications available, you call them by selecting the buttons of the corresponding application:

·,,Advanced Model Extension

·,,Advanced UI Settings

·,,Activate Extensions

Advanced Model Extension

This application is the expert mode for the enhancement of the Solution Documentation model.

View „Define New Attribute Types“

To define an attribute type, you have to fill the following fields:

  • Attribute type: ID of the attribute type
  • Label: Text for the label of the attribute type in the attribute panel
  • Language dependent: A flag that specifies that the attribute type contains language dependent content that is potentially translation relevant
  • Has Text: A flag that indicates that a text is available for the entry in this field. The system will try to find this text e.g. by using the texts that are defined in the corresponding domain.
  • Reference Data Element: A DDIC data element that is used to retrieve technical information such as length and search help as well as possible values that might be defined on the domain
  • Scope Definition Relevance: This field defines how the attribute type is used as filter in the scoping. If it is set to "not relevant", the attribute will not be available during scope definition.

Views „Model extensions“ and “Assign attribute types to element types”

After you have created an own attribute type in your customer namespace, you have to assign this attribute type to an element type of the model. You do this by defining an extension ID in your customer namespace. This extension allows you to assign attribute types to existing SAP element types.

You have to specify a cardinality for this assignment of an attribute type to an element type. Here you specify if you want to have a multi-value attribute that can have several values or a single value attribute.

Advanced UI Settings

Define how your new attribute types appear on the UI

In this application, you can define how your new attribute types will appear on the UI. These settings are optional.

View "Define Customer Attribute Groups"

Here you can define own customer attribute groups and assign your attributes to this group. This group will then be visible in the attribute panel. The field “Sequence” will define where your new attribute group will appear in relation to the attribute groups defined by SAP. Note that an attribute group is only shown in the attribute panel if an attribute type is assigned to the corresponding element. Empty attribute groups are hidden automatically.

It is not necessary that you define your own attribute group. You can also assign new attributes to existing SAP attribute groups. However, we recommend to assign your own attributes only to your own attribute groups.

View „Assign Attributes to Attribute Groups“

  • The field “Sequence” will define, where the attribute will appear in an attribute group, in relation to the sequences defined for the other attribute types.
  • The field “Display Type” defines how the field is shown on the UI. Note that it depends on the definition of your attribute type and reference data element, which “Display types” make sense here. If you choose “technical ID and text” and no text can be found automatically by the system, e.g. because the data element does not have a domain with fixed values, this setting will be ignored and only the technical ID will be shown.
  • The display type “Drop down box” is only supported for fixed domain values. Search help data is not used to fill drop down boxes. The display type "Drop down box" is only supported for single value attributes. It will not work for multi value attributes.

  • The display types that do not only show the technical ID but also the text are only supported if a text can be read from the search help.

  • The display type “Checkbox” is only useful for attributes of length 1 that only allow the two values “X” and Space as fixed values on a domain.

Activate Extensions

Once an extension is created, you have to activate it using this activity. You add the extension to the table shown in this activity, if it is not yet contained in this table. Here you can also deactivate it either by deleting the corresponding line from the table or by setting the flag “Inactive”. In case of conflicts between different extensions, the field “Priority” will define the sequence of processing, but we strictly recommend to avoid conflicting extensions. To avoid conflicts, we recommend to put all your model enhancements concerning your own attribute types into one single customer extension.

Note
While the attribute type definition as well as the extensions are client independent objects, the activation of an extension is done client-specifically. It is classified as client specific customizing and only allowed if your client settings are set accordingly.

Example






SUBST_MERGE_LIST - merge external lists to one complete list with #if... logic for R3up   Vendor Master (General Section)  
This documentation is copyright by SAP AG.

Length: 12913 Date: 20240520 Time: 131153     sap01-206 ( 242 ms )