Versions Compared

Old Version 7

changes.mady.by.user Bettina Borces

Saved on

compared with

New Version Current

changes.mady.by.user Bettina Borces

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

This structure represents the unique key fields associated with identifying an Engagement Stageengagement stage. Engagement Stages can be identified by EngagementStageName, EngagementStageShortName or EngagementStageUid. When specifying a PwsEngagementStageRef as an input to a web service, you may specify any combination of one or all three fields the more of EngagementStageName, EngagementStageShortName and/or EngagementStageUid. However, if you do specify all threemore than one, they must refer to the same Engagement Stage engagement stage or the Engagement Stage engagement stage reference will not be considered valid. When a PwsEngagementStageRef is returned in the response to a web service, the EngagementStageName, EngagementStageShortName and /or EngagementStageUid will all be populated, and guaranteed to refer to a single Engagement Stage.engagement stage.


In association with PwsSaveEngagement here are the rules:

  • If an Engagement Stage is specified, the web service will use it
  • Otherwise, the following rules will be in effect:
    • If there is a default engagement stage for the engagement type (due to enterprise configuration), use it
      • OR
    • Select the first allowed engagement stage (specifically, or via ‘(all engagement stages)’) ordered by sort order, if any
  • Otherwise, throw an error

Format


Panel
titlePwsEngagementStageRef
  • PwsEngagementStageRef
    • EngagementStageId: Int32
    • EngagementStageName: String (50)
    • EngagementStageShortName: String (15)
    • EngagementStageUid: Int64

...


Elements


OP

Element

Data Type

Required?Default

Description

Sample Data

EngagementStageId

Int32

Engagement Stage IdNo

The engagement stage Id is a unique identifier for an engagement stage. For internal use only.


EngagementStageName

String Engagement Stage Name(50)

One of EngagementName, EngagementStageShortName or EngagementStageUid is required


The engagement stage name is a unique identifier for an engagement stage.

Open

EngagementStageShortName

String

Engagement Stage Short Name

(15)

See EngagementStageName

The engagement stage short name is a unique identifier for an engagement stage.

Open

EngagementStageUid

Int64

See EngagementStageName


A unique and immutable Id identifier for an Engagement Stageengagement stage.

1152921504606849675

Usage Example(s)


Code Block
languagexml
titleExample 01
collapsetrue
                     <EngagementStageIdentity><b:EngagementStageIdentity>
                        <EngagementStageId<b:EngagementStageId i:nil="true"/>
                        <EngagementStageName>Open<<b:EngagementStageName>Open</b:EngagementStageName>
                        <EngagementStageShortName>OP<<b:EngagementStageShortName>Open</b:EngagementStageShortName>
                        <EngagementStageUid>1152921504606849675<<b:EngagementStageUid>1152921504606849675</b:EngagementStageUid>
                     </b:EngagementStageIdentity>