HomeGuidesRecipesAPI
HomeGuidesAPILog In

Projects and Publish Folders

Projects

Project Folders contain the Projects currently saved, and provide a way of organizing and controlling edit-ability of projects, data connections, and content items. The (None) folder is a valid folder. Projects with a padlock icon next to their name are published projects.

The search function "Name" accepts % as a wildcard, e.g. "%min" will return any project names that contain 'min'.

📘

Project Folders vs Publish Folders

Project folders differ to Publish folders in that Project Folders control which users can edit or Design with content as opposed to running it in Produce.

Clicking on a project name gives you a number of controls to manage the project.

Option/sDescription
Import and exportImport and export files contain projects and Sync packages that can be re-imported later
PublishPublishes the project to the produce app
DesignTakes you straight to the design app loading the project
Version HistoryLists the version number, modification/save date, what user made the last save, their comments, and a version rollback feature
Publish FoldersLists the folders the project is published in
FolderAllows you to set what folder the project is contained within

📘

Project major and minor versions

Each save to a project in Design represents a minor version, whereas a major change is defined as when the project is closed and the designer is prompted for version comments (optional).

Project Permissions

Different folder permissions can be set for different Groups of users, which apply to anything in a content folder including Projects, Data Connections and Content Items.

📘

Projects, Content Library, and Data Connections share folders and folder permissions

These folders are known broadly as 'content folders'

Clicking the desired folder then 'edit folder' presents the option to enable/disable the Edit and Design permissions for the user groups. This can include different permissions for child folders, however a child folder cannot have a permission that a parent folder does not have.

259

Edit permission allows that group to see the folder and edit, delete, and create items in that folder.

Design permission allows that group to open existing projects in Design, see and access data sources, fragments and other content items in Design drop down lists to choose from.

Exporting and Importing Projects

Export Project

Exports project contents including Fragments, Data Connections and related Content Library items​ into an .ixpkg file.

Export Sync Package

Export sync package will call the admin API sync export and create an .iqpkg with the returned JSON. The .iqpkg file has the same contents as the .ixpkg file but also includes information related to the project, how it is interconnected and creates the folder structure; Folders (and their permissions)​, Groups (and their permissions)​, Custom Fields definitions, Communication Templates​, Sequences​, and Approvals.

Import

🚧

Attempting to import a sync package into an environment that already has a range of projects, groups, folders etc already configured is not likely to work

🚧

Ensure that you are logged in using an account with appropriate permissions

If the user does not have access to any part of the sync package, the import will fail

Importing an .iqpkg file presents a read only view of the project name, with optional import overrides. The import options are the same as the admin API import options: Always, If Not Exists, and If Newer

After importing the project, Manage validates the package by running it through the test API import feature and will only commit the changes if successful.

Publish Folder

Publish folder contains the projects that have been published into production. Folder options provide the same group permissions controls as the project folders.

Published Project Options

The options available depend on the type of project

There are a variety of modes that can be enabled to help manage SmartIQ projects, the user experience, and help solve problems.

OptionDescription
Maintenance Mode
Allow PreviewEnables the Preview Button in Produce which allows users to preview the documents to be generated. In a Workflow if there are no documents generated in the next transition there will be no documents to preview
Allow Restart After SubmissionWhen the option is ‘On’ and it is not a workflow submission, there is a new ‘Restart’ link on the finish page. This starts a new form with the same values as the last time you generated it.
Show SaveAllows users to save their answers on a form.
Auto-create In Progress FormsDetermines whether the form should be automatically saved before a user manually saves, otherwise it is discarded on exit. In a workflow project, this setting will save an in progress form (but will not create escalations or a workflow entry) before a user manually clicks save. Once workflow has been created (or a user has manually clicked save), the form is automatically saved regardless of this setting.
Track ChangesTracks the changes to the published project
Form Interaction LogEnables data collection for individual projects. This data contains detailed and accurate data for individual projects and page activities. This data can be viewed and downloaded under Reports in Manage.
Display Validation on NavigationEnables displaying a check mark against pages in the navigation menu with no validation issues.
Enforce ValidationWhen enabled a user cannot finish the web form if there are questions with outstanding validations.
Update Document FieldsUpdate the generated document fields after the content has been generated. For example update data tables and recalculate formulas. This may impact performance for large projects.
Hide Navigation PaneWill hide the navigation pane (sometimes called progress menu) within the web form. This is useful when end users should answer the questions in only the correct order and not skip ahead and when there are only minimal pages to display
Hide Recent Files on Form
Show Form ActivityIts main purpose is to display the status of workflow forms as they transition between states. The Form Activity tab is displayed in Produce.
Match project version when loading in progress formsThis allows control over how a project loads when it is loading from an existing workflow, answer file or save in progress. If this flag is turned on, the form will use the same version that was used when the workflow/answer file/ in progress for the form was initiated. Without this option turned on, in-flight projects that have major changes made to them could get stuck and break.
Troubleshooting ModeHelps identify errors like those in data sources
Show in Web HomeShows published projects on the web page or restricts the project from the web channel.
Show in App HomeShows published projects on the App or restricts the project from the App. This option will be disabled if the project has a custom question and hidden if the license does not include App Users.
Allow Offline LaunchThis feature if turned ‘On’ allows tasks which contain data sources to be continued while offline (mobile clients) This option will be hidden if the license does not include App Users.
Set as Home PageSets the current page as the homepage. If a user has access to more than one Home Page Project, then the first home page project that would have displayed in the project list on Produce Home will be the one shown.
Keep Form History After CompletionWhen enabled, SmartIQ keeps the workflow history and logging until the expiration set on the Retention Settings and then deleted. Disabling this option means that when the form is completed, the workflow history, log information, and who submitted it will be removed. In this case, logging in Manage > Management will show "Unknown User" in the User column.
Restrict Availability DatesAllows you to provide a start and end date controlling the projects availability.

🚧

Match project version when loading in progress forms can have breaking unexpected behaviour

Make sure to have this on by default unless its necessary for all in-flight versions to also be updated and the potential for breaking the Workflow is worth the risk.

projectGroupGuid

Once a project has been published, it is assigned a unique id. In Manage, go to the Projects section. Click on the name of the project, the ID and URL will be listed.