Back to General Enhancements

New mobile (MRO) keywords

• Object & Section Keywords
• Snippet Keywords

New mobile (MRO) keyword additions to obtain more object and section attributes

New keywords for use within MRO snippets provide specific attributes for various objects and sections. The following tables lists the new keywords available to respond to certain object types. The keyword for the snippet appears in the left column and a brief description of what the value represents displays in the right column.

New Section Keywords

Keyword	Description
documaker.section.lss.tag	Dynamic insert equation name
documaker.section.lss.equation	Dynamic insert equation
documaker.section.lss.fields	Dynamic insert fields from equation
documaker.section.lss.insert	Dynamic insert associated section name
documaker.section.isinsert	Is a dynamic insert section

New Font Keywords

Keyword	Description
documaker.font.ttyfile	The font TrueType filename specified for PDF

New Field Keywords

Keyword	Description
documaker.field.insequ	Field referenced by insert equation
documaker.field.agg.type	Field aggregate type (Sum, Count, Average, Min, Max)
documaker.field.agg.text	Field aggregate type (Sum, Count, Average, Minimum, Maximum)
documaker.field.agg.tag	Field aggregate tag to collect
documaker.field.agg.scope	Field aggregate scope (section, form, global)
documaker.field.aggregation	Field aggregate tag
documaker.field.mlt.hyphen	Field TXM hyphen
documaker.field.mlt.tab	Field TXM tab size
documaker.field.mlt.column	Field TXM column count
documaker.field.mlt.cangrow	Field TXM can grow and shrink
documaker.field.mlt.canspan	Field TXM can span
documaker.field.mlt.mustfit	Field TXM must fit

New Textarea Keywords

documaker.textarea.tab Text area tab size documaker.textarea.hyphen Text area hyphen documaker.textarea.cangrow Text area can grow and shrink documaker.textarea.canspan Text area can span documaker.textarea.mustfit Text area must fit documaker.textarea.vlsuppress Text area variable line suppress documaker.textarea.hyphenzone Text area hyphen zone

New Vector Keywords

documaker.vector.type Vector type description documaker.vector.typenum Vector type number documaker.vector.penstyle Vector pen style documaker.vector.penwidth Vector pen width documaker.vector.pencolor Vector pen color documaker.vector.brushstyle Vector brush style documaker.vector.brushcolor Vector brush color documaker.vector.json Vector json data

New Signature Keywords

Keyword	Description
documaker.sign.type	Signature type
documaker.sign.typeval	Signature type value
documaker.sign.inputmethod	AssureSign input method
documaker.sign.inputtype	AssureSign input type
documaker.sign.fontname	AssureSign font name
documaker.sign.fontsize	AssureSign font size
documaker.sign.fontbold	AssureSign font bold
documaker.sign.fontitalic	AssureSign font italic
documaker.sign.underline	AssureSign underline
documaker.sign.wf.email	Signer email
documaker.sign.wf.order	AssureSign order
documaker.sign.wf.step	AssureSign step
documaker.sign.wf.required	AssureSign required
documaker.sign.wf.name	DocuSign workflow name
documaker.sign.wf.type	DocuSign workflow type
documaker.sign.wf.signer	DocuSign signer name
documaker.sign.wf.idlookup	DocuSign ID lookup
documaker.sign.wf.route	DocuSign Routing order
documaker.sign.wf.blockid	Silanis approval block ID
documaker.sign.wf.role	Silanis role
documaker.sign.wf.auth	Silanis authenticate
documaker.sign.wf.ordernum	Silanis order number
documaker.sign.typevalue	AssureSign typed vale
documaker.sign.phonetype	DocuSign phone type
documaker.sign.phonenumber	DocuSign phone number
documaker.sign.street	Signer street address
documaker.sign.street2	Signer street address2
documaker.sign.city	Signer city
documaker.sign.state	Signer state
documaker.sign.country	Signer country
documaker.sign.zipcode	Signer zip
documaker.sign.horizontal	AssureSign horizontal alignment
documaker.sign.vertical	AssureSign vertical alignment
documaker.sign.wordwrap	AssureSign word wrap
documaker.sign.signatory	AssureSign signatory input type
documaker.sign.validation	AssureSign validation type
documaker.sign.paramname	AssureSign parameter name
documaker.sign.certified	AssureSign display certified
documaker.sign.border	AssureSign display border
documaker.sign.inkcolor	AssureSign ink color
documaker.sign.choicesjson	AssureSign choice options json

New MTFormat Keywords

