Used for editing metadata of an item. Add this tag "<pf-edit-metadata>" to html to use this component. Below are inputs and event of this component.

Input

Description

Sample Input

auth-service-url

The url to the identity server authentication service.

http://localhost:19081/Authentication/Core

auth-redirect-url

When the authentication service authenticated the user, the auth service will redirect to this url. Note: this url must be configured as "redirect url" of auth service

http:// localhost:19081/MetadataEditor/

auth-logout-url

Logout redirect url of auth service

http:// localhost:19081 /MetadataEditor/

auth-silent-refresh-url

The silent refresh html that oidc client use to refresh the auth token

http:// localhost:19081/silent-refresh.html

metadata-editor-uri

Currently the metadata editor do not directly access Vidispine or ConfigPortal api. Instead request are made to a proxy "metadata editor host" installed with VidiFlow which then routed to Vidispine or ConfigPortal api. So this is the url of that proxy service.

http://localhost:19081/Platform.Clients/MetadataEditor/ (backslash needed.)

object-id

Item id of the metadata to be edited. Needed when updating metadata. Same with the query param "objectId" when accessing it via iframe

pf://systemname/item/VX-237

Segment-uuid

When this value is provided, it turns the Metadata Editor to a segment layout editor for the specific segment of an item.
The segment uuid is the metadata group uuid in an item at any timespan.
The layout for the segment can be added via ConfigPortal - MetadataEditor – Custom Layout.

f9576869-6a1e-44f8-a0b3-5458018c1696

header-text

Text shown in header of MetadataEditor

Metadata
#

read-only

True or false. When ReadOnly is true, the metadataEditor will open with all fields disabled. User need to click on "edit" button (if user have the right) to begin editing metadata.

True

false


Output

Description

Sample

saveClicked

Triggered when the save button is clicked.


metadataUpdated

  1. When updating existing item metadata, this will emit the result whether success or failed. The structure of the emitted event look like this

    {
    success: boolean;
    errorMessage: string;
    }

{

success:: true

}

{

success: false

errorMessage: "some error"
}

Read/Write Permission of Edit Metadata Component

Read and Write permission are introduced in version 20.1.1-beta.55 and apply to Edit Metadata Component only (Create placeholder item do not require read and write permission). Below are the new roles and their respective rights.


PF_MetdataEdit

PF_MetdataView

PF_MetadataUser


X

PF_MetadataEditor

X

X


Users who are not assigned any role will not be able to view metadata in metadata editor. Roles can be assigned to User Domain Group via ConfigPortal.