Administration

User Administration

Create new user

All administrators in Sweet Automation have the authority to create new users in the system.

In the top bar, click the gear icon to get to the settings page. Click the tab Users and two tabs are displayed below. Click the other tab for Users and in the upper right corner you find the button + Add user.

• Add first name (optional)

• Add last name (optional)

• Add email address (optional)

• Add phone number (optional)

• Create a username

• Password is automatically generated by the system when a username is created. To see it click Generate and make sure to distribute it separately from the username to the new user. Once the user logs in for the first time, the password can be changed.

• Choose a user level

  • Normal, has the right to create new flows, selections and dashboards using available datasources. Is limited from changing locked or sealed selections and flows.
  • Admin, has access to all settings and have the authority to adjust locked, but not sealed selections and flows.
  • API, more of an administrative user that enables the use of API’s.
  • Light

• Set language, Swedish or English

• Set a theme for the layout. Light is the recommended standard theme and the theme that is being updated regularly.

• Font zoom, a setting to adjust the size of the font text

• Groups on user (optional), here you can easily add a new user to one or more user groups

• Scopes on user (optional), here you have the opportunity to give certain rights to a user such as Attest rights.

Create new user group

All administrators in Sweet Automation have the authority to create new user groups in the system.

In the top bar, click the gear icon to get to the settings page. Click the tab Users and two tabs are displayed below. Click the tab for Groups to display available groups and add new.

• Create new group In the bottom of the list of groups, click New to create a new user group.
• Name your group by simply giving it a name
• To create a hierarchy with sub groups, click + New group in the edit box. If no hierarchy is needed, you can give the top node the same name as the group.
• Add users to the group by clicking the name of the user, in the box of Available users
• Remove user from group by clicking the name of the user in the box of Users in group and see how it moves from that box, to the box of Available users

Set up the API

Sweets API enables the use of data from Sweet Automation, outside of Sweet Automation. There are som requirement that need to be met for the API to work, you need an API user group and an API user, and you need to publish the data you want to make available on the API.

Set up an API user

• Go do Administration and Users
• Click + Add user
• Give it a name, like API user, and add a username
• Copy the Longlived token, by clicking Generate next to the longlived token, and store it somewhere safe
• On Userlevel, select API
• Done

Set up an API user group

• Go to Administration, Users, and Groups
• Click New and give the group a name, here “API”
• A default folder called “Root” is created, either change the name of that too, to “API” or keep it as is
• To create the actual group, click + New group and give it a name, it goes under the root folder
• Add your API user to this group by searching for it in the list of Available users, click it to select it
• The user group is auto saved, so you are now done

Test your API

• Copy your Sweet Automation URL, and add API to the end of it, it should look like this

  • The SA URL: https://sweetbeta.sweetsystems.se/SweetAutomation
  • The API URL: https://sweetbeta.sweetsystems.se/SweetAutomationAPI

• On the API URL, click the Swagger link
• Paste your API token in the field api-token, and click the Explore button
• If the API is working correctly it sould say VALID

API documentation

• Copy your Sweet Automation URL, and add API to the end of it, it should look like this

  • The SA URL: https://sweetbeta.sweetsystems.se/SweetAutomation
  • The API URL: https://sweetbeta.sweetsystems.se/SweetAutomationAPI

• On the API URL, click documentation

Publish a flow to the API

To make a flow available on the API, open the Flow settings by clicking the gear in the top bar of the flow. Scroll to the Publish setting and activate it, and select the group that should have access to the API.

• Propagate = to apply the settings fo sub-user groups
• R = the permission to Read (see) data from the selection
• W = the permission to Write (update or overwrite) data to the selection
• E = the permission to Execute (run or get) data from the selection
• A = the permission to Read, Write and Execute (all) data from the selection

Publish a selection to the API

To make a selection available on the API, open the Selection settings by clicking the gear in the top bar of the selection. Scroll to the Publish setting and activate it, and select the group that should have access to the API. By publishing a selection to the API, you make the datasource available elsewhere.

• Propagate = to apply the settings fo sub-user groups
• R = the permission to Read (see) data from the selection
• W = the permission to Write (update or overwrite) data to the selection
• E = the permission to Execute (run or get) data from the selection
• A = the permission to Read, Write and Execute (all) data from the selection

The selection can now be used, for example as a datasource in Sweet Performance.

Metadata

Metadata is the place where you add new, and find existing datasources. Under the tab Connections you administrate new and existing connections, to add new you must have access to all connection details.

Soon to come

Connection

Under the tab Connections you administrate new and existing connections, to add new you must have access to all connection details.

Add a new connection

• Open Admin on the top bar by clicking the gear, and select Metadata
• Go to Connections and click + New connection
• Name it and select the type of connection you would like to add from the drop down list
• Depending on the type of connection you add, you must enter required credentials or details
• The settings are autosaved

Physical

The physical metadata view provides a detailed representation of the actual database and its relationships. It is crucial to have a solid understanding of the database structure before making any changes here, as modifications could potentially impact the queries executed on the database, leading to potential issues. If there is no immediate need to modify the physical database, we highly recommend creating views in the Visual database insted. In the Visual database, you can experiment and make changes in real time, allowing for more flexibility and exploration.

Visual

Example 1 - Add a missing field/ data point to selection conditions and results, from the Sweet One CRM connection

Background: You are using Sweet One as your CRM system, and have Sweet One as an existing connection (here called Sweet). You are creating a new Selection on Cases to analyze some case data, but notice that one data point, a field from the CRM, is missing and want to add it. Now you want to add the case field “Created By” to your selection, to be able to follow up on what user has created cases.

• As an administrator, go to Administration, Metadata and Visual
• In the Connection drop down, find the Sweet One connection and select it

• Now you must select the entity your looking for in the Metadata drop down, here Sweet Case
• To the left, under Metadata, you can now see the Case database columns, that each represent a field or data point. And also relations between the Case entity and other entities, such as Company or Private person. By clicking a database icon, you expand the group and can see what fields/ data points it contains.

• In the middle, under Visual view, you find all of the already visibile fileds and data points, by clicking the arrow-box icons you can expand it’s content and see what fields/ data points is already available.
• In Metadata, find the field representing Created by, here called by its database name CreatedByUserId, and drag and drop it to the top node Cases to add it to the list

• The new field is added at the bottom of the list, but can be moved in the edit view to the right, by grabbing it by it’s left hand side and drag and dropping it where you like

• The Condition and Result settings for each data point decides if the field is visibile as either one, or both in the Selection.

• To see that your newly added field is available in Selections, open the selection and look in the tree structure for the field.

Valuetypes

This is the place where you can add or change fortmatters, conditions, aggregators and more. Either by adding new ones, or changing existing.

Configuration

The Configuration page is a guide of what you should do in order to properly configure Sweet Automation, as a super user you are not expected to do much here. It is rather a guide for Sweet’s developers when setting up the solution.

Settings

In the Settings you make changes to behaviour of Sweet Automation like change number of allowed tries to login before lock, or the name of the application.

Captions

The Caption Manager enables you to modify captions such as error messages or texts within Sweet Automation, categorized by language. This functionality can be particularly valuable in aligning the system with your business terminology, thereby enhancing user understanding and guidance. It provides a means to customize and fine-tune the system’s language elements, ensuring a more tailored experience for users.

Actions

These settings pertain to advanced configurations for Flow Actions and Tasks. It is important to exercise caution and have a thorough understanding of the settings to avoid disrupting the flow’s functionality. Making incorrect changes here can potentially cause the flow to break. Therefore, it is recommended that you proceed with these settings only if you are confident in your knowledge and expertise.

Import

Webhooks