Namespace: typedef

Help4.typedef

Source:

Type Definitions

BPMConfiguration

Type:
  • Object
Properties:
Name Type Attributes Description
arisBaseUrl string <nullable>
 base URL to ARIS server
arisTenant string <nullable>
 ARIS tenant ID
Source:

BrandingConfiguration

Type:
  • Object
Properties:
Name Type Attributes Description
logoSrc string <nullable>
logoUrl string <nullable>
Source:

BubbleAnimationType

Type:
  • 'default' | 'expand' | 'fade' | 'pulse' | 'scaleup' | 'shake' | 'shrink' | 'wobble'
Source:

BubbleOrientation

Type:
  • 'auto' | 'W' | 'N' | 'S' | 'E'
Source:

BubbleType

Type:
  • 'start' | 'end' | 'important' | 'info' | 'note' | 'tip' | 'action'
Source:

CoreConfiguration

Type:
  • Object
Properties:
Name Type Attributes Description
customTheme string <nullable>
 custom base theme
defaultLanguage Object
editor boolean user has editor permission
infoBarTimeout number
infoBarTimeoutError number
infoBarTimeoutWhatsNew number
isActiveCMP4 boolean whether CMP4 mode is active
isEditMode boolean edit mode information
isEditorView boolean information about author view (published view / author view)
isRemoteMode boolean DA/WA mode enabled
language Object language
mixedLanguages boolean allow mixed languages within tour and learning content
languageFallbackMode string allow mixed languages within help content, values allowed - standard/mix and defaults to standard
mobile boolean mobile mode enabled
multifile boolean allow multifile requests to SEN servers
noHelpMode string what happens in case of no help
showMinimizeButton boolean show minimize button on panel
showCloseButton boolean show close button on panel
openImmediately string open panel immediately
playbackTag string what tag to use for playback; default: "published"
product string product
readCatalogue boolean
resourceUrl string URL to all CMP resources
role string <nullable>
 role of user
rtl boolean enable RTL mode
screenId string screen ID
solution string for tracking purposes
system string <nullable>
 system
theme string theme name
tenant string tenant info; only for public s/4 cloud customers
version string version
recentlyClosed boolean
Source:

EveryExecutor(item, index, array, scopeopt) → {boolean}

iterates an array
Parameters:
Name Type Attributes Description
item * the current item
index number the current index
array Array.<*> the iterated array
scope Object <optional>
 scope the iterator runs in
Source:
Returns:
Type
boolean

FeatureConfiguration

Type:
  • Object
Properties:
Name Type Description
enableFioriSpacesMigration boolean XRAY-5098
Source:

ForEachExecutor(item, index, array, scopeopt)

iterates an array
Parameters:
Name Type Attributes Description
item * the current item
index number the current index
array Array.<*> the iterated array
scope Object <optional>
 scope the iterator runs in
Source:

HelpConfiguration

Type:
  • Object
Properties:
Name Type Attributes Description
autoStartTour string <nullable>
 tour to be auto-started on CMP boot
featureProfileUACP string <nullable>
 will be send as "profile" to UACP server
mediaUrl string <nullable>
 URl to resolve media from UACP against
published * ???
roModel 'uacp' | 'wpb' RO model information
rwModel 'uacp' | 'wpb' RW model information
showLaserBeam boolean show laser beam in help mode
showShortDescription boolean whether to show description in tiles
serviceLayer 'uacp' | 'wpb' | 'ext' backend mode selection (UACP only, SEN only, mixed mode)
serviceUrl string URL to RO backend
serviceUrl2 string <nullable>
 URL to RW backend
useGlobalHelp boolean whether global help feature is enabled
fioriApplication string <nullable>
 fioriApplication identifier
whatsNew * ???
whatsNewDirect boolean play whatsnew immediately
whatsNewExpiration number whatsnew expiration date
useABAPHelpTexts boolean enable UR texts for WDA, SAP GUI, etc. in Fiori
useURHotspots boolean enable UR hotspots for new content (XRAY-6405) - implicit with useABAPHelpTexts
useUI5HelpTexts boolean
Source:

HotspotIconPosition

Type:
  • 'R' | 'Q' | 'A' | 'B' | 'C' | 'D' | 'E' | 'F' | 'G' | 'H' | 'I' | 'J' | 'K' | 'L' | 'M' | 'N' | 'O' | 'P'
Source:

HotspotIconType

Type:
  • 'attachment' | 'help' | 'info' | 'learn' | 'link' | 'news' | 'step' | 'star' | 'support' | 'tip' | 'tour' | 'whatsnew' | 'change' | 'compliance' | 'maintain' | 'note' | 'update' | 'warning'
Source:

HotspotSize

Type:
  • Object
Properties:
Name Type Description
size string
radius number
icon number
localization string
Source:

LearningConfiguration

Type:
  • Object
Properties:
Name Type Attributes Description
enabled boolean enable learning mode
learningAppBackendUrl string <nullable>
 URL to SEN server
learningAppCommunityUrl string <nullable>
 external URL to community
learningAppFeedback boolean enable feedback
learningAppProjectMode string <nullable>
 what project mode to use for learning
learningAppWorkspace string <nullable>
 workspace id on SEN server
learningCenterUrl string <nullable>
 URL to external learning center
showLearningCenter boolean whether to show learning center
Source:

MapExecutor(item, index, array, scopeopt)

iterates an array
Parameters:
Name Type Attributes Description
item * the current item
index number the current index
array Array.<*> the iterated array
scope Object <optional>
 scope the iterator runs in
Source:

SplashOption

Type:
  • 'once' | 'always'
Source:

SystemConfiguration

Type:
  • Object
Properties:
Name Type Description
CMP4 boolean CMP4 mode enabled
WM number WalkMe support mode
core Help4.typedef.CoreConfiguration core configuration
learning Help4.typedef.LearningConfiguration learning configuration
tracking Help4.typedef.TrackingConfiguration tracking configuration
help Help4.typedef.HelpConfiguration help & tour configuration
features Help4.typedef.FeatureConfiguration feature configuration
translation Help4.typedef.TranslationConfiguration translation configuration
bpm Help4.typedef.BPMConfiguration BPM configuration
branding Help4.typedef.BrandingConfiguration Branding configuration
Source:

TileIcons

Type:
  • 'noicon' | 'whatsthisapp' | 'link' | 'video' | 'prerequisites' | 'faq' | 'pdf' | 'external' | 'support'
Source:

TrackingConfiguration

Type:
  • Object
Properties:
Name Type Attributes Description
trackingUrlSEN string <nullable>
 URL of SEN server that receives tracking information
Source:

TranslationConfiguration

Type:
  • Object
Properties:
Name Type Description
activeMLTranslation boolean MLT enabled
allowMLTranslations boolean ???
translationAvailable boolean ???
Source:

XmlHttpResponse

response of an XHR request
Type:
  • Object
Properties:
Name Type Attributes Default Description
status number xhr.status
statusText string xhr.statusText
responseText string xhr.responseText
responseXML XMLDocument <nullable>
 xhr.responseXML
hasTimeout boolean <optional>
 false did a timeout occur?
Source: