HomeGuidesRecipesAPI
HomeGuidesAPILog In

Manage - Left Panel Menu Items Overview

The left panel is the heart of Manage. The different menu items present in the left panel helps the user to perform all the administrative activities. The different menu items are as follows:

Projects

When the user clicks on the Projects menu item in the left panel, they will see the different folders currently present in SmartIQ . When the user clicks on a particular folder, the corresponding projects present inside that folder will be displayed.

For example, in the below screenshot, we have a folder Dashboard in SmartIQ and when we click on the Dashboard folder, we see the different projects inside this Dashboard folder.

When you choose a project from the Projects list, if the project is of type Fragment Page/Fragment Portion, there is a button on the button bar as 'Projects'. Clicking this button, a user can view the list of projects that use the selected fragment. The projects from the list can be edited or not based on the same logic that is applied to the project list page which checks for user permission on the content folder.

๐Ÿ“˜

Searching for projects by an incomplete name

When searching for projects, the default is to match a complete string at the beginning of the project name. To search for partial values, use the % character as a wildcard in the search term

The additional features provided under this Projects menu item includes:

  • New Folder: To create a new folder.
  • Edit Folder: To specify groups that can make changes to existing folder content in Manage or Design.
  • Delete Folder: To delete an existing folder.
  • Import: To import an SmartIQ project.

๐Ÿ“˜

Error Message information on Import Projects

When performing "Import Project" from Manage UI or Admin API, if there is a failure, descriptive error messages can be viewed in Manage UI and Admin API respectively

๐Ÿšง

Making changes to Project Versions

Project Names can be configured in Design under Project Properties

Publish Folders

When the user clicks on the Publish Foldersmenu item in the left panel, they will see the different published folders currently present in SmartIQ . When the user clicks on a particular folder, the corresponding projects present inside that folder will be displayed.
The different projects published inside these publish folders projects can be accessed by the user in Produce.

For example, in the below screenshot, there are two folders and the different projects published inside the folders.

When the user navigates to Produce, the folder names act as the heading under which the different projects are shown.

The additional features provided under this Publish Folders menu item includes:

  • New Folder: To create a new publish folder.
  • Edit Folder: To edit an existing publish folder.
  • Publish Project: To publish a SmartIQ project so that it is accessible to the end user from Produce.

๐Ÿ“˜

Info

Only published projects are accessible in Produce.

Content Library

๐Ÿ“˜

Content Library License

Contact your sales representative if you are interested in obtaining a valid Content Library licence key for your SmartIQ instance.

Content Library acts a repository of contents in SmartIQ . The content of the content library is accessible in the SmartIQ Forms via Content Library question type. SmartIQ supports four types of content items which are as follows:

  • Attachment
  • Document Fragment
  • Font
  • Image
  • Text

When you click on the Content Library menu item in the left panel, they will see the different content library folders currently present in SmartIQ . When the user clicks on a particular content library folder, they will see the different content items which are present inside that folder.

For example, in the below screenshot, we have a content library folder Dashboard in SmartIQ and when we click on this Dashboard folder, we see an attachment content item present inside this Dashboard folder.

The additional features provided under this Content Library menu item includes:

  • New Folder: To create a new content library folder.
  • Edit Folder: To specify groups that can make changes to an existing content library folder in Manage or Design.
  • Delete Folder: To delete an existing content library folder.
  • New Content Item: To create a new content item.
  • Delete Selected Item: To delete an existing content item.

Folders can be arranged in a tree-like structure.

๐Ÿ“˜

Info

This option would be visible when you have a valid Content Library licence key.

Data Connections

This is the place in SmartIQ where you configure the connections to the external data sources which can be used in populating data in the forms and generated documents output. SmartIQ includes the following generic data connections:

  • OLEDB
  • SQL Server
  • CSV
  • Web Service
  • XML
  • SmartIQ
  • JSON
  • REST

Additional data connections are delivered as third party components to the core platform.

Custom Fields

Additional fields can be added to various areas of the platform such as user profile and address fields. These are accessible within the Design experience and maintained by the API or the user themselves.

  1. Fill in the title.

  2. Choose the location:
    Contact
    Group Address
    User
    Response Metadata

  3. Choose the type of field:
    Text
    Date
    Image

  4. Set the field length.

Categories

Categories provide a mechanism to classify content library items as additional collection and search metadata.

Click the New Category button.
Type in the name of the new category.

Communication Templates

