This npm package was developed to centralize core functionality and worklfow processes for building Veeva iRep CLM Presentations.
If you're developing and managing several client Veeva CLM projects, then you know it's cumbersome to introduce new functionality (outside of content) when your code-base is inconsistent across multiple repositories.
:link: Veeva CLM Example
configuration.yml
fileconfiguration.yml
fileconfiguration.yml
fileIn This Documentation
Install the following prerequisites on your development machine.
sudo npm install -g gulp
brew install imagemagick
apt-get install imagemagick
$ npm install veeva --save
Once the npm install
has completed, the following file structure below will need to be placed into your project root directory.
For a complete working example, please reference Veeva CLM Example
Add your files to the appropriate app
sub directories. Gulp will process and compile them into build
.
Notes:
root/
|—— app/
| |—— assets/
| | |—— scss/
| | |—— js/
| |—— templates/
| | |—— includes
| | |—— layouts
| | |—— pages
| | | |—— globals
| | | | |—— fonts
| | | | |—— images
| | | | |—— isi.hbs
| | | | |—— terms.hbs
| | | |—— veeva-home
| | | | |—— images
| | | | |—— veeva-home.hbs
| | | |—— veeva-overview
| | | | |—— images
| | | | |—— veeva-overview.hbs
| | | |—— veeva-resources
| | | | |—— images
| | | | |—— veeva-resources.hbs
| | | |—— veeva-sitemap
| | | | |—— images
| | | | |—— js
| | | | |—— veeva-sitemap.hbs
|
|
|—— configuration.yml
|—— gulfile.js
|—— package.json
Sass files are located in app
> assets
> scss
. Gulp watches and generates minified and unminified CSS files.
JavaScript files are located in the app
> assets
> js
directory.
Template files are located in the app
> templates
.
View full configuration.yml example
Inside configuration.yml
, add Key Messages under the clm node.
clm:
product:
name: 'Product-Name'
suffix: '-'
primary:
name: 'CLM-Presentation-ID'
key_messages:
- key_message: 'home'
description: 'Home'
display_order: '0'
slides:
- slide: 'home'
id: '0'
- key_message: 'overview'
description: 'Veeva Test Overview'
display_order: '1'
slides:
- slide: 'Veeva Test Overview'
id: '2-0'
- key_message: 'sitemap'
description: 'Sitemap'
display_order: '2'
slides:
- slide: 'Sitemap'
id: '0-1'
Inside configuration.yml
you'll see a variable named paths
. Adjust the paths to suit your workflow.
"paths": {
"src": "app",
"dist": "build",
"deploy": "deploy",
"tmp": "build/.tmp",
"pages": "app/templates/pages",
"layouts": "app/templates/layouts"
}
For a quick reference in your terminal:
$ gulp --help
Usage: gulp <task> [options]
TASKS
_________________________________________________________________________
$ gulp Default task that kicks off development mode
$ gulp build Build task
$ gulp stage Stage task
$ gulp veeva-deploy Deploy task
$ gulp veeva-vault-stage Generates a Veeva Vault Multichannel Loader .CSV file
OPTIONS
_________________________________________________________________________
-a --all-key-messages Include hidden Key Messages when staging and deploying
-c --config Show merged configuration
-d --dry-run Do not touch or write anything, but show the commands and interactivity
-e --debug Output exceptions
-h --help Print this help
-k --key-message Build, Stage, and Deploy single Key Message
-v --version Print version number
-V --verbose Verbose output
$ gulp
Runs the following workflow:
$ gulp build
Runs the following workflow:
$ gulp stage
Runs the following workflow:
deploy
directoryconfiguration.yml
file details and places them into the deploy
directory$ gulp veeva-deploy
Note: this process uses FTP information stored in the configuration.yml
file
Runs the following workflow:
.zip
files sitting in the deploy
directory.zip
files have been uploaded, all .ctl
files sitting in the deploy
directory are then uploaded$ gulp veeva-vault-stage
Runs the following workflow:
.csv
file based on configuration.yml
detailsIf you're having issues with the Veeva Node Package, submit a submit a GitHub Issue.