service-configuration.md

description
This page explains the asset management specific configuration

Configuration

Content service file configuration is available at https://github.com/project-sunbird/sunbird-devops/blob/master/ansible/roles/stack-sunbird/templates/content-service_application.conf

Content service configuration

Variable	Purpose
content.cache.ttl	Not used
content.cache.enable	Not used
content.hierarchy.removed_props_for_leafNodes
content.tagging.backward_enable	Not used
content.tagging.property	Not used
content.h5p.library.path*	Download the H5P Libraries and Un-Zip the H5P Library Files
content.copy.invalid_statusList	Can not copy content which is in this status list
content.copy.origin_data	Set the origin data which is available in this list
content.copy.props__to__remove	Remove the metadata from copied content which is available in this list
content.media.base.url	Blob base URL, where all the media will uploaded
collection.cache.enable	Not used
collection.image.migration.enabled
composite.search.url	Composite search service URL
channel.default	Default channel to tag in telemetry
channel.fetch.suggested_frameworks	Enable suggested framework in get channel API
channel.content.primarycategories	Default objectCategory mapping for channel
channel.content.additionalcategories	Default objectCategory mapping for channel
channel.collection.primarycategories	Default objectCategory mapping for channel
channel.collection.additionalcategories	Default objectCategory mapping for channel
channel.asset.primarycategories	Default objectCategory mapping for channel
channel.asset.additionalcategories	Default objectCategory mapping for channel
master.category.validation.enabled
dial__service.api.base__url	DIAL service base URL. Used while DIAL link.
dial_service.api.auth_key	DIAL service auth key. Used while DIAL link.
contentTypeToPrimaryCategory
resourceTypeToPrimaryCategory
mimeTypeToPrimaryCategory

Content import functionality

Variable	Purpose
import.request_size_limit	This variable is used to validate the number of objects allowed in single request. Default value is 200.
import.required_props	This variable is used to validate the mandatory properties. Default value is ["name", "code", "mimeType", "contentType", "artifactUrl", "framework"]
import.remove_props	This variable is used to validate the remove properties. Default value is ["downloadUrl", "variants", "previewUrl", "streamingUrl", "itemSets"]

Collection CSV import/export functionality

