UI components
Learn more about the UI components that Auditors and Operators can use to perform their tasks with Offline Signing Orchestrator.
From the UI left navigation area, you can access the following pages:
- Getting started
- Confirmation queues (Auditors only)
- Preconfirmation queue
- Postconfirmation queue
- System operations (Operators only)
- Click the About this product button on the user menu header of the UI to open a modal which displays the version and license information for the Offline Signing Orchestrator.
- Click the User button to view the User menu.
- The Change theme option in the User menu lets you change the following themes of your application in the browser , such as:
- Selecting the System default option and clicking the Confirm button resets your UI to the default theme configured in the system settings. This action overrides any previously selected theme.
- Dark: Selecting the Dark option and clicking the Confirm button sets the theme of the UI to dark mode. Whenever you get authenticated to the UI, it will be displayed in dark mode.
- Light: Selecting the Light option and clicking the Confirm button sets the background theme of the UI to light mode. Whenever you get authenticated to the UI, it will be displayed in light mode.
Getting started
The Getting started page provides a brief introduction to IBM Digital Asset Offline Signing Orchestrator. Links to resources which can help you learn and quickly get started with IBM Digital Asset Offline Signing Orchestrator. Resource topics include documentation, an architecture overview, and a technical demo.
Confirmation queues
Auditors can use the Confirmation queues link to view, approve, or deny a document.
Switch between the Preconfimation queue tab and Postconfirmation queue tab to take actions against documents in the Preconfirmation queue or Postconfimraiton queue.
- Preconfirmation queue lists documents that are obtained from the frontend. A document in the preconfirmation queue must get the required number of approvals from Auditors before it can be moved into a signing iteration.
- Postconfirmation queue lists documents that are obtained from the backend and have been signed during a signing iteration. A document in the postconfirmation queue must get the required number of approvals from Auditors before it can be moved back to the frontend.
The following document attributes are displayed on the Confirmation queues page.
| Property | Description |
|---|---|
| Document ID | Unique ID of the document. |
| Status | Possible status values of documents in the queue:
|
| Received approvals | Received number of approvals on the document. |
| Approvers | Names of the Auditors who approved the document. |
| Pending approvals | Remaining number of approvals before document status changes toApproved. |
| Required approvals | Required number of approvals before document status changes toApproved. |
| Document age | Time length in seconds since the document is added in the queue. |
| Release time | Time countdown in seconds until the time based security releases the approved document. |
| Confirmation age | Time length in seconds since the document status is changed toApproved. |
Queued: The document is added to the queue.
Approved: The document is approved with required number of approvals from Auditors.
Denied: The document is denied by at least one of the Auditors.
Moved: The document is moved out of the queue.
Timed out: The document doesn't get required approvals within the preconfigured time duration if defined.Document details
When an Auditor selects a document in the table, the View details is displayed on table header and shows more details about the document.
| Property | Description |
|---|---|
| Document ID | A unique identifier for the document. |
| Internal OSO ID | The internal ID of the document. |
| Status | The current state of the document in the queue. |
| Event log |
Provides a timeline of actions taken on the document. You can select an event to see the following details:
|
| Comments | Shows any comments made by users when approving or rejecting the document. |
| Approvers | Lists the auditors who have approved the document. |
| Document metadata |
Contains detailed information about the document, including its status, approval details, and various timestamps. This metadata helps auditors understand the document's history and current state. The document metadata optionally displays the following reserved attributes with their values, such as:
Note: The values shown here are reserved keywords that may be provided by the author of the document(s).
|
| Document contents | The document contains content from the digital asset custodian transaction. |
Approving or denying a document
Auditors can select a document and click either Approve or Deny . A confirmation window will appear, prompting you to enter the reason for approval or denial. Then, click Approve or Deny to finalize the action for the selected document.
When you Approve or Deny a document, you can optionally add a comment corresponding to the action.
For more information, see Approving a document and Denying a document.
System operations
The Operators can use the System operations page to view and start a signing iteration, or to start a system flush.
The System operations page automatically refreshes every 30 seconds only when a signing iteration is in progress. For immediate refresh of this page, click the Refresh button on the top right.
Signing iteration
The Operators can click the Start button in the Signing iteration card to start a signing iteration. Only one iteration can be started and running at one time.
- Current iteration ID: Unique ID of the current or the latest signing iteration.
- Iteration start time: Start time of the current running iteration.
- Iteration status: Status of the current or the latest signing iteration.
System flush
The Operators can click the Flush button in the System flush card to flush the system. When a system flush starts, any documents in confirmation queues will be removed and any running signing iteration will be stopped.
- Flush operator: Operator who started the current system flush.
- Flush start time: Start time of the current system flush.
For more information, see Flushing the system.