Blocworx Documentation
  • Welcome to Blocworx
  • The structure of Blocworx
    • What is a project?
  • Getting Started
  • How To's
    • How To's
      • Get Started: Build a Simple Module
      • Build a simple invoicing system
  • Page
    • Page Overview
      • Page Sections
      • Modules in Pages
      • Sub Pages
      • URL Links
    • Edit a Page
    • Manage Pages
  • Module
    • Module Overview
      • Module Sections
      • Blocs in Modules
      • Automated Reports
    • Module Editor
      • Add, remove and move Sections and Blocs
      • Edit Module Location & Icon
      • Edit Module Details
      • Import from another Module
      • Delete a Module
      • Make this module available to child instances
    • Manage Modules
  • Bloc
    • Bloc Overview
    • Bloc Front End Overview
      • Data Display
      • Advanced Reports
    • Bloc Editor Overview
    • Pdf & Doc File Template Builder
    • The Blocworx Process Flow
    • Edit Templates
  • Bloc Editor
    • Bloc Form Builder Preview
    • Fields, Tools and Charts
      • Standard Input Fields
        • QR Code
        • Text
        • Large Text Field
        • Checkbox
        • Multi Button
        • Dropdown from List
        • Date/Time Selector
        • Bluetooth (Beta)
        • Button
      • File & Image Fields
        • File Field
        • Multi File Field
        • Image URL Field
      • Linked Data Selection Fields
        • Dropdown from Bloc
        • Autocomplete
        • Radio Buttons From Bloc
        • Checkboxes From Bloc
        • Link Data Field
      • Content Editing Components
        • HTML Field
        • Separator Field
        • Content Editor For User (WYSIWYG)
        • Content Editor (WYSIWYG)
      • User Based Components
        • Create User Pop Up
        • Logged in Users Information
        • User Select Field
        • Signature & Authentication
      • Dynamic Output & Variable Components
        • Time/Date Difference
        • Auto Generate Field
        • Plain Data Field
        • Maths Field
        • Field Merge Builder
        • Label Field
        • Barcode Generator
      • Third Party Integration Components
        • Blocworx Gateway
        • Bartender Integration
        • File Builder
        • Mindee API
      • Charts, Results & Data Feeds
        • Local Data Doughnut Chart
        • Advanced Chart Set 1
        • Results Box
      • Sub Blocs, Tools & Components
        • Submit Button
        • Sub Bloc
        • Cross-Bloc Data Manipulator
        • Bloc List
        • Mail Alert
        • Calendar & Resource Planning
    • Field Create, Edit, Parameters, Rules and Actions
      • Creating a Field
      • Editing a Field
      • Field Parameters
        • Choose hidden options for this field
        • Mobile Configurations
        • Rule and Actions Based Parameters
        • Main Field Parameters
        • Conditional Value
        • Set Character View Limit
        • Conditional Visibility
        • Dynamic Data Update (Update Value Based On Another Date Field)
        • Field Names in Different Languages
        • Manage Field Actions
        • Load Data from Another Bloc
      • Field Rules and Actions
        • Can not be empty
        • Must Be Equal To
        • Cannot Be Equal To
        • Must be Between Two Values
        • Must be at least X number of characters
        • Must be exactly X number of characters
        • Item must have been entered elsewhere
        • Item must not have been entered elsewhere
        • A specific value is required elsewhere
        • A specific value cannot be present elsewhere
        • Populate another local field with data from elsewhere
        • Populate another local field with total from elsewhere
        • Max Allowed Duplicates
        • Can only be numbers/integers
        • Keep Data for Next Entry
        • Must be Certain Format
        • Cannot be Equal Another Local Field
        • Must be equal to another local field
        • Populate another local field with part of this field
        • Populate local field with data from another local field
        • Must have matching equivalent data in another form
    • Bloc Settings
      • Main Bloc Settings
      • Functional Behaviour Settings
      • Bloc Layout and Visibility Settings
      • Data Display Settings
      • User Restricted Data Settings
      • Manage and Build Templates
      • Bloc, User and Role Access
      • List of available Field Slugs
      • Manage Bloc Scheduler
  • Manage Data
    • Manage Data Overview
    • Raw Data and Counting Reports
    • Look Up/Edit Data
    • Find and Replace Data
  • Administration
    • Admin & Development Overview
    • Manage Users
      • Profile Filter
    • Roles & Permissions
      • Roles
      • Permissions
    • Manage Mail Alerts
  • App Settings
    • Sign In With Google
    • Timeout Setting
  • No Code Development
    • Manage Blocworx Instances
      • Parent and Child Instances
    • Edit Theme
    • Manage Modules
    • Manage Pages
    • Extra and Beta Features
Powered by GitBook
On this page

Was this helpful?

  1. Bloc Editor
  2. Fields, Tools and Charts
  3. Third Party Integration Components

File Builder

PreviousBartender IntegrationNextMindee API

Last updated 9 months ago

Was this helpful?

The File Builder Field is designed to retrieve data from a bloc and build a file with this data that then gets added to a location on the server. This is useful for integrations with hardware or other software.

The result of the file is a list of records with a | symbol as a seperator and at the top of the file as column names. It works in a similar way to our field but is designed to retrieve lists of data based on search filters as opposed to building a file that contains the values that are on the bloc itself at the time of file building.

Note: As this field is based on adding files to the server, it will require you to work with the Blocworx team for achieving your integration with the file that has been created.

Coming Soon: The ability to download the file directly to your computer , as opposed to simply adding the file to a location on the server. This will give you total control and will t require involvement from our team.

Initial Field Parameters

Parameter
Description

Type Filename with Extension

This is the file that will be created, e.g. myfile.txt

Path

The file will be stored on the hosted server of Blocworx. The path chosen here is relative to our own predetermined path. As mentioned above, you will need to work with our team to complete this field.

Button Text

This is the text that will appear on the button that triggers the generation of the file.

Button Colour

This is the colour of the button that will trigger the generation of the file.

Data Source, Select Bloc

This is used to choose the bloc you want to get the data from. (You can use the same bloc that you are building the field on)

Local Field to Check and Field to Look Up

These are the matching pairs that must occur so it can determine what data to find. It uses the value in the local field (the field on the bloc you are on) and searches the values of the field in the bloc you are loading the data from.

Fields to Show on the file.

This is where you can add the fields that should appear on the file. You must select fields here otherwise the file will be empty. This feature is to prevent unwanted data in the file and gives you more freedom to build the file in the structure you would like to build it.

field slugs
Bartender Integration
A typical dataset generated by the field into a file