1.3.4. Client Apps
- wiki
The Client Apps page can be reached by navigating to the menu item.
After installation, there will be 3 client apps added by default:
- FSRestAPI - Client app configured to provide information and access token for third-party scripts invoking (deprecated and new) RestAPI methods. For more information, check FSRestAPI Client App at the end of this page
- Portal - Client app for Flowster Portal
- WebApps - Client app for Flowster WebApps
NOTE: Users can define other Flowster Studio client apps with specific settings. Client apps are used in order to configure the communication between Administrator and Flowster WebApps clients.
The Client Apps page is divided into two major areas: Client Apps and Specific Configuration. Client Apps displays a list of all defined client apps applications (e. g. Portal 1, Additional Portal 2). Specific configuration displays information regarding the selected client app divided into the following tabs: Info (Settings), Security, Agents, Configuration and Sessions Configuration.
In order to add a new client app, follow the next steps:
- Click the Add Client App button. The Add Client App window will open.
- Type in a client app name
- Type in a description (optional)
- Check the Show tabs according to what type of info you want to be displayed
- Click the Save changes button to save or Close to abort the current operation
The new created client app will be displayed in the client apps list. When selected, information regarding the Name, Description and Hash will be displayed in the Info tab. Client app's hash code is unique and automatically generated.
As mentioned above, a client app can have its own settings list. In order to add a new setting, follow the next steps:
- Click the
button from the Setting values area. The Add new setting value window opens:
- Type in a setting name
- Type in a setting value
- Type in a setting description (optional)
- Click the Save changes button to save or Close to abort the current operation
In order to edit an existing setting value, follow the next steps:
- Select the client app and go to the Setting values
- Select a value and click the Edit button
- The Edit setting value window opens
- Edit the setting name
- Edit the setting value
- Edit the setting description
- Click the Save changes button
In order to remove a setting value, follow the next steps:
- Select the client app and go to the Setting values
- Select a value and click the Remove button
Users Groups can be restricted/permitted to a selected client app from Security tab. By default no users group assignments are added. To add permissions for the client app, click on Edit button and add the desired users/users groups.
Agents can be added to the client app from Agents tab. Agents, like client app, are defined by name, description and a hash code, also unique and automatically generated. In order to add an agent, follow the next steps:
- Select a client app and go to the Agents tab
- Click the Add button. The Add new agent window opens
- Type in an agent name
- Type in an agent description
- Click the Save changes button to save or Close to abort the current operation
In order to remove an agent, select the desired agent from agents list and click the Remove button.
The Configuration tab allows the user to specify if the selected client app would be displayed and accessible from the Web Client Apps website.
In order to display a client app on the website, follow the next steps:
- Check the Show In Web Client Apps option
- Select an image to associate the client app with, by clicking the Browse button
- Type in the client app web address
- Click Save.
The Sessions Configuration tab allows the user to enable the visibility of the Portal → History → Sessions View button to display the list of the logged in user sessions. This setting should be used only for Portal type client apps. By default, the value is set to None Selected, which means the Sessions View button is visible.
If the value is Hidden the Sessions View button will be hidden in Portal → History.
In order to remove a client app, select the desired client app from client apps list and click the button. The client app will be removed from the client apps list.
FSRestAPI Client App
This client app is configured during installation to be later used for third-party scripts invoking RestAPI methods. The RestAPI documentation URL is added as a Setting for the client app:
In order to invoke deprecated RestAPI methods, users require the following information from the client app's configuration:
- Hash value from the client app's Info tab
- User account from the client app's Security tab. The account is requested during installation, together with the password that is set automatically to obtain the access token. The password inserted during installation should match the password used in the scripts. Users can change the password provided during installation by selecting the assigned user and click the Set Password button. The user account is also added in the Security Groups in a user type group created for the RestAPI client app configuration:
- RestAPI Endpoint from the client app's Security tab. Select the user account which has the password set and the RestAPI Endpoint will be automatically displayed
In order to invoke new RestAPI methods, users only require the RestAPI Endpoint and credentials for a user account with permissions in Flowster Studio. It doesn't need to be the user account from the client app's Security tab (that user is configured during installation only to provide backwards compatibility with deprecated methods from previous versions of Flowster Studio that required special settings for the RestAPI client app), it can be any user account with permissions in Flowster Studio.
For further information regarding RestAPI and code samples on how to use it, please visit RestAPI.