CmClientSteps Step Reference
The CmClientSteps step library gives access to campaign management functions within a script.
Softdial Scripter™ Designer is loaded by default with the steps contained in Sytel.StepLibrary. Other step libraries, such as CmClientSteps, may be imported as necessary.
Below is an index of steps with a brief description and a link for more details.
Show step index
Call Control
| Step | Description |
|---|---|
| Do Not Call Number | Instructs the Campaign Manager service for this tenant to not call a particular number in the future. |
| Get Row Count | Gets a count of rows |
| Stop Campaign and Chain | Stops campaign (and chains). |
Campaign Manager
| Step | Description |
|---|---|
| Block Campaign Key | Blocks a partidcular record key. |
| Close Campaign | Stops a campaign. |
| Get Campaign Properties from Campaign Manager Server | Gets an XML document containing the properties of a given campaign. |
| Get Status from Campaign Manager Server | Gets an XML document describing the status of campaigns on a given tenant. |
| Insert Callback | Inserts a new callback and if current campaign is outbound, caches for dial. |
| Insert Record | Inserts a new record and if current campaign is outbound, caches for dial. |
| Kill Campaign | Terminates a campaign immediately. |
| Open Campaign | Starts a campaign. |
| Resume Campaign | Resumes a campaign. |
| Sets Campaign Properties in Campaign Manager Server | Sets properties of a given campaign from an XML document. |
| Suspend Campaign | Suspends a campaign. |
| Update Record | Updates a record in the database of an outbound campaign, making it available for immediate dialing. |
Data
| Step | Description |
|---|---|
| Add Field to Record | Adds a named field to an XML representation of a database record. If the field already exists it is updated. |
| Remove Field from Record | Removes a named field from an XML representation of a database record. |