CaseCreation Component

Coveo for Salesforce 4.2 (April 2020)

The CaseCreation component creates a form that allows Salesforce users to submit a case. The form automatically searches for solutions while the user is filling form parameters. To work, this component needs to interact with other components that contain the necessary information to create the case.

A CaseCreation component must be present in the page for the form to work.

List of Components

Options

searchSort

Specifies how to sort the results.

  • For more information on the way sorting works, see $some.

  • The fielddescending and fieldascending sorts are unavailable for this component.

Initialization configuration example:

searchSort: 'datadescending'

Markup configuration example:

data-search-sort='rankingexpressions'

The default value is relevancy.

useSomeQRE

Specifies whether to generate the query using the $some query extension instead of Coveo Machine Learning (Coveo ML) (see $some). Setting this option to true effectively disables Coveo ML for this component.

See also the someBest, someMatch, and someMaximum options.

Initialization configuration example:

useSomeQRE

Markup configuration example:

data-use-some-q-r-e='true'

The default value is false.

someBest

Specifies an absolute or relative (percentage) value indicating the number of best keywords that the query must match (see $some).

Keywords that occur less frequently in the index are considered better than those that are very common.

Specifying a value for this option is only useful if the useSomeQRE option is true.

Initialization configuration example:

someBest : '50%'

Markup configuration example:

data-some-best='1'

The default value is the empty string.

someMatch

Specifies an absolute or relative (percentage) value indicating the minimum number of keywords that the query must match (see $some).

Specifying a value for this option is only useful if the useSomeQRE option is true.

Initialization configuration example:

someMatch : '5'

Markup configuration example:

data-some-match='50%'

The default value is the string 1.

someMaximum

Specifies the maximum number of keywords to use (see $some). If the query contains a larger number of keywords, remaining keywords are simply ignored.

Specifying a value for this option is only useful if the useSomeQRE option is true.

Initialization configuration example:

someMaximum : '100'

Markup configuration example:

data-some-maximum='150'

The default value is 300. The minimum value is 0.

searchDelay

Specifies the delay (in milliseconds) before triggering a new query when the end user types new text inside a Field component.

Initialization configuration example:

searchDelay : 250

Markup configuration example:

data-search-delay='500'

The default value is 500. The minimum value is 0.

searchType

Specifies to return only a certain type of results (see $some).

Initialization configuration example:

searchType : 'Opportunity'

Markup configuration example:

data-search-type='Account'

The default value is the empty string.

openLinkInNewWindow

Specifies whether to open the link that the component creates in a new window.

Initialization configuration example:

openLinkInNewWindow : false

Markup configuration example:

data-open-lin-in-new-window='false'

The default value is true.

useDefaultRule

Specifies whether to use the Assignment Rules (see Set Up Assignment Rules).

Initialization configuration example:

useDefaultRule: false

Markup configuration example:

data-use-default-rule='false'

The default value is true.

sendCaseDataToAnalytic

Specifies whether the component should send case-related metadata when logging case creation events in the Coveo Usage Analytics (Coveo UA) service.

Initialization configuration example:

sendCaseDataToAnalytic : false

Markup configuration example:

data-case-data-to-analytic='false'

The default value is true.

Methods

createCase

Creates a case with the information included in the form.

Parameters

redirectUrl (Optional) Where to redirect the user after the case has been created.

The case is sent even if some required fields are invalid. To have some validation, use the submit method of the Submit component instead.

$('#myCaseCreation').coveo('createCase', redirectUrl?: string)

Sample

<div class='CoveoCaseCreation'></div>
What's Next for Me?