Document Log UI

From the Document Log page of the SBS portal, you can perform the following actions:

• View all the log records stored in SBS for the currently selected account, application, and tenant.
• Filter logs by various criteria.

Logs are records created from the Document Log Service. For example, your organization may use this service to systematically log all kind of events for debugging, tax, compliance, or audit purposes.

Access

You can access the Document Log page of the portal as follows:

1. Sign in to the SBS Portal. During the sign-in process, you will be prompted to select the account, app, and tenant where you are entitled to sign in.
2. Click Document Log in the left hand-side menu.

To interact with the Document Log service, you can use either the Web UI or a GraphQL interface. You can switch at any time between the two interfaces by clicking the switch displayed at the top of the page:

View logs

After you access the Document Log UI, the logs stored in SBS for the selected account, application, and tenant are displayed in a grid. By default, the grid shows logs starting with the 1st of the current month up to the current date. To change the date range, use the calendar pickers in the top bar, and then click View.

To view details about a particular log, click the log ID (first column) in the grid. This opens a dialog box with the log’s details, for example:

The table below shows the file fields that are exposed through the Web UI.

Filter logs

By default, the grid shows logs filtered by the Logged at attribute, starting with the first of the month up to the current date. You can optionally filter logs further, by any of the following log attributes:

• The from and to date of the logged event
• Document Type
• Document ID
• Author ID
• ID
• Attribute ID
• Action
• Custom 1
• Custom 1

To filter logs:

1. Click the Filter button.

2. Fill in the required fields. The only mandatory parameters are from and to dates. All other parameters are optional.

   

3. Click View.

Query logs through GraphQL

To query logs through GraphQL

1. Switch to the GraphQL interface.
2. Run the logs query.

For example, the query below retrieves full details about a single log by ID:

query logs ($filter:LogsFilter) {
    logs (filter:$filter) {
        items {
            id
            action
            dateTime
            documentId
            documentType
            createdAt
        }
        nextToken
    }
}

{
    "filter": {
        "id": "YOUR_LOG_ID"
    }
}

Create logs

Creating logs is available only from the GraphQL interface. Also, an updateLog mutation exists for updating certain log attributes. For details, see the Document Log API Reference.