Overview
Document Templates are Microsoft Word-based documents used to merge data from specific functional areas, such as permits, evaluations and compliance actions. Document templates are used to create letters, permits, inspection reports, or just about any other document. For more information on how to edit and format documents using Microsoft Word visit Microsoft Word Help Center.
In order to use the Document Template editor, the AceOffix browser plugin must be installed on the client desktop browser. In addition, Microsoft Office must also be installed on the desktop.
To edit document templates, navigate to Admin > Document Templates. This page displays a list of existing document templates; to edit a template, click the corresponding Open button. Or, to create a new template, click the Add New Document Template button. In either case, a page will display to configure the document template. To review an existing document template click on Preview or Edit to start editing the document template. If Preview or Edit is clicked, an AceOffix window opens (as the New Document Template or Edit Document Template page).
| Info |
|---|
Note that, when editing or viewing a document template in the AceOffix window, a popup window will be displayed over the main nVIRO page, indicating that AceOffix is open in another window. |
Editing a Document Template Using AceOffix
AceOffix window contains the Editor section, which displays the document itself as an editable Word document, along with a list of merge fields available for insertion into the document (Left Side).
Image Removed
Creating a document is the same as creating a document in Microsoft Word, the only change is the words or values that would change dynamically based on the Permit information, Inspection, or any other data that would be different from one document to another.
Insertable Fields Type
There are two types of fields, single insertable fields (nonbold), and Looping insertable fields (bold).
Single Insertable Fields
Listed in a nonbold typeface. To insert a field in the document, double click on any nonbold insertable fields from the list, a text will be inserted in the document (at the location of cursor) in the form of| Code Block |
|---|
|
<<[FieldName]>> |
this field will be changed to its corresponding value when previewing or generating the document.
Image Removed
Looping Insertable Fields
Which is listed as a bold insertable field in the list. The Bold insertable field, groups multiple fields that represent a table of values. For example, a site usually have multiple contacts associated with it, to insert in a document all contacts, double click contacts, a text will be inserted in the document (at the location of cursor) in the form of
| Code Block |
|---|
|
<<foreach [contact in contacts]>> <</foreach>> |
which will loop through all contacts available for that document. For more details on loops visit Using Loops in Document Templates.
Image Removed
To display the items available within a bold insertable field, single-click on any bold insertable fields which will display the available fields.
Image Removed
For more details on how to use loops in a document check Document Template Syntax Guide.
Document Template Possibilities
The Document template tool is a powerful tool which can regenerate complicated document based on logic and data sources, it can also perform data manipulation and calculations. Some of the codes that could be used in a document template can be found at Document Template Syntax Guide page.
Standard Document Template Fields
The table lists all of the standard document template fields for view-based data sources, 
Image Removed the loop icon represents that the insertable field contains multiple fields and each field contains multiple data which will require a loop to display these data, check Using Loops in Document Templates:
| Ui expand |
|---|
| expanded | true |
|---|
| title | Document Template Fields |
|---|
|
| Ui expand |
|---|
| title | Application/Request Fields |
|---|
|
The view name for this data source in database is VW_SVC_DATASRC_APP_REQUEST_STDRD_NOPARSE
| Subject Area | Insertable Field Name | Description |
|---|
| Submission Information | Id | System Submission ID |
|---|
| SubmissionReferenceNumber | Submission Reference Number |
| SubmissionFormNumber | nFORM submission number |
| SubmissionFormName | Form Name |
| SubmissionFormType | Action Type |
| SubmissionActionType | Submission Type (Application, Permit Change, etc..) |
| SubmissionProjectName | Project Name |
| SubmissionReceivedDate | Submission Received Date (yyyy-MM-dd HH:MM:SS) |
| SubmissionCompleteDate | Submission Completed Date (yyyy-MM-dd HH:MM:SS) |
| SubmissionPriority | Submission Priority |
| SubmissionProcessDueDate | Submission Due Date (yyyy-MM-dd HH:MM:SS) |
| SubmissionReviewCompleteDate | Submission Review Completed Date (yyyy-MM-dd HH:MM:SS) |
Submission Contact (Tag associated with this Field??) (APPLCNT) | ApplicantPrefix | Applicant Prefix (Mr, Ms, Mrs., etc.) |
|---|
| ApplicantName | Applicant Display Name |
| ApplicantFirstName | Applicant First Name |
| ApplicantLastName | Applicant Last Name |
| ApplicantAddress1 | Applicant Address Line 1 |
| ApplicantAddress2 | Applicant Address Line 2 |
| ApplicantCity | Applicant City |
| ApplicantStateCode | Applicant State (2 letters format) |
| ApplicantZip | Applicant Zipcode |
| ApplicantPhone | Applicant Phone formatted with Extension if available |
| ApplicantTitle | Applicant Title |
| ApplicantOrganization | Applicant Organization |
| Assigned Staff | SubmissionStaffWorkgroupName | Assigned Workgroup Name |
|---|
| SubmissionStaffDisplayName | Staff Display Name who's the application is assigned to |
| SubmissionStaffFirstName | Staff First Name |
| SubmissionStaffLastName | Staff Last Name |
| SubmissionStaffEmail | Staff Email address |
| SubmissionStaffPhone | Staff Phone Number with extinction if available |
| SubmissionStaffOrganization | Staff Organization Name |
| SubmissionStaffWorkgroupSupervisorName | Staff Supervisor Name |
| System Info | AgencyAcronym | Agency Acronym |
|---|
| AgencyFullName | Agency Full Name |
| SystemContactUrl | Website address for agency contact information |
| SystemName | System Name |
| SystemUrl | System website address |
| SystemIsProduction | System is Production (1 or 0 values) |
| Site | SiteNumber | Site Number |
|---|
| SiteName | Site Name |
| SiteAddress | Site full address, Address Line 1 Address Line 2 City, State Zip-Code |
| SiteAddress1 | Site Address line 1 |
| SiteAddress2 | Site Address line 2 |
| SiteCity | Site City |
| SiteStateCode | Site State (2 letters format) |
| SiteZipCode | Site Zipcode |
| SiteTaxParcelNumber | Site Parcel Id |
| SiteAddressComments | Site Address Comments |
| SiteOwnrshType | Owner Type (Public, Private, etc..) |
| SiteSicList | Standard Industrial Classification Code (SIC) |
| SiteNaicsList | North American Industry Classification System Code (NAICS) |
| Site Location | SiteLatitude | Site Latitude |
|---|
| SiteLongitude | Site Longitude |
| SiteCounty | Site County Name |
| SiteFipsCode | Site FIPS Code (Federal Information Processing Standard) |
 Image Removed
