Downtime Announcement: Please note the SAP Community Wiki will be unavailable due to a system upgrade on Thursday, September 24th between 6 and 7 AM CEST
Skip to end of metadata
Go to start of metadata

As mentioned in chapter Maintain Interface Attributes you can create custom interface attributes and interface technologies. This enables you to document your interfaces in a complete and technically correct manner in case the standard set of attributes and technologies doesn’t describe the interface sufficiently. There are two possibilities to do this. The first is a lite version, accessible from the Interface Documentation UI which is detailed in section 4.1. The second option has more functionality. It allows you to create custom attributes and technologies and assign them as you wish (see section 4.2).

 

4.1     Built-in Maintenance of Custom Content

Open the Interface Documentation UI as described in chapter Maintain Interface Attributes. At the bottom of the screen you can open the custom attribute maintenance via button Create Customer Attributes. This built-in maintenance UI allows you to create attributes for the technology you have selected. Note that interface subtypes are currently not respected. This means if you create a custom attribute for interface technology HTTP, subtype ABAP, this attribute will be available for all other subtypes of HTTP, too.

 

 

In this built-in customer attribute maintenance you can see a list of all (standard and custom) attributes currently assigned to the interface technology. You can switch the attribute groups using the drop-down menu.

 

The following functions are possible:

  • Add Attribute: create a new custom attribute in the current context (combination of interface technology and attribute group). Note that the attribute name must be in customer namespace (Y* or Z*).
  • Copy Attribute: mark the line of an existing attribute to copy it via this button.
  • Un-assign Attribute: remove a custom attribute from the current context. Note that the custom attribute won’t be finally deleted since it can belong to different interface technologies, too. But it will be removed for the current interface technology. This has effect on all Interface Documentations in the system with the same interface technology, so handle this function with care. Full deletion of customer attributes can only be done in the stand-alone application.
  • Save / Save and Close / Cancel: Let you save your current changes with the possibility to add further attributes (Save) or to directly return to the main area for attribute maintenance (Save and Close). Cancel discards all your unsaved changes and returns to the main area for attribute maintenance.

 

Per attribute you can provide a descriptive text. If needed a domain from the Data Dictionary can be assigned, to provide input for a fixed value help. Note that if a domain value is provided the custom attribute automatically turns into a dropdown field. In addition, you can provide the cardinality and the system dependency (true = system-dependent attribute) for the attribute. See chapter Maintain Interface Attributes for more details on those two characteristics.

 

4.2     Stand-alone Maintenance of Custom Content

 

You can use transaction AGS_DCM_CUST_IFDOCU to create custom attributes and technologies, and to do the assignment between the both. You should always use it instead of the lite version for customer attribute creation if you have to perform multiple or complex operations.

When you run the transaction you will be presented with the following screen:

The possible functions are described in the following.

 

4.2.1   Define Custom Attributes

 

In tab Define Attributes you can maintain customer attributes. Standard attributes are not editable. Per default all attributes (standard or custom) available in the system are displayed. The following actions are possible:

  • Add Attribute: to create a new custom attribute in customer namespace (Y* or Z*). Provide the technical identifier of the attribute and a speaking name for it. Note that the technical identifier must be unique in the system and must not contain special or blank characters.

You also have the possibility to provide input for a value help. Currently it’s only possible to assign a domain from the Data Dictionary to the custom attribute. Value helps via table / field name combination or a dedicated search help are not respected in the Interface Documentation UI. Note that if you provide a domain value the custom attribute automatically turns into a dropdown field. In addition, you can set the cardinality and the system dependency (true = system-dependent attribute). See chapter Maintain Interface Attributes for more details on those two characteristics.

  • Copy Attribute: to copy an existing attribute with all properties. Note that you have to adjust the technical identifier (at least move it to customer namespace).
  • Delete Attribute: to remove a custom attribute from the system. Note that a custom attribute could be assigned to multiple interface technologies, so perform this action with care.
  • Save / Cancel: to save or discard all unsaved changes.

 

4.2.2   Define Custom Interface Technologies

In tab Define Interface Technology you can create a custom interface technology. Standard interface technologies are not editable. Per default all interface technologies (standard or custom) available in the system are displayed. The following actions are possible:

  • Add Technology: to create a new custom interface technology in customer namespace (Y* or Z*). Provide the technical identifier of the interface technology and a speaking name for it. Note that the technical identifier must be unique in the system and must not contain special or blank characters.

  • Copy Technology: to copy an existing technology.
  • Delete Technology: to delete custom technologies system-wide. Standard technologies can’t be deleted.
  • Save / Cancel: to save or discard all unsaved changes.

4.2.3   Assign Attributes to Technologies

In tab Assign Attributes to Technology you can assign custom and standard attributes to a custom or standard interface technology. First select the interface technology type and subtype (if available), as well as the attribute group attributes should be assigned to. The system shows all currently assigned attributes according to this selection. The following actions are possible.

 

 

  • Assign Attribute: to assign attributes which exist in the system to the current context. You can use the value help to load the attributes. A sequence number is assigned to the attribute automatically which you can still change manually. Sequence numbers define the order the attributes appear in the Interface Documentation UI. You can re-arrange the attributes by changing the sequence numbers, however, each number must be unique.
  • Un-assign Attribute: to remove an assigned customer attribute from the current context. You can’t un-assign standard attributes.
  • Save / Cancel: to save or discard all unsaved changes.

 

 

  • No labels