Offline client plugin - FORMCYCLE Wiki

author	version	line-number	content
1	[[Plugin download>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/plugin-bundle-offline-client&fileid=328\|\|target="_blank"]] (requires login)
2
3	{{info}}
4	Please use plugin version 2.0.0 or above for {{formcycle/}} Version 6.
5	{{/info}}
6
7	{{info}}
8	Please use plugin version 2.2.2 or above for {{formcycle/}} Version 6.6.3 or higher.
9	{{/info}}
10
11	{{content/}}
12
13	In combination with an [[iOS->>https://apps.apple.com/de/app/formcycle-offline-app/id1063311719]], [[Android->>https://play.google.com/store/apps/details?id=de.xima.formcycle&hl=de]] or Desktop-App the offline client plugin allows for offline data collection with FORMCYCLE forms. The collected data can later be transmitted to the FORMCYCLE server. This plugin is subject to additional charge.
14
15	Please note: As it cannot be guaranteed that an active internet connection exists, there are a few restrictions when using the offline app.
16
17	* The [[appointment finder>>doc:Formcycle.FormDesigner.FormElements.Appointment.WebHome]] is not available in the offline app.
18	* JavaScript that accesses resources from the internet (such as CSV data sources) is not supported.
19
20
21	== Offline Apps ==
22	{{id name="fig_offline_client_settings_electron"/}}
23	{{figure image="offline_client_settings_electron_de.png"}} The FORMCYCLE Desktop app for collection form data. Marked in red is the number of //finished// and //saved// form records. When the next synchronisation process is executed all finished form records will be send to the FORMCYCLE server. In the middle the configuration dialog of the app is visible. In the desktop app the client has to be specified within the user input field.{{/figure}}
24
25	There three different apps that can be used for collecting form data offline:
26
27	* [[FORMCYCLE iOS-App->>https://apps.apple.com/de/app/formcycle-offline-app/id1063311719]]
28	* [[FORMCYCLE Android-App->>https://play.google.com/store/apps/details?id=de.xima.formcycle&hl=de]]
29	* Desktop-App (in development, currently only available in Beta version)
30
31	In order to use these apps it is neccessary to install the offline client plugin in FORMCYCLE. This plugin provides the capability to synchronize forms between app and server.
32
33	=== Configuration ===
34
35	On app startup the connection to the FORMCYCLE server needs to be configured. These settings can be changed anytime by accessing the menu entry //Settings//.
36
37	; User name
38	: Name of the [[FORMCYCLE user>>doc:Formcycle.UserInterface.UserSettings.User.WebHome]] that collects data using this app.
39	: {{info}}In the desktop app the [[client>>doc:Formcycle.UserInterface.Client.WebHome]] needs to be specified within this field like so: user@client{{/info}}
40	; Password
41	: Password of the [[FORMCYCLE user>>doc:Formcycle.UserInterface.UserSettings.User.WebHome]]
42	; Client (only in iOS- and Android-App)
43	: FORMCYCLE client of the user.
44	: {{info}}In the desktop app the client needs to be specified within the user name field: user@client{{/info}}
45	; URL
46	: URL under which the FORMCYCLE system is accessible.
47	: {{info}}Bei direktem Zugriff auf einen {{formcycle/}} {{mserver/}} muss diese URL mit der [[Basis-URL>>Formcycle.UserInterface.Client.Settings.WebHome]] des Mandanten übereinstimmen. Beim Zufriff auf einen {{fserver/}} muss eine URL angegeben werden, unter der dieser erreichbar ist.{{/info}}
48	{{info}}This URL needs to the same as the [[base URL>>Formcycle.UserInterface.Client.Settings.WebHome]] of the client if a {{formcycle/}} master server is accessed. If a frontend server is accessed, its URL has to be used instead, e.g. // {{html}}https://fs.example.com/frontend-server{{/html}} //{{/info}}
49	; Language (only in Desktop-App)
50	: Language of the app
51	; Logfile Level (only in Desktop-App)
52	: Determines what kind of messages will be logged for the app
53
54	=== Using the App ===
55
56	After configuring the FORMCYCLE offline app the available forms will be loaded from the server. These forms will then appear on in the overview of the app and can be opened anytime. Which forms will be loaded from the server depends on the [[user permissions>>doc:Formcycle.UserInterface.MyForms.Access.WebHome] and the [[configured form group>>\|\|anchor="sec_global_settings"]] in the offline client plugin.
57
58	; Synchronize
59	: After Clicking/tapping that button all forms will be loaded from the FORMCYCLE server and all //finished// form records of the app will be send to the server.
60
61	Clicking/Tapping a form from the form overview opens it. The form can now be filled out. If the form is filled out it can be //finished// or //saved// by clicking/tapping Send or Save. Finished form records will not be send directly to the server. Only after clicking/tapping //Synchronize// in the form overview will the finished form records be send to the FORMCYLE server. Saved form records will be saved on the device the offline app is installed on. These form records will not be send to the server.
62	Finished and saved form records can be accessed to the left of the form or via the menu in the top right corner. Saved form records can be changed before finishing and synchronizing them with the server.
63
64	{{info}}Form buttons for submitting or saving the form are not available in the offline apps because the form records will not be send directly to the server.Us the buttons Send and Save of the offline app instead.{{/info}}
65
66	{{id name="sec_global_settings" /}}
67	== Global plugin settings ==
68
69	After [[installung>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]] the offline client plugin it can be configured with the following parameter:
70
71	; group-name
72	: If not all forms of a client should be available in the offline app, a form group can be specified here. If a form group is set only the forms of that group will be available in the offline app.

1

[[**Plugin download**>>url:https://customer.formcycle.eu/index.php/apps/files/?dir=/FORMCYCLE%20-%20Plugins%20Customer/plugin-bundle-offline-client&fileid=328||target="_blank"]] (requires login)

2

3

4

Please use **plugin version 2.0.0** or above for {{formcycle/}} Version 6.

Please use **plugin version 2.2.2** or above for {{formcycle/}} Version **6.6.3** or higher.

In combination with an [[iOS->>https://apps.apple.com/de/app/formcycle-offline-app/id1063311719]], [[Android->>https://play.google.com/store/apps/details?id=de.xima.formcycle&hl=de]] or Desktop-App the offline client plugin allows for offline data collection with FORMCYCLE forms. The collected data can later be transmitted to the FORMCYCLE server. This plugin is subject to additional charge.

14

15

Please note: As it cannot be guaranteed that an active internet connection exists, there are a few restrictions when using the offline app.

16

17

* The [[appointment finder>>doc:Formcycle.FormDesigner.FormElements.Appointment.WebHome]] is not available in the offline app.

18

* JavaScript that accesses resources from the internet (such as CSV data sources) is not supported.

== Offline Apps ==

{{figure image="offline_client_settings_electron_de.png"}} The FORMCYCLE Desktop app for collection form data. Marked in red is the number of //finished// and //saved// form records. When the next synchronisation process is executed all finished form records will be send to the FORMCYCLE server. In the middle the configuration dialog of the app is visible. In the desktop app the client has to be specified within the user input field.{{/figure}}

24

25

There three different apps that can be used for collecting form data offline:

26

27

* [[FORMCYCLE iOS-App->>https://apps.apple.com/de/app/formcycle-offline-app/id1063311719]]

28

* [[FORMCYCLE Android-App->>https://play.google.com/store/apps/details?id=de.xima.formcycle&hl=de]]

29

* Desktop-App (in development, currently only available in Beta version)

30

31

In order to use these apps it is neccessary to install the offline client plugin in FORMCYCLE. This plugin provides the capability to synchronize forms between app and server.

32

33

=== Configuration ===

34

35

On app startup the connection to the FORMCYCLE server needs to be configured. These settings can be changed anytime by accessing the menu entry //Settings//.

36

37

; User name

38

: Name of the [[FORMCYCLE user>>doc:Formcycle.UserInterface.UserSettings.User.WebHome]] that collects data using this app.

39

: {{info}}In the desktop app the [[client>>doc:Formcycle.UserInterface.Client.WebHome]] needs to be specified within this field like so: **user@client**{{/info}}

40

; Password

41

: Password of the [[FORMCYCLE user>>doc:Formcycle.UserInterface.UserSettings.User.WebHome]]

42

; Client (only in iOS- and Android-App)

43

: FORMCYCLE client of the user.

44

: {{info}}In the desktop app the client needs to be specified within the user name field: **user@client**{{/info}}

45

; URL

46

: URL under which the FORMCYCLE system is accessible.

47

: {{info}}Bei direktem Zugriff auf einen {{formcycle/}} {{mserver/}} muss diese URL mit der [[Basis-URL>>Formcycle.UserInterface.Client.Settings.WebHome]] des Mandanten übereinstimmen. Beim Zufriff auf einen {{fserver/}} muss eine URL angegeben werden, unter der dieser erreichbar ist.{{/info}}

48

{{info}}This URL needs to the same as the [[base URL>>Formcycle.UserInterface.Client.Settings.WebHome]] of the client if a {{formcycle/}} master server is accessed. If a frontend server is accessed, its URL has to be used instead, e.g. // {{html}}https://fs.example.com/frontend-server{{/html}} //{{/info}}

49

; Language (only in Desktop-App)

50

: Language of the app

51

; Logfile Level (only in Desktop-App)

52

: Determines what kind of messages will be logged for the app

53

54

=== Using the App ===

55

56

After configuring the FORMCYCLE offline app the available forms will be loaded from the server. These forms will then appear on in the overview of the app and can be opened anytime. Which forms will be loaded from the server depends on the [[user permissions>>doc:Formcycle.UserInterface.MyForms.Access.WebHome] and the [[configured form group>>||anchor="sec_global_settings"]] in the offline client plugin.

57

58

; Synchronize

59

: After Clicking/tapping that button all forms will be loaded from the FORMCYCLE server and all //finished// form records of the app will be send to the server.

60

61

Clicking/Tapping a form from the form overview opens it. The form can now be filled out. If the form is filled out it can be //finished// or //saved// by clicking/tapping **Send** or **Save**. Finished form records will not be send directly to the server. Only after clicking/tapping //Synchronize// in the form overview will the finished form records be send to the FORMCYLE server. Saved form records will be saved on the device the offline app is installed on. These form records will not be send to the server.

62

Finished and saved form records can be accessed to the left of the form or via the menu in the top right corner. Saved form records can be changed before finishing and synchronizing them with the server.

63

64

{{info}}Form buttons for submitting or saving the form are not available in the offline apps because the form records will not be send directly to the server.Us the buttons **Send** and **Save** of the offline app instead.{{/info}}

65

66

67

== Global plugin settings ==

68

69

After [[installung>>doc:Formcycle.UserInterface.Client.Plugins.WebHome]] the offline client plugin it can be configured with the following parameter:

70

71

; **group-name**

72

: If not all forms of a client should be available in the offline app, a form group can be specified here. If a form group is set only the forms of that group will be available in the offline app.

Wiki source code of Offline-Client-Plugin

Navigation