Site Alt Name | SiteAltNames_SiteAltNameTypeDescription | Site Alternative Name Description (Master ID, Historical Name, etc..) |
|---|
| SiteAltNames_SiteAltNameTypeCode | Site Alternative Name Tag |
| SiteAltNames_SiteAltName | Site Alternative Name Description |
| District Office | DistrictOfficeName | Name of District Office (Based on County defined in District Office Lookups) |
|---|
| DistrictSupervisorName | District Office Supervisor Name |
| DistrictOfficeAddress | District Office full address, Address Line 1 Address Line 2 City, State Zip-Code |
| DistrictOfficeAddress1 | District Office Address Line 1 |
| DistrictOfficeAddress2 | District Office Address Line 2 |
| DistrictOfficeCity | District Office City |
| DistrictOfficeState | District Office State (2 Letters Format) |
| DistrictOfficeZip | District Office Zip code |
| DistrictOfficePhone | District Office Phone formatted with Extension if available |
| DistrictOfficeFax | District Office Fax number |
Image Removed | | Contacts_ContactPrefix | Contact Prefix (Mr, Ms, Mrs., etc.) |
| Contacts_ContactFirstName | First Name |
| Contacts_ContactLastName | Last Name |
| Contacts_ContactName | Display Name |
| Contacts_ContactOrganizationName | Organization Name |
| Contacts_ContactTitle | Title |
| Contacts_ContactAddress1 | Address Line 1 |
| Contacts_ContactAddress2 | Address Line 2 |
| Contacts_ContactCity | City |
| Contacts_ContactState | Contact State (2 letters format) |
| Contacts_ContactZipCode | Zip Code |
| Contacts_ContactCityStateZip | City, State Zip Code (Portland, OR 97239) |
| Contacts_ContactEmail | Email |
| Contacts_AffiliationTypeCode | Contact Affiliation Code, a List of types is configured in Admin → Lookups → Affiliation Types (Roles) |
| Contacts_AffiliationTypeDescription | Contact Affiliation Description, a List of types is configured in Admin → Lookups → Affiliation Types (Roles) |
| Contacts_ContactPhone | Phone Number |
| Contacts_ContactPhoneExtension | Phone Extension |
| Contacts_ContactPhoneTypeDescription | Phone Type (Home, Mobile, etc..) |
| Permit Info | PermitNumber | Permit Number |
|---|
| PermitVersion | Permit Version this is the major version before the decimal (1.x) |
| PermitRevision | permit revision, this is the first decimal after the version (x.1) |
| PermitNumberAndVersion | Permit number and version eg. (PRMT0001 v 1.0) |
| PermitCategory | Permit Category |
| PermitType | Permit Type |
| PermitStatus | Permit Status (In Effect, Expired, etc...) |
| PermitIssueDate | Permit Issue Date (yyyy-MM-dd HH:MM:SS) |
| PermitEffectiveDate | Permit Effective Date (yyyy-MM-dd HH:MM:SS) |
| PermitExpireDate | Permit Expiration Date (yyyy-MM-dd HH:MM:SS) |
| Ui expand |
|---|
|
The view name for this data source in database is VW_SVC_DATASRC_PERMIT_STDRD_NOPARSE
| Subject Area | Insertable Field Name | Description |
|---|
| Assigned Staff | AgencyContactOrganization | Agency Contact Organization |
|---|
| AgencyContactUserDisplayName | Agency Contact User Display Name |
| AgencyContactUserEmail | Agency Contact User Email |
| AgencyContactUserFirstName | Agency Contact User First Name |
| AgencyContactUserLastName | Agency Contact User Last Name |
| AgencyContactUserPhone | Agency Contact User Phone formatted with Extension if available |
| AgencyContactWorkgroupName | Agency Contact Workgroup Name |
| AgencyContactWorkgroupSupervisorName | Agency Contact Workgroup Supervisor Name |
| Compliance Staff | ComplianceManagerDisplayName | Compliance Manager Dipslay Name |
|---|
| ComplianceManagerEmail | Compliance Manager Email |
| ComplianceManagerFirstName | Compliance Manager First Name |
| ComplianceManagerLastName | Compliance Manager Last Name |
| ComplianceManagerOrganization | Compliance Manager Organization |
| ComplianceManagerPhone | Compliance Manager Phone formatted with Extension if available |
| ComplianceManagerWorkgroupName | Compliance Manager Workgroup Name |
| ComplianceManagerWorkgroupSupervisorName | Compliance Manager Workgroup Supervisor Name |
Image Removed Contact | Contacts_AffiliationTypeCode | Contact Affiliation Code, a List of types is configured in Admin → Lookups → Affiliation Types (Roles) |
|---|
| Contacts_AffiliationTypeDescription | Contact Affiliation Description, a List of types is configured in Admin → Lookups → Affiliation Types (Roles) |
| Contacts_ContactAddress1 | Contact Address Line 1 |
| Contacts_ContactAddress2 | Contact Address Line 2 |
| Contacts_ContactCity | Contact City |
| Contacts_ContactCityStateZip | City, State Zip Code (Portland, OR 97239) |
| Contacts_ContactEmail | Contact Email |
| Contacts_ContactFirstName | Contact First Name |
| Contacts_ContactLastName | Contact Last Name |
| Contacts_ContactName | Contact Name |
| Contacts_ContactOrganizationName | Contact Organization Name |
| Contacts_ContactPhone | Contact Phone |
| Contacts_ContactPhoneExtension | Contact Phone Extension |
| Contacts_ContactPhoneTypeDescription | Phone Type (Home, Mobile, etc..) |
| Contacts_ContactPrefix | Contact Prefix (Mr, Ms, Mrs., etc.) |
| Contacts_ContactState | Contact State (2 letters format) |
| Contacts_ContactTitle | Contact Title |
| Contacts_ContactZipCode | Contact Zip Code |
| Contacts_FunctionalAreaId | Functional Area Id |
| Account code | Id | Id |
|---|
| AccountVerificationCode | Account Verification Code |
Permit Contact Info (Tag associated with this Field??) | PermitteeAddress1 | Permittee Address Line 1 |
|---|
| PermitteeAddress2 | Permittee Address Line 2 |
| PermitteeCity | Permittee City |
| PermitteeFirstName | Permittee First Name |
| PermitteeLastName | Permittee Last Name |
| PermitteeName | Permittee Display Name |
| PermitteeOrganization | Permittee Organization |
| PermitteePhone | Permittee Phone formatted with Extension if available |
| PermitteePrefix | Permittee Prefix (Mr, Ms, Mrs., etc.) |
| PermitteeState | Permittee State (2 letters format) |
| PermitteeTitle | Permittee Title |
| PermitteeZip | Permittee Zip |
| District Office | DistrictOfficeAddress | District Office full address, Address Line 1 Address Line 2 City, State Zip-Code |
|---|
| DistrictOfficeAddress1 | District Office Address Line 1 |
| DistrictOfficeAddress2 | District Office Address Line 2 |
| DistrictOfficeCity | District Office City |
| DistrictOfficeFax | District Office Fax |
| DistrictOfficeName | Name of District Office (Based on County defined in District Office Lookups) |
| DistrictOfficePhone | District Office Phone formatted with Extension if available |
| DistrictOfficeState | District Office State (2 letters format) |
| DistrictOfficeZip | District Office Zip code |
| DistrictSupervisorName | District Office supervisor name |
| Permit Info | PermitApplicationDueDate | Permit application due date (yyyy-MM-dd HH:MM:SS) |
|---|
| PermitCategory | Permit category |
| PermitComments | Permit comments |
| PermitEffectiveDate | Permit effective date (yyyy-MM-dd HH:MM:SS) |
| PermitExpireDate | Permit expiry date (yyyy-MM-dd HH:MM:SS) |
| PermitIsAfterTheFact | Permit is after the fact (1 or 0 value) |
| PermitIssueDate | Permit issue date (yyyy-MM-dd HH:MM:SS) |
| PermitNumber | Permit number |
| PermitNumberAndVersion | Permit number and version eg. (PRMT0001 v 1.0) |
| PermitRevision | permit revision, this is the first decimal after the version (x.1) |
| PermitStatus | Permit status |
| PermitTerminationDate | Permit Termination Date (yyyy-MM-dd HH:MM:SS) |
| PermitType | Permit Type |
| PermitVersion | Permit Version this is the major version before the decimal (1.x) |
Image Removed Schedule | Schedules_IsReoccurring | Schedules is Reoccurring (1 and 0 value) |
|---|
| Schedules_NumDaysBeforeDueAllowSubmission | Number of Days before schedule submission is allowed |
| Schedules_ScheduleAchievedDate | Schedule achieved date (yyyy-MM-dd HH:MM:SS) |
| Schedules_ScheduleDecisionDate | Schedule decision date (yyyy-MM-dd HH:MM:SS) |
| Schedules_ScheduleDueDate | Schedule due date (yyyy-MM-dd HH:MM:SS) |
| Schedules_ScheduleDueDateTypeDescription | Type of schedule due date (as needed, specific due date, etc..) |
| Schedules_ScheduleGroupName | Schedule group name |
| Schedules_ScheduleName | Schedule name |
| Schedules_ScheduleReceivedDate | Schedule received date (yyyy-MM-dd HH:MM:SS) |
| Schedules_ScheduleSequenceNumber | Schedule sequence number |
| Schedules_ScheduleStatusDescription | Schedule status description (Received, Not Submitted, etc..) |
| Schedules_SubmissionDecisionDate | Schedule submission decision date (yyyy-MM-dd HH:MM:SS) |
| Schedules_SubmissionDecisionDescription | Schedule submission decision description |
| Schedules_SubmissionReceivedDate | Schedule submission received date (yyyy-MM-dd HH:MM:SS) |
| Schedules_SubmissionVersionNumber | Schedule submission version number |
| Site | SiteAddress | Site full address, Address Line 1 Address Line 2 City, State Zip-Code |
|---|
| SiteAddress1 | Site address line 1 |
| SiteAddress2 | Site address line 2 |
| SiteAddressComments | Site address comments |
| SiteCity | Site city |
| SiteNaicsList | North American Industry Classification System Code (NAICS) |
| SiteName | Site name |
| SiteNumber | Site number |
| SiteOwnrshType | Site ownership type |
| SiteSicList | Standard Industrial Classification Code (SIC) |
| SiteState | Site state (2 letters format) |
| SiteTaxParcelNumber | Site tax parcel number |
| SiteZip | Site zip code |
Image Removed Site Alt Name | SiteAltNames_SiteAltName | Site alternative name |
|---|
| SiteAltNames_SiteAltNameTypeCode | Site alternative name type code |
| SiteAltNames_SiteAltNameTypeDescription | Site Alternative Name Description (Master ID, Historical Name, etc..) |
| Site Location | SiteCounty | Site county |
|---|
| SiteFipsCode | Site FIPS Code (Federal Information Processing Standard) |
| SiteLatitude | Site location Latitude |
| SiteLongitude | Site location Longitude |
| Submission Info | SubmissionActionType | Submission Type (Application, Permit Change, etc..) |
|---|
| SubmissionCompleteDate | Submission completed date (yyyy-MM-dd HH:MM:SS) |
| SubmissionFormName | Submission form name |
| SubmissionFormNumber | nFORM submission number |
| SubmissionFormType | Submission form type |
| SubmissionProjectName | Submission project name |
| SubmissionReceivedDate | Submission received date (yyyy-MM-dd HH:MM:SS) |
| SubmissionReferenceNumber | Submission referenced number |
| System Info | AgencyAcronym | Agency Acronym |
|---|
| AgencyFullName | Agency full name |
| SystemContactUrl | Agency website for contact information |
| SystemIsProduction | System is Production (1 or 0 values) |
| SystemName | System name |
| SystemUrl | Website link to the system |
| Ui expand |
|---|
|
The view name for this data source in database is VW_SVC_DATASRC_EVAL_STDRD_NOPARSE
| Subject Area | Insertable Field Name | Description |
|---|
| Assigned Staff | EvaluationAssignedUserDisplayName | Inspector display name |
|---|
| EvaluationAssignedUserEmail | Inspector email |
| EvaluationAssignedUserFirstName | Inspector first name |
| EvaluationAssignedUserLastName | Inspector last name |
| EvaluationAssignedUserOrganization | inspector organization |
| EvaluationAssignedUserPhone | Inspector Phone formatted with Extension if available |
| EvaluationAssignedWorkgroupName | Inspector work group |
| EvaluationAssignedWorkgroupSupervisorName | Inspector work group supervisor name |
Compliance InfoComplianceActionCaseNumber | Compliance action case number | | ComplianceActionCategory | Compliance action category |
| ComplianceActionDate | Compliance action date (yyyy-MM-dd HH:MM:SS) |
| ComplianceActionNumber | Compliance action number |
| ComplianceActionProgramArea | Compliance action program area |
| ComplianceActionResolutionDate | Compliance action resolution date (yyyy-MM-dd HH:MM:SS) |
| ComplianceActionResolutionDescription | Compliance action resolution description |
| ComplianceActionStatus | Compliance action status |
| ComplianceActionType | Compliance action type |
Image Removed Contact | Contacts_AffiliationTypeCode | Contact Affiliation Code, a List of types is configured in Admin → Lookups → Affiliation Types (Roles) |
|---|
| Contacts_AffiliationTypeDescription | Contact Affiliation Description, a List of types is configured in Admin → Lookups → Affiliation Types (Roles) |
| Contacts_ContactAddress1 | Contact Address Line 1 |
| Contacts_ContactAddress2 | Contact Address Line 2 |
| Contacts_ContactCity | Contact City |
| Contacts_ContactCityStateZip | City, State Zip Code (Portland, OR 97239) |
| Contacts_ContactEmail | Contact Email |
| Contacts_ContactFirstName | Contact First Name |
| Contacts_ContactLastName | Contact Last Name |
| Contacts_ContactName | Contact Display Name |
| Contacts_ContactOrganizationName | Contact Organization Name |
| Contacts_ContactPhone | Contact Phone |
| Contacts_ContactPhoneExtension | Contact Phone Extension |
| Contacts_ContactPhoneTypeDescription | Phone Type (Home, Mobile, etc..) |
| Contacts_ContactPrefix | Contact Prefix (Mr, Ms, Mrs., etc.) |
| Contacts_ContactState | Contact State (2 letters format) |
| Contacts_ContactTitle | Contact Title |
| Contacts_ContactZipCode | Contact Zip Code |
| Contacts_FunctionalAreaId | Functional Area Id |
Permittee and Inspection Contact (Tag associated with this Field??) | InspectionContactAddress1 | Facility inspection contact address line 1 |
|---|
| InspectionContactAddress2 | Facility inspection contact address line 2 |
| InspectionContactCity | Facility inspection contact city |
| InspectionContactFirstName | Facility inspection contact first name |
| InspectionContactLastName | Facility inspection contact last name |
| InspectionContactName | Facility inspection contact display name |
| InspectionContactOrganization | Facility inspection contact organization name |
| InspectionContactPhone | Facility inspection contact Phone formatted with Extension if available |
| InspectionContactPrefix | Facility inspection contact name Prefix (Mr, Ms, Mrs., etc.) |
| InspectionContactState | Facility inspection contact state (2 letters format) |
| InspectionContactTitle | Facility inspection contact title |
| InspectionContactZip | Facility inspection contact zip code |
| PermitteeAddress1 | Permittee address line 1 |
| PermitteeAddress2 | Permittee address line 2 |
| PermitteeCity | Permittee address city |
| PermitteeFirstName | Permittee first name |
| PermitteeLastName | Permittee last name |
| PermitteeName | Permittee display name |
| PermitteeOrganization | Permittee organization name |
| PermitteePhone | Permittee Phone formatted with Extension if available |
| PermitteePrefix | Permittee name Prefix (Mr, Ms, Mrs., etc.) |
| PermitteeState | Permittee state (2 letters format) |
| PermitteeTitle | Permittee title |
| PermitteeZip | Permittee zip code |
| District Office | DistrictOfficeAddress | Agency district office full address Address Line 1 Address Line 2 City, State Zip-Code |
|---|
| DistrictOfficeAddress1 | Agency district office address line 1 |
| DistrictOfficeAddress2 | Agency district office address line 2 |
| DistrictOfficeCity | Agency district office city |
| DistrictOfficeFax | Agency district office fax number |
| DistrictOfficeName | Name of District Office (Based on County defined in District Office Lookups) |
| DistrictOfficePhone | Agency district office Phone formatted with Extension if available |
| DistrictOfficeState | Agency district office state (2 letters format) |
| DistrictOfficeZip | Agency district office zip code |
| DistrictSupervisorName | Agency district office supervisor name |
| Evaluation Info | EvaluationComments | Evaluation comments |
|---|
| EvaluationDecision | Evaluation decision |
| EvaluationDecisionDate | Evaluation decision date (yyyy-MM-dd HH:MM:SS) |
| EvaluationEndDate | Evaluation end date (yyyy-MM-dd HH:MM:SS) |
| EvaluationNumber | Evaluation number |
| EvaluationReportTransmittedDate | Evaluation report transmitted date (yyyy-MM-dd HH:MM:SS) |
| EvaluationSamplesTransmittedDate | Evaluation samples transmitted date (yyyy-MM-dd HH:MM:SS) |
| EvaluationScheduledDate | Evaluation scheduled date (yyyy-MM-dd HH:MM:SS) |
| EvaluationStartDate | Evaluation start date (yyyy-MM-dd HH:MM:SS) |
| EvaluationStatus | Evaluation status |
| EvaluationStatusDescription | Evaluation status description |
| EvaluationType | Evaluation type |
| Permit Info | PermitApplicationDueDate | Permit application due date (yyyy-MM-dd HH:MM:SS) |
|---|
| PermitCategory | Permit category |
| PermitComments | Permit comments |
| PermitEffectiveDate | Permit effective date (yyyy-MM-dd HH:MM:SS) |
| PermitExpireDate | Permit expire date (yyyy-MM-dd HH:MM:SS) |
| PermitIsAfterTheFact | Permit is after the fact (1 or 0 value) |
| PermitIssueDate | Permit issue date (yyyy-MM-dd HH:MM:SS) |
| PermitNumber | Permit number |
| PermitNumberAndVersion | Permit number and version eg. (PRMT0001 v 1.0) |
| PermitRevision | permit revision, this is the first decimal after the version (x.1) |
| PermitStatus | Permit status |
| PermitTerminationDate | Permit termination date (yyyy-MM-dd HH:MM:SS) |
| PermitType | Permit type |
| PermitVersion | Permit Version this is the major version before the decimal (1.x) |
| Project Info | MasterProjectEnvironmentalEventDate | Master Environmental project event date (yyyy-MM-dd HH:MM:SS) |
|---|
| MasterProjectName | Master project name |
| MasterProjectNumber | Master project number |
| ProjectActivityCategory | Project activity category |
| ProjectActivityEndDate | Project activity end date (yyyy-MM-dd HH:MM:SS) |
| ProjectActivityName | Project activity name |
| ProjectActivityNumber | Project activity number |
| ProjectActivityStartDate | Project activity start date (yyyy-MM-dd HH:MM:SS) |
| ProjectActivityStatus | Project activity status |
| ProjectActivityType | Project activity type |
| Site | SiteAddress | Site full address Site Address Line 1 Site Address Line 2 City, State zip-code |
|---|
| SiteAddress1 | Site address line 1 |
| SiteAddress2 | Site address line 2 |
| SiteAddressComments | Site address comments |
| SiteCity | Site city |
| SiteNaicsList | North American Industry Classification System Code (NAICS) |
| SiteName | Site name |
| SiteNumber | Site number |
| SiteOwnrshType | Site ownership type |
| SiteSicList | Standard Industrial Classification Code (SIC) |
| SiteState | Site state (2 letters format) |
| SiteTaxParcelNumber | Site tax parcel number |
| SiteZip | Site zip-code |
Image Removed
Site Alt NameSiteAltNames_SiteAltName | Site alternative name | | SiteAltNames_SiteAltNameTypeCode | Site alternative name type code |
| SiteAltNames_SiteAltNameTypeDescription | Site Alternative Name Description (Master ID, Historical Name, etc..) |
| Site Location | SiteCounty | Site county |
|---|
| SiteFipsCode | Site FIPS Code (Federal Information Processing Standard) |
| SiteLatitude | Site location Latitude |
| SiteLongitude | Site location Longitude |
| Submission Info | SubmissionActionType | Submission Type (Application, Permit Change, etc..) |
|---|
| SubmissionCompleteDate | Submission completed date (yyyy-MM-dd HH:MM:SS) |
| SubmissionFormName | Submission form name |
| SubmissionFormNumber | nFORM submission number |
| SubmissionFormType | Submission form type |
| SubmissionProjectName | Submission project name |
| SubmissionReceivedDate | Submission received date (yyyy-MM-dd HH:MM:SS) |
| SubmissionReferenceNumber | Submission referenced number |
| System Info | AgencyAcronym | Agency Acronym |
|---|
| AgencyFullName | Agency full name |
| SystemContactUrl | Agency website for contact information |
| SystemIsProduction | System is Production (1 or 0 values) |
| SystemName | System name |
| SystemUrl | Website link to the system |
Image Removed Violation | Violations_DetectEndDate | Violation end date (yyyy-MM-dd HH:MM:SS) |
|---|
| Violations_DetectStartDate | Violation start date (yyyy-MM-dd HH:MM:SS) |
| Violations_Id | Violation system id |
| Violations_IsSignificantNonCompliance | Violation is significant non compliance (1 or 0 value) |
| Violations_RegulationReference | Violation regulation reference |
| Violations_ViolationCategoryDescription | Violation category description |
| Violations_ViolationComments | Violation comments |
| Violations_ViolationId | Violation id |
| Violations_ViolationTypeDescription | Violation type description |
| Ui expand |
|---|
|
The view name for this data source in database is VW_SVC_DATASRC_CMPL_ACTN_STDRD_NOPARSE
| Subject Area | Insertable Field Name | Description |
|---|
| Assigned Staff | ComplianceActionAssignedUserDisplayName | Compliance Action assigned user Display Name |
|---|
| ComplianceActionAssignedUserEmail | Compliance Action assigned user Email |
| ComplianceActionAssignedUserFirstName | Compliance Action assigned user First Name |
| ComplianceActionAssignedUserLastName | Compliance Action assigned user Last Name |
| ComplianceActionAssignedUserOrganization | Compliance Action assigned user Organization |
| ComplianceActionAssignedUserPhone | Compliance Action assigned user Phone formatted with Extension if available |
| ComplianceActionAssignedWorkgroupName | Compliance Action assigned user Workgroup Name |
| ComplianceActionAssignedWorkgroupSupervisorName | Compliance Action assigned user Workgroup Supervisor Name |
| Compliance Info | ComplianceActionCaseNumber | Compliance Action Case Number |
|---|
| ComplianceActionCategory | Compliance Action Category |
| ComplianceActionComments | Compliance Action Comments |
| ComplianceActionDate | Compliance Action date (yyyy-MM-dd HH:MM:SS) |
| ComplianceActionNumber | Compliance Action Number |
| ComplianceActionProgramArea | Compliance Action Program Area |
| ComplianceActionResolutionDate | Compliance Action Resolution date (yyyy-MM-dd HH:MM:SS) |
| ComplianceActionResolutionType | Compliance Action Resolution Type |
| ComplianceActionStatus | Compliance Action Status |
| ComplianceActionType | Compliance Action Type |
 Image Removed
