Skip to main content

xSuite Apps for SAP Fiori Installation Guide

Appendix A. "settings.json" parameters for the xSuite Apps

Notice

You might see parameters in the settings.json file that are not listed here. These settings are intended for a future product version.

CLOUD?/GATEWAY?/HANA?

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

cloud

Specifies whether the xSuite Apps are used on-premises or in the Cloud Foundry environment.

[BLANK]

String

[BLANK] On-Premise

true: Cloud Foundry Environment

mutlibackend

Specifies whether the SAP NetWeaver Gateway will be used.

The back-end must be customized for multi-back-end mode. If this customization is not performed, the multi-back-end mode will not be used.

false

Boolean

true: A gateway is used.

false: No gateway is used.

hana

Specifies whether an SAP S/4HANA back end is used.

false

Boolean

true: An SAP S/4HANA back end is used.

false: No SAP S/4HANA back end is used.

GATEWAY-SETTINGS

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

nwgw

Settings for the SAP NetWeaver Gateway

These settings only have an effect if the parameter use_nwgw has the value true.

--

--

--

nwgw > nwgw_host

Scheme, host and, if applicable, port of the gateway, e.g., https://www. example.com:port

window.location.protocol + '//' + window.location.host

String

--

nwgw > nwgw_target

See Overview of the basic settings for the xSuite Apps.

Caution: A default value does not exist. Therefore, be sure to set a value.

--

String

--

nwgw > nwgw_path

Determines the path, without log or host, for the web service xf_gw_web_service_srv.

The string must begin and end with a slash (/).

/sap/opu/odata/wmd/xf_gw_web_service_srv/

String

--

nwgw > nwgw_archive_path

Determines the path, without log or host, for invoking the archive by way of the gateway xf_archive_srv.

The string must begin and end with a slash (/).

/sap/opu/odata/wmd/xf_archive_srv/

String

--

nwgw > nwgw_oci_path

Determines the path, without log or host, for invoking the OCI services xf_oci.

The string must begin and end with a slash (/).

/sap/bc/bsp/wmd/xf_oci/

String

--

nwgw > nwgw_entity

--

payloadSet

String

--

nwgw > nwgw_download_entity

--

downloadSet

String

--

nwgw > nwgw_oci_entity

--

index.htm

String

--

nwgw > nwgw_upload_entity

--

uploadSet

String

--

nwgw > nwgw_ssopathfile

Specifies the path (without log or host) and file of the SSO service.

The string must begin with a slash (/) and end with "htm" or "html".

/sap/bc/bsp/wmdgw/xf_gw_sso_fiori/sso.htm

String

--

NON-GATEWAY-SETTINGS

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

uri

Settings for stand-alone mode (without gateway).

These settings only have an effect if the parameter use_nwgw has the value false.

--

--

--

uri > host

Scheme, host and, if applicable, port of the back end, e.g., https://www. example.com:port

window.location.protocol + '//' + window.location.host

String

--

uri > service_url

Specifies the path to the xSuite web service.

The path is specified without either protocol or host.

The string must begin with a slash (/) and end with a question mark (?).

/sap/bc/wmd_web_service?

String

--

uri > ssopathfile

Defines the path to the xSuite SSO service.

The path is specified without either protocol or host.

The string must begin with a slash.

--

String

--

uri > target

Determines whether the SAP back end and the xSuite Apps are on the same system or on different systems.

"" (blank string)

String

"": The SAP back end and the xSuite apps will be on the same system.

Created RFC destination: The SAP back-end and the xSuite apps will be located on different systems.

loginlogo

Specifies the image file that is displayed as the logo on the Login page (stand-alone mode, no SSO login).

For more information on modifying the non-SSO login page, see the publication xSuite Apps for SAP Fiori Development Guide.

"" (blank string)

String

"": xSuite logo

"-" (minus): no logo

showLogoutBtn

Determines whether the logout button is displayed.

true

Boolean

VIEWER-/BUS-SETTINGS

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

viewerType

The parameter sets the viewer used.

P

String

P: PNG Viewer

D: DocViewer as a plugin in PNG Viewer

pngViewer

Settings for the PNG Viewer.

--

--

--

pngViewer > hideNonExistingThumbnails

Sets whether pages that do not exist will be hidden in the tab Pages (true), or whether placeholders will be displayed for these pages (false).

true

Boolean

pngViewer > extFileSupportMimetypes

List of additional MIME types whose files the browser can display, e.g. due to plug-ins.

To prevent unnecessary downloads and data transfer, the Viewer only displays attachments whose output is supported by the web browser.

By default, files of the following MIME types are output:

  • application/json

  • application/pdf

  • application/xhtml+xml

  • application/xml

  • text/css

  • text/csv

  • text/html

  • text/json

  • text/markdown

  • text/plain

  • text/xml

  • image/gif

  • image/jpeg

  • image/png

  • image/svg+xml

If the web browser supports the output of additional file types (due to plug-ins, for example), the list of supported MIME types can be extended, so that the Viewer also displays files of this type.

--

String with values separated with commas

--

pngViewer > parseEML

Sets whether e-mails of file type EML (MIME type: message/rfc822) are parsed and displayed, provided that the respective file can be parsed using JavaScript.

This display does not replace the display in a full-fledged e-mail program such as MS Outlook. Script and format specifications are ignored and not displayed. The display provides only an overview of the content.

true

Boolean

pngViewer > parseEMLshowHTML

