Incent Queue
The incent queue command returns summary log information for submitted and actively running jobs submitted to Incent’s processing queue. Most queue events are submitted from the Incent application, not Connect. The command simply allows developers to monitor Incent’s active queue programmatically from the Connect application.
The processing queue manages jobs tied to Incent’s Process Group features. Process Groups allow comp admins and developers to create a series of commands to orchestrate data uploads, calculation processing, etc. from the Incent UI. Process groups can call an “External Process” to occur from an Xactly Connect Pipeline. Process Groups are an Incent feature and not specific to Connect.
Incent Admin Guide for Process Groups: https://helpcenter.xactlycorp.com/article/configure-process-groups/
Incent Admin Guide for External Processes: https://helpcenter.xactlycorp.com/article/configure-external-processes/
Syntax
incent queue; |
Return Type
Table result set
Details
For information specific to Connect steps, pipelines, incent upload commands, etc. you may find Show Invocations and Show Invocation Details most useful. Use Incent Diagnostic to obtain log information for both historical and running queue events.
The diagnostic command returns the following result set.
| Column Name | Data Type | Description |
|---|---|---|
| batchName | string | Sales order batch name if applicable to the command running in the queue. |
| createdByName | string | Incent user who submitted the job to the queue. |
| processStatus | string | Job’s current running status. Examples: Submitted, InProgress |
| pgId | string | Xaclty internal use. Process Group identifier. |
| eventIdBeforeThis | string | Preceding queue job if applicable. |
| periodName | string | The processing period the job affects. |
| batchId | string | xactly.xc_user_batch.batch_id for the job. |
| pgName | string | Process Group name if applicable. |
| unreleaseName | string | |
| modifiedByName | string | Incent user who modfied the job, perhaps to pause a running job or resume a paused one. |
| modifiedById | string | xactly.xc_user.user_id for modifiedByName |
| eventName | string | |
| id | string | Job’s unique identifier |
| createdById | string | xactly.xc_user.user_id for createdByName |
| order | string | |
| periodId | string | xactly.xc_period.period_id the job affects |
| unreleaseId | string | |
| eventType | string | Process descriptor for the job (short form) |
| params | string | Any Process Group parameters passed to job |
| releaseGroupId | string | |
| regionId | string | Xactly internal use. |
| queueEventId | string | Xactly internal use. |
| releaseGroupName | string | |
| region | string | |
| scenarioId | string | |
| eventTypeDisplayString | string | Process descriptor for the job (long form) |
| status | string | Queue status descriptor |
| tnxId | string | Xactly internal use. |
Examples
incent queue;
select batchName, processStatus, status,periodName, eventTypeDisplayString from (incent queue);
