Share via

Implement deferred correction (.NET)

For more information on deferred correction, see:

Prerequisites

Document workflow support must be implemented. For more information, see: Support functionality for document workflows.

Procedure

Initialize the session and configure the document mode

  1. Configure the service URL: ISession.ServiceURL

  2. Open a session: ISession.Open(Document Mode):

    Document mode for authors - Frontend

    Document mode for transcriptionists - Correctionist

The session can be kept open for the life cycle of the application and is user-specific.

Initialize the VuiController

  1. Create a new VuiController instance. A new instance should be used per document; don't reuse an instance.

  2. Set the document field ID on the VuiController for each text control: VuiController.SetDocumentFieldId

    The same document field ID must be used for the same textbox when reopening the document.

  3. If you're reopening an existing document, restore document text into the text control.

  4. Apply optional configurations:

    Set the language: VuiController.Language

    Set the topic: VuiController.Topic

  5. Open the VuiController: VuiController.Open

    For the deferred correction workflow, the VuiController must be opened with a unique document ID and document token per document.

The deferred correction workflow can now be used; when using a new document, follow the clean-up steps and repeat the initialization steps.

Clean up the VuiController

  1. Close the VuiController: VuiController.Close

    To discard changes, call Close with an empty string as an argument.

    To keep changes, call Close with the document ID and the document state as arguments. Set the document state to Corrected once the author has reviewed the final text and signed it off. Set the document state to Uncorrected at all other times.

  2. Dispose the VuiController instance: VuiController.Dispose

Clean up the session

Call Close on the session: ISession.Close

Important information

  • Documents are identified using the unique ID passed by the integration. The same ID must be used throughout the workflow of a document

  • Fields within the document are identified using a unique ID passed by the integration. The same ID should be used, for each field, throughout the workflow of a document.

  • Documents with multiple fields are supported.

  • When a document is reopened, the text must be restored by the integration.

  • It's recommended that your integration always provides a document ID when creating a document with workflow support. For more information, see: Document IDs.

  • A document token must be provided when using deferred correction.

  • Multiple authors recording into a document isn't supported; your integration must ensure this can't occur.

See also

Deferred correction concept