Communication Templates allow the designer to create and modify templates which can be used in place of default system emails, and used as the input to some inbuilt Actions and Escalations (primarily Send Email).

For more information, refer to Communication Templates.

Sequences

Define sequences that can be leveraged across SmartIQ forms. They will be created following a specified pattern during run time. Creating sequences requires Design permissions.

For more information, refer to Sequences .

Approvals

The Approval workflow state is delivered as a new type of workflow state and can be added to the workflow by selecting from the dropdown list of available approvals.โ€‹

For more information, refer to Approvals.

Users

User management for the system is conducted in this section

Clicking the Export button will allow you to export all User information to a .csv file.

Selecting a username will take you to their profile screen. This screen allows to:

  • Modify users information and regional settings.
  • Delete the User.
  • Configure Security (Groups and Roles).

Remember to click Save before leaving this page to commit your changes.

Groups

The Groups section will show all existing groups.

Clicking on the New Group button will take you to a menu where you can create a new group.

  1. Type in a group name.
  2. Choose the role:
  • End User
  • Global Administrator
  • Workflow Administrator

You can set the permissions level for the Role name.

Group Address

Emails can be sent to a dedicated group email address by entering a valid email address in the Email field. Additionally, emails can also be configured to send to all users in the group by enabling the โ€œEmail Individual Group Membersโ€ checkbox.

Roles

In the roles section, you can create roles that work for your organization. Create the Role Name, then select from the list of permission that this role should have.

Custom roles can be created to set the security level for a user. When creating a new role there are various permissions that can be attached to that role. Each permission has its own role which is detailed below:

Change settings

This option allows the user to modify the settings of the SmartIQ site. When this permission is set to a user, that user will be able to see the settings menu in manage and can modify them. These permissions are best set for a role that only needs the ability to modify settings in manage.

Content approver

This option allows the user to approve changes to the content items in the content library. This role only applies when โ€œEnable Content Approvalโ€ is enabled in settings.

Note: The user will need to have the โ€œManage content libraryโ€™ permission set as well so that they can view the content library. This permission is best set for a role that needs the ability to approve content in the content library.

Design projects

This option allows the user to create projects in design as well as publishing those projects to folders. This permission is best set for a role that only needs the ability to run SmartIQ design application.

Impersonate Users

This option allows the user to impersonate other users in the client API.
Important: This permission should only be given to service accounts.

Licensing

This option grants permission to modify your SmartIQ licensing configuration.

Manage content library

This option allows the user to add and delete content library items. When this permission is set to a user, that user will be able to see the content library menu. This permission is best set for roles that need the ability to manage the content library.

Manage data connections

This option allows the user to create, edit or delete data connections. When this permission is set to a user, that user will be able to see the Data Connections menu. This permission is best set for a role that needs the ability to modify the data connections.

Manage groups

This option allows the user to create, edit or delete groups. When this permission is set to a user, that user will be able to see the Groups menu. This permission is best set for a role that needs the ability to modify the groups in manage.

Manage security

This option allows the user to create, edit or delete Roles which can be used to set the security for users. When this permission is set to a user, that user will be able to see the Roles menu. This permission is best set for a role that needs the ability to modify roles.

Manage users

This option allows the user to manage the users for the environment. When this permission is set to a user, that user will be able to access the Users menu. This permission is best set for a role that needs the ability to manage the users for the SmartIQ environment.

Manage workflow tasks

This option allows the user to manage the workflow tasks for the SmartIQ environment. This is where you can view all workflow tasks as well as terminating and reassigning those tasks. This permission is best for a role that needs to manage the workflow.

Management console

This option allows the user to view the management console. This permission is best set for a role that needs the ability to view the management logs in manage.

Manage publish folders

This option allows the user to manage folder access and publish projects. This permission is best set for a role that needs the ability to manage the folder access and can edit projects.

View event log

This option allows the user to view the logs for the different events that may occur. This role is best set for a user that needs to ability to view and troubleshoot errors in the system.

Management

Event Log

The Event Log menu displays event log messages specific to the current tenant and only users with the "View event log" permission will have access to the Event Log.

To ensure separation of access for cloud tenants, these logs will be encrypted in the database as it may contain information that should not be visible to the cloud database admins. Additionally, logs that are not tenant specific will show empty GUID Business Units (00000000-0000-0000-0000-000000000000).

A new endpoint to retrieve Event Log messages under Admin is also available in swagger.

Workflow

๐Ÿ“˜

Workflow License

