Immersion is a command-line (CLI) tool built for the Content Direct product catalog system.
Node.js is required in order to run Immersion. Please ensure you have Node.js installed: http://nodejs.org/.
Immersion helps in ingesting categories, media, people, playlists, and products by pulling data from a CSV file.
npm install -g immersionRunning immersion -h will display the help menu which indicates a successful install.
The CSV file that is ingested should have a header row followed by the rows of entity (i.e. Category, Media, Person, Playlist, Product) information. Each row below the header is equivalent to one entity that will be created or updated.
Each column in the header should map to an object in the specified request. For example, when creating products the headers should follow the CreateProduct request format:
Product.Id.Type,Product.Id.Value,Product.Name,Product.References[0].Type,Product.References[0].Value
Objects are referenced using dot notation while arrays use brackets.
{Entity}.Id.Value is required.
The entity rows can contain either primitive values (i.e. boolean, number, string) or valid JSON.
Use your sandbox credentials to view the core request formats: https://documentation.doc1.cdops.net/v5.7/Interface.aspx?interface=Catalog.
A logs folder is created in the directory of the file provided when immersion is run. A sub-folder is created for the core API method used for the requests. Sub-sub-folders are created for each entity id. The sub-sub-folders will contain a request.json file and a response.json file for every create or update API call.
immersion -f examples/person.csv create Person
Creates person objects in sandbox.
immersion -e stg1 -f examples/media.csv update Media
Updates media objects in staging.
immersion -f examples/product.csv -t update Product
Updates product objects in sandbox using targetted method.
ISC???
FAQs
Content Direct product catalog command line tool
The npm package immersion receives a total of 3 weekly downloads. As such, immersion popularity was classified as not popular.
We found that immersion demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.
Security News
NIST's new password guidelines remove periodic changes and special character requirements, focusing on longer, more secure passwords for better authentication practices.