Frontify

The Frontify connector allows assets to be uploaded and used in Frontify. Additionally is allows tagging assets in Frontify with metadata from KeyShot. It is a one-directional connector following the Managed integrations architecture.

The custom configuration for the Frontify connector is as follows

Parameter	Description

Parameter	Description
`ApiKey`	The API Key for Frontify. Can be generated on https://{your-domain}/api/developer/token with basic read/write.
`FrontifyDomain`	The domain for Frontify
`ProjectId`	The project id in Frontify
`UploadFormatId`	Optional format id used to determine which format goes into Frontify. If nothing is specified it defaults to the source.
`ExpirationDateMetaFieldItemGuid`	Metafield mapped to 'expiresAs' in Frontify
`TagsMetaFieldItemGuid`	Metafield mapped to 'tags' in Frontify
`AuthorMetaFieldItemGuid`	Metafield mapped to 'author' in Frontify
`TitleMetaFieldItemGuid`	Metafield mapped to 'title' in Frontify
`DescriptionMetaFieldItemGuid`	Metafield mapped to 'description' in Frontify
`Copyright`	Copyright configuration object - see below
`CustomMetadataConfigurations`	Custom metadata configuration array- see below
`MappedCollections`	Collection configuration array- see below

Additionally the connector supports mapping Copyright information which has the following options

Parameter	Description

Parameter	Description
`CopyrightNoticeMetaFieldItemGuid`	Metafield mapped to 'copyright.notice' in Frontify
`CopyrightStatusMetaFieldItemGuid`	Metafield mapped to 'copyright.status' in Frontify
`UnknownCopyrightStatusComboId`	The combo id of the ‘copyright.status' that maps to 'unknown’ in copyright status
`CopyrightedCopyrightStatusComboId`	The combo id of the ‘copyright.status' that maps to 'public domain’ in copyright status

The connector also supports Custom metadata in Frontify which is an array consisting of objects with the following options

Parameter	Description

Parameter	Description
`MetaFieldItemGuid`	Metafield guid of field in KeyShot from which value should be taken
`PropertyId`	PropertyId of the property in Frontify on which the value should be updated
`FrontifyPropertyType`	Frontify property type - see above documentation under custom metadata for a full list of types
`SelectValueMapping`	Optional field used if the property type is a SelectValue - see example below

If the Select value type is mapped, then the following parameters must be filled out

Parameter	Description

Parameter	Description
`FrontifyValue`	Value in the select value list to map
`DigizuiteValue`	Value in the corresponding KeyShot combo to map

Lastly there is the collections to which the asset should be mapped. These are controlled by the following configuration object

Parameter	Description

Parameter	Description
`FrontifyCollectionId`	The collection id in Frontify
`MetaFieldItemGuid`	The metafield guid in KeyShot which controls the collection mapping
`DigizuiteValue`	The value in the above collection mapping

With the above documentation this gives us the following example JSON to be created

{
  "ProjectId": "<Project Id of Frontify>",
  "ApiKey": "<Api key for Frontify>",
  "FrontifyDomain": "<Domain of Frontify>",
  "MappedCollections": [
    {
      "FrontifyCollectionId": "<Frontify collection id>",
      "DigizuiteValue": <Value in KeyShot>,
      "MetaFieldItemGuid": "<Keyshot metafield guid>"     
    },
    {
      "FrontifyCollectionId": "<Frontify collection id>",
      "DigizuiteValue": <Value in KeyShot>,
      "MetaFieldItemGuid": "<Keyshot metafield guid>"     
    }
  ],
  "ExpirationDateMetaFieldItemGuid": "<Expiration metafield guid>",
  "Copyright": {
    "CopyrightNoticeMetaFieldItemGuid": "<Copyright notice metafield guid>",
    "CopyrightStatusMetaFieldItemGuid": "<Copyright status metafield guid>",
    "PublicDomainStatusComboId": <Id of combo in KeyShot for public domain status>,
    "CopyrightedCopyrightStatusComboId": <Id of combo in KeyShot for copyright status>
  },
  "TagsMetaFieldItemGuid": "<Tags metafield guid>",
  "CustomMetadataConfigurations": [
    {      
      "PropertyId": "<Property id of the property to be updated in Frontify>",
      "MetaFieldItemGuid": "<metafield guid of KeyShot metafield from which value is extracted>",
      "FrontifyPropertyType": "<frontify property type>"
    },
    {      
      "PropertyId": "<Property id of the property to be updated in Frontify>",
      "MetaFieldItemGuid": "<metafield guid of KeyShot metafield from which value is extracted>",
      "FrontifyPropertyType": "<frontify property type>"
    }
  ]
}