SessionID

The property SessionID is a string that specifies the KCM Core session ID associated with the submitted job. KCM Core session IDs serves two purposes:

  • Mutual exclusion: The KCM Core guarantees that multiple requests for the same session ID are not handled in parallel by multiple Document Processors. Instead, multiple simultaneous requests with the same session ID are queued and processed in a series.

  • Persistent storage across jobs: KCM Core services may use the session ID to store information across several KCM Core jobs, so that each job can use data stored by earlier jobs.

During KCM ComposerUI runs of interactive KCM Master Templates, the session ID is used for both purposes. If no session ID is provided, KCM ComposerUI automatically assigns a session ID to the Master Template run during the method Start. This session ID is automatically retrieved and stored in the property SessionID.