Skip to content

Commit

Permalink
Screenshot updates December 2023 (#740)
Browse files Browse the repository at this point in the history
* updated public attestation screenshots

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>

* updated document profile asset registration screenshots

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>

* updated document profile event registration screenshots

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>

* updated asset creation screenshots

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>

* updated event creation screenshots

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>

* updated location screenshots

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>

* updated verified domain screenshots

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>

* updated iam screenshots

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>

* updated software package profile text to match new UI menu

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>

* updated abac screenshots

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>

* updated obac screenshots

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>

* updated yaml reference and simple hash verification article screenshots

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>

* access token article screenshots

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>

* update containers as assets article screenshot

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>

---------

Signed-off-by: pcnorth <120174435+pcnorth@users.noreply.github.com>
  • Loading branch information
pcnorth committed Dec 13, 2023
1 parent 9c5c8e8 commit a0c4575
Show file tree
Hide file tree
Showing 57 changed files with 29 additions and 35 deletions.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ If `Settings` does not appear in the navigation, see your DataTrails Administrat
### Using the DataTrails App to Create an Integration (First-Time Setup)

1. As an Administrator, open the <a href="https://app.datatrails.ai/" target="_blank">DataTrails App</a>
1. Navigate to `Settings` on the sidebar
1. Navigate to the `Integrations` tab
1. Navigate to `Integrations` on the sidebar
1. The `Integrations` tab will be automatically selected
{{< img src="IntegrationsTab.png" alt="Rectangle" caption="<em>Navigate to Settings, then Integration</em>" class="border-0" >}}
1. Click the `Custom` box to create a Custom Integration
1. Enter any `Display Name` you'd like
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ You must express `public` as an asset attribute and have `true` as a property to

{{< tabs name="create_sbom_public" >}}
{{{< tab name="UI" >}}
Select `Register Asset` from the sidebar and fill in the desired details.
Select `Assets & Documents` from the sidebar and then `Add Custom Asset`. Fill in the desired details.
Set the `Attest Publicly` toggle to `On`.

{{< img src="PublicCheck.png" alt="Rectangle" caption="<em>Check Asset as Public</em>" class="border-0" >}}
Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/developers/yaml-reference/assets/AssetsCreate.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Original file line number Diff line number Diff line change
Expand Up @@ -366,10 +366,7 @@ A pre-existing location can be added during Asset creation, using the Location I

{{< /tab >}}
{{< tab name="YAML" >}}
{{< note >}}
**Note** - The `EVENTS_CREATE` action must contain at least one key-value pair for `event_attributes`.
{{< /note >}}

The `EVENTS_CREATE` action must contain at least one key-value pair for `event_attributes`.
```yaml
---
steps:
Expand Down
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/platform/administration/verified-domain/DomainBadge.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/platform/overview/creating-an-asset/Asset.png
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified content/platform/overview/creating-an-asset/AssetRegister.png
Binary file modified content/platform/overview/creating-an-asset/AssetView.png
6 changes: 3 additions & 3 deletions content/platform/overview/creating-an-asset/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ Check out our [Core Concepts](/platform/overview/core-concepts/#assets) for more
1. Create your Asset
{{< tabs name="add_asset" >}}
{{{< tab name="UI" >}}
Using the sidebar, select `Register Asset`.
Using the sidebar, select `Assets & Documents` and then `Add Custom Asset`
{{< img src="AssetRegister.png" alt="Rectangle" caption="<em>Adding an Asset</em>" class="border-0" >}}
{{< /tab >}}
{{< tab name="YAML" >}}
Expand Down Expand Up @@ -239,7 +239,7 @@ This example also adds a location to our Asset. To find out more about locations
1. Complete your Asset creation
{{< tabs name="finish_create_asset" >}}
{{{< tab name="UI" >}}
Click `Register Asset`.
Click `Register Asset`
{{< img src="AssetCreate.png" alt="Rectangle" caption="<em>Create the Asset</em>" class="border-0" >}}
{{< /tab >}}
{{< tab name="YAML" >}}
Expand Down Expand Up @@ -271,7 +271,7 @@ curl -v -X POST \
1. View your Assets
{{< tabs name="view_all_assets" >}}
{{{< tab name="UI" >}}
Navigate to 'Assets' to see your Asset in the UI.
Navigate to 'Assets & Documents' to see your Asset in the UI.
{{< img src="Asset.png" alt="Rectangle" caption="<em>Managing Assets</em>" class="border-0" >}}
{{< /tab >}}
{{< tab name="YAML" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ This Event will be POSTed to a specific Asset endpoint when the curl command is
`Asset Attributes` - Attributes of the Asset that may change as a result of the Event, i.e. overall weight of a container
{{< tabs name="add_event_attr" >}}
{{{< tab name="UI" >}}
Select the `Add Attribute` button on each tab to add your key-value pairs. You may also add an attachment to your Event. Select the symbol to upload a file. In this case, we will attach a PDF document labeled `Inspection Standards`.
Select the `Add Attribute` button on each tab to add your key-value pairs. You may also add an attachment to your Event. Select the symbol to upload a file. In this case, we will attach a text document called `Inspection Standards`.
{{< img src="AttachmentUpload.png" alt="Rectangle" caption="<em>Event Specific Attributes</em>" class="border-0" >}}

{{< img src="EventAssetAttributes.png" alt="Rectangle" caption="<em>Event Asset Attributes</em>" class="border-0" >}}
Expand Down Expand Up @@ -193,12 +193,12 @@ Add your `event_attributes` and `asset_attributes` as key-value pairs. Use the `
Here we see someone noted the type of cargo loaded in the Event, and recorded the total weight of the cargo using a newly defined `Weight` attribute.<br><br>
Every Event has an automatically generated `timestamp_accepted` and `principal_accepted` attribute that records _when_ who performed what, as submitted to DataTrails.<br><br>
There is an option to append `timestamp_declared` and `principal_declared` attributes on the Event, for example, if the Event happened offline or a third party reports it. This creates a more detailed record.<br><br>
PDFs or images can be recorded with an Event in the same way as an Asset. This is useful for storing associated material for posterity. For example, each `Inspection` Event can store the PDF document of a specific standard for container inspection. This allows historical compliance checking of Events.
Documents and images can be recorded with an Event in the same way as an Asset. This is useful for storing associated material for posterity. For example, each `Inspection` Event can store the documentation for a specific standard used for container inspection. This allows historical compliance checking of Events.

1. Record your Event
{{< tabs name="record_event" >}}
{{{< tab name="UI" >}}
Once you have entered all data, click the `Record Event` Button to add to your Asset.
Once you have entered all data, click the `Record Event` Button to add the Event to your Asset.
{{< img src="EventRecorded.png" alt="Rectangle" caption="<em>Submitting the Event</em>" class="border-0" >}}
You will see that the Asset Attribute we changed is also recorded in the Asset View.

Expand Down Expand Up @@ -232,14 +232,14 @@ curl -v -X POST \
1. View your Event details
{{< tabs name="view_event" >}}
{{{< tab name="UI" >}}
Click the Event row to inspect the Event:
Click the `Event history` tab and then on a row to inspect the Event:

{{< img src="EventView.png" alt="Rectangle" caption="<em>Viewing an Event</em>" class="border-0" >}}

Here we see the details entered earlier and also a tab that will show both the Event attributes and Asset attributes:
Here we see the details entered earlier and also tabs that will show both the Event attributes and Asset attribute updates:

{{< img src="EventAttributeView.png" alt="Rectangle" caption="<em>Viewing Event Attributes</em>" class="border-0" >}}

{{< img src="AttributeUpdatesView.png" alt="Rectangle" caption="<em>Viewing Attribute Updates</em>" class="border-0" >}}
{{< /tab >}}
{{< tab name="YAML" >}}
The `EVENTS_LIST` action can be used to view all Events, or filtered using attributes (`attrs`) to view details of a specific Event
Expand Down
Binary file modified content/platform/overview/public-attestation/AddPublicEvent.png
Binary file modified content/platform/overview/public-attestation/CreateAsset.png
Binary file modified content/platform/overview/public-attestation/PublicAsset.png
Binary file modified content/platform/overview/public-attestation/PublicView.png
15 changes: 6 additions & 9 deletions content/platform/overview/public-attestation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,15 +33,13 @@ For more detailed Asset creation instructions, visit [Creating an Asset](/platfo
**Warning**: Assets can only be made public at Asset Creation and cannot be made private afterwards. The Asset and all its Events will be publicly accessible forever.
{{< /warning >}}

1. Create an Asset with your desired attributes and set it to public. See [Creating an Asset](/platform/overview/creating-an-asset/) for detailed instructions
1. Create an Asset with your desired attributes and set it to public. See [Creating an Asset](/platform/overview/creating-an-asset/) for detailed instructions on this topic.
{{< tabs name="create_asset_public" >}}
{{{< tab name="UI" >}}
Select `Register Asset` from the sidebar and fill in the desired details.
{{< img src="CreateAsset.png" alt="Rectangle" caption="<em>Asset Details</em>" class="border-0" >}}

Select `Register Asset` from the sidebar and fill in the desired details.<br>
Set the toggle next to `Attest Publicly` to `ON`.
{{< img src="CreateAssetNumbered.png" alt="Rectangle" caption="<em>Asset Details</em>" class="border-0" >}}

{{< img src="PublicCheck.png" alt="Rectangle" caption="<em>Check Asset as Public</em>" class="border-0" >}}
{{< /tab >}}
{{< tab name="JSON" >}}
Create a JSON file with your desired Asset details. Set keyword `public` to true.
Expand All @@ -68,7 +66,7 @@ Create a JSON file with your desired Asset details. Set keyword `public` to true
{{< tabs name="set_public_public" >}}
{{{< tab name="UI" >}}
Click `Register Asset` to complete your Public Asset creation.
{{< img src="PublicCheck.png" alt="Rectangle" caption="<em>Publish Your Asset</em>" class="border-0" >}}
{{< img src="CreateAsset.png" alt="Rectangle" caption="<em>Publish Your Asset</em>" class="border-0" >}}
{{< /tab >}}
{{< tab name="JSON" >}}
Use the curl command to run your JSON file. See instructions for [creating your `BEARER_TOKEN_FILE`](/developers/developer-patterns/getting-access-tokens-using-app-registrations/) here.
Expand All @@ -90,7 +88,7 @@ curl -v -X POST \
{{< /note >}}
{{< tabs name="get_link_public" >}}
{{< tab name="UI" >}}
Click on the **Share** button next to the green `PUBLIC` badge. This will open a pop-up containing options for copying the public and private links of the Asset.
Click on the **Share** button next to the right of the Asset Details. This will open a pop-up containing options for copying the public and private links of the Asset.
{{< img src="PublicAsset.png" alt="Rectangle" caption="<em>Copy the Public Link</em>" class="border-0" >}}
{{< /tab >}}
{{< tab name="JSON" >}}
Expand Down Expand Up @@ -148,9 +146,8 @@ curl -v -X POST \
{{< /tab >}}
{{< /tabs >}}

1. Your Event will be readable when the Public Asset link is followed
1. Your Event will be readable in the Event History tab when the link to the public view is followed. Click on the Event to see the details.
{{< img src="PublicViewEvent.png" alt="Rectangle" caption="<em>Event Listed in Public View</em>" class="border-0" >}}
{{< img src="EventPublic.png" alt="Rectangle" caption="<em>Event Information</em>" class="border-0" >}}
1. You may also retrieve a public URL to the Event itself, using the [Assets API](/developers/api-reference/assets-api/)
{{< tabs name="get_link_event_public" >}}
{{< tab name="JSON" >}}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Check out our [Core Concepts](/platform/overview/core-concepts/#assets) for more
1. Register your Document
{{< tabs name="add_asset" >}}
{{< tab name="UI" >}}
Using the sidebar, select `Register Document`.
Using the sidebar, select `Assets & Documents` and then `Register Document`.
{{< img src="RegDocMenu.png" alt="Rectangle" caption="<em>Registering a Document</em>" class="border-0" >}}
{{< /tab >}}
{{< tab name="YAML" >}}
Expand Down Expand Up @@ -305,8 +305,8 @@ curl -v -X POST \
1. View your Document
{{< tabs name="view_all_assets" >}}
{{{< tab name="UI" >}}
Navigate to 'Assets' to see your Asset in the UI.
{{< img src="RegDocMenu.png" alt="Rectangle" caption="<em>Managing Assets</em>" class="border-0" >}}
Navigate to 'Assets & Documents' to see your Asset in the UI.
{{< img src="RegDocMenu2.png" alt="Rectangle" caption="<em>Managing Assets</em>" class="border-0" >}}
{{< /tab >}}
{{< tab name="YAML" >}}
You can view all Asset data using the `ASSETS_LIST` action. Use the `print_response` keyword to get the full output.
Expand Down Expand Up @@ -336,11 +336,11 @@ curl -v -X GET \
1. View details of the Asset you created
{{< tabs name="view_specific_asset" >}}
{{{< tab name="UI" >}}
To view your Asset, click on the Asset row. You will see the detailed history of your Asset.
To view your Asset, click on the Asset row. You will see the details and event history of your Asset.
{{< img src="DocAsset.png" alt="Rectangle" caption="<em>Viewing Document Asset</em>" class="border-0" >}}

The extended attributes are in the `More Details` tab.
{{< img src="DocAssetDetails.png" alt="Rectangle" caption="<em>Viewing Document Asset Details</em>" class="border-0" >}}
The extended attributes are in the `Attributes` dropdown.

{{< /tab >}}
{{< tab name="YAML" >}}
The `ASSETS_LIST` action can be filtered using identifying attributes (`attrs`) to view the details of a specific Asset.
Expand Down Expand Up @@ -379,4 +379,4 @@ Here we see all details entered: The extended attributes and a history of Events
For more information on creating Events, [click here.](/platform/overview/creating-an-event-against-a-document/)
{{< /note >}}

The first Event will always be the Document Registration. In the next section, we will cover how to create your own Events for your Document.
The first Event in the Event History will always be the Document Registration. In the next section, we will cover how to create your own Events for your Document.
Original file line number Diff line number Diff line change
Expand Up @@ -294,12 +294,12 @@ curl -v -X POST \
1. Viewing Event details
{{< tabs name="view_event" >}}
{{{< tab name="UI" >}}
The Event History can be seen in the Asset Overview from step 1, simply click on any Event row to view it.<br>
The Document tab shows information about the document version that you are viewing and also provides a drag-and-drop box that allows you to check any locally stored versions of the document that you have against this specific version.
The Event History can be seen in the Asset Overview from step 1, simply click on the Event History tab and then any Event row to view it.<br>
The Overview tab shows the details of the Event including the version and document hash of this specific version.

{{< img src="EventDetails.png" alt="Rectangle" caption="<em>Viewing an Event</em>" class="border-0" >}}

The More Details tab provides information about the Event itself and includes a link to the transaction. It also includes any optional attributes that were included in the Event.
The Event attributes and Asset attributes tabs contain any custom attributes that were added when the Event was registered.

{{< img src="MoreEventDetails.png" alt="Rectangle" caption="<em>Viewing Event Attributes</em>" class="border-0" >}}

Expand Down

0 comments on commit a0c4575

Please sign in to comment.