Contact | Contacts_AffiliationTypeCode | Contact Affiliation Code, a List of types is configured in Admin → Lookups → Affiliation Types (Roles) |
|---|
| Contacts_AffiliationTypeDescription | Contact Affiliation Description, a List of types is configured in Admin → Lookups → Affiliation Types (Roles) |
| Contacts_ContactAddress1 | Contact Address Line 1 |
| Contacts_ContactAddress2 | Contact Address Line 2 |
| Contacts_ContactCity | Contact City |
| Contacts_ContactCityStateZip | City, State Zip Code (Portland, OR 97239) |
| Contacts_ContactEmail | Contact Email |
| Contacts_ContactFirstName | Contact First Name |
| Contacts_ContactLastName | Contact Last Name |
| Contacts_ContactName | Contact Display Name |
| Contacts_ContactOrganizationName | Contact Organization Name |
| Contacts_ContactPhone | Contact Phone |
| Contacts_ContactPhoneExtension | Contact Phone Extension |
| Contacts_ContactPhoneTypeDescription | Phone Type (Home, Mobile, etc..) |
| Contacts_ContactPrefix | Contact Prefix (Mr, Ms, Mrs., etc.) |
| Contacts_ContactState | Contact State (2 letters format) |
| Contacts_ContactTitle | Contact Title |
| Contacts_ContactZipCode | Contact Zip Code |
| Contacts_FunctionalAreaId | Functional Area Id |
Responsible Party Contact (Tag associated with this Field??) | ResponsiblePartyAddress1 | Responsible Party Address line 1 |
|---|
| ResponsiblePartyAddress2 | Responsible Party Address line 2 |
| ResponsiblePartyCity | Responsible Party City |
| ResponsiblePartyFirstName | Responsible Party First Name |
| ResponsiblePartyLastName | Responsible Party Last Name |
| ResponsiblePartyName | Responsible Party Name |
| ResponsiblePartyOrganization | Responsible Party Organization |
| ResponsiblePartyPhone | Responsible Party Phone formatted with Extension if available |
| ResponsiblePartyPrefix | Responsible Party Prefix (Mr, Ms, Mrs., etc.) |
| ResponsiblePartyState | Responsible Party State (2 letters format) |
| ResponsiblePartyTitle | Responsible Party Title |
| ResponsiblePartyZip | Responsible Party Zip |
| District Office | DistrictOfficeAddress | Agency district office full address Address Line 1 Address Line 2 City, State Zip-Code |
|---|
| DistrictOfficeAddress1 | Agency district office address line 1 |
| DistrictOfficeAddress2 | Agency district office address line 2 |
| DistrictOfficeCity | Agency district office city |
| DistrictOfficeFax | Agency district office fax number |
| DistrictOfficeName | Name of District Office (Based on County defined in District Office Lookups) |
| DistrictOfficePhone | Agency district office Phone formatted with Extension if available |
| DistrictOfficeState | Agency district office state (2 letters format) |
| DistrictOfficeZip | Agency district office zip code |
| DistrictSupervisorName | Agency district office supervisor name |
| Evaluation Info | EvaluationComments | Evaluation comments |
|---|
| EvaluationDecision | Evaluation decision |
| EvaluationDecisionDate | Evaluation decision date (yyyy-MM-dd HH:MM:SS) |
| EvaluationEndDate | Evaluation end date (yyyy-MM-dd HH:MM:SS) |
| EvaluationNumber | Evaluation number |
| EvaluationReportTransmittedDate | Evaluation report transmitted date (yyyy-MM-dd HH:MM:SS) |
| EvaluationSamplesTransmittedDate | Evaluation samples transmitted date (yyyy-MM-dd HH:MM:SS) |
| EvaluationScheduledDate | Evaluation scheduled date (yyyy-MM-dd HH:MM:SS) |
| EvaluationStartDate | Evaluation start date (yyyy-MM-dd HH:MM:SS) |
| EvaluationStatus | Evaluation status |
| EvaluationStatusDescription | Evaluation status description |
| EvaluationType | Evaluation type |
| Permit Info | PermitApplicationDueDate | Permit application due date (yyyy-MM-dd HH:MM:SS) |
|---|
| PermitCategory | Permit category |
| PermitComments | Permit comments |
| PermitEffectiveDate | Permit effective date (yyyy-MM-dd HH:MM:SS) |
| PermitExpireDate | Permit expire date (yyyy-MM-dd HH:MM:SS) |
| PermitIsAfterTheFact | Permit is after the fact (1 or 0 value) |
| PermitIssueDate | Permit issue date (yyyy-MM-dd HH:MM:SS) |
| PermitNumber | Permit number |
| PermitNumberAndVersion | Permit number and version eg. (PRMT0001 v 1.0) |
| PermitRevision | permit revision, this is the first decimal after the version (x.1) |
| PermitStatus | Permit status |
| PermitTerminationDate | Permit termination date (yyyy-MM-dd HH:MM:SS) |
| PermitType | Permit type |
| PermitVersion | Permit Version this is the major version before the decimal (1.x) |
Image Removed Schedule | Schedules_IsReoccurring | Schedules is Reoccurring (1 and 0 value) |
|---|
| Schedules_NumDaysBeforeDueAllowSubmission | Number of Days before schedule submission is allowed |
| Schedules_ScheduleAchievedDate | Schedule achieved date (yyyy-MM-dd HH:MM:SS) |
| Schedules_ScheduleDecisionDate | Schedule decision date (yyyy-MM-dd HH:MM:SS) |
| Schedules_ScheduleDueDate | Schedule due date (yyyy-MM-dd HH:MM:SS) |
| Schedules_ScheduleDueDateTypeDescription | Type of schedule due date (as needed, specific due date, etc..) |
| Schedules_ScheduleGroupName | Schedule group name |
| Schedules_ScheduleName | Schedule name |
| Schedules_ScheduleReceivedDate | Schedule received date (yyyy-MM-dd HH:MM:SS) |
| Schedules_ScheduleSequenceNumber | Schedule sequence number |
| Schedules_ScheduleStatusDescription | Schedule status description (Received, Not Submitted, etc..) |
| Schedules_SubmissionDecisionDate | Schedule submission decision date (yyyy-MM-dd HH:MM:SS) |
| Schedules_SubmissionDecisionDescription | Schedule submission decision description |
| Schedules_SubmissionReceivedDate | Schedule submission received date (yyyy-MM-dd HH:MM:SS) |
| Schedules_SubmissionVersionNumber | Schedule submission version number |
| Site | SiteAddress | Site full address Site Address Line 1 Site Address Line 2 City, State zip-code |
|---|
| SiteAddress1 | Site address line 1 |
| SiteAddress2 | Site address line 2 |
| SiteAddressComments | Site address comments |
| SiteCity | Site city |
| SiteNaicsList | North American Industry Classification System Code (NAICS) |
| SiteName | Site name |
| SiteNumber | Site number |
| SiteOwnrshType | Site ownership type |
| SiteSicList | Standard Industrial Classification Code (SIC) |
| SiteState | Site state (2 letters format) |
| SiteTaxParcelNumber | Site tax parcel number |
| SiteZip | Site zip-code |
Image Removed Site Alt Name | SiteAltNames_SiteAltName | Site alternative name |
|---|
| SiteAltNames_SiteAltNameTypeCode | Site alternative name type code |
| SiteAltNames_SiteAltNameTypeDescription | Site Alternative Name Description (Master ID, Historical Name, etc..) |
| Site Location | SiteCounty | Site county |
|---|
| SiteFipsCode | Site FIPS Code (Federal Information Processing Standard) |
| SiteLatitude | Site location Latitude |
| SiteLongitude | Site location Longitude |
| Submission Info | SubmissionActionType | Submission Type (Application, Permit Change, etc..) |
|---|
| SubmissionCompleteDate | Submission completed date (yyyy-MM-dd HH:MM:SS) |
| SubmissionFormName | Submission form name |
| SubmissionFormNumber | nFORM submission number |
| SubmissionFormType | Submission form type |
| SubmissionProjectName | Submission project name |
| SubmissionReceivedDate | Submission received date (yyyy-MM-dd HH:MM:SS) |
| SubmissionReferenceNumber | Submission referenced number |
| System Info | AgencyAcronym | Agency Acronym |
|---|
| AgencyFullName | Agency full name |
| SystemContactUrl | Agency website for contact information |
| SystemIsProduction | System is Production (1 or 0 values) |
| SystemName | System name |
| SystemUrl | Website link to the system |
Image Removed Violation | Violations_DetectEndDate | Violation end date (yyyy-MM-dd HH:MM:SS) |
|---|
| Violations_DetectStartDate | Violation start date (yyyy-MM-dd HH:MM:SS) |
| Violations_Id | Violation system id |
| Violations_IsSignificantNonCompliance | Violation is significant non compliance (1 or 0 value) |
| Violations_PermitNumberAndVersion | Violation related Permit number and version eg. (PRMT0001 v 1.0) |
| Violations_RegulationReference | Violation regulation reference |
| Violations_SourceEvaluationNumber | Violation source evaluation number |
| Violations_ViolationCategoryDescription | Violation category description |
| Violations_ViolationComments | Violation comments |
| Violations_ViolationId | Violation id |
| Violations_ViolationTypeDescription | Violation type description |
On this page
Sub-Topics
| Page Tree |
|---|
root | @selfOverview
This section provides details on how to view, edit, and configure document template metadata and content. Document template contents are edited using the AceOffix editor.
To edit template metadata:
Navigate to Admin > Document Templates.
Click Open next to an existing template or select Add New Document Template to create a new one.
The document template metadata editor page is displayed.
Image AddedConfigurable Fields on the Document Template Page
The following key fields are available when configuring a document template:
Field | Description |
|---|
Template Name | The name of the document template. |
Template Description | An internal description of the template. |
Security Classification | Defines visibility (Public, Internal, Authorized Users). |
Functional Area | Specifies the category of the document (Permit, Compliance Action, etc.). |
Document Category | Groups templates based on predefined categories. |
Program Area | Determines applicable programs for the template. This value is derived from the selected Document Category. |
Base Datasource | Defines the merge field list available for the template. |
Dynamic Datasources | Specifies the forms and reports whose fields can be merged. The available forms depend on the document template's functional area: For document templates in the application/request, complaint/incident, or schedule functional areas, submission forms within those functional areas and permit, submission, and site program component forms can be selected. For document templates in the permit functional area, application/request forms and permit, submission, and site program component forms can be selected. For document templates in the site functional area, application/request forms and program component forms from any functional area can be selected. For document templates in the compliance action functional area, compliance action and site program component forms can be selected. For document templates in the evaluation functional area, evaluation and site program component forms can be selected. For document templates in the project functional area, project and site program component forms can be selected. For document templates in the receivable functional area, permit program component forms can be selected.
|
Right Sidebar | |
Active/Inactive | Controls whether the template is available for use. When saving changes to an active document template in a production environment, a dialog box that prompts the user to provide a description of the edits made. |
Allow multiple documents to be finalized | If unchecked, only one generated document based on this template is allowed for a given entity. |
Auto-create event upon finalization | If checked, an event will be created with the Event Type "Document Generated" when a document is generated using this template. Notifications can also be configured to be sent when an event is created. A System Action will need to be created for the corresponding Functional Area Event. |
Allow security classification changes | When checked, the security classification of documents generated from this template may be changed. When unchecked, documents that have been generated from this template cannot have their security classification changed. |
Allow file name changes | If checked, users will be given the option to type a name for the generated document before it is generated. If unchecked, the name of the generated document will be the same as the template name. |
Prefix Generated File Name with Record Identifier | Prefixes the generated document name with the current record’s business identifier (e.g. Permit Number, Compliance Action Number, Site Number, etc). |
View History | Displays metadata changes over time. |
Previewing a Document with Merged Data
Clicking Preview opens a read-only version of the document with actual data merged from the selected source.
Editing Document Template Content using AceOffix
To edit template content:
Navigate to Admin > Document Templates.
Click Open next to an existing template or select Add New Document Template to create a new one.
Click Edit to modify the document content.
The template opens in an AceOffix window, displaying the document as an editable Word file along with a list of available merge fields.
When the AceOffix editor is open, a popup window will indicate that AceOffix is running separately from the main application.
Image AddedInsertable Fields
Templates contain insertable fields that dynamically merge data from the system:
Single Insertable Fields: Appear in non-bold text and are inserted as placeholders (e.g., <<[FieldName]>>).
Looping Insertable Fields: Appear in bold text and represent repeating data structures (e.g., a list of contacts). These use <<foreach [item in items]>> … <</foreach>> syntax.
The available fields are driven by the selected datasources on the document template metadata page (see above).
To insert a field:
Double-click a non-bold field to insert it at the cursor location.
Double-click a bold field to insert a loop structure.
Click a bold field once to display its available subfields.
For more information on looping and advanced syntax, see Using Loops in Document Templates.
Variables, Formulas, Formatting Content and Controlling Logic
The Document Template editor is a powerful tool that can regenerate complicated documents based on logic and data sources. It can also perform data manipulation and calculations. Some of the codes that could be used in a document template can be found at Document Template Syntax Guide page
On this page
Related Content
