Creating Metadata Definitions for IMP, PKL and CPL

Note: A feature toggle is required to enable IMP in Enterprise. This is done using the following consul KV: `flex.shared.flex-enterprise.featureToggles.packageAssetsEnabled`

Creating Metadata Definitions for IMP, PKL and CPL

Before you can use the Import IMP action to import a package asset into Flex Media Platform, you must create three metadata definitions: asset map, PKL, and CPL. When you have created these definitions, you can then run an import action and it will pick up the details in these metadata definitions.

You can create Metadata Definitions using both the REST API and the UI.

Creating Metadata Definitions Using the UI

You can upload the details of each metadata definition in the form of XML files to Flex Media Platform, using the Metadata Designer.

Note: See the Appendix section for CPL, ASSETMAP, and PKL metadata definitions (XML).

1) In the Metadata Designer, click .

2) From the drop down, click .

3) In the Upload a Metadata Schema window, drag the XML file into the selection area.

4) Click

5) Select the newly uploaded definition.

6) Click Enable and all the fields appear.

Creating an Asset Map Metadata Definition (REST API)

Alternatively you can use the REST API to create the required metadata definitions.

1) Run the following REST request:

POST /api/metadataDefinitions/

Example body:

{
  "name": "imf_am_st0429_9_2007",
  "description": "imf_am_st0429_9_2007",
  "visibilityIds": [4],
  "accountId": 4
}

2) Add the metadata to the asset map metadata definition, using:

PUT:/api/metadataDefinitions/{MetadataDefinitionEntityId}/definition
Note: See the Appendix for CPL, ASSET MAP, PKL metadata definitions. (JSON)

3) Navigate to the definition in the metadata definition and enable it.

Creating a PKL Metadata Definition

1) Run the following REST request:

POST: /api/metadataDefinitions/

Example body:

{
  "name": "imf_pkl_st2067_2_2016",
  "description": "imf_am_st0429_9_2007",
  "visibilityIds": [4],
  "accountId": 4
}
       

2) Add the metadata to the PKL metadata definition, using:

PUT:/api/metadataDefinitions/{MetadataDefinitionEntityId}/definition
Note: See the Appendix for CPL, ASSET MAP, PKL metadata definitions (JSON)

3) Navigate to the definition in the metadata definition and enable it.

Creating a CPL Metadata Definition

1) Run the following REST request:

POST:/api/metadataDefinitions/

Example body:

            {
            "name": "imf_cpl_st2067_3_2016",
            "description": "imf_am_st0429_9_2007",
            "visibilityIds": [4],
            "accountId": 4
            }
        

2) Add the metadata to the CPL metadata definition, using:

PUT:/api/metadataDefinitions/{MetadataDefinitionEntityId}/definition
Note: See the Appendix section for CPL, ASSETMAP, and PKL metadata definitions (XML).

3) Navigate to the definition in the Metadata Definition and enable it.

https://help.ooyala.com/sites/all/libraries/dita/en/media-logistics/flex/user/70/imp_configuring_flex_to_use_imp_creating_metadata_definitions.html

Was this article helpful?