Version 3

    Topics

     

     

    Getting Started

     

    There are 3 things that are needed in order to start using the Forms App:

     

    • At least one HTML source document - used by a form template to create Jive content
      • This is what will be used to create the body of the document, discussion, etc.
    • At least one Form template - used by the Forms App to create an input form
      • This can either be created within the Forms App using the Form Creator, or can be created by hand, manually
    • The Forms App - installed from the Apps Market
      • The Forms App will be used to select a form from the list of forms available (that you've created) and to enter information into the form and publish the output into your Jive community.
      • The Forms App can also be used to create Templates that you may use within the Forms App to generate new documents.

     

    Use the following steps to install a sample template into your community for use by the Forms App.  There are a multiple ways you can utilize the following exercises, but the recommended approach, for initially getting started with the app would be to perform the steps in the following order:

     

    First Exercise,  Post a New Document Using a Pre-Defined Template

     

    This is the simplest way to get started, and to see how the app will be used the majority of the time.

     

    • Step 1.  Create an HTML Source Document
      • This is required before doing anything else.  The HTML source document is where you will perform most of the layout of how your document will look.
      • You only need to do this once for the following exercises.  The single sample HTML document below may be used to create both the pre-defined template and/or a new template.
    • Step 2a.  Create a Form Template Document - Using a Pre-Defined Template
      • This will quickly get you started with using the app, without having to immediately worry about how to create templates
    • Step 3.  Use the Forms App to Create a New Document
      • This will allow you to quickly see the results of the app, by merging the contents of a form and the HTML source - quick and easy results.

     

    Second Exercise, Post a New Document using a Newly Created Template

     

    Now that you have used the app, once, and learned about using an HTML source and a form template, now would be a better time to learn to create a template in the app.

     

    • Go Back to Step 2b.  Create a Form Template - Using a Newly Created Template
      • Remember, you can re-use the HTML source from Step 1, for this newly created template, and do not need to repeat that step
    • Go Back and Repeat Step 3.  Use the Forms App to Create a New Document
      • This time you will use your newly created form template, rather than the pre-defined one
      • Note that since you are using the same HTML source, then resulting document will look the same in both exercises

     

    Step 1.  Create an HTML Source Document

     

    1. Create a new document in your Jive community, in a place where every user can read it.
    2. Make an exact copy of the sample HTML document - Sample HTML: {$msgFrom.label} {$msgFrom}, {$msgTo.label} {$msgTo}
      1. Make sure the title is specified exactly as - Sample HTML: {$msgFrom.label} {$msgFrom}, {$msgTo.label} {$msgTo}
      2. Copy the entire body content into the body of your document
        1. You may reformat your copy of the document however you like - move things around, change highlights / styles, colors, etc.
        2. The only important parts are the {$value} which specify where form field data will go - feel free to re-style these items, just don't delete or rename them
    3. Save the document - you now have an HTML source document in your community that can be used by a form template
      1. Make note of the document ID for the HTML document that has just been created, you will be required to use it in the next step
      2. Note: the document ID is strictly the numeric portion of the ID and the numeric portion only
        1. For the sample document at, https://community.jivesoftware.com/docs/DOC-69936, 69936 is the document ID, not DOC-69936


    Step 2a.  Create a Form Template Document - Using a Pre-Defined Template


    Follow these steps if you would like to skip the template creation process and just get started using a pre-defined sample template.

          If you would like to create a custom template, and use that, then skip down to Step 2b.

     

    1. Create a new document in your Jive community, in an place where every user can read it.
    2. Give the document a title of Sample Templates
    3. Add the tag fbldr_templates to the document
      1. This is so the Forms App will be able to recognize the document as containing form templates
    4. Switch the document editor to the HTML view (click the HTML button in the toolbar) and enter the following text - <pre></pre>
      1. The Forms App only looks for valid templates contained in <pre> tags within a document
    5. Copy the JSON contents of the Message Template - Template Source: Forms App: Message Template - and paste in between the <pre> tags you entered in the previous step

      1. Copy the content of the template, from "{" to "}", including those curly braces
    6. Edit the docId in the content section of the template, and replace with the document ID from the HTML source document that was created earlier
      1. Replace 69936 with your sample HTML document ID
    7. Save the document - you now have a template in your community that can be used by the Forms App
      1. Make note of the document ID for the template document that has just been created, you may (optionally) use it in the next step
      2. Note: the document ID is strictly the numeric portion of the ID and the numeric portion only
        1. For the sample document at, https://community.jivesoftware.com/docs/DOC-69936, 69936 is the document ID, not DOC-69936

     

    Step 2b.  Create a Form Template Document - Using a Newly Created Template

     

    Steps to Create a New Template:  (this will essentially be a slightly simpler recreation of the above pre-defined template)

     

    1. Open the Forms App
    2. Select the Create New Form link in the upper right
      1. This will open the app to the template creator, for which more in-depth information can be found here - Forms App: Template Creator
    3. Select the Form Template tab in the upper right
      1. Enter "Your Templates" as the template Category
      2. Enter "Message Template" as the template Name
      3. Enter "This is a template that I use to message stuff." as the template Description
      4. Select "Document" as the template Content Type
      5. Select "Another Jive Document" as the template HTML Source
      6. Enter the document ID of the HTML source document, created in Step 1, as the template HTML Doc ID
    4. Select the Form Fields tab in the upper right
      1. Add the following 6 fields, ID and Label
        1. msgTo / To
        2. msgFrom / From
        3. msgCopy / CC
        4. msgSubj / Subject
        5. msgBody / Message
        6. msgSend / Send
      2. For the sake of simplicity, just set all field types as Text Field
      3. You can adjust field types, titles (tooltips), default values, required as desired
        1. See the Forms App: Template Creator for more detailed information on the available options
    5. Now that the form and fields have been defined, select the available tabs on the left and look for the following
      1. The Form Preview tab on the left should now show a valid form with 6 fields displayed
      2. The Form Source tab on the right should now show a valid JSON template within the text pane
    6. Select the Form Preview tab in the upper left, fill out the preview form, and click the Create Document button
    7. Given no form errors, the Content Preview tab in the upper left should now be active, select the Content Preview tab
      1. The HTML content, complete with the form data you entered, should now be displayed
      2. The HTML content may not be as rich as that rendered in the RTE, since it is a more basic HTML preview, but it should be relatively similar
    8. Select the Form Source tab in the upper left, and keep a copy of the JSON displayed in the text pane for use in the next step

     

    Steps to Install the New Template:

     

    1. Create a new document in your Jive community, in an place where every user can read it.
    2. Give the document a title of Created Templates
    3. Add the tag fbldr_templates to the document
      1. This is so the Forms App will be able to recognize the document as containing form templates
    4. Switch the document editor to the HTML view (click the HTML button in the toolbar) and enter the following text - <pre></pre>
      1. The Forms App only looks for valid templates contained in <pre> tags within a document
    5. Copy the JSON contents of the Form Source tab, from the app in the previous step, containing your newly created template
      1. Copy the content of the template, from "{" to "}", including those curly braces
    6. Edit the docId in the content section of the template, and replace with the document ID from the HTML source document that was created earlier
      1. Replace 69936 with your sample HTML document ID
    7. Save the document - you now have a template in your community that can be used by the Forms App
      1. Make note of the document ID for the template document that has just been created, you may (optionally) use it in the next step
      2. Note: the document ID is strictly the numeric portion of the ID and the numeric portion only
        1. For the sample document at, https://community.jivesoftware.com/docs/DOC-69936, 69936 is the document ID, not DOC-69936

     

    Step 3.  Use the Forms App to Create a New Document

     

    Important Note:  After you create the template document above, you may have to wait a few minutes to be able to locate the template in the Forms App.  The delay varies based on the time to index the new document and its tags within Jive's search service.  You have a couple options at this point:

    1) wait 5 to 10 minutes in order for your template to be indexed by the search engine; or,

    2) go into the Forms App, edit your app settings, and add your document template ID, not your HTML source ID (ID from Step 2, not Step 1) and place it in the document ID settings in the app.

     

    The app, by default, only looks for tagged documents, but can be set up to also look for specific document IDs as well.  You can also use this method (a hard-coded document ID and not a tag) to test a template in your app before you tag the document and make the template available for everyone to use.

     

    1. Open the Forms App
    2. Select the Sample template that was previously created
      1. Category - Your Templates
      2. Name - Message Template
    3. Enter values for all the fields in the form
    4. Post the form to a place where everyone can read
      1. Note: After posting you should be asked where you would like to post the document, using the Jive place picker
    5. You should then be automatically redirected to the new document
      1. If you kept the same formatting as the sample HTML document source, it should look something like this - Sample HTML: From Me, To You

     

    Congratulations!  You have now successfully used the Forms App to create a new, templated piece of Jive content.