Wiki source code of Sharepoint plugin

Show last authors
1 {{content/}}
2
3 {{error}}
4 The SharePoint plugin FormCycle.wsp can only be used until SharePoint version 2013. In the following versions, the interface is no longer available and the plugin will not be further developed.
5 {{/error}}
6
7 == Adding the plugin to SharePoint ==
8
9 === Step 1: Upload the plugin ===
10
11 1. Download the plugin from the [[Customer-Cloud>>https://customer.formcycle.eu]].
12
13 === Step 2: Install the plugin for {{formcycle/}} ===
14
15 {{figure clear="h2" group="step2" image="step2.png"}}
16 Installing the {{formcycle/}} plugin for SharePoint integration.
17 {{/figure}}
18
19 Sign in to {{formcycle/}} with the //superadmin// account and install the plugin by following these steps:
20
21 1. Go to //System// -> //System plugins//.
22 1. Click on //new// to add a new the plugin.
23 1. Click on //browse// and upload the file {{code language="none"}}plugin-sharepoint.jar{{/code}}.
24 1. Select all clients to which the plugin should be available by changing the value for the plugin parameter {{code language="none"}}fc.sharepoint.plugin.clients{{/code}}. Client names are separated by commas {{code language="none"}},{{/code}}. You can use a star {{code language="none"}}*{{/code}} as wildcard to select all clients.
25 1. Save all settings by clicking on //save//.
26 1. Beginning at version 2.0.0 of the plugin, an additional plugin parameter has been added, {{code language="none"}}fc.sharepoint.plugin.client.required{{/code}}. When it is set to {{code language="none"}}true{{/code}}, the plugin will not return any forms or form data unless the SharePoint plugin specifies at least one client.
27
28 === Step 3: Upload the plugin to the SharePoint server ===
29
30 Upload the plugin (web service provider) to SharePoint.
31
32 Copy the file {{code language="none"}}FormCycle.wsp{{/code}} to the SharePoint-Server. You can download the web service provider [[from our download page>>https://customer.formcycle.eu]].
33
34 === Step 4: Install the SharePoint plugin ===
35
36 {{figure clear="h2" group="step4" image="step4.png"}}
37 Open a shell management shell in SharePoint. You must be an administrator with the appropriate permissions.
38 {{/figure}}
39
40 {{figure clear="h2" group="step4" image="step5.png"}}
41 Command used when installing the plugin for the first time.
42 {{/figure}}
43
44 {{figure clear="h2" group="step4" image="step6.png"}}
45 The service //SharePoint administration// must be active. You can check this in the SharePoint administration interface.
46 {{/figure}}
47
48 {{figure clear="h2" group="step4" image="step7.png"}}
49 Final command to finish the installation.
50 {{/figure}}
51
52 1. Open a //SharePoint-Verwaltungsshell// as an administrator with extended permissions.
53 1. When you are installing the plugin for the first time, run the command {{code language="none"}}Add-SPSolution C:\Users\Administrator\Desktop\FormCycle.wsp{{/code}}. When installing an update of the plugin {{code language="none"}}FormCycle.wsp{{/code}}, run the command {{code language="none"}}run Update-SPSolution -Identity FormCycle.wsp -LiteralPath "C:\Users\Administrator\Desktop\FormCycle.wsp" -GacDeployment{{/code}}.
54 1. Check whether the service //SharePoint administration// is running.
55 1. Run the command {{code language="none"}}Install-SPSolution -identity "FormCycle.wsp" -GACDeployment -AllWebApplications{{/code}}.
56
57 === Step 5: Edit the URL to the {{fcserver/}} ===
58
59 Go to the //propertyBag// and modify the the parameter {{code language="none"}}xima.formcycle.server.url{{/code}} so that it points to the URL to the {{fcserver/}}. How to set this parameter depends on whether you are using SPWeb or SPSite.
60
61 {{figure clear="h2" group="step4" image="step8.png"}}
62 The parameter {{code language="none"}}xima.formcycle.server.url{{/code}} must be set correctly or no connection can be established between SharePoint and {{formcycle/}}.
63 {{/figure}}
64
65 {{figure clear="h2" group="step4" image="sharepoint_33.png"/}}
66
67 ==== For SPWeb ====
68
69 1. Set the URL of the site collection: {{code language="none"}}$web = Get-SPWeb http://sharepoint-server{{/code}}
70 1. Seth the URL to the {{fcserver/}}: {{code language="none"}}$web.AllProperties["xima.formcycle.server.url"]="http://formcycle-server/formcycle"{{/code}}
71 1. Beginning at version 2.0.0 of the plugin, you can set the name of client to be used in SharePoint: {{code language="none"}}$web.AllProperties["xima.formcycle.server.client"]="meinMandantName"{{/code}}
72 1. Update the settings: {{code language="none"}}$web.Update(){{/code}}
73
74 ==== For SPSite ====
75
76 1. Set the URL to the site collection: {{code language="none"}}$site = Get-SPSite http://sharepoint-server/siteCollection{{/code}}
77 1. Get the side ID: {{code language="none"}}$site.ID{{/code}}. Take note of this ID as you will need it shortly. This ID is a unique key of the available SPSites on the farm.
78 1. Set the URL to the {{fcserver/}}. Replace the part marked in red with the ID from the previous step.
79 {{box}}$site.RootWeb.Properties["xima.formcycle.server.url_(% style="color: rgb(255, 0, 0);" %)IdDerSPSite(%%)"]="http:~/~/formcycle-server/formcycle"{{/box}}
80 Example: {{code language="none"}}$site.RootWeb.Properties["xima.formcycle.server.url_a755f7e7-4beb-47de-b41c-6648b2d3fb7a"]="http://formcycle-server/formcycle/"{{/code}}
81 1. Beginning at version 2.0.0 of the plugin, you can set the name of the client to be used in SharePoint. Replace the part marked in red with the ID from step 2.
82 {{box}}$site.RootWeb.Properties["xima.formcycle.server.client_(% style="color: rgb(255, 0, 0);" %)IdDerSPSite(%%)"]="meinMandantName"{{/box}}
83 Example: {{code language="none"}}$site.RootWeb.Properties["xima.formcycle.server.client_a755f7e7-4beb-47de-b41c-6648b2d3fb7a"]="demoMandant"{{/code}}
84 1. Update the settings: {{code language="none"}}$site.RootWeb.Properties.Update(){{/code}}
85
86 == Using the plugin ==
87
88 === Setting up the web part for the plugin ===
89
90 {{figure clear="h2" group="webpart" image="step9.png"}}
91 Step 1: Adding the web part to the web part gallery.
92 {{/figure}}
93
94 {{figure clear="h2" group="webpart" image="step10.png"}}
95 Step 2: Select //web parts// in the web part settings.
96 {{/figure}}
97
98 {{figure clear="h2" group="webpart" image="step11.png"}}
99 Step 3: Create a new document.
100 {{/figure}}
101
102 {{figure clear="h2" group="webpart" image="step12.png"}}
103 Step 4: Add the {{formcycle/}} web part.
104 {{/figure}}
105
106 {{figure clear="h2" group="webpart" image="step13.png"}}
107 Step 5: Open the web part settings.
108 {{/figure}}
109
110 {{figure clear="h2" group="webpart" image="step14.png"}}
111 Step 6: Set a group for the web part.
112 {{/figure}}
113
114 1. Click on //web page settings// and add the {{formcycle/}} web part to your web part gallery.
115 1. Go to //web designer galleries// and click on //web parts//.
116 1. Click on //files// {{rarrow/}} //New document//.
117 1. Select {{code language="none"}}FormCycle.FormCycleWebPart.FormCycleWebPart{{/code}} and click on //Populate gallery//.
118 1. Open the web part details.
119 1. Set a group for the web part, eg. //forms//.
120
121 === Creating a SharePoint document with a form ===
122
123 {{figure clear="h2" group="erstellen" image="step15.png"}}
124 Adding a web part to a dcoument.
125 {{/figure}}
126
127 {{figure clear="h2" group="spInstr" image="step16.png"}}
128 Inserting the {{formcycle/}} web part to a document.
129 {{/figure}}
130
131 1. Go to the document to which you would like to add a {{formcycle/}} form, and click on //Edit// {{rarrow/}} //Insert// {{rarrow/}} //Web part//.
132 1. Select the group you set for the web part and click on //Add//.
133
134 The plugin has now been added to the document and allows for {{formcycle/}} forms to be integrated into SharePoint.
135
136 === Copying form data to a SharePoint list ===
137
138 Form data that has been submitted can be copied to a SharePoint list when necessary.
139
140 See the help pages on [[SharePoint lists>>doc:Formcycle.CMSExtension.SharepointPlugin.CopyToSharePointList]] for further instructions.