Keyword	Description
documaker.mtfb.type	Format object type
documaker.mtfb.char	Bullet Font character
documaker.mtft.type	Tab stop type (left, right, center, decimal)
documaker.mtft.lead	Tab stop lead
documaker.mtft.index	Tab stop index
documaker.mtft.value	Tab stop value
documaker.mtfb.color	Bullet color
documaker.mtfb.uline	Bullet underline
documaker.mtfb.align	Bullet alignment (left, right, center)
documaker.mtfb.ntype	Bullet number style
documaker.mtfb.start	Bullet start at
documaker.mtfp.align	Text alignment (left, right, center, justify)
documaker.mtfp.level	TOC level
documaker.mtfp.shade	Shade (True,False)
documaker.mtfp.ind.by	Special Indent by amount
documaker.mtfp.hyphen	Hyphenation enabled (Yes,No)
documaker.mtfp.noedit	No user edit (true, false)
documaker.mtfp.border	Border (true, false)
documaker.mtfb.symbol	Bullet Symbol type (smldot, smlbox, lmobox)
documaker.mtfb.prefix	Bullet prefix
documaker.mtfb.valign	Bullet vertical alignment (default, top)
documaker.mtfb.indent	Bullet indent
documaker.mtfb.txtind	Bullet text indent
documaker.mtfb.fontid	Bullet font
documaker.mtfb.graphic	Bullet graphic name
documaker.mtfb.postfix	Bullet postfix
documaker.mtfp.nobreak	Do not break (true, false)
documaker.mtfp.tabs.json	Json list of tabs defined for paragraph
documaker.mtformat.type	Format object type
documaker.mtfp.ind.left	Left Indent
documaker.mtfp.lsp.type	Line spacing type (6LPI, 7LPI, 8LPI, Custom)
documaker.mtfp.language	Hyphenation language
documaker.mtfp.sp.after	Spacing after
documaker.mtfp.direction	Direction left to right, right to left
documaker.mtfp.sp.before	Spacing before
documaker.mtfp.ind.right	Right Indent
documaker.mtfp.lsp.value	Line spacing (single,double,exactly,atleast,multiple)
documaker.mtfp.lsp.amount	Line spacing amount for at least or custom
documaker.mtfp.border.top	Border top (true, false)
documaker.mtfp.tab.default	TabDefault
documaker.mtfp.ind.special	Special Indent (first line, hanging, none)
documaker.mtfp.border.left	Border left (true, false)
documaker.mtfp.border.horz	Border horizontal
documaker.mtfp.border.vert	Border vertical
documaker.mtfp.shade.color	Shade color
documaker.mtfp.border.right	Border right (true, false)
documaker.mtfp.border.color	Border color
documaker.mtfp.border.bottom	Border Bottom (true, false)
documaker.mtfp.border.spacng	Border Spacing
documaker.mtfp.shade.spacing	Shade Spacing
documaker.mtfp.shade.pattern	Shade pattern
documaker.mtfp.border.pattern	Border pattern

Back to top

New Mobile (MRO) keyword supports including another snippet

Snippets are typically small text files utilized by the mobile (MRO) output containing text and keyword instructions that extract specific information from a transaction document.

In general, each “object” type within Documaker is evoked by a particular snippet. For instance section information might utilize a snippet named “section.txt”. Fields information is extracted utilizing a snippet named “field.txt” etc.

Snippets contain a combination of text and “keywords” to extract variable information from the transaction documents. Snippet keywords all begin with the “documaker.” designation. (“documaker.name”, “documaker.top”, “documaker.color”, etc. )

New to version 12.7.2 is a keyword that will include another snippet. The snippet including the keyword will be paused while the newly named snippet will begin execution. Once the included snippet finishes, the original snippet will resume where it left off.

This ability to include another snippet can be useful when you have the content that needs to be referenced in multiple places. By isolating this common content into its own snippet and then including in the others, you save time and effort keeping the snippets in sync.

The keyword is declared like this:

documaker.include.filename

Where filename specifies the new snippet that should begin execution. Note that you do not put any extension on the snippet name as it will assume the same file extension utilized for the configuration in use.

To demonstrate, assume you have two snippets, chart and field, that contain this content.

Now say you want to include another attribute that fields and charts have in common – perhaps documaker.name.form – you would have to edit both snippets to ensure these remained consistent.

Utilizing the include keyword, you could extract out these common elements and make it easier to ensure you keep your output in sync.

Example:

With a common snippet shared by both chart and field, you can modify a single place and know that the generation will still occur in the all the snippets where this one is included.

Some behaviors of the include keyword to keep in mind.

• Any snippet may include one or more snippets, but may not include itself or cause recursion. In other words, if snippet A includes B, then B may not include A or B. Likewise, if snippet B includes C, then snippet C may not include A, B or C as that causes an endless loop. However, snippet A may include both snippet B and C, even if snippet B contains C as that does not cause a conflict.
• The included snippet begins and ends exactly at the point where the documaker.include keyword appears. So if your snippets are meant to generate a specific format file – say html or xml, it is your responsibility to ensure that braces, commas, brackets and/or any format required is maintained.
• On some platforms, filenames are case specific. The file CAR.txt is different from the file car.TXT. We recommended that you keep all filename references in lowercase and ensure your snippet files on disk are named using lowercase.

This was not meant to be a complete description of snippet processing or mobile generation. For more information be sure to review the mobile specific documentation.

Back to top