WikiSysop: Created page with "{{Article |Standalone=No |DisplayName=Naming conventions |TocName=Naming conventions |Context=Recommendations for naming Designer applications and resources. |ComingSoon=Yes |..."

2022-10-11T17:45:41Z

Created page with "{{Article |Standalone=No |DisplayName=Naming conventions |TocName=Naming conventions |Context=Recommendations for naming Designer applications and resources. |ComingSoon=Yes |..."

New page

{{Article
|Standalone=No
|DisplayName=Naming conventions
|TocName=Naming conventions
|Context=Recommendations for naming Designer applications and resources.
|ComingSoon=Yes
|Platform=GenesysEngage-onpremises
|Role=Administrator
|Application=Designer
|Section={{Section
|alignment=Vertical
|structuredtext=Using a consistent standard of naming conventions can help to keep your applications and resources better organized. It enables application developers to quickly understand the logic and structure of an application and also makes it easier to troubleshoot issues or review reporting data in {{Link-SomewhereInThisVersion|manual=Designer|topic=AnalyticsBar}}.

You can follow the recommended naming conventions described on this page, or use them as a starting point for developing a standard that fits the needs of your organization. The most important recommendation is to adopt a standard and be consistent.

If a specific naming convention is required, it will be noted as such, including any restrictions (such as whether or not you can use certain special characters).
|Status=No
}}{{Section
|sectionHeading=Variable naming
|alignment=Vertical
|structuredtext=When naming a variable, use "v" as a prefix to identify it as a variable and use camel-case. For example:

*<code>vMyNewVariable</code>
*<code>vSkill</code>
*<code>vVQName</code>

For variables that are used in {{Link-SomewhereInThisVersion|manual=Designer|topic=SharedModulesBar}}, you can designate the variable as being "in" or "out" (or both). For example:

*<code>viName</code> (in)
*<code>voName</code> (out)
*<code>vioName</code> (in and out)
|Status=No
}}{{Section
|sectionHeading=Block naming
|alignment=Vertical
|structuredtext=Designer allows you to assign each block a custom name. You can name a block whatever you would like, but we recommend using a prefix that identifies the type of block being used. For example:

*Assign Variables = <code>AV_<block name></code>
*Segmentation = <code>SG_<block name></code>
*Route Call = <code>RC_<block name></code>
*Business Hours = <code>BH_<block name></code>

Don't use any special characters in the names except for a hyphen ("-") or space. For shared blocks, you can use a format that adds the line of business (LOB) and the version, such as:

*<code>[<LOB>]<shared module name>_v1.0</code>

If a shared module is being used in multiple applications, you could add the prefix ''common'' to the name. For example:

*<code>common_<shared module name></code>
|Status=No
}}{{Section
|sectionHeading=Media resource naming
|alignment=Vertical
|structuredtext=Media resource files should be named as follows:

<code><''media resource name''>_<''short language name''>.<''file extension''></code>

Example: welcome_en-US.wav

File names must only contain alphanumeric characters, underscores (_), hyphens (-), or dots (.) and cannot be longer than 50 characters. File names with special characters are not supported.

For more information, see {{Link-SomewhereInThisVersion|manual=Designer|topic=MediaResources|anchor=ac_create|display text=Adding media resources to a collection}}.
|Status=No
}}
}}

DES/Current/Designer/Naming - Revision history

WikiSysop: Created page with "{{Article |Standalone=No |DisplayName=Naming conventions |TocName=Naming conventions |Context=Recommendations for naming Designer applications and resources. |ComingSoon=Yes |..."