Sets whether HTML tags are included when parsing EML emails.

If the parameter pngViewer > parseEML has the value false, this parameter is not relevant.

In EML e-mail files, the inclusion of HTML tags can be enabled at your own risk. For security reasons, the inclusion of HTML tags is disabled by default (i.e., HTML tags are removed before the text is output or no HTML is parsed in the displayed text). Head and body scripts, img tags and script tags as well as the CSS of the e-mail should not be included even if activated.

false

Boolean

pngViewer > parseMSG

Sets whether emails of the file type MSG (MIME type: application/vnd.ms-outlook) are parsed and displayed, provided that the respective file can be parsed using JavaScript.

This display does not replace the display in a full-fledged e-mail program such as MS Outlook. Script and format specifications are ignored and not displayed. The display provides only an overview of the content.

true

Boolean

pngViewer > PDFbrowserRendering

Determines whether PDF files that do not come from xSuite Bus should be rendered by the browser (true) or by the Viewer (false).

false

Boolean

pngViewer > showPageview

Sets whether the tab Pageview will be displayed.

true

Boolean

pngViewer > showThumbnails

Sets whether the tab Pages will be displayed.

true

Boolean

pngViewer > trainingRequestInterval

Defines the time interval in which the training data is loaded after saving to check if the training has been completed; expressed in milliseconds.

500

Number

200 to 2000

busSettings

Viewer settings

--

--

--

busSettings > _default_

Settings for the standard back end, provided no other back end has been defined with the "rfc" parameter.

--

--

--

busSettings > _default_ > _default_

Settings for all interface applications of all standard back ends

For an example, see Appendix B, "settings.json" parameters—additional information.

--

--

--

busSettings > _default_ > _default_ > enabled

Determines whether the Viewer is used.

If the value is false, the remaining busSettings settings for this RFC destination will have no effect.

true

Boolean

busSettings > _default_ > _default_ > cloud

The Viewer displays data from the xSuite Helix Archive.

false

Boolean

busSettings > _default_ > _default_ > uri

Specifies the host and directory where the xSuite Bus web service or the xSuiteCaptureDataService of the Helix Archive is located.

Caution: A default value does not exist. Therefore, you must specify a value when using a viewer.

--

String

--

busSettings > _default_ > _default_ > tokenRequired

Determines whether a token is required for access to the Bus interface.

If a token is needed, this token will be loaded via the service /WMD/XF_WEB_CAPTURE_TOKEN_GET.

false

Boolean

busSettings > exampleRFC

Settings for back ends whose data deviates from the data of the standard back end

Notes:

  • Rename the key exampleRFC to the respective rfc parametric value. Note that the value is case-sensitive.

  • Duplicate this property for each back end addressed by rfc parametric value or login form, and name the respective keys accordingly.

For an example, see Appendix B, "settings.json" parameters—additional information.

--

--

--

busSettings > exampleRFC > exampleAPPL

Settings for the Interface Application exampleAPPL of the back end with the rfc parameter exampleRFC

--

--

--

busSettings > exampleRFC > exampleAPPL > enabled

See busSettings > _default_ > _default_ > enabled.

--

--

--

busSettings > exampleRFC > exampleAPPL > cloud

See busSettings > _default_ > _default_ > cloud

--

--

--

busSettings > exampleRFC > exampleAPPL > uri

See busSettings > _default_ > _default_ > uri

--

--

--

busSettings > exampleRFC > exampleAPPL > tokenRequired

See  busSettings > _default_ > _default_ > tokenRequired

--

--

--

busSettings > exampleRFC > default

Settings for all interface applications of the back end with the rfc parameter exampleRFC, for which there are no separate settings.

In this case, they apply to all interface applications except exampleAPPL.

For each rfc destination, the _default _ values of the interface application must be set.

--

--

--

busSettings > exampleRFC > default > enabled

See busSettings > _default_ > _default_ > enabled

--

--

--

busSettings > exampleRFC > default > cloud

See busSettings > _default_ > _default_ > cloud

--

--

--

busSettings > exampleRFC > default > uri

See busSettings > _default_ > _default_ > uri

--

--

--

busSettings > exampleRFC > default > tokenRequired

See  busSettings > _default_ > _default_ > tokenRequired

--

--

--

GENERAL ITS-SETTINGS

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

its

Settings for the SAP Internet Transaction Server (ITS) and SAPGUI for HTML (webgui)

--

--

--

its > _default_

Settings for the standard back end, provided no other back end has been defined with the "rfc" parameter.

--

--

--

its > _default_ > host

Sets the host of the SAP Internet Transaction Server.

window.location.protocol + '//' + window.location.host

String

--

its > _default_ > path

Sets the path, without host, for the webgui.

The string must begin with a slash (/) and end with transaction=.

/sap/bc/gui/sap/its/webgui?~transaction=

String

--

its > exampleRFC

Settings for each additional back end addressed with "rfc" parameters. For more information, see Setting an individual RFC connection for an xSuite tile in the Fiori Launchpad ("rfc" parameter).

Notes:

  • Rename the key exampleRFC with the respective "rfc" parametric value. Note that the value is case-sensitive.

  • If more than one additional back end is addressed with different tiles, duplicate this property and rename the respective keys.

--

--

--

its > exampleRFC > host

See its > default > host.

window.location.protocol + '//' + window.location.host

String

--

its > exampleRFC > path

See its > default > path.

