SAP Knowledge Base Article - Public

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

Symptom

  • The "Custom External Module" option is visible in the Home page module picker (module drop-down).
  • Administrators want to enable or disable (hide/remove) this option

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

Environment

SAP SuccessFactors HCM Suite

Reproducing the Issue

  1. Log in to SAP SuccessFactors.
  2. Navigate to the Home page.
  3. Open the module picker (module drop-down).
  4. Observe that "Custom External Module" appears in the module list.

Cause

The "Custom External Module Integration" feature is enabled in Provisioning.
This feature allows a single external module to be introduced in the BizX suite via a BizX wrapper page.
The wrapper page renders the module’s main content in an iframe.

Resolution

To disable (hide/remove) "Custom External Module" from the module picker:

  1. Access Provisioning for the affected company instance.
    • As a customer, you do not have access to Provisioning. Please engage your Implementation Partner or open a case with SAP Support (Component: LOD-SF-PLT-NAV).
  2. Go to Company Settings and locate the setting "Custom External Module Integration" and disable it.
  3. Save the changes by clicking the "Save Feature" button at the top of the page.

If you want to enable this feature, consider the following:

  1. In the "Frame URL" field, enter the URL you want to load. The URL can include the tokens "@CSS@" and "@LOCALE@". If present, SuccessFactors will automatically replace them with the correct values when the page is loaded in the iframe. 

    Custom external module.png

  2. 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 "https://www.successfactors.com/" and an "about" URL to be "https://www.successfactors.com/en_us/about-successfactors.html".  Then, in the "Frame URL" field, you would specify the following:
https://www.successfactors.com/
about|https://www.successfactors.com/en_us/about-successfactors.html


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.

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.

CustomExternalModuleInModulePicker.png

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

Keywords

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

Product

SAP SuccessFactors HCM Suite all versions