Last modified by teamwire001 on 2025/10/29 11:28

From version 9.1
edited by teamwire001
on 2025/09/12 11:19
Change comment: DOC-481
To version 8.1
edited by teamwire001
on 2025/08/12 11:12
Change comment: Uploaded new attachment "email-templates-EN.zip", version 1.2

Summary

Details

Page properties
Content
... ... @@ -1,172 +1,93 @@
1 -This document provides information on how to set up Teamwire for your organisation in a few simple steps.
1 +Learn how to configure Teamwire for your company in just a few steps.
2 2  
3 -This document covers the following topics:
4 4  
5 -* [[image:Public.Attachments.WebHome@icons-star.svg||style="padding-bottom:3px"]] [[Create admin account>>doc:||anchor="admin"]]
6 -* [[image:Public.Attachments.WebHome@icons-business.svg||style="padding-bottom:3px"]] [[Set up organisation>>doc:||anchor="organisation"]]
7 -* [[image:Public.Attachments.WebHome@icons-user.svg||style="padding-bottom:3px"]] [[Create and manage users>>doc:||anchor="user"]]
8 -* [[image:Public.Attachments.WebHome@icons-integration.svg||style="padding-bottom:3px"]] [[Distribute to users>>doc:||anchor="rollout"]]
9 -* [[image:Public.Attachments.WebHome@icons-reshare.svg||style="padding-bottom:3px"]] [[Next steps...>>doc:Public.Getting-Started.First-steps-for-Teamwire-admins.Next-Steps.WebHome]]
10 -## ##
4 += Create admin account =
11 11  
12 -{{id name="admin"/}}
6 +----
13 13  
14 -= (% class="numbox" %){{{1}}}(%%) (% class="numbox-title" %)Create admin account(%%) =
8 +Access the [[Teamwire Dashboard>>url:https://backend.teamwire.eu/static/dashboard/index.html#/auth/register||rel="noopener noreferrer" target="_blank"]] and register as **admin** by using your business email address.
9 +Be sure to use a valid email address and mobile number to verify both information by confirmation link and PIN. [[What's the Teamwire Dashboard? (Registration required)>>doc:Customer.Administration.Dashboard-User-Manual.Overview.WebHome||target="_blank"]]
15 15  
16 -Visit the Teamwire Dashboard and register as **Teamwire admin**. Please provide a valid business email address and a current mobile phone number so that both details can be successfully verified via a confirmation link or PIN code.
11 +Your registration will be reviewed by our team.
12 +Once your account has been approved, you will receive an email notification and can log in at [[url:https://backend.teamwire.eu||rel="noopener noreferrer" target="_blank"]].
17 17  
18 -{{html}}
19 -<a href="https://backend.teamwire.eu/static/dashboard/index.html#/auth/register" style="text-decoration: none;" target="_blank">
20 -<button class="btn btn-gili_blue" style="width:220px; height:50px;" type="button">Register as admin now</button></a>
21 -{{/html}}
14 +We recommend that you use **two-factor authentication** to ensure maximum security for your admin account. The feature is available in your admin profile.
22 22  
23 -Your registration will be reviewed and approved by Teamwire.
16 +1. Select "Enable two-factor authentication".
17 +1. Scan the QR code with your Authenticator app (e.g. [[FreeOTP Authenticator>>https://freeotp.github.io||rel="noopener noreferrer" target="_blank"]]) and click "Continue".
18 +1. Enter the token and confirm.
19 +## ##
24 24  
25 -Once your account has been approved, you will receive an email and will be able to log in at [[url:https://backend.teamwire.eu||rel="noopener noreferrer" target="_blank"]]
26 -
27 -{{info title="Maximum security for your admin account"}}
28 -We recommend that you enable two-factor authentication to prevent unauthorised access.
29 -
30 -You can find this feature at the upper right-hand corner under **My Profile**.
31 -
32 -* Here, please select **Enable two-factor authentication**.
33 -* Scan the QR code with your authenticator app (e.g. [[FreeOTP Authenticator>>url:https://freeotp.github.io||rel="noopener noreferrer" target="_blank"]]) and click **Continue**.
34 -* Enter the generated token and confirm your input.
35 -{{/info}}
36 -
37 -
38 -(% class="numbox-title" %) {{icon name="sliders" size="1x"/}} Optional: Language settings
39 -
40 -The display language of the dashboard is based on your browser settings. If required, you can set the language of the dashboard yourself.
41 -
42 -This setting can be found at the upper right-hand corner under **My Profile** ("Mein Profil").
43 -
44 -
45 -{{id name="organisation"/}}
46 -
47 -= (% class="numbox" %){{{2}}}(%%) (% class="numbox-title" %)Set up organisation(%%) =
48 -
49 -Before your users get started, you should take care of the most important organisation settings.
50 -
51 -{{tabs idsToLabels="privacy=Privacy settings, registration=Login options, templates=Email templates"/}}
52 -
53 -(% id="privacy" %)
21 +(% class="box infomessage" %)
54 54  (((
55 -In the [[image:Public.Attachments.WebHome@icons-lock.svg||height="18" style="padding-bottom:5px" width="18"]] **Privacy Settings** section, you can specify with whom users of the organisation are permitted to communicate.
23 +You can change the **Dashboard language.**
56 56  
57 -* **Privacy Mode**
58 -This determines which contacts are being synchronised (e.g. additional address book contacts). All modes are explained in detail in the dashboard.
59 -
60 -* **Privacy Options**
61 -Here you will find further options for allowing or restricting communication with external and internal contacts.
25 +Log in on the Dashboard to open your admin profile in the upper-right area ("My Profile") and change your settings.
62 62  )))
63 63  
64 -(% id="registration" %)
65 -(((
66 -In the [[image:Public.Attachments.WebHome@icons-key.svg||height="18" style="padding-bottom:5px" width="18"]] **Login & Registration** section, you can define policies for the user login.
67 67  
68 -These include, i.a.
69 69  
70 -* the maximum amount of devices per user.
71 -* to enable/disable login in with a password.
72 -* the password policies (length, strength, expiration, autom. blocking for failed login attempts).
73 -* the registration token for authentication via EMM or MDM configuration.
74 -)))
30 += Configure organisation =
75 75  
76 -(% id="templates" %)
77 -(((
78 -In the [[image:Public.Attachments.WebHome@icons-file.svg||height="18" style="padding-bottom:5px" width="18"]] **Email Templates** section, you can customise the email messages sent to dashboard admins and Teamwire users.
79 -
80 -More information is available in the [[Teamwire Dashboard manual ( {{icon name="sign-in" size="1x" cssClass="fa-blue helpc" title="This document is only available to logged-in users"/}})>>doc:Customer.Administration.Dashboard-User-Manual.Email-Templates.WebHome||title="This document is only available to logged-in users"]].
81 -)))
82 -
83 -(% style="border-color:var(--gili_blue_300)" %)
84 84  ----
85 85  
34 +Before your users get started, you should take care of the most important settings.
86 86  
87 -{{id name="user"/}}
36 +* **Privacy Mode** at (% class="mark" %)Settings > Privacy Settings(%%)
37 +It determines whom the Teamwire users are allowed to get in contact with (e.g. users from their address book). All modes are explained in detail in the dashboard.
88 88  
89 -= (% class="numbox" %){{{3}}}(%%) (% class="numbox-title" %)Create and manage users(%%) =
39 +* **Password Login** at (% class="mark" %)Settings > Login & Registration(%%)
40 +Enable this option to allow Teamwire users to log in with email address and password. [[How do users log in on the Teamwire app? (Login required)>>doc:Customer.Administration.Registration-Options.WebHome||target="_blank"]]
90 90  
91 -You can now start creating user accounts.
42 +* **Password Policies** at (% class="mark" %)Settings > Login & Registration(%%)
43 +Define the requirements for the password that users can set to log in on the Teamwire app.
92 92  
93 -In the [[image:Public.Attachments.WebHome@icons-user.svg||height="18" style="padding-bottom:7px" width="18"]] **Users** section, you are able to create and manage accounts. You may choose one of the following options - and be careful to only use email addresses that correspond to your company's domain.
45 +## ##
94 94  
95 -Please note that **your admin account is not a user account**. If you'd like to use the Teamwire app yourself, you will need to create a user account, too.
47 += Create and manage users =
96 96  
97 -{{tabs idsToLabels="createuser=Create users, importuser=Import users, ldapuser=Sync LDAP users"/}}
49 +----
98 98  
99 -(% id="createuser" %)
100 -(((
101 -Select **Create new user** and enter the employee's first and last name, and business email address.
51 +You can now start creating and inviting user accounts for your employees.
102 102  
103 -The user will receive an automated email notification (see email template "Access email").
104 -)))
53 +They are maintained in the Dashboard at (% class="mark" %)Manage > Users(%%). Make sure that all users use the same email domain.
105 105  
106 -(% id="importuser" %)
107 -(((
108 -Click **Import CSV** to create multiple users at once. Select a CSV file from your file explorer to upload it.
55 +* **Invite individual users**
56 +Select "Invite User" and enter the employee's first and last name, and email address. They will receive an email that a Teamwire account has been created.
109 109  
110 -Please note the following specifications for the file.
58 +* **Import users via CSV file**
59 +Use "Import CSV" to create multiple users at once. Select a CSV file from your file explorer to upload it.
60 +You can use [[this file>>attach:benutzerimport.csv||download="benutzerimport.csv"]] as template for your import. Make sure to use commas for delimiter and to encode the file in UTF-8.
61 +## ##
111 111  
112 -* Encoding: UTF-8
113 -* Delimiter: comma
114 -* Must contain the header row: {{code language="none"}}email,first_name,last_name,group{{/code}}
115 -* CSV import is limited to 1,000 lines (incl. header). Please split larger files, following line limit.
63 +Optional: After you have successfully created the user accounts, you can **generate a one-time password** for them and send it automatically by mail. To do this, tick the respective users and select "Set one-time password".
64 +Please note that your users can only log in with the password if you have previously enabled the "Password Login" option.
116 116  
117 -The email address, and first and last names are mandatory. An assignment to a circle (here "group") is optional and allows you to create new circles during user import.
118 118  
119 -It is possible to assign users to multiple circles by listing them multiple times and specifying one of the circles under "group" for each line.
67 +**Important: Your admin account is not a user account.**
68 +To log in on the Teamwire app, create a user with your email address.
120 120  
121 -[[{{icon name="download" size="1x"/}} Feel free to use this example file as a template for your import>>attach:Public.Attachments.WebHome@userimport.zip||download="Public.Attachments.WebHome@userimport.zip"]]. The optional assignment to "Divisions" is currently not supported by CSV import.
122 -)))
123 123  
124 -(% id="ldapuser" %)
71 +(% class="box infomessage" %)
125 125  (((
126 -You can import existing users and groups from your LDAP or Active Directory infrastructure into Teamwire. This avoids the effort of manual user maintenance and circle assignment.
127 -
128 -This option is available in the dashboard's [[image:Public.Attachments.WebHome@icons-sync.svg||height="13" style="padding-bottom:5px" width="13"]] **LDAP Integration** section. For a detailed documentation on connecting an LDAP server, please refer to the [[Teamwire Dashboard manual ( {{icon name="sign-in" size="1x" cssClass="fa-blue helpc" title="This document is only available to logged-in users"/}})>>doc:Customer.Administration.Dashboard-User-Manual.LDAP-Synchronisation.WebHome||title="This document is only available to logged-in users"]].
73 +You can customise the mail notifications sent to your users and other admins in your organisation. They can be changed in the Dashboard at (% class="mark" %)Settings > Email Templates(%%).
129 129  )))
130 130  
131 -(% style="border-color:var(--gili_blue_300)" %)
132 -----
133 133  
77 += Quick start for your users =
134 134  
135 -(% class="numbox-title" %){{icon name="sliders" size="1x"/}} Optional: Create one-time passwords
79 +----
136 136  
137 -Once you have completed the user account creation process, you can generate one-time passwords for your employees and send them automatically by email. After successfully logging in, the users will be prompted to set a new password.
81 +Email invitations to users already include information on how to download the Teamwire app.
138 138  
139 -To do this, select the respective users in the overview and choose **Set one-time password**.
140 -
141 -
142 -
143 -{{id name="rollout"/}}
144 -
145 -= (% class="numbox" %){{{4}}}(%%) (% class="numbox-title" %)Distribute to users(%%) =
146 -
147 -The default email notification of the user creation process already include information on how to download the Teamwire app.
148 -
149 149  We recommend that you provide the most important resources in a central info pool to allow your users to get started quickly - e.g. via intranet, SharePoint or mail. This includes
150 -We recommend that you also provide your users with the most important resources for a quick start in a central info pool, e.g. via intranet, a SharePoint, or newsletter.
151 151  
152 -This includes
153 -
154 -* the links for the [[App Download>>doc:Public.Getting-Started.App-Download.WebHome||target="_blank"]]
85 +* links for the [[app download>>doc:Public.Getting-Started.App-Download.WebHome||target="_blank"]]
155 155  * a link to access the Teamwire Web Client: [[https://backend.teamwire.eu/web-client||rel="noopener noreferrer" target="_blank"]]
156 -* a link to [[frequently asked questions (FAQ)>>doc:Public.FAQ.WebHome||target="_blank"]]
157 -* the quick start guide "Setting up your Teamwire app" for [[iOS>>doc:Public.Applications.iOS.Quick-Start-App-Setup.WebHome||target="_blank"]] and [[Android>>doc:Public.Applications.Android.Quick-Start-App-Setup.WebHome||target="_blank"]]
158 -* the quick start guide "Teamwire key features" for [[iOS>>doc:Public.Applications.iOS.Quick-Start-Key-Features.WebHome||target="_blank"]] and [[Android>>doc:Public.Applications.Android.Quick-Start-Key-Features.WebHome||target="_blank"]]
159 -* the Teamwire app user manuals for [[iOS>>doc:Public.Applications.iOS.User-Manual.WebHome||target="_blank"]], [[Android>>doc:Public.Applications.Android.User-Manual.WebHome||target="_blank"]] and [[Desktop>>doc:Public.Applications.Desktop.User-Manual.WebHome||target="_blank"]]
87 +* Quick Start Guide: Easily setting up Teamwire for [[iOS>>doc:Public.Applications.iOS.Quick-Start-App-Setup.WebHome||target="_blank"]] or [[Android>>doc:Public.Applications.Android.Quick-Start-App-Setup.WebHome||target="_blank"]]
88 +* Quick Start Guide: Key features of Teamwire for [[iOS>>doc:Public.Applications.iOS.Quick-Start-Key-Features.WebHome||target="_blank"]] or [[Android>>doc:Public.Applications.Android.Quick-Start-Key-Features.WebHome||target="_blank"]]
89 +* user manuals of the Teamwire app for [[iOS>>doc:Public.Applications.iOS.User-Manual.WebHome||target="_blank"]], [[Android>>doc:Public.Applications.Android.User-Manual.WebHome||target="_blank"]] or [[desktop>>doc:Public.Applications.Desktop.User-Manual.WebHome||target="_blank"]]
160 160  
161 -Feel free to use our [["Rollout to Users" template ( {{icon name="sign-in" size="1x" cssClass="fa-blue helpc" title="This document is only available to logged-in users"/}})>>doc:Customer.Administration.Rollout-to-Users-Template.WebHome||title="This document is only available to logged-in users"]], which contains useful information about Teamwire's features.
91 +You are also free to use the [[Rollout to Users Template (Login required)>>doc:Customer.Administration.Rollout-to-Users-Template.WebHome||target="_blank"]] with useful information about the Teamwire features.
162 162  
163 -
164 164  ## ##
165 -
166 -{{id name="next"/}}
167 -
168 -(% class="numbox-title" %)[[image:Public.Attachments.WebHome@icons-reshare.svg||style="padding-bottom:3px"]] [[Next steps...>>doc:Public.Getting-Started.First-steps-for-Teamwire-admins.Next-Steps.WebHome]]
169 -
170 -The next steps will allow you to further customise Teamwire to suit your company's needs.
171 -
172 -## ##