/sap/bc/gui/sap/its/webgui?~transaction=

String

--

itsConfirmClose

Determines whether the ITS dialog must be confirmed to close.

false

Boolean

true: When closing the dialog, you must confirm that you really do want to close the dialog.

false: Then the dialog will close.

itsFullscreen

Determines whether the dialog screen that displays the ITS completely fills the browser window.

true

Boolean

true: The dialog screen will fill the browser window.

false: The dialog screen will be displayed next to the attachents. If there is no attachment, the dialog screen will fill the browser window.

MYINBOX SETTINGS

Integration of xSuite workitems into the SAP Fiori MyInbox 2.0 must always be configured in a section of the settings.json file.

During configuration, assign each system and client to the respective RFC connection. Then assign each system alias to the respective RFC connection. The section in the settings.json file should look like this:

"__comment__": "------------- MYINBOX SETTINGS -------------",
"myinbox": {
     "__comment__":
"***** MAPPING SYSTEM + CLIENT TO RFC ******",
     "sc": {
           "exampleSystem": {
                "clientA":                 "",
                "clientB":                 ""
           }
     },
     "__comment__": "***** MAPPING SYSTEMALIAS TO RFC **********",
     "alias": {
           "exampleAlias":                 ""
     }
},

Specify the systems plus client and the respective RFC connections under "sc". Store the system alias and the associated RFC connections under "alias".

Example

The system is set up with the following structure:

SAP system

Client

System alias

RFC connection

S01

100

S01100

RFC_S01_100

S01

800

S01800

RFC_S01_800

P02

200

P_02

RFC_P02

Configure the section in the settings.json file as follows:

"__comment__": "------------- MYINBOX SETTINGS -------------",
"myinbox": {
     "__comment__": "***** MAPPING SYSTEM + CLIENT TO RFC ******",
     "sc": {
           "S01": {
                "100":               "RFC_S01_100",
                "800":               "RFC_S01_800"
           },
           "P02": {
                "200":               "RFC_P02" 

           },
     },
     "__comment__": "***** MAPPING SYSTEMALIAS TO RFC **********",
     "alias": {
           "S01100":                  "RFC_S01_100",
           "S01800":                  "RFC_S01_800",
           "P_02":                    "RFC_P02",
     }
},

WORKFLOW SETTINGS

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

dispdoc

Workflow-specific settings (independent of app)

--

--

--

dispdoc > csvNumberOfHeaders

Determines the number of header lines in a CSV file.

The header lines are ignored in a CSV file upload or import. All CSV files must therefore have the same number of headers.

0

Number

0 to 99

dispdoc > dataReloadAfterMail

Determines whether work-item data is to be reloaded after an e-mail has been sent.

When you reload, the attachments will be refreshed and the e-mails displayed directly.

For slow systems or slow data connections, select false in order to cut down on data requests.

true

Boolean

true: The e-mail will be accessible in the attachments.

false: The e-mail will only be displayed when the work item is reloaded manually or called up again.

dispdoc > generalAccountingTplsType

Determines whether a general account-assignment template can be applied in one or two levels.

2

Number

1: All templates and account-assignment rows will be displayed immediately. Templates will be available for selection.

2: Only the templates will be displayed when the window is opened.

To display the account assignment rows and adopt a template, first open the one desired.

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s

Determining the ucomms that use the ITS

--

--

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > AL

Settings for work items of the "AL" group

--

--

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > AL > AL

Ucomms of the work items of type /WMD/XF_AL that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > IV

Setting for the work items of the "IV" group

--

--

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > IV > AP

Ucomms of the work items of type /WMD/XF_AP that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

chng_inv, disp_inv, post, reverse

String with values separated with commas

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > IV > LO

Ucomms of the work items of type /WMD/XF_LO that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

chng_inv, disp_inv, post, reverse

String with values separated with commas

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > IV > XI

Ucomms of the work items of type /WMD/XF_XI that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > OC

Setting for the work items of the "OC" group

--

--

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > OC > OC

Ucomms of the work items of type /WMD/XF_OC that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > PO

Setting for the work items of the "PO" group

--

--

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > PO > PF

Ucomms of the work items of type /WMD/XF_PF that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > PO > PO

Ucomms of the work items of type /WMD/XF_PO that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

chng_doc, disp_doc

String with values separated with commas

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > PO > PR

Ucomms of the work items of type /WMD/XF_PR that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

chng_doc, disp_doc

String with values separated with commas

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > PS

Setting for the work items of the "PS" group

--

--

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > PS > CD

Ucomms of the work items of type /WMD/XF_CD that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

chng_inv, disp_inv, post

String with values separated with commas

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > PS > FM

Ucomms of the work items of type /WMD/XF_FM that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

chng_inv, delete, disp_inv, post

String with values separated with commas

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > SD

Setting for the work items of the "SD" group

--

--

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > SD > OR

Ucomms of the work items of type /WMD/XF_OR that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

chng_doc, disp_doc

String with values separated with commas

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > SI

Setting for the work items of the "SI" group

--

--

--

dispdoc > i‍t‍s‍U‍c‍o‍m‍m‍s > SI > SI

Ucomms of the work items of type /WMD/XF_SI that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > itsAccUcomms

Determining the ucomms in the accounting block that use the ITS

--

--

--

dispdoc > itsAccUcomms > AL

Settings for work items of the "AL" group

--

--

--

dispdoc > itsAccUcomms > AL > AL

