PEC-Developer/Current/SCAPI/ConfigurationNamespace - Revision history

WikiSysop at 13:44, February 22, 2023

2023-02-22T13:44:17Z

WikiSysop at 12:45, July 4, 2022

2022-07-04T12:45:46Z

WikiSysop at 18:00, June 28, 2022

2022-06-28T18:00:59Z

Jumunn: Published

2022-03-02T14:02:21Z

Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

2020-07-25T02:33:41Z

Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"

2020-07-15T11:44:41Z

Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Jerickso: Published

2020-06-08T18:50:23Z

Published

New page

{{Article
|Standalone=No
|DisplayName=Configuration namespace
|TocName=Configuration namespace
|Context=Learn about the Configuration namespace methods and type definitions in the Service Client API.
|ComingSoon=No
|Platform=PureEngage
|Prereq=
|Section={{Section
|sectionHeading=
|anchor=
|alignment=Vertical
|Media=
|image=
|structuredtext={{NoteFormat|You must work with your Genesys representative to enable and use this part of the Service Client API.}}
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Methods
|anchor=Methods
|alignment=Vertical
|Media=
|image=
|structuredtext=The Configuration namespace includes the following methods:

*{{Link-SomewhereInThisManual|topic=ConfigurationNamespace|anchor=getOption|display text=getOption}}

===getOption===
{{{!}}
!Signature
{{!}}<static> getOption(''options'') → {Array.<{{Link-SomewhereInThisManual|topic=ConfigurationNamespace|anchor=Section|display text=Section}}>}
{{!}}-
!Description
{{!}}Get configuration options and values for a specific option name or a subset of options from the '''[interaction-workspace]''' section or a custom section.
{{!}}-
!Parameters
{{!}}
{{{!}}
!Name
!Type
!Argument
!Description
{{!}}-
{{!}}options
{{!}}string
{{!}}
{{!}}An array of configuration options or sections to return. Unless otherwise specified, the API will return options from the '''[interaction-workspace]''' section by default. You can specify any of the following:

*A single option: <tt>genesys.wwe.service.configuration.getOption('voice.auto-answer', succeeded, failed)</tt>
*A single option in a specific section: <tt>genesys.wwe.service.configuration.getOption('CustomSection/option.custom.customer.code', succeeded, failed)</tt>
*Multiple options: <tt>genesys.wwe.service.configuration.getOption(['voice.auto-answer', 'privilege.email.can-mark-done'], succeeded, failed)</tt>
*Multiple options in different sections: <tt>genesys.wwe.service.configuration.getOption(['privilege.*', 'CustomSection/option.custom.customer.code'], succeeded, failed)</tt>

You can use an asterisk '*' as a wildcard, but only at the end of each word. For example:

*voice.*
*voice.auto*
*sipendpoint.*
*CustomAPI/test.*

You cannot use an asterisk at the start of an option or section. For example, the following values are not allowed:

*<nowiki>*.mark-done</nowiki>
*<nowiki>*.auto</nowiki>
{{!}}}
{{!}}-
!Returns
{{!}}Array.<{{Link-SomewhereInThisManual|topic=ConfigurationNamespace|anchor=Section|display text=Section}}>
{{!}}}
|structuredtextwide=
|FAQHeading=
|Status=No
}}{{Section
|sectionHeading=Type definitions
|anchor=Typedefinitions
|alignment=Vertical
|Media=
|image=
|structuredtext=The Configuration namespace includes the following object types:

*{{Link-SomewhereInThisManual|topic=ConfigurationNamespace|anchor=Section|display text=Section}}

===Section===
{{{!}}
!Description
{{!}}Represents the JSON structure of a configuration section. Each section includes a list of key/value pairs for the matching option(s).
{{!}}-
!Type
{{!}}Object
{{!}}-
!Properties
{{!}}
{{{!}}
!Name
!Type
!Description
{{!}}-
{{!}}name
{{!}}string
{{!}}The name of the configuration option.
{{!}}-
{{!}}value
{{!}}string or array of strings
{{!}}The value of the configuration option.
{{!}}}
{{!}}}
|structuredtextwide=
|FAQHeading=
|Status=No
}}
}}

@@ Line 22: / Line 22: @@
 {{{!}}
 !Signature
-{{!}}<static> getOption(''options'') → {Array.<{{Link-SomewhereInThisManual|topic=ConfigurationNamespace|anchor=Section|display text=Section}}>}
+{{!}}<static> getOption(''options'', succeeded, failed) → {Array.<{{Link-SomewhereInThisManual|topic=ConfigurationNamespace|anchor=Section|display text=Section}}>}
 {{!}}-
 !Description
@@ Line 54: / Line 54: @@
 *<nowiki>*.mark-done</nowiki>
 *<nowiki>*.auto</nowiki>
 {{!}}}
 {{!}}-
