new= create a new template project, it launches a simple interactive wizard for template metadata
list= list all templates (latest versions) from configured DSW
get= download a template project with specified template ID from DSW
put= upload the local template project to DSW (once or continually on-change when
--watchflag is used)
verify= check the metadata of the local template project
package= create a ZIP distribution package from the local template project (ZIP is importable to DSW via its web interface)
getwill create a new folder according to the template ID if not explicitly set in other way.
--helpto find out details:
DSW_API= URL of DSW API with which you want to communicate
DSW_USERNAME= your login (email address) to that DSW instance, must be administrator account
DSW_PASSWORD= corresponding password
.envfile in the project root and it will be loaded automatically. Or you can specify the path to a
id= composed full ID of the template (
organizationId= identifier of organization developing the template (lowercase, numerics, dot)
templateId= identifier of template (lowercase, numerics, dash)
version= version (semver) in X.Y.Z format where X, Y, and Z are non-negative numbers
name= name of the template
description= short description of the template
license= name of the used license
readme= longer description usually containing changelog
metamodelVersion= supported version of template metamodel, it affects with which DSW version is can be used
recommendedPackageId= identifier of recommended package (if any,
readmefor you, so you can skip then and naturally use
nullvalue serves as wildcard, i.e., filter with all
nullvalues means that all packages are allowed.
orgId: identifier of organization (e.g.
kmId: identifier of knowledge model (e.g.
minVersion: minimal package version (in format X.Y.Z, inclusive)
maxVersion: maximal package version (in format X.Y.Z, inclusive)
uuid: UUID of the format (within template)
name: display name of the format
shortName: short name (ideally extension) for the format, it can be used for example to be displayed in icons
template.jsonbut those are never stored directly in DSW.
version: metadata version for needs of migrations
readmeFile: files used to get content for
readmeof the template, usually
files: list of patterns to specify files that are part of the document template (it uses Git’s wildcard-match patterns, so you can also exclude files or directories)
config= object with DSW configuration related to documents, e.g.,
clientUrlfor referring to the DSW instance
createdAt= timestamp when the document was created
createdBy= object describing author of the document
knowledgeModel= object describing used KM for the questionnaire
chapterUuids= list of UUIDs for chapters
integrationUuids= list of UUIDs for integrations
tagUuids= list of UUIDs for tags
answers, and other maps with UUID-entity pairs
name= name of the knowledge model
uuid= UUID of the knowledge model
level= current desirability level selected for the questionnaire
levels= list of desirability levels possible
metrics= list of available metrics
organization= object describing organization that runs the DSW instance
package= object with metadata about the KM package such as
questionnaireName= name of the questionnaire
questionnaireReplies= map of replies with path-reply pairs, each reply has
questionnaireUuid= UUID of the questionnaire
report= object that contains report for the questionnaire that contains computed information about number of answered questions as well as metric values
updatedAt= timestamp when the document was last updated
uuid= UUID of the document
json= produces a JSON as simply dump of document context
jinja2= produces a document by supplying document context to specified Jinja2 template and renders it
template= path of the template entry file (POSIX style, relative from
content-type= resulting content type of the rendered document (e.g.
extension= file extensions for the rendered document (e.g.
from= source format (one of:
to= target format (as above)
any= check if any value of iterable is true
all= check if all values of iterable are true
extract= for object/map and list of keys it returns list of corresponding values from that object/map
of_alphabet= transforms a numer to letter of alphabet (e.g.
roman= transforms given number to Roman numerals
markdown= transforms Markdown into HTML
dot= ends string with
.if it does not already end with it nor is empty
reply_str_value= gets string value from given reply (if valid, otherwise empty string)
reply_int_value= gets integer value from given reply (if valid, otherwise
reply_float_value= gets float value from given reply (if valid, otherwise
reply_items= gets list of items (their UUIDs) from given list-question reply (if valid, otherwise empty list)
reply_path= joins given list of UUIDs into reply path
iskeyword... just as in Python.
dsw-tdk put -fwwith
.envfile prepared for your dev instance.
knowledgeModel.entitiesof the context.
.valueneeded). In case you are using filters such as
reply_str_valueno changes are needed.
questionnaireRepliesto use path-reply map and removed then redundant
questionnaireRepliesMapfrom document context.