Ucomms of the work items of type /WMD/XF_AL that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > itsAccUcomms > IV

Setting for the work items of the "IV" group

--

--

--

dispdoc > itsAccUcomms > IV > AP

Ucomms of the work items of type /WMD/XF_AP that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > itsAccUcomms > IV > LO

Ucomms of the work items of type /WMD/XF_LO that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > itsAccUcomms > IV > XI

Ucomms of the work items of type /WMD/XF_XI that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

po

String with values separated with commas

--

dispdoc > itsAccUcomms > OC

Setting for the work items of the "OC" group

--

--

--

dispdoc > itsAccUcomms > OC > OC

Ucomms of the work items of type /WMD/XF_OC that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > itsAccUcomms > PO

Setting for the work items of the "PO" group

--

--

--

dispdoc > itsAccUcomms > PO > PF

Ucomms of the work items of type /WMD/XF_PF that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > itsAccUcomms > PO > PO

Ucomms of the work items of type /WMD/XF_PO that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > itsAccUcomms > PO > PR

Ucomms of the work items of type /WMD/XF_PR that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > itsAccUcomms > PS

Setting for the work items of the "PS" group

--

--

--

dispdoc > itsAccUcomms > PS > CD

Ucomms of the work items of type /WMD/XF_CD that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > itsAccUcomms > PS > FM

Ucomms of the work items of type /WMD/XF_FM that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > itsAccUcomms > SD

Setting for the work items of the "SD" group

--

--

--

dispdoc > itsAccUcomms > SD > OR

Ucomms of the work items of type /WMD/XF_OR that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > itsAccUcomms > SI

Setting for the work items of the "SI" group

--

--

--

dispdoc > itsAccUcomms > SI > SI

Ucomms of the work items of type /WMD/XF_SI that require the ITS

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

--

String with values separated with commas

--

dispdoc > oci

Settings that affect OCI catalogs.

--

--

--

dispdoc > oci > modifyMercateoURL

Determines whether an attempt should be made to correct an incorrect Mercateo configuration.

false

Boolean

true: With an attempt at correction, which must be confirmed by the user.

false: No attempt at correction

dispdoc > scrollToSection

Determines whether the system automatically scrolls to a section when a work item is opened.

true 

Boolean

true: Will scroll automatically to a specific section. Which section is scrolled to depends, among other things, on which sections are displayed.

false: No automatic scrolling to a section.

dispdoc > showGoReWeWrbtr

Determines whether the totals column is displayed in the goods-receipt dialog screen.

false

Boolean

SSO ONLY SETTINGS

Parameter

Parameter

Default v‍a‍l‍u‍e

Data type

Range of values

use_nwgw

Specifies whether the SAP NetWeaver Gateway will be used.

The parameter is only included if the xSuite Apps with SSO are used in standalone mode (without SAP Fiori Launchpad).

true

Boolean

True: A gateway is used.

False: No gateway is used.

MISCELLANEOUS GENERAL SETTINGS

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

attachNoPDFiFrame

If settings determine that file attachments be displayed in an iFrame, this parameter determines whether this also applies to PDF attachments.

true

Boolean

true: Never open PDFs in iFrame.

false: Open PDFs according to user settings in the iFrame or object.

busytype

Sets the type of screen output, for instance when the app is waiting for a response from the back end.

2

Number

1: The busy indicator is used. The GUI is shaded over. A moving image will be displayed.

2: The busy dialog is used. As in (1), an additional text such as "Please wait for..." will be displayed.

cacheInterval

Specifies the number of seconds after which the cache timer is updated in the document display.

This parameter is only included if the parameter cacheShowBtn is true.

1

Number

0 to 60

cacheShowBtn

Defines how the expiration of the cache runtime should be handled.

false

Boolean

true: The cache timer will be displayed in the footer. A click on the cache timer will restart the cache runtime.

false: The cache timer will not be displayed in the footer. Five minutes before the cache runtime expires, a dialog screen will appear informing the user of imminent runtime expiration.

The user will either be able to restart the cache runtime or to leave the document.

CsrfTokenPeriod

Sets the length of time before the request for the CsrfToken is repeated. Expressed in minutes.

This prevents the CsrfToken from becoming invalid during use of the app. Once the time is up, CsrfToken will be requested.

When inactive, CsrfToken is not requested again. In this case, it expires.

The time span must be shorter than the length of validity of CsrfToken.

15

Number

5 to 240

doctypeStrict

Determines whether the document type must be strictly observed for Excel and Word documents (XLS, XLSX, DOC, DOCX).

true

Boolean

true:

  • XLS only allows XLS files

  • XLSX only allows XLSX files

  • DOC only allows DOC files

  • DOCX only allows DOCX files

false:

  • XLS allows XLS and XLSX files

  • XLSX allows XLS and XLSX files

  • DOC allows DOC and DOCX files

  • DOCX allows DOC and DOCX files

exportParams

Settings for exporting tables as Excel files

--

--

--

exportParams > asCurr

Determines whether amounts are formatted according to the currency or whether no formatting takes place.

true

Boolean

true: Amounts are formatted according to the currency during export.

false: Amounts are exported without formatting.

exportParams > asDate

Determines whether date and time information is exported in the appropriate data type or as a correspondingly formatted string.

true

Boolean

true: Date and time information is exported in the corresponding date/time format.

false: Date and time information is exported as a correspondingly formatted string.

