Product Documentation

Integrating Secure Forms with ShareFile

Sep 06, 2016

To deploy Citrix Secure Forms, formerly Citrix WorxForms, you must set up ShareFile folders either manually or by using a PowerShell script.

PowerShell Script Setup

Note: The script works only if you have a Citrix-managed (cloud) ShareFile StorageZone. If you have a customer-managed (on-premise) StorageZone, use the following manual steps:

1. Install the ShareFile PowerShell SDK, available here.

2. Open the PowerShell console and run the CitrixsSecureForms.ps1 script, available here.

3. Enter a user name and password that has permission to create root-level folders and user and distribution groups.

localized image

The script automatically creates the groups CitrixSecureFormsAdminUsers and CitrixSecureFormsEndUsers, as well as the required folders with appropriate permissions assigned.

You can now add users to these groups from the ShareFile console.

User Permissions

Users added to CitrixSecureFormsAdminUsers can access the composer at secureforms.citrix.com, create and publish forms, and read data from submitted forms.

Users added to CitrixSecureFormsEndUsers can use the mobile app only. They can sign on to secureforms.citrix.com, but they have read-only access to forms. They can't edit or publish forms, or access submitted data.

Form Storage

All published forms are saved in Shared Folders > Citrix_SecureFormsTemplate.root > Default.workspace.

All submitted forms are saved in Citrix_SecureFormsData.root.

Manual Setup

If the PowerShell script doesn't work, you can set up the necessary folders manually.

1. Log on to ShareFile with a user name and password that has permission to create root-level folders, as well as user and distribution groups.

2. Go to Manage Users > Distribution Groups and then select New Group.

localized image

3. Create a distribution group called CitrixSecureFormsAdminUsers.

localized image

4. Click Add Member to add users who can access the Secure Forms Composer. Members of this group can create, update, publish and delete forms.

localized image

 

5. Create a distribution group called CitrixSecureFormsEndUsers. Members of this group can use the Secure Forms mobile app to fill out and submit forms. On the composer, members have read-only access to forms. They can't publish forms or view submitted data.

localized image

The distribution groups you've just created appear in Manage Users > Distribution Groups.

localized image

6. Return to Home and go to Shared Folders.

localized image

7. Create a folder called Citrix_SecureFormsTemplate.root.

localized image

8. Give all permissions for the Citrix_SecureFormsTemplate.root folder - download, upload, delete, and admin - to CitrixSecureFormsAdminUsers.

localized image

9. Give download permission only to CitrixSecureFormsEndUsers.

localized image

10. Inside the Citrix_SecureFormsTemplate.root folder, create another folder named Default.workspace. Make sure Default.workspace has the same distribution group permissions as Citrix_SecureFormsTemplate.root. All published forms are saved inside Default.workspace.

localized image

11. Return to Home and go to Shared Folders.

12. Create a folder named Citrix_SecureFormsData.root. All submitted forms data goes into this folder.

localized image

13. Give all Citrix_SecureFormsData.root permissions - download, upload, delete, and admin - to CitrixSecureFormsAdminUsers.

localized image

14. Give CitrixSecureFormsEndUsers upload only permissions for the Citrix_SecureFormsData.root folder. CitrixSecureFormsEndUsers members can submit but not view form data.

localized image

Troubleshooting in Secure Forms Composer

The following troubleshooting tips apply to errors users may see when using Secure Forms Composer. Many of these errors result from mistakes made during the initial ShareFile setup.

Error Code

Message User Sees

What It Means

What To Do

12501

You don't have permission to publish. Please contact your ShareFile administrator.

The user can't publish the template. This usually happens because the user doesn't have permission to access
My Files and Folders > Citrix_SecureForms.root > My Unpublished Templates, or
Shared Folders > Citrix_SecureFormsTemplate.root > Default.workspace.

 

Log in to ShareFile as an administrator and add the user to the CitrixSecureFormsAdminUsers distribution group, following the instructions at Integration with ShareFile > Manual Setup. This gives the user permission to access these folders.

 

12502

You don't have permission to delete. Please contact your ShareFile administrator.

The user doesn't have permission to delete the particular form or template.

 

Log in to ShareFile as an administrator and give the user delete permission:

Add the user to the CitrixSecureFormsAdminUsers distribution group, following the instructions at Integration with ShareFile > Manual Setup.  Make sure that CitrixSecureFormsAdminUsers has delete permissions.

 

 

12503

You don't have permission to unpublish. Please contact your ShareFile administrator.

The user can't unpublish a template. 

This happens when the user has read-only access to the shared location, Shared Folders > Citrix_SecureFormsTemplate.root > Default.workspace.

 

Log in to ShareFile as an administrator and give the user full permission to the shared location.

Add the user to the CitrixSecureFormsAdminUsers distribution group, following the instructions at Integration with ShareFile > Manual Setup.  Make sure that CitrixSecureFormsAdminUsers has write permission tso the shared folder.

12504

Couldn't find or create the given NFS path.

