KBA-01606: Overview of the VXLConfig Rule Group

Overview:

The VXLConfig rules configure options for data exchange via a Microsoft Excel worksheet.

The VXLConfig rule group is found in the Rules Maintenance tool on the System Admin Dashboard. Each rule in the group consists of a rule name, a filter value (which can be blank) and a result value.


Filter Values:

Any Doc type

The VXLConfig rules accept any Doc type (as defined in the Doc Types tool and appearing on the filter drop-down) as the filter value, except where noted.


Result Values:

Varies

Result values for the VXLConfig rules depend on the rule and are indicated within the description of each rule. Some rules are enabled and disabled through a checkbox in the result value, for example:

checkbox result value


Rules:

Enabled

Specifies (in the result value checkbox) whether the  (see ImportSheet) sheet should be imported to create/update items on the document.  This is similar to using the Spitfire ViaExcel method menu command.    (See also ImportCIEnabled below.)

  • unchecked = No.  Some processing time is saved.  Recommended for Doc Types where many or large workbooks are attached and the import feature is not relevant.
  • checked = Yes (default).

Note: Only one option (Enabled or ImportCIEnabled) should be configured for a specific Doc Type.

ExportEnabled 

[V2020+] Specifies (in the result value checkbox) whether the Excel Attachments on documents of this type should be have data refreshed.  The ImportSheet is included in the refresh.

  • unchecked = No.  (default).
  • checked = Yes

ForwardLookingRows

Specifies (in the result value) the number of consecutive blank rows that can be found in an import worksheet without stopping the import.  It is necessary to recycle the application in order for a change to this value to take effect. Default is 399.  If you specify a value greater than 400, you should specify the total number of rows expected in the import.

ImportAutoLoad  

[V2020+] Specifies (in the result value checkbox) whether the Microsoft Excel Attachments on documents with ImportEnabled (or ImportCIEnabled) should always be loaded automatically without an additional prompt.

  • unchecked = No. Import worksheets will continue to prompt “load now?”
  • checked = Yes (default).

ImportCIEnabled

Specifies (in the result value checkbox) whether the “Change Item budget import from Microsoft Excel” feature (using the BFA Budget mapping method) is enabled for this document type.  (See also Enabled above for items)  Typically only applicable to Change Order and Potential Change Order document types. Requires a BFA Import map defined for your Doc Type.

  • unchecked = No.  Some processing time is saved.  Recommended for Doc Types where many or large workbooks are attached and the import feature is not relevant.
  • checked = Yes (default).

Note: If ImportCIEnabled is Yes for specific Doc Type, the Enabled option must be set to No.

ImportCIRevenueSummary

Specifies (in the result value) whether the Change Items importing revenue should combine all revenue lines into a single revenue line at the end of the import.  This rule is not filtered.

  • unchecked = No.
  • checked = Yes (default).

ImportCIRunAllocations

Specifies (in the result value) whether the CI Budget Entries’ Run Allocations feature should be enabled for Change Items that are loaded via import from a worksheet.  This rule is not filtered.

    • 0 = No (default). Disable the Run Allocations menu choice.
    • 1 = Yes. Enable the Run Allocations menu choice.
    • Always = Automatically run allocations immediately after the import of Change Items.

ImportCISheet

Specifies (in the result value) the name of the worksheet in the workbook from which CI data will be imported.  The default is SpitfireImportData.

ImportCIViaCommitment:AccountCategory

Specifies (in the result value) whether the Change Items imported with the specified Account Category should create commitment-related tasks as follows: a CCO if a single existing Commitment exists for the cost code, otherwise, a new Commitment. By default, the account category specified by WBAConfig | Subcontract is handled automatically without this rule. This rule is not filtered.

  • unchecked = No (default for most account category).  The imported line will be “Self Perform.”
  • checked = Yes. (default for account category in WBAConfig | Subcontract)

ImportRecalc

[V2020+] Specifies (in the result value) which Cost Code-related Item field should be used as the basis for recalculating the other Item fields after an import.  Default is 0.

  • 0 – No recalculation (default)
  • Amt – recalculate based on total gross amount (sum of work and materials)(TO_DocItemTask_RevenueAmount)
  • Pct – recalculate based on percent (To_SPRLineDetails_TotalPercentRequest)
  • Units – based on Quantity (To_DocItemTask_Quantity)
  • Work -recalculate based on WorkAmount (To_DocItemTask_WorkAmount)
  • Materials – recalculate based on StoredAmount (To_DocItemTask_StoredAmount)

ImportSheet

Specifies (in the result value) the name of the worksheet in the workbook from which document item data will be imported.  [V2020+] If the name is in the format Sheet1, then the internal sheet code name is used.  Otherwise, the Excel sheet display name is used.   The default is ToSpitfire, which is a sheet display name.

 UseWBAConfigSubcontract

Specifies (in the result value) whether the Account Category specified in the WBAConfig | Subcontract rule will be automatically treated as being “Via Commitment” during the Change Items import.  This rule is not filtered.

  • unchecked = No.  See ImportViaCommitment (above)
  • checked = Yes (default), thus no ImportViaCommitment:subcontract rule is required for this one account category.

Additional Comments:

 


KBA-01606; Last updated: June 2, 2020 at 12:07 pm;  green text = new