favicon

Specifies the favicon (image file) that is displayed, for example, in the web browser tab bar.

When using an external or local image file, this image file must match the image format and size of the favicon.

"" (blank string)

String

"": Standard icon

"-" (minus): no favicon

String begins with "http": External image file, where the URL for the external image file must be specified in its entirety. String does not begin with "http": Local image file; the file name with file extension must be located in the /userexits/ directory of the xSuite Base Library.

f4maxhits

Sets the maximum number of entries in F4 input help.

1000

Number

>= 0

f4SingleLoadDirectlyAll

Determines whether the basic search is displayed within the single step F4 input help (workflow).

The basic search filters all data fields for the value, not just a specific data field.

Note: In the two-step F4 input help, the basic search does not work because the data is not accessible in the same way.

For an example, see Appendix B, "settings.json" parameters—additional information.

false

Boolean

maxBlobSize

Attachments that exceed a certain size cannot be displayed by web browsers using a data URL. The maximum file size will vary from browser to browser.

If the maximum file size is exceeded, a message text will appear to this effect. This will prevent the occurrence of an error in the PDF plugin.

This parameter sets the maximum size for PDF files displayed via a data URL.

--

--

--

maxBlobSize > CR

Chrome

2097152

Number

>= 10

maxBlobSize > EDGEC

Microsoft Edge (with Chromium rendering engine / Version 75+)

2097152

Number

>= 10

maxBlobSize > FF

Firefox

33554432

Number

>= 10

maxBlobSize > SF

Safari

2097152

Number

>= 10

maxBlobSize > OTHER

All other browsers

2097152

Number

>= 10

maxURIlength

This value specifies the maximum length permitted for the URL of a search parameter.

Example: A user saves the search criteria entered for an xSuite overview as a bookmark.

If the URL with the search parameters exceeds the maximum length, the search parameter will not be added.

The maximum length of the URL is limited. It varies depending on the web browser and version. A length of up to 2000 characters is generally supported. If all users are using the same version and it supports a longer URL, you can set a higher value.

If the search aborts in the xSuite overviews, set a lower value.

2000

Number

0: Any search criteria entered will not be appended to the URL when saved as a bookmark.

1 to 8000

maxRowSelections

Defines the maximum number of lines that can be selected simultaneously from the table to perform an action on them (for example, forwarding in the results list of the Incoming Invoice Ledger).

100

Number

10 to 1000

modelSizeLimit

Sets the maximum number of entries in that are used for model bindings.

1000

Number

100 to 5000

modifyTitle

Specifies the page title that is displayed in the web browser tab.

1

Number

0: Page title = app title

1: Page title = app page · app title. Example: Incoming Invoice Ledger · xSuite App

2: Page title = app title · app page. Example: xSuite App · Incoming Invoice Ledger

plainpdf

The dummy PDF displayed in the Attachments section if there is no attachment.

For more information, see the publication xSuite Apps for SAP Fiori Development Guide.

"" (blank string)

String

"": The standard dummy PDF is used.

PDF file without the file extension ".pdf": This PDF is used. It must be in the /wmd/userexits/ directory.

skipTextHeaderline

Determines whether the formatted header line should be output in the logs.

true

Boolean

true: The formatted header line will not be output.

false: The formatted header line will be output.

secondaryCalendarType

Specifies whether pop-up windows displaying calendars should add a second date format to the existing Gregorian calendar.

For an example, see Appendix B, "settings.json" parameters—additional information.

"" (blank string)

String

Islamic

Japanese

Persian

"": Only the Gregorian calendar is displayed.

textRightAlign

Sets the SAP data types that have values that are aligned to the right.

CURR,NUMC,DEC,FLTP,INT1,INT2,INT4,QUAN

String with values separated with commas

--

validationerror

Settings for the output of validation errors

--

--

--

validationerror > duration

Defines the number of milliseconds a message toast is displayed.

The default value 2500 corresponds to 2.5 seconds.

2500

Number

500 to 20000

validationerror > msgtype

Determines whether validation errors are output in a message toast or a dialog.

A message toast will disappear automatically. A dialog must be closed by the user.

2

Number

1: Output in a message toast (without specifying the field)

2: Output in a message toast

3: Output in dialog (must be actively closed)

validationerror > position

Defines where a message toast is displayed in the web browser window.

center bottom

String

center top

center center

center bottom

APP SPECIFIC SETTINGS

ARCHIVELINK MONITOR APP

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

app_arm

Settings for the ArchiveLink Monitor App

--

--

--

app_arm > attachmentsGrid

Determines how the attachments of a work item are displayed.

For an example, see Appendix B, "settings.json" parameters—additional information.

true

Boolean

true: Attachments are displayed in the grid.

false: Attachments are displayed in the form of a list.

app_arm > attSecInFrontOf1

Outputs attachments section before this section if both sections are displayed.

If the section defined here is not displayed, the parameter attSecInFrontOf2 is applied.

TEXT

String

HEAD, ITEM, TEXT, WFLOG

app_arm > attSecInFrontOf2

Outputs attachments section before this section if both sections are displayed.

If the section defined here is not displayed, the Attachments section will be displayed as the last section if it is to be displayed.

Caution: The values of the parameters attSecInFrontOf1 and attSecInFrontOf2 must not be identical.

WFLOG

String

HEAD, ITEM, TEXT, WFLOG

app_arm > itsEnabled

