SAP Knowledge Base Article - Public

2628761 - How To Enable Or Disable Custom External Module Integration Feature in Successfactors


Custom External Module feature is visible on the hompe page under module picker.

"Image/data in this KBA is from SAP internal systems, sample data, or demo systems. Any resemblance to real data is purely coincidental."


SAP SuccessFactors HXM Suite

Reproducing the Issue

Login to successfactors --> Navigate to Home page dropdwon menu--> Custom External Module is available in the module list


Custom External Module Integration has been enabled in the provisioning. The "Custom External Module Integration" feature allows for a single new module to be introduced in the BizX suite, where a BizX wrapper page would show an iframe for the main content area, and within the iframe, it would show the new module content.


 To Enable or Disable the "Custom External Module Integration" feature, do the following:

  1. Go to the provisioning area of the BizX company instance and configure the URL for the iframe.
    1. Login to the Provisioning app of the BizX environment where the company instance resides.
    2. Locate the company instance, and then go to the "Edit Company Settings | Company Settings" page.
    3. Find the "Enable Custom External Module Integration" checkbox area.  For the checkbox, check it, and then save the change via the "Save Feature" button at the top of the page. Even if it says "[Demoable, Not Ready for Production], it can be enable in Production systems already and this is just an old message in provisioning.
    4. For the "Frame URL" field in the "Enable Custom External Module Integration" checkbox area, you need to add the URL to this field.  Note that the "@CSS@" and "@LOCALE@" substitution tokens are supported, so if they exist in the URL, then they will be replaced with appropriate values when the URL is used in the iframe.

      Custom external module.png

    5. Starting in b1308 via UI-1994, you can specify additional URLs in the "Frame URL" field, but you have to give names to the other URLs, and only the nameless URL will be associated with the "Custom External Module" menu item in the module picker (see step #2).  To specify a name for a URL, put the name first, and then a pipe character ('|') after the name, immediately before the URL.  For example, let's say that you have the main URL be "" and an "about" URL to be "".  Then, in the "Frame URL" field, you would specify the following:

      Once this is done, then the "/sf/customExternalModule" URL would go show the main URL, and the "/sf/customExternalModule?urlName=about" would show the "about" URL.

  2. Once the URL for the iframe is configured in provisioning, you will see a "Custom External Module" menu item in the module picker.  If you want to change the "Custom External Module" menu item text to something else, then you can go to the "Admin Center | Text Replacement" admin tool, and change the value there.


Or if you don't want the "Custom External Module" menu item in the module picker to show up, then simply un-check the "Enable Custom External Module Integration" checkbox in provisioning (see item #1 for details).

  1. Note that you can have the URLs like "/sf/customExternalModule" and "/sf/customExternalModule?urlName=about" to be used as custom navigation items in the module picker and other locations.  See the "Admin Center | Configure Custom Navigation" admin tool for details.

See Also

2373626 - Enable Configure Custom Navigation and grant permission


Custom External Module Integration , KBA , LOD-SF-PLT-NAV , Custom Navigation , LOD-SF-FWK-UI , User Interface Framework , LOD-SF-PLT-PRV , Provisioning Changes , How To


SAP SuccessFactors Platform all versions