Page tree

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 28 Next »

This is the documentation for ConfiForms Server/Data Center app

However, this might also work for ConfiForms cloud and in most cases it does. But please see this page to understand the differences between server and cloud versions of the ConfiForms app.


  • What is ConfiForms?
    ConfiForms is an add-on for Atlassian Confluence which helps you to build and manage data entry forms.


  • Who develops ConfiForms and how I can get help?
    ConfiForms add-on is developed and maintained by Vertuna LLC, established in 2005 and based in Estonia, Tallinn. We are Atlassian Verified partner since 2015

    You can contact us directly via the button below and we aim to answer you within 48 hours, but in most cases much faster (smile)




  • Where ConfiForms stores data?
    ConfiForms stores data in page metadata table called OS_PROPERTYENTRY. Internally the data is stored as XML. As the data is stored as page metadata it becomes a part of Confluence standard backup and restrore procedure. But this also introduces the limits - we are able store (within one form) as much as the "text_val" field in "OS_PROPERTYENTRY" table can accomodate. You can have multiple ConfiForms, this limit is per form. For example, when Confluence uses MySQL database then this field type is MEDIUMTEXT which has a limit of 16MBs (which you can easily ALTER to be of a larger size). 

  • What is storage format?

    When we ask you to provide us with a storage format for your page configuration - here is what we mean.

    It allows us to import the contents directly to our test server and see exactly the configuration you have, and to help you with troubleshooting the issues you might have, a lot faster.


  • How to see the version of ConfiForms

    This is easy when you already have a form (ConfiForms Form macro). It requires you to do the following 2 steps



  • How many records could I save into ConfiForms?
    We do not have any hard limits but you have to understand that ConfiForms is not a replacement to JIRA and storing support cases in thousands and having hundreds of concurrent users accessing the same forms datasets is not what it is designed for. However, we have seen installations where ConfiForms holds 5000+ records in one form. Not recommended, but possible (See also the Q/A above). We suggest to split your data into multiple forms, have an archiving in-place using IFTTT macro and try to keep your busy ConfiForms with small datasets. Please also note that complex forms with many fields (like 100+) will need more space to hold for one record.

    Some numbers to share (very old, and has been improved with new releases):

    Records #Fields #Data sizeForm renderedAdmin UI all recordsRendered size (of HTML for admin UI)All records filtered by one field, no edit controlsAll records with sorting (3 fields) with Edit controlsAll records,  no sorting, no Edit controlsPaged view, 50 records per page sorted, and with edit controlsPaged view, 50 records per page sorted, and no edit controls
    1564172.5MB0.15 sec32 sec 12 sec300 kb6 sec50 sec8.5 sec0.9 sec0.6 sec

    This tests were executed on a very low-end machine, with 2GB of RAM total, shared VM on SSD, having the PostgreSQL database on the same machine, 1 core, Linux CentOS 7
    Updated results for AdminUI loading of 1564 records: ConfiForms version 1.26.2+ (optimizations of edit controls rendering)


  • I have a feature request - what shall I do?
    Yes, please share it with us! We are very customer driven and love to hear your feedback. As only the feedback you gave us helps us to built the product you want! Use the contact form above to do that. Thank you in advance.



  • Who is form admin and how to remove AdminUI?
    Each ConfiForms Form is associated with a page (or a blogpost), the page where this form is defined using ConfiForms Form macro container. Administrators for this form are users who:
    • have administrative access to Confluence (Confluence admins and superusers)
    • users who have edit permissions on the page where the form is configured
    • users (users in a group) who are explicitly set to be Form administrators via ConfiForms Form parameter to set additional form admins (they might not have Edit permissions on the page)


  • Why do I see a "+" button on my form?

    This is because you are the administrator of the form and allowed to see some metadata and create records on someones behalf. Ordinal users will not see this button

  • What happens with the date when the ConfiForms plugin is disabled/uninstalled
    Nothing. The data stored with ConfiForms plugin is stored as page metadata and remains in the database even if uninstall the plugin.


  • ConfiForms plugin could not replace JIRA for you

    This is very important to understand. ConfiForms is not a replacement to JIRA or any other issue tracking system. However, it could be easily used as one, but keep in mind the dataset size and the complexity of the forms you are building.


    The original purpose of ConfiForms plugin is to allow customers to store structured data within Confluence. We strongly advice you to try to avoid forms with 5000+ rows, or better put, to avoid pages with forms that have 5000+ rows (as you may have many forms on the same Confluence page) There is no limit on a number of forms you can create, and no limit on number of rows, but our tests show that the plugin works best then a number of rows is up to 2000 (per form) and dataset is smaller than 10MB. We strongly suggest to keep the datasets sizes as small as possible, splitting the data between forms or using other external storages, such as JIRA as an example.


  • I could not enable the plugin (Plugins are disabled during startup due to unsatisfied dependencies errors)
    We depend on Confluence Workbox, to send internal notifications. Please make sure you have  Workbox – Host Plugin (version 4.0.2 or can be other version, depending on your Confluence server version) is enabled

    This might be the log entry you see in the Confluence general log:

    ERROR [http-nio-8090-exec-10] [atlassian.plugin.manager.PluginEnabler] actualEnable Unable to start the following plugins due to timeout while waiting for plugin to enable: com.vertuna.confluence.plugins.confiforms -- referer: https://YOUR_SERVER/plugins/servlet/upm | url: /rest/plugins/1.0/com.vertuna.confluence.plugins.confiforms-key 
     
    WARN [http-nio-8090-exec-10] [confluence.util.profiling.DefaultActivityMonitor] close Exceeded the threshold of 60000 ms: ActivitySnapshot{startTime=1500375387027, threadId=214, threadName='http-nio-8090-exec-10', userId='admin', type='web-request', summary='/rest/plugins/1.0/com.vertuna.confluence.plugins.confiforms-key'}



  • I could not edit CondiForms Field Definition macros - the loading icon keeps spinning.
    This is a known issue, when you have Brikit Theme plugin version 2.0.0 and up till 2.0.4, where the issue has been fixed (Brikit was braking the editor JavaScript scripts execution and blocked ConfiForms scripts from running). Please update your Brikit plugin to version 2.0.4.

  • How to get the number of pages using ConfiForms?
    On a database level this operation is quite simple. Below you can find the queries which can help you to do this

    select count(*) from os_propertyentry where entity_name = 'confluence_ContentEntityObject' and entity_key like 'confiform_content%';
    
    select distinct entity_id as "content_id" from os_propertyentry where entity_name = 'confluence_ContentEntityObject' and entity_key like 'confiform_content%';





  • No labels