Home

NetChain Media

Documentation

Veeva Creators Aid (VCaid)

Creators aid tool for creating veeva content

Installation

VCaid has been build on Node.js v14.17.5, and has not been tested on older versions yet. You can install it globally as below

npm i -g @netchainmedia/vcaid

Features

  • (In-progress) Generate boilerplate template of approved emails and clm presentations from yaml configuration files.
  • (Not complete) Prepares deployment ready content for veeva platform
  • (Not complete) FTP uploads veeva content to the vault.

Configuration

Emails

This tool generates boilerplate code from configuration and templates, if provided the user's configurations will be effective otherwise the code is generated from master configuration and template.

  1. To generate email boilerplate code, add default.yml file under /config directory.
mkdir test && cd test && mkdir config && touch config/default.yml
  1. Populate the default.yml file with below code as a starter and can be modified as suited.
email:

  output_dir: email

  images_dir: images

  default_font: Arial

  fallback_font: sans-serif

  content:

    preheader_text: The default preheader text

    header:

      title: Email Title

      belowtitle_text: addition text below title

      background:

        file_path: header.png

    prescribing_information:

      text: Click here for prescribing information

      href: "{{PILink}}"

    salutation: Dear {{accTitle}} {{accLname}}

    prefragment_text: This is the default text that appears before fragments. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labo re et dolore magna aliqua.

    fragments:

      - fragment:

          image:

            alt: Packshot

            file_path: packshot.png

          title: Fragment Title

          description:

            - paragraph: This is the fragment default description.

            - paragraph: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt

          button:

            text: Click here

            href: https://example.com

    body:

      - paragraph: This is the email body text that appears after the fragments. Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labo re et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.

    preclosure_text:

      - paragraph: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labo re et dolore magna aliqua

    closure_text: Yours sincerely,

    user_name: "{{username}}"

    user_email: "{{userEmailAddress}}"

    user_phone: "{{user.MobilePhone}}"

    disclaimer:

      - paragraph: Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt

    logo:

      alt: Logo

      file_path: logo.png

      width: 135

    footer:

          company_name: Lorem Ipsum Ltd

          address:

            - line: Lorem Ipsum

            - line: Lorem, Ipsum Consectetur, AB00 0XY

          phone: 00000 00100

          copyright_text: Copyright <sup>©</sup> 2021 Lorem Ipsum Ltd. Company number 000000. All rights reserved.

          unsub_text: <a style="color:#373737!important;margin:0;font-family:Arial,sans-serif;font-size:12px;line-height:14.06px;" href="{{unsubscribe_product_link}}">Click here</a> to manage your email settings or unsubscribe, and to view <a style="color:#373737!important;margin:0;font-family:Arial,sans-serif;font-size:12px;line-height:14.06px;" href="https://example.com/privacy-statement">privacy statement</a>

    job_code: XY-AB-000000 V1 | October 2021
  1. Create directory for images as per the yml configuration above to match with images_dir key, in this case images
mkdir images
  1. Copy files for header, fragment, logo as per the yml configuration above to match with email.content.header.background.file_path, content.fragments.fragment.image.file_path & content.logo.file_path respectively to the images directory
  2. Run generate command to generate the approved email
vcaid gen -t email