Variable	Purpose
sunbird_dialcode_search_api	This variable is used to connect with DIAL code service list API.
framework_read_api_url	This variable is used to connect with learning service framework read API.
sunbird_link_dial_code_api	This variable is used to connect with learning service collection DIAL code link API.
collection.csv.maxRows	This variable is used to validate the number of rows of data allowed in csv. Default value is 6500
collection.csv.allowedContentTypes	NOT USED
collection.csv.maxFirstLevelUnits	This variable is used to limit writing the number of contents linked to a unit while downloading a csv. Default value is 30.
collection.csv.ttl	NOT USED
collection.csv.maxUnitFieldLength	This variable is used to validate the unit name length in the input csv. Default value is 50.
collection.csv.maxDescFieldLength	This variable is used to validate the unit description length in the input csv. Default value is 250.
collection.csv.contentTypeToUnitType*	This variable is used to derive the unit's contentType based on the collection's contentType.
collection.csv.headers.folderIdentifier	This variable is used to identify the unit folder identifier column header in the input csv. Default value is "Folder Identifier"
collection.csv.headers.hierarchy	This variable is used to identify the unit folders column header names in the input csv. Default value is ["Level 1 Folder","Level 2 Folder","Level 3 Folder","Level 4 Folder"]
collection.csv.headers.QR	This variable is used to identify the QR code linking related column headers in the input csv. Default value is ["QR Code Required?","QR Code"]
collection.csv.headers.topics	This variable is used to identify the mapped topics related column header in the input csv. Default value is ["Mapped Topics"]
collection.csv.headers.collectionName	This variable is used to identify the collection name column header in the input csv. Default value is ["Collection Name"]
collection.csv.headers.linkedContents	This variable is used to identify the linked contents related column headers in the input csv. Default value is ["Linked Content 1","Linked Content 2","Linked Content 3","Linked Content 4","Linked Content 5","Linked Content 6","Linked Content 7","Linked Content 8","Linked Content 9","Linked Content 10","Linked Content 11","Linked Content 12","Linked Content 13","Linked Content 14","Linked Content 15","Linked Content 16","Linked Content 17","Linked Content 18","Linked Content 19","Linked Content 20","Linked Content 21","Linked Content 22","Linked Content 23","Linked Content 24","Linked Content 25","Linked Content 26","Linked Content 27","Linked Content 28","Linked Content 29","Linked Content 30"]
collection.csv.headers.output	This variable is used to write the column headers of downloaded csv. Default value is ["Collection Name","Folder Identifier","Level 1 Folder","Level 2 Folder","Level 3 Folder","Level 4 Folder","Description","Mapped Topics","Keywords","QR Code Required?","QR Code","Linked Content 1","Linked Content 2","Linked Content 3","Linked Content 4","Linked Content 5","Linked Content 6","Linked Content 7","Linked Content 8","Linked Content 9","Linked Content 10","Linked Content 11","Linked Content 12","Linked Content 13","Linked Content 14","Linked Content 15","Linked Content 16","Linked Content 17","Linked Content 18","Linked Content 19","Linked Content 20","Linked Content 21","Linked Content 22","Linked Content 23","Linked Content 24","Linked Content 25","Linked Content 26","Linked Content 27","Linked Content 28","Linked Content 29","Linked Content 30"]
collection.csv.headers.sequence.create	This variable is used to identify the column headers of the input csv to recognise TOC creation flow. Default value is {"Level 1 Folder":0,"Level 2 Folder":1,"Level 3 Folder":2,"Level 4 Folder":3,"Description":4}
collection.csv.headers.sequence.update	This variable is used to identify the column headers of the input csv to recognise TOC update flow. Default value is {"Collection Name":0,"Folder Identifier":1,"Level 1 Folder":2,"Level 2 Folder":3,"Level 3 Folder":4,"Level 4 Folder":5,"Description":6,"Mapped Topics":7,"Keywords":8,"QR Code Required?":9,"QR Code":10,"Linked Content 1":11,"Linked Content 2":12,"Linked Content 3":13,"Linked Content 4":14,"Linked Content 5":15,"Linked Content 6":16,"Linked Content 7":17,"Linked Content 8":18,"Linked Content 9":19,"Linked Content 10":20,"Linked Content 11":21,"Linked Content 12":22,"Linked Content 13":23,"Linked Content 14":24,"Linked Content 15":25,"Linked Content 16":26,"Linked Content 17":27,"Linked Content 18":28,"Linked Content 19":29,"Linked Content 20":30,"Linked Content 21":31,"Linked Content 22":32,"Linked Content 23":33,"Linked Content 24":34,"Linked Content 25":35,"Linked Content 26":36,"Linked Content 27":37,"Linked Content 28":38,"Linked Content 29":39,"Linked Content 30":40}
collection.csv.headers.sequence.linkedContents	This variable is used to identify the sequence of linked content column headers of the input csv. Default value is {"Linked Content 1":0,"Linked Content 2":1,"Linked Content 3":2,"Linked Content 4":3,"Linked Content 5":4,"Linked Content 6":5,"Linked Content 7":6,"Linked Content 8":7,"Linked Content 9":8,"Linked Content 10":9,"Linked Content 11":10,"Linked Content 12":11,"Linked Content 13":12,"Linked Content 14":13,"Linked Content 15":14,"Linked Content 16":15,"Linked Content 17":16,"Linked Content 18":17,"Linked Content 19":18,"Linked Content 20":19,"Linked Content 21":20,"Linked Content 22":21,"Linked Content 23":22,"Linked Content 24":23,"Linked Content 25":24,"Linked Content 26":25,"Linked Content 27":26,"Linked Content 28":27,"Linked Content 29":28,"Linked Content 30":29}
collection.csv.mandatory.create	This variable is used to identify the mandatory data validation for the mentioned unit folder column header in the input csv during TOC creation flow. Default value is ["Level 1 Folder"]
collection.csv.mandatory.update	This variable is used to identify the mandatory data validation for the mentioned unit folder column headers in the input csv during TOC update flow. Default value is ["Collection Name","Folder Identifier"]