Login

To login navigate to the OneBlink Console


If you’re not yet registered, you can ask a colleague to add you in, or contact us and we’ll be happy to help. Once you login, you’ll be taken to the organisation dashboard. 


Home

This is the opening dashboard for your organisation. The display shows a list of your Forms, Information Pages, and Apps. From here clicking on any of the items in the lists will take you to that item.

These options are also available from the side menu, on the left hand side of your screen.


Create

My App 

Here you are able to see the application Icon, name, link to open the web app, and a manage section. 

From the app manage menu, you have access to the app details, content page, app customisation, app user pool and app submission history.


For more on My Apps check out this article


Forms 


The form list page will show you all of the forms you currently have saved in your organisation, as well as offering you the ability to create a new form.

The form list includes a search bar which allows you to quickly filter down your forms. It also includes the form description as well as some useful icons. These icons can either be red or grey. If the icon is red it then this means the feature is enabled.


The star is used to represent whether or not the form is in the forms library.


The lock is used to represent whether or not the form is authenticated.


The arrow is used to represent whether or not the form has any submission events.


The form menu:


Copy: Create a copy of the form.

Delete: Delete the form.

Download: This will download the JSON definition of the form, which will allow you to share to form between organisations.

View Schema: This option allows you to view the JSON schema of that specific form.

Convert to Info Page: This will convert the form to an information page by removing all of the form element with an input, and placing the form into the Info Pages menu.

Open in browser: This will open the form in a new browser window.


Creating & Upload Form


On the Forms list page, you’ll see a plus button at the bottom right of your screen

Hover over this button will give you the option to add form (create a new form) or upload form (upload a forms JSON definition)


Summary


Form Name: The name of your form, this does not need to be unique however it should be informative and represent what will be contained inside the form.

Description: This will be a brief description of the form and what it contains.

Authentication required: Yes or No (Default No), Do you want this form to be authenticated.

Published in Forms Library: Yes or No (Default No), Do you want this form to be included in your library.


Where would you like your users to go after submitting this form:


My App: Take the user back to the app after the form has been submitted

Close Page: Sometimes for publicly facing un published forms you may want the page to close after submitting the form

Redirect URL: This option will allow you to place a redirect URL that the user will be taken to after the form has been submitted.

This can be used to take users to a company website or even to another form.


Once you’ve filled out the above information, click the Save button to create your new form.


Builder


To start adding elements to your form, click on the Builder tab.

You can then press the ‘ADD NEW ELEMENT’ button to create your first element. This will add a new element to the bottom of the form, and prompt you to name the element.

You can press Enter to create a new element, or you can update the element details.


For more information on the builder please visit Forms Builder


Submission Events


When a form is submitted, the form data is automatically saved to a OneBlink data store.

In addition to this, you can also add other submission events which are performed after a form is successfully submitted.

To set these, select the Submission Events tab in the forms section of the console.


Draft Submission:


Submission Events can also be setup to run on a save draft. 

To implement this simply select the draft submission switch on the submission event.

This will ensure that this event ONLY occurs on a draft submission.


Submission Event Types:


  • Email + PDF: Enter an email address to have a PDF document emailed, containing all of your form submission data.

  • Spotto: Select this submission event type to automatically link to your Spotto account

  • Webhook: OneBlink will send a request to this URL on successful form submission. This is an advanced feature used for integration purposes.


Submission History


To view the history of forms that your users have previously submitted, select the “Submission History” tab at the top of the screen.

The submission history will display the most recent 50 submission of the form. Continue to scroll down the screen, and further items will be displayed as you scroll.

You can also select a date range to specify the submissions you would like to see.

Once you see your historical items, you can click on any of them and view the form data that was submitted for this item.


Styling


The styling tab will allow you to easily change styling options for your web app, and Progressive Web App (PWA). 


Foreground Colour: This is the colour of the Banner where the ‘Banner Image’ is located.

Highlight Colour: This is the colour of your buttons in the forms library when they are hovered over and the colour of the buttons in the form.

Contrast Colour: This is the colour of the text in the button in the library when hovered over and the colour of the text in the buttons of the form. 

Banner Image: The banner image is used to show a company logo at the top of your web app main page. Ensure your image is a PNG, and that the image size is appropriate for your intended screens.


Progressive Web App Settings