Determines whether ITS functionality is available in the ArchiveLink Monitor App.

If itsEnabled has the value false, the remaining its parameters have no effect.

false

Boolean

app_arm > itsUcomms

Defines all ucomms that run via ITS in the ArchiveLink Monitor App.

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

"" (blank string)

String with values separated with commas

--

app_arm > searchMaxHits

Defines the maximum number of data records that can be delivered from the back end by the ArchiveLink Monitor App.

500

Number

25 to 10000

app_arm > splitOldTimeline

Determines whether log entries created by the old log module are displayed in the timeline individually or in the form of a text block.

Caution: Splitting only works if the formatting of the header line corresponds to the standard, i.e. it has not been customized.

true

Boolean

true: Split old entries and display them individually, if possible.

false: Display old entries in the form of a text block.

CHECK CUSTOMIZING APP

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

app_chkcust

Settings for the Check Customizing App

--

--

--

app_chkcust > wiListGrowThres

Affects the tables that use the Grow functionality. This means that initially only the first X table entries are displayed. The next X entries can then be displayed step by step.

X is the value of this parameter.

25

Number

10 to 50

DELIVERY NOTES MONITOR APP

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

app_dnm

Settings for the Delivery Notes Monitor App

--

--

--

app_dnm > attachmentsGrid

Determines how the attachments of a work item are displayed.

For an example, see Appendix B, "settings.json" parameters—additional information.

true

Boolean

true: Attachments are displayed in the grid.

false: Attachments are displayed in the form of a list.

app_dnm > attSecInFrontOf1

Outputs attachments section before this section if both sections are displayed.

If the section defined here is not displayed, the parameter attSecInFrontOf2 is applied.

TEXT

String

HEAD, ITEM, TEXT, WFLOG

app_dnm > attSecInFrontOf2

Outputs attachments section before this section if both sections are displayed.

If the section defined here is not displayed, the Attachments section will be displayed as the last section if it is to be displayed.

Caution: The values of the parameters attSecInFrontOf1 and attSecInFrontOf2 must not be identical.

WFLOG

String

HEAD, ITEM, TEXT, WFLOG

app_dnm > itsEnabled

Determines whether ITS functionality is available in the Delivery Notes Monitor App.

If itsEnabled has the value false, the remaining its parameters have no effect.

false

Boolean

app_dnm > itsUcomms

Defines all ucomms that run via ITS in the ArchiveLink Monitor App.

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

"" (blank string)

String with values separated with commas

--

app_dnm > searchMaxHits

Defines the maximum number of data records that can be delivered from the back end by the Delivery Notes Monitor App.

500

Number

25 to 10000

app_dnm > splitOldTimeline

Determines whether log entries created by the old log module are displayed in the timeline individually or in the form of a text block.

Caution: Splitting only works if the formatting of the header line corresponds to the standard, i.e. it has not been customized.

true

Boolean

true: Split old entries and display them individually, if possible.

false: Display old entries in the form of a text block.

INBOX APP

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

app_inbox

Settings for the Inbox App

--

--

--

app_inbox > itsEnabled

Determines whether ITS functionality is available in the Inbox App.

If itsEnabled has the value false, the remaining its parameters have no effect.

false

Boolean

app_inbox > noCustomFields

Determines whether the custom fields are available in the web workstation.

false

Boolean

true: The custom fields in the web workstation will be available.

false: The custom fields in the web workstation will not be available.

app_inbox > resub

Settings for resubmission in the Inbox App

--

--

--

app_inbox > resub > addDays

In the resubmission dialog, the selection calendar of the field "Resubmission time" is preset to today's date plus X days.

X is the value of this parameter.

1

Number

1 to 30

app_inbox > resub > hours

In the resubmission dialog, the selection calendar of the field "Resubmission time" the hourly value of the time is preset to this value.

7

Number

0 to 23

app_inbox > resub > minutes

In the resubmission dialog, the selection calendar of the field "Resubmission time" the minute value of the time is preset to this value.

0

Number

0 to 59

app_inbox > splitOldTimline

Determines whether work item texts stored in the old long text system are split into individual timeline items with time and user.

Caution: Splitting only works if the standard scheme is used for the header. If a different scheme has been defined, splitting will most likely fail. Then this parameter must be set to false.

true

Boolean

true: Old long texts will be split and displayed with explicitly highlighted user and time.

false: Display old entries in the form of a text block.

app_inbox > wiListGrowThres

Concerns the tables that use the Grow functionality. This means that initially only the first X table entries are displayed. The next X entries can then be displayed step by step.

X is the value of this parameter.

25

Number

10 to 50

INVOICE MONITOR APP

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

app_invm

Settings for the Invoice Monitor App

--

--

--

app_invm > attachmentsGrid

Determines how the attachments of a work item are displayed.

For an example, see Appendix B, "settings.json" parameters—additional information.

true

Boolean

true: Attachments are displayed in the grid.

false: Attachments are displayed in the form of a list.

app_invm > attSecInFrontOf1

Outputs attachments section before this section if both sections are displayed.

If the section defined here is not displayed, the parameter attSecInFrontOf2 is applied.

TEXT

String

HEAD, ITEM, TEXT, WFLOG

app_invm > attSecInFrontOf2

Outputs attachments section before this section if both sections are displayed.

If the section defined here is not displayed, the Attachments section will be displayed as the last section if it is to be displayed.

Caution: The values of the parameters attSecInFrontOf1 and attSecInFrontOf2 must not be identical.

