Custom Report
Compile any Word file with model info and results

Custom Report is a plugin for NextFEM Designer able to insert in a DocX document file (typically made in Microsoft Word(R)) images, text and tables about model and results.
By now, General Design module license is required to use this plugin.

Custom Report automatically seeks in the folder where model is saved if a DocX template is available. File must be called “reportTemplate.docx”. If there’s such file, it will be loaded automatically.

Let’s see which commands are available inside this plugin:

  1. tab 1 contains commands to load your .docx template and for writing report;
  2. tab 2 allows to see graphically how viewport is screen-shot inside the report. Please position your model in the best way possible. To insert a screenshot of the model as it, use keyword #image.asis# in the Word document;
  3. tab 3 contains options: you can specify the font for tables and its size. Keywords to be included in the docx template are listed. Read the following for their explanation.

The docx template is a simple document containing keywords, that will be replaced with the requested contents. The available keywords are:

Comments can be inserted by embracing them between ###.

Keyword Description
##text.name## Name of the current model file
##text.nodesnumber## Number of nodes
##text.elementsnumber## Number of elements
##text.length## Length unit
##text.force## Force unit
##text.beamdiagram(ID,loadcase,time,type,station)## Beam diagram value for current element ID, loadcase, time, type is 1=N, 2=Vy, 3=Vz, 4=Mt, 5=My, 6=Mz; station can be 1=I, 2, 3, 4 or 5=J
##text.nodalreaction(nodeID,loadcase,time,type)## Nodal reactions for the selected nodeID, loadcase, time, type is 1=X, 2=Y, 3=Z, 4=RX, 5=RY, 6=RZ
##text.maxverticalnodalreaction## Maximum nodal reaction in Z direction
##text.minverticalnodalreaction## Minimum nodal reaction in Z direction
##text.elementconnectivity(elemID)## Element connectivity for elemID
##text.functiondata(functionID)## User data for functionID
##table.nodes## Node tables with coordinates
##table.elements## Element tables with connectivity
##table.checking(loadcase,time)## Checking results table for current loadcase and time
##table.materials## Table of materials with main properties
##table.sections## Table of sections with main properties
##table.combinations## Table of combinations set in the model
##table.modesandpartmasses## Table of modes and participating masses ratios
##table.generic(key,fontSize)## Generic table given by a list of arrays of strings. To be used from API only. See compileDocX API
##table.beamforces## Table of beam forces in load cases and combinations
##image.asis## Image as displayed in viewport
##image.extruded## Image of extruded model
##image.nodesnumber## Image of the model with nodes numbers
##image.elementsnumber## Image of the model with elements numbers
##image.showloads(loadcase)## Image of applied loads for selected loadcase
##image.beamdiagram(loadcase,time,type)## Image of beam diagrams for the current loadcase, time and type ( 1=N, 2=Vy, 3=Vz, 4=Mt, 5=My, 6=Mz)
##image.areaforce(loadcase,time,type)## Image of area forces for the current loadcase, time and type ( 1=fxx, 2=fyy, 3=fxy, 4=mxx, 5=myy, 6=mxy, 7=qxz, 8=qyz, 9=mxWAbot, 10=myWAbot, 11=mxWAtop, 12=myWAtop, 13=mxWA, 14=myWA)
##image.soilpressure(loadcase,time)## Image of soil pressure for selected loadcase and time
##image.path(imagePath,sizeRatio)## Image from external path. SizeRatio is the percentage of the page width
##image.elementsection(elemID,station,sizeRatio)## Insert image of the element section. SizeRatio is the percentage of the page width
##image.functionplot(functionID,sizeRatio)## Insert plot of the selected function. SizeRatio is the percentage of the page width
##image.functionplots(sizeRatio)## Insert plots of all functions in the model. SizeRatio is the percentage of the page width
##image.base64(string,sizeRatio)## Image from PNG Base64 string. SizeRatio is the percentage of the page width
##image.elementfiresection(elemID,station,sizeRatio)## Insert image of the element section at the end of thermal analysis. SizeRatio is the percentage of the page width
##image.firesections(sizeRatio)## Insert images of all element sections at the end of thermal analysis. SizeRatio is the percentage of the page width
##image.section(sectID,sizeRatio)## Insert image of the specified section. SizeRatio is the percentage of the page width
##image.sectionNAxis(sectID,calcType,domainType,N,Myy,Mzz,

Nserv,Myyserv,Mzzserv,sizeRatio)##

 Insert image of the specified section with its section axis, consistent with the forces provided. SizeRatio is the percentage of the page width
##image.sectionResDomain(sectID,calcType,domainType,

N,Myy,Mzz,Nserv,Myyserv,Mzzserv,sizeRatio)##

 Insert image of the domain of the specified section, consistent with the forces provided. SizeRatio is the percentage of the page width
##image.sectionMcurvature(sectID,N,Myy,Mzz,Nserv,

Myyserv,Mzzserv,sizeRatio)##

 Insert image of the moment-curvature diagram of the specified section, consistent with the forces provided. SizeRatio is the percentage of the page width
##image.userview(name,sizeRatio)## Insert named image from Views control.SizeRatio is the percentage of the page width
##image.alluserviews(sizeRatio)## Insert all images from Views control. SizeRatio is the percentage of the page width
##equation(size,asciiFormula)## Insert equation in Ascii math format. First parameter is the font size.
##fromfile(path)## Copy text only from external DocX file specified in path (*)
##fromfilet(path)## Copy tables only from external DocX file specified in path (*)
##fromfileall(path)## Copy all items from external DocX file specified in path (*). Incomplete support for this function, usage is strongly discouraged.
##check.details(checkName)## Get verification data from an already checked element. CheckName is the name of the checking set.