One of several possible Network File System (NFS) errors has occurred:

  • Invalid NFS connector name or no such connector (this returns a 404 HTTP)
  • Not enough permission to create a new folder in the NFS connector
  • NetScaler/NetScaler Gateway isn't handling the OPTIONS request through a separate load balancer/policy
  • Anonymous/Windows  authentication is disabled in the Storage Zone Controller
  • Storage Zone Controller is down/unavailable
  • Invalid credentials (user name, password, domain name)
  • Citrix.com is not an allowable top-level domain.

 

  • Make sure the NFS connector name exists and is accessible in ShareFile.
  • Check Shared Folders permissions.
  • Check load balancer configuration in NetScaler.
  • Make sure both Anonymous and Basic authentication are enabled in the Storage Zone Controller.
  • Manually check to make sure the Storage Zone Controller is available.
  • Verify the user's credentials.
  • Add citrix.com as an allowable top-level domain.

For more information, see Configuring a Network File System.

12505

You've reached the duplication limit. Please delete some copies to continue.

A template has reached 100,000 duplicates, the maximum allowed.

 

Delete some templates.

 

 

12506

Couldn't find My Files and Folders in your ShareFile account.

The top folder, My Files and Folders, is unavailable. Usually, My Files and Folders is created automatically in ShareFile when a user is added to a particular subdomain. Secure Forms creates a root folder in My Files and Folders where all user-specific data is stored.

 

Make sure that the user is added to the folder as an employee, not as a client. For more information on the differences between employees and clients in ShareFile, see this article.

There also may be a licensing issue, in which case you should contact ShareFile support or go to the MyCitrix portal for help. 

12507

Couldn't find Shared Folders in your ShareFile account.

The folder Shared Folders is unavailable. Usually, Shared Folders is created automatically in ShareFile when a user is added to a particular subdomain. Secure Forms uses this location to access shared data.

 

Log in to ShareFile as an administrator. Make sure Shared Folders is available and that the user is in the group that has permission to access it. Follow the instructions at Integration with ShareFile > Manual Setup.

 

12508

Couldn't find the root folder in Shared Folders.

The folder Shared Folders > Citrix_SecureFormsTemplate.root is unavailable. This folder contains the default.workspace folder, where published forms are stored.

Log in to ShareFile as an administrator. Make sure Citrix_SecureFormsTemplate.root exists and that the user has permission to access it.

Go to Integration with ShareFile > Manual Setup and follow the instructions at Create a folder called Citrix_SecureFormsTemplate.root.

12509

Couldn't find the data folder in Shared Folders.

The folder Shared Folders > Citrix_SecureFormsData.root is unavailable. Submitted forms are stored in this folder.

 

Log in to ShareFile as an administrator. Make sure Citrix_SecureFormsData.root exists and that the user has permission to access it.

Go to Integration with ShareFile > Manual Setup and follow the instructions at Create a folder called Citrix_SecureFormsData.root.

 

12510

Couldn't find the default workspace in the Shared Folders.

The folder Shared Folders > Citrix_SecureFormsTemplate.root   > default.workspace isn't available. Published forms are stored in this folder.

Log in to ShareFile as an administrator. Make sure the default.workspace folder exists and that the user has permission to access it.


Go to Integration with ShareFile > Manual Setup and follow the instructions at Create a folder called default.workspace.

12511

Couldn't load the root folder in Shared Folders.

The folder Shared Folders > Citrix_SecureFormsTemplate.root  failed to load.

 

Log in to ShareFile as an administrator and make sure the user has permission to accessr Shared Folders > Citrix_SecureFormsTemplate.root.

Go to Integration with ShareFile > Manual Setup and follow the instructions at Give all folder permissions—download, upload, delete, and admin—to CitrixSecureFormsAdminUsers.

12513

Couldn't access ShareFile user information.

The Secure Forms mobile app is trying to access basic user information, such as first name, last name, or email, but ShareFile fails to respond. This usually happens when the administrator has disabled the user.

 

Log in to ShareFile as an administrator, go to Manage Users > Search Users and make sure the user isn't disabled.

12514 Please refresh this page and enter your company credentials. In ShareFile Restricted Zone setups, a user entered the wrong credentials. The user should refresh the page and enter the correct credentials.
12515 Access this website from within your organization's network. Contact your help desk if you continue to see this error.
  • A user canceled or closed the composer after an unsuccessful sign-on attempt.
  • There are self-signed certificates that the browser doesn't trust.
  • The user is trying to access a Restricted Zone from outside the network.
  • A general network, Internet, or DNS failure has occurred.
The user should try again later or contact the help desk.

Error Code 12000

An error code of 12000 is an unidentified issue. You need to contact Citrix support. Follow these steps to generate console logs and send them to Citrix.

1. Open the Chrome inspector. Right-click anywhere within the Chrome window and then select Inspect. The page source code appears.

2. Get console logs. Click the Console tab in the inspector window. Right-click and then select Save as to save the logs as a file. Close the inspector.

3. Contact Citrix. Click the dialog bubble icon in the upper-right corner of Secure Forms Composer. In the message window, write a short description of the issue. Then, take a screen shot and attach the console log file. 

localized image