WFLOG

String

HEAD, ITEM, TEXT, WFLOG

app_invm > itsEnabled

Determines whether ITS functionality is available in the Invoice Monitor App.

If itsEnabled has the value false, the remaining its parameters have no effect.

false

Boolean

app_invm > i‍t‍s‍U‍c‍o‍m‍m‍s

Defines all ucomms that run via ITS in the Invoice Monitor App.

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

call_sap_ta_park, call_sap_ta_post, create_vendor, disp

String with values separated with commas

--

app_invm > searchMaxHits

Defines the maximum number of data records that can be delivered from the back end by the Invoice Monitor App.

500

Number

25 to 10000

app_invm > splitOldTimline

Determines whether log entries created by the old log module are displayed in the timeline individually or in the form of a text block.

Caution: Splitting only works if the formatting of the header line corresponds to the standard, i.e. it has not been customized.

true

Boolean

true: Split old entries and display them individually, if possible.

false: Display old entries in the form of a text block.

ORDER CONFIRMATION MONITOR APP

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

app_ocm

Settings for the Order Confirmation Monitor App

--

--

--

app_ocm > attachmentsGrid

Determines how the attachments of a work item are displayed.

For an example, see Appendix B, "settings.json" parameters—additional information.

true

Boolean

true: Attachments are displayed in the grid.

false: Attachments are displayed in the form of a list.

app_ocm > attSecInFrontOf1

Outputs attachments section before this section if both sections are displayed.

If the section defined here is not displayed, the parameter attSecInFrontOf2 is applied.

TEXT

String

HEAD, ITEM, TEXT, WFLOG

app_ocm > attSecInFrontOf2

Outputs attachments section before this section if both sections are displayed.

If the section defined here is not displayed, the Attachments section will be displayed as the last section if it is to be displayed.

Caution: The values of the parameters attSecInFrontOf1 and attSecInFrontOf2 must not be identical.

WFLOG

String

HEAD, ITEM, TEXT, WFLOG

app_ocm > itsEnabled

Determines whether ITS functionality is available in the Order Confirmation App.

If itsEnabled has the value false, the remaining its parameters have no effect.

false

Boolean

app_ocm > itsUcomms

Defines all ucomms that run via ITS in the Order Confirmation Monitor App.

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

call_sap_ta_park, call_sap_ta_post

String with values separated with commas

--

app_ocm > searchMaxHits

Defines the maximum number of data records that can be delivered from the back end by the Order Confirmation App.

500

Number

25 to 10000

app_ocm > splitOldTimline

Determines whether log entries created by the old log module are displayed in the timeline individually or in the form of a text block.

Caution: Splitting only works if the formatting of the header line corresponds to the standard, i.e. it has not been customized.

true

Boolean

true: Split old entries and display them individually, if possible.

false: Display old entries in the form of a text block.

OVERVIEWS APP

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

app_overviews

Settings for the Overviews App

---

---

---

app_overviews > itsEnabled

Determines whether ITS functionality is available in the Inbox App.

If itsEnabled has the value false, the remaining its parameters have no effect.

false

Boolean

app_overviews > maxSearchHits

Defines the default value of the Max. number of hits field with which the field is pre-filled in the search mask of the overviews.

500

Number

0 to 9999

app_overviews > splitOldTimline

Determines whether work item texts stored in the old long text system are split into individual timeline items with time and user.

Caution: Splitting only works if the standard scheme is used for the header. If a different scheme has been defined, splitting will most likely fail. Then this parameter must be set to false.

true

Boolean

true: Old long texts will be split and displayed with explicitly highlighted user and time.

false: Display old entries in the form of a text block.

PROCESS ANALYZER (ONLINE) APP

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

app_paonl

Settings for the Process Analyzer App (online)

---

---

---

app_paonl > defaultBukrs

Determines which company code is used for the quick queries "last month", "this month", "last week" and "this week".

In the complex search, the entry field for the company code is also filled with the company code defined here.

1000

String

Maximum length of string in characters: 4

FEEDER MONITOR APP

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

app_pfm

Settings for the Feeder Monitor App

---

---

---

app_pfm > searchMaxHits

Defines the maximum number of data records that can be delivered from the back end by the Feeder Monitor App.

500

Number

25 to 10000

PUBLIC SECTOR MONITOR APP

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

app_psm

Settings for the Public Sector Monitor App

---

---

---

app_psm > attachmentsGrid

Determines how the attachments of a work item are displayed.

For an example, see Appendix B, "settings.json" parameters—additional information.

true

Boolean

true: Attachments are displayed in the grid.

false: Attachments are displayed in the form of a list.

app_psm > attSecInFrontOf1

Outputs attachments section before this section if both sections are displayed.

If the section defined here is not displayed, the parameter attSecInFrontOf2 is applied.

TEXT

String

DUE, HEAD, ITEM, TEXT, WFLOG

app_psm > attSecInFrontOf2

Outputs attachments section before this section if both sections are displayed.

If the section defined here is not displayed, the Attachments section will be displayed as the last section if it is to be displayed.

Caution: The values of the parameters attSecInFrontOf1 and attSecInFrontOf2 must not be identical.

WFLOG

String

DUE, HEAD, ITEM, TEXT, WFLOG

app_psm > itsEnabled

Determines whether ITS functionality is available in the Public Sector Monitor App.

If itsEnabled has the value false, the remaining its parameters have no effect.