App Name: This will be the name displayed below the app on the device 

Splash Screen Name: This is the title that will show when the application initially loads

App Icon: This is the Application Icon that well appear on the device 192 x 192 pixels PNG. This will rescale the size of the icon depending on the device being used to download the PWA


Advanced Styling


This option allows users to create custom CSS stylings for the web app and corresponding forms. 


For more information on form styling please visit our Styling Guide



Advanced 


API Hosting


You can access the API Hosting section by going to the side menu and selecting “API Hosting.”

This will display a list of your API endpoints hosted on the OneBlink platform, with the following options:


Endpoint: The unique URL that represents the api.

Environment Health: The environmental health column will show you the environments for that endpoint that have been deployed (for example, dev, test, and prod). The health is represented by a traffic light system, which measure percentage of errors over 24 hours.


Green: < 5% errors

Yellow: >= 5% errors

Red: >= 20% errors


You can then click on the API items to view details for that particular API endpoint.


Endpoint Instance Details:


The instance details show detailed settings for the API endpoint, and is designed for advanced users.


Name: This is the name of your endpoint

Date Created: The date the api was first created

Security Groups: The security group assigned to the instance (advanced feature)

Subnets: the subnets assigned to the instance
Environments & Routes: Select an environment from this drop down list to view more details about that specific deployment. Note, if the dropdown does not contain any options this is because the api is not deployed to any environments.

Last Deployment: The time and date of the most recent deployment of the API
Route Names: This will list all of the routes available for this particular environment


Web/CDN Hosting


You can access the Web Apps section by going to the side menu and selecting “Web Apps.”

This will display a list of your custom web apps hosted on the OneBlink platform.

Endpoint: This is the unique URL for your web app.


You can then click on the web app items to view details for that particular web app.


Web App Instance Details:

The Web App instance details show detailed settings for the API endpoint, and is designed for advanced users.


Name: This is the name of your endpoint

Date Created: The date the api was first created


Developer Keys 


OneBlink allows developers to create their own keys inside of the OneBlink console.

Keys can be created for Forms, Web Apps, API's, and PDF


To create a new key click the plus button. You will then be asked to give the key a name and to select what privileges you would like the key to have.


SDK


The OneBlink SDK is an open source SDK designed to allow developers easy access to features.

Users have access to the OneBlink GitHub SDK and NPM documentation. 




Administration


Users 

You are able to invite your colleagues to your organisation, giving them access to the OneBlink console.

To do this, select “Users” from the side menu.

On the users page you will see a list of current console users in your organisation. 

Users are broken up into two categories, console users and app users. Console users have access to the full console and everything in it. App users only have access to the forms library and authenticated and unauthenticated forms.


For more information on user please visit Users


Analytics

The analytics system allows you to create and to view KPI style dashboards representing the usage of your app.

Form submissions and API requests will all be automatically tracked by OneBlink, and for more advanced users, you are able to add custom tracking code to your app to help you track projects specific information that you want to report on.

To view your dashboards, select “Analytics” from the side menu. You will be taken to the Dashboard list.


Dashboards

This will show you a list of dashboards available to you. You are able to have multiple dashboards, which gives you the opportunity to create dashboards specific to different groups of people, such as business owners, project managers, or even developers.

If you would like help creating your first dashboard, please contact us and we’ll be happy to help get you started.


Dictionary (Advanced)

The dictionary allows you to replace terms that may come through in your data structure with something more readable and user friendly.


Queries (Advanced)

Queries are set requests to the analytics service to give you the information you’re interested in. For example, a query may say “tell me the total number of form submissions per day, for the past week.”

Preset Queries: You can select from a series of preset queries that are commonly used, and have them added to your dashboard automatically.

Query Playground: Designed for advanced users, this section allows you to test our your queries before loading them into a dashboard, and view the data being returned.

Add Query: Designed for advanced users, this section allows you to create your own queries from scratch.







Getting Help

If you need help, we’re just a click away.


At the top right of any screen within the console you will see a question mark. Select this, and it will take you to this support help desk where you can create a ticket and we’ll be more than happy to help guide you.


What’s Next


The OneBlink suite of services is a brand new offering from OneBlink. As with all of our products, it is continually developed and new features will be released all the time.

Please keep an eye out for product release information as we announce via email, and again, welcome to the new OneBlink suite of services.