Akumina Developer Documentation

Akumina Developer Documentation

  • API
  • Docs
  • Blog

Version 4.1

ChangeList

[4.1.1904.1501] - 04.15.19

  • sleep,exportlists,uploadfiles,webpartgallery,groups,siteproperties options added
  • azurestorageassets arg added (Azure CDN deployment support)
  • addmastertoroot arg added
  • added support to 'lists' option to update items based on id rather than title (for large lists)

[4.1.1812.0601] - 12.06.18

  • clientid clientsecret args added - use with spUrl

[4.1.1811.1501] - 11.15.18

  • Removed args output as password was exposed

[4.1.1810.2601] - 10.26.18

  • Added support for Group assignment for contenttype import (contenttype.xml)

[4.1.1810.1501] - 10.15.18

  • Bug 10527 - 4.1 Site Deployer error with Add Widget Packages - ApproveListItems does not have an implementation

[4.1.1809.1925] - 10.10.18

  • Initial Load

Install

npm install

Command line parameters

argumentdescriptionexample
versionShows the Site deployer version
envdirPath to location that contains SiteDefinitions directory - should have trailing slashC:\TEMP\
assetdirectoryDirectory name in SiteDefinitions directoryMyClient (Looks in envdir\SiteDefinitions\MyClient)
optionsComma deliminted list of options - see belowjs,widgets
mlPopulate AkId,AkLanguageId,AkLanguageCode columnstrue or false
langidLanguage Id1033
spdirectoryFolder in Sharepoint Style Library where bits gets deployedDigitalWorkplace
spUrlSharepoint site collectionhttps://tenant.sharepoint.com/sites/mysitecollection
spUserSharepoint usernamemyusername@tenant.onmicrosoft.com
spPasswordSharepoint password12345
clientidSharepoint app client idguid
clientsecretSharepoint app client secret
azurestorageaccountnameAzure Storage account name
azurestoragecontainerAzure Storage blob container name
azurestorageaccountkeyAzure Storage account key
cdnprefixreplaces {{CDNPrefix}} token in Master page with this value

Minimum usage with username|password

Akumina.SiteDeployer.exe options "js" spUser "myusername@tenant.onmicrosoft.com" spPassword "mypassword" spUrl "https://tenant.sharepoint.com/sites/mysitecollection" envdir "C:\TEMP\\" assetdirectory "MyClient" spdirectory "DigitalWorkplace"

Minimum usage with clientid|clientsecret

Akumina.SiteDeployer.exe options "js" spUrl "https://tenant.sharepoint.com/sites/mysitecollection" clientid "myclientid" clientsecret "myclientsecret" envdir "C:\TEMP\\" assetdirectory "MyClient" spdirectory "DigitalWorkplace"

Usage

node deploy.js

Check deploy.js for proper flags:

optionDescription
masterpageDeploys contents of envdir/sitedefinitions/assetdirectory/MasterPages (classic sites)
jsDeploys contents of envdir/sitedefinitions/assetdirectory/branding/js
cssDeploys contents of envdir/sitedefinitions/assetdirectory/branding/css
listsDeploys lists based on envdir/sitedefinitions/assetdirectory/ListDefinitions/Lists.xml
layoutsDeploys new page layouts from envdir/sitedefinitions/assetdirectory/PageLayouts/Elements.xml
pagesDeploys new .aspx pages from envdir/sitedefinitions/assetdirectory/Pages/Elements.xml
pagewidgetsBETA Deploys an Akumina virtual page envdir/sitedefinitions/assetdirectory/ProvisionWidgets/pagewidgets.json
addtermsetsDeploys termsets based on envdir/sitedefinitions/assetdirectory/Taxonomy/terms.xml
controlsDeploys widgets onto pages from envdir/sitedefinitions/assetdirectory/PageContent/pages.xml
widgetsDeploys widget packages from envdir/sitedefinitions/assetdirectory/WidgetPackages/*.zip
contentfilesDeploys contents of envdir/sitedefinitions/assetdirectory/branding/content
imagefilesDeploys contents of envdir/sitedefinitions/assetdirectory/branding/imgimages
updatelistsDeploys list content based on envdir/sitedefinitions/assetdirectory/ListDefinitions/Update.xml
homepageSets default home page for the site collection to Pages/home.aspx
fontsDeploys contents of envdir/sitedefinitions/assetdirectory/branding/fonts
addwikiN/A
modernIn PROGRESS Not Supported
sleepThe deployer will sleep for 15 seconds
exportlistsReads 'exportLists' key from app.config - will export configured lists
uploadfilesDeploys contents of envdir/sitedefinitions/assetdirectory/UploadFiles
webpartgallery
groupsDeploys Sharepoint Security Groups from envdir/sitedefinitions/assetdirectory/SecurityGroups/groups.xml
sitepropertiesDeploys Site Properties from envdir/sitedefinitions/assetdirectory/SiteProperties/properties.xml
Akumina Developer Documentation
Docs
Akumina Framework 5.0Akumina Widget BuilderAkumina Yeoman GeneratorSite Deployer
Community
Akumina Community Site
More
GitHubStar
Copyright © 2024 Akumina