false

Boolean

app_psm > itsUcomms

Sets all ucomms that run in the Public Sector Monitor App via the ITS.

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

call_ta, disp, gpart, lifnr, vkont

String with values separated with commas

--

app_psm > searchMaxHits

Defines the maximum number of data records that can be delivered from the back end by the Public Sector Monitor App.

500

Number

25 to 10000

app_psm > splitOldTimline

Determines whether log entries created by the old log module are displayed in the timeline individually or in the form of a text block.

Caution: Splitting only works if the formatting of the header line corresponds to the standard, i.e. it has not been customized.

true

Boolean

true: Split old entries and display them individually, if possible.

false: Display old entries in the form of a text block.

SALES DOCUMENT MONITOR APP

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

app_sdm

Settings for the Sales Document Monitor App

--

--

--

app_sdm > attachmentsGrid

Determines how the attachments of a work item are displayed.

For an example, see Appendix B, "settings.json" parameters—additional information.

true

Boolean

true: Attachments are displayed in the grid.

false: Attachments are displayed in the form of a list.

app_sdm > attSecInFrontOf1

Outputs attachments section before this section if both sections are displayed.

If the section defined here is not displayed, the parameter attSecInFrontOf2 is applied.

TEXT

String

HEAD, ITEM, TEXT, WFLOG

app_sdm > attSecInFrontOf2

Outputs attachments section before this section if both sections are displayed.

If the section defined here is not displayed, the Attachments section will be displayed as the last section if it is to be displayed.

Caution: The values of the parameters attSecInFrontOf1 and attSecInFrontOf2 must not be identical.

WFLOG

String

HEAD, ITEM, TEXT, WFLOG

app_sdm > itsEnabled

Determines whether ITS functionality is available in the Sales Document Monitor App.

If itsEnabled has the value false, the remaining its parameters have no effect.

false

Boolean

app_sdm > itsUcomms

Sets all ucomms that run in the Sales Document Monitor App via the ITS.

Caution: If you define your own ucomms that run on the ITS, they must be added here as values.

call_sap_ta_park, call_sap_ta_post, create_customer, disp

String with values separated with commas

--

app_sdm > searchMaxHits

Defines the maximum number of data records that can be delivered from the back end by the Sales Document Monitor App.

500

Number

25 to 10000

app_sdm > splitOldTimline

Determines whether log entries created by the old log module are displayed in the timeline individually or in the form of a text block.

Caution: Splitting only works if the formatting of the header line corresponds to the standard, i.e. it has not been customized.

true

Boolean

true: Split old entries and display them individually, if possible.

false: Display old entries in the form of a text block.

TRANSACTIONS APP

Parameter

Description

Default v‍a‍l‍u‍e

Data type

Range of values

app_transactions

Settings for the Transactions App

--

--

--

app_transactions > transactionsVisible

Settings for the availability of the individual tiles within the Transactions App

--

--

--

app_transactions > transactionsVisible > BC_GET_SAPUSER

Determines whether the tile Extract User Data (/WMD/BC_GET_SAPUSER) is available in Transactions App.

true

Boolean

true: The tile is available.

false: The tile is not available.

app_transactions > transactionsVisible > BC_SPRO

Determines whether the tile Customizing (/WMD/BC_SPRO) is available in the Transactions App.

true

Boolean

true: The tile is available.

false: The tile is not available.

app_transactions > transactionsVisible > BC_USER_UPDATE

Determines whether the tile User Update (/WMD/BC_USER_UPDATE) is available in the Transactions App.

true

Boolean

true: The tile is available.

false: The tile is not available.

app_transactions > transactionsVisible > BC_USER_UPLOAD

Determines whether the tile User Upload (/WMD/BC_USER_UPLOAD) is available in the Transactions App.

true

Boolean

true: The tile is available.

false: The tile is not available.

app_transactions > transactionsVisible > FP_ACC

Determines whether the tile Account assignment templates (/WMD/FP_ACC) is available in the Transactions App.

true

Boolean

true: The tile is available.

false: The tile is not available.

app_transactions > transactionsVisible > FP_ACC_PS

Determines whether the tile Account assignment templates (Public Sector) (/WMD/FP_ACC_PS) is available in the Transactions App.

false

Boolean

true: The tile is available.

false: The tile is not available.

app_transactions > transactionsVisible > FP_STAT

Determines whether the tile Capture Analyzer Invoice (/WMD/FP_STAT) is available in the Transactions App.

true

Boolean

true: The tile is available.

false: The tile is not available.

app_transactions > transactionsVisible > XF_ESCALATION

Determines whether the tile Escalation Report (/WMD/XF_ESCALATION) is available in the Transactions App.

true

Boolean

true: The tile is available.

false: The tile is not available.

app_transactions > transactionsVisible > XF_RD_ADMIN

Determines whether the tile Recurring Documents Overview (/WMD/XF_RD_ADMIN) is available in the Transactions App.

true

Boolean

true: The tile is available.

false: The tile is not available.

app_transactions > transactionsVisible > XF_USR_MAIL_TPL

Determines whether the tile Notes mail via template is available in the Transactions App.

true

Boolean

true: The tile is available.

false: The tile is not available.

app_transactions > openType

Determines whether the ITS is opened in a new browser tab or within a dialog in the current browser tab.

W

String

W: The ITS is opened in a new browser tab.

D: The ITS is opened in a dialog.