@@ Line 63: / Line 71: @@
 {{{!}}
 !Signature
-{{!}}<static> getContextualOption(''options'', ''interactionId'') → {Array.<{{Link-SomewhereInThisManual|topic=ConfigurationNamespace|anchor=Section|display text=Section}}>}
+{{!}}<static> getContextualOption(''options'', ''interactionId'', succeeded, failed) → {Array.<{{Link-SomewhereInThisManual|topic=ConfigurationNamespace|anchor=Section|display text=Section}}>}
 {{!}}-
 !Description
@@ Line 100: / Line 108: @@
 {{!}}-
 {{!}}succeeded
-{{!}}string
+{{!}}function
-{{!}}The callback function to use if the operation is successful.
+{{!}}A function called when the operation succeeds.
 {{!}}-
 {{!}}failed
-{{!}}string
+{{!}}function
-{{!}}The callback function to use if the operation fails.
+{{!}}A function called when the operation fails.
 {{!}}}
 {{!}}-

@@ Line 36: / Line 36: @@
 {{!}}options
 {{!}}string
-{{!}}An array of configuration options or sections to return. Unless otherwise specified, the API will return options from the '''[interaction-workspace]''' section by default. You can specify any of the following:
+{{!}}An array of configuration options or sections to return. Unless otherwise specified, the API returns options from the '''[interaction-workspace]''' section by default. You can specify any of the following:
 *A single option: <tt>genesys.wwe.service.configuration.getOption('voice.auto-answer', succeeded, failed)</tt>
@@ Line 66: / Line 66: @@
 {{!}}-
 !Description
-{{!}}Get configuration options and values in the context of this interaction when they are overridden by a routing strategy. If the interaction is not found or this parameter is missing, the API throws an exception.
+{{!}}Get configuration options and values in the context of this interaction when they are overridden by a routing strategy. If the interaction is not found or this parameter is missing, the API throws an exception. Note: The getContextualOption method can be applied to any option, even if the option doesn’t support overriding options with a routing strategy in Workspace Web Edition. Only Workspace Web Edition options with the following text in their descriptions can be overridden by a routing strategy: "This option can be overridden by a routing strategy as described in this [https://docs.genesys.com/Documentation/HTCC/8.5.2/IWWDep/OverridingInteractionWorkspaceOptions Configuration Guide]." Using the getContextualOption method doesn’t interfere with how Workspace Web Edition handles options.
 {{!}}-
 !Parameters

@@ Line 17: / Line 17: @@
 *{{Link-SomewhereInThisManual|topic=ConfigurationNamespace|anchor=getOption|display text=getOption}}
 ===getOption===
@@ Line 31: / Line 32: @@
 !Name
 !Type
 !Description
 {{!}}-
 {{!}}options
 {{!}}string
 {{!}}An array of configuration options or sections to return. Unless otherwise specified, the API will return options from the '''[interaction-workspace]''' section by default. You can specify any of the following:
@@ Line 55: / Line 54: @@
 *<nowiki>*.mark-done</nowiki>
 *<nowiki>*.auto</nowiki>
 {{!}}}
 {{!}}-
@@ Line 93: / Line 144: @@
 {{!}}}
 {{!}}}
 |Status=No
 }}
 }}

@@ Line 6: / Line 6: @@
 |ComingSoon=No
 |Platform=GenesysEngage-cloud
 |Section={{Section
 |alignment=Vertical
-|Media=
+|structuredtext={{NoteFormat|Depending on your environment, you might need to contact your Genesys representative to complete the configuration described on this page.|}}<br />
 |Status=No
 }}{{Section
@@ Line 21: / Line 14: @@
 |anchor=Methods
 |alignment=Vertical
 |structuredtext=The Configuration namespace includes the following methods:
@@ Line 69: / Line 60: @@
 {{!}}Array.<{{Link-SomewhereInThisManual|topic=ConfigurationNamespace|anchor=Section|display text=Section}}>
 {{!}}}
 |Status=No
 }}{{Section
@@ Line 76: / Line 65: @@
 |anchor=Typedefinitions
 |alignment=Vertical
 |structuredtext=The Configuration namespace includes the following object types:
@@ Line 106: / Line 93: @@
 {{!}}}
 {{!}}}
 |Status=No
 }}
 }}

@@ Line 5: / Line 5: @@
 |Context=Learn about the Configuration namespace methods and type definitions in the Service Client API.
 |ComingSoon=No
-|Platform=GenesysEngage-onpremises
+|Platform=GenesysEngage-cloud
 |Prereq=
 |Section={{Section

PEC-Developer/Current/SCAPI/ConfigurationNamespace - Revision history

WikiSysop at 13:44, February 22, 2023

WikiSysop at 12:45, July 4, 2022

WikiSysop at 18:00, June 28, 2022

Jumunn: Published

WikiSysop: Text replacement - "\|Platform=([^\|]*)GenesysEngage-onpremises([\|]*)" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|]*)PureEngage([\|]*)" to "|Platform=$1GenesysEngage-onpremises$2"

Jerickso: Published

WikiSysop: Text replacement - "\|Platform=([^\|])GenesysEngage-onpremises([\|])" to "|Platform=$1GenesysEngage-cloud$2"

WikiSysop: Text replacement - "\|Platforms?=([^\|])PureEngage([\|])" to "|Platform=$1GenesysEngage-onpremises$2"