Contact your sales representative if you are interested in obtaining a valid Workflow licence key for your SmartIQ instance.

Following each workflow task, there is an option that allows the task's history to be viewed. A column is available with a history icon:

Click on this icon to display the Task History screen

The following information is now available for each transition of each task:

  • State
  • Created
  • Assigned To: (Group name / Full User name / Username)
  • Opened
  • Completed

Licensing

The licensing section is the overview of what licensing your company holds. In order to add new licenses, you need your Tenancy Key. Use the Copy to Clipboard button to copy your key and send it to your SmartIQ representative if new modules are needed.

From this page you can tell the following information at a glance:

License Type

User Licenses: how many you have/how many are in use.
Mobile App User Licenses: how many you have/how many are in use.
Anonymous Project Licenses: projects that can be accessed without needing a login to Produce - how many you are allowed/how many are in use.
Authenticated User Project Licenses: projects that can only be accessed via a user login to Produce - how many you are allowed/how many are in use.

You can also view what Modules you currently have in place.

Demo and Test Licenses

If you have a demonstration or test license, there will be a message at the top of any form in Produce indicating it is for "demonstration" or "test" purposes only. There will also be a stamp on generated documents.

Availability:

  • Excel
  • JSON
  • PDF generations
  • PowerPoint
  • Text
  • Word
  • XML

๐Ÿ“˜

Note

For all Microsoft outputs, the resulting document will be read only.

Generated Documents Stamp

Allows user to define a customized stamp

Below is the generated output document with stamp.

๐Ÿšง

Generated Documents Stamp is available only for Standard/ Transactional licences

Availability:

  • .docx
  • .pdf
  • .pptx

Settings

๐Ÿ“˜

Permissions

The Settings page is only visible to Administrators with the โ€˜Change Settingsโ€™ permission. If Administrators are unable to see the Settings page, go to Manage > Roles > Your Role (e.g. Global Administrator) and check that the โ€˜Change settingsโ€™ permission has been enabled. After making changes, log out of SmartIQ before the changes will take effect.

General Tab

Google Tag Manager

This feature requires a new license module "Google Tag Manager".

Once the site has that license then Manage > Settings > General > Google Tag Manager Container ID will display. This allows the entry of the GTM-XXXX style code that can be retrieved from the Google administration console.

Produce will then start reporting to Tag Manager browses to Home and Forms similar to Google Analytics does.

๐Ÿ“˜

Note

Content-Security-Policy header needs to be modified for Produce to add https://www.google-analytics.com https://www.googletagmanager.com to allow communications and js download from those sites. (See appsettings.json)
When using on a non-https site, eg localhost, http://www.googletagmanager.com also needs to be added to the CSP header.

Defaults Tab

Defaults have settings that can be distributed and applied to all projects.
The following settings can be set:

  • Default Culture, Language and Time Zone Settings
    Default setting for Time zone, culture, and language settings.
  • Default File Extensions
    A comma-separated list of valid file type extensions to be used system wide for File Selection questions when selecting the attachment content type, or when adding a Content Library item.
    For example, .pdf, .png, .jpg.

๐Ÿ“˜

Note

If no value is entered, all file extension types will be allowed. This setting can be overwritten on individual questions in Design by using the Valid Extensions setting.

  • Default PDF Embed Fonts
    Global setting to enable embedding full fonts on generated PDFs. Embedding stores the font information, which means the document size will be larger.
  • Default Form Interaction Log option
    Global setting for Form Interaction Log.
  • Default Strict Accessibility
    Default setting for Strict Accessibility

User Profile Mapping Tab

Security Tab

Password Settings

SmartIQ provides several password settings for improving security. Different password settings are:

  1. Enforce Minimum Password Length โ€“ Sets the minimum length requirement for passwords.
  2. Lock Out Users For 5 Minutes After Invalid Password Attempts โ€“ Prevents users from logging in for 5 minutes after a number of invalid password inputs.
  3. Enforce Password History โ€“ Enables storing a certain number of passwords to prevent password reuse.
  4. Enforce Password Expiry โ€“ Enables password expiry and request password change after a certain number of days.
  5. Enforce Complex Passwords โ€“ Ensures that the password contains upper/lower case, digit, and special characters.Password must not contain a username and any other similar combinations of username (note that it is available from 8.5.0.25 onwards).

Retention Tab

For more information, refer to Retention Settings.

556556

On Premise Settings

488488

Cloud Settings

Theme Settings Tab

To see how to use these settings, see SmartIQ Theme Settings.