FAQs
This page addresses frequently asked questions about Collection Service.
Collection when created will have 'Draft' status. When the Collection is submitted for Review, collection status will be updated to 'Review'. When a Collection is accepted (submitted for publishing), status will first move to 'Processing' and then to 'Live' if it is processed successfully else to 'Failed'. When a published collection is edited, an image node gets created with the id ending with '.img' (do_Id.img). Status of the image node will be 'Draft' whereas status of non-image node will be 'Live'. Image node will follow the above life cycle.
When a collection in 'Review' status is rejected in Review, status of the collection will be updated back to 'Draft'.
When a collection is submitted for delete/retire, status of the collection will be updated to 'Retired'.
When a collection retire API is triggered, status of the collection will be updated to 'Retired'. Please note that when a collection with both actual node and image node existing is retired, image node is hard deleted from the system and actual node's status is updated to 'Retired'.
Yes, discard collection API can be used to delete the image node of a collection object. Please note that the image node will be hard deleted from the system.
Actual node will be hard deleted from the system.
Yes, using Add Hierarchy API and Remove Hierarchy API, one can add or remove contents/collections to/from a collection unit.
Collection object metadata is stored in the Neo4j database. Uploaded appIcon images are stored in Cloud. Collection Hierarchy is stored in json format in Cassandra database. Metadata is synced to Elasticsearch and Redis.
Actual node metadata can be read using 'Read Collection API' URL in the format '/collection/v1/read/do_id'.
Image node metadata can be read using 'Read Collection API' URL in the format '/Collection/v1/read/do_id**?mode=edit**' or '/collection/v1/read/do_id**.img**'.
When a Collection object Publish API is invoked, after metadata validation, content-publish flink job is invoked using respective kafka topic. In the flink job, post the pkgVersion validation, a collection is first updated to 'Processing' status. Later, packaging of the collection starts (ECAR generation) with types ONLINE and SPINE. Once ECAR is generated and uploaded to cloud, status is updated to 'Live'.
Last modified 7mo ago