To install Cinchy Meta-Forms on Kubernetes you will need:
A deployed Cinchy platform. Note that these instructions are specific to a Kubernetes deployment; for instructions relevant to an IIS deployment please see here.
The Cinchy CLI. Please see here if you do not have this running.
The Cinchy Meta-Forms code is hosted on GitHub here. For a Kubernetes deployment, you need to download the Meta-Forms-Data-Experience zip file.
Ensure that you download the latest version.
Navigate to the Meta-Forms-Data-Experience package.
Open "\post-install\post-install-1.sql" and replace the below with your own URLs.
Open an instance of Powershell or similar terminal.
Run the below command, using the table as a guide and inputting your own parameters.
Once you have installed the experience, your environment will be populated with these tables and queries:
Forms table
Forms Sections table
Form Fields table
Get Form Metadata query
Get Form Sections Metadata query
Get Form Fields Metadata
Forms Table: This table houses all of the existing forms in your environment. Adding an entry to this table, will add a form to the complete list of forms. The table is used to link form fields and form sections to one specific form, and it connects to the table which contains all of the form responses/data.
Form Sections Table: This table is used to create separation between parts of the form. For instance, when creating a quiz based on compliance, you can use this table to create a section for the technological questions, one for the policy based questions, and one for any possible quiz feedback. A new form section can be created by adding a new entry to this table. The form sections need to be connected to the form created in the Forms table.
Form Fields Table: This table is used to create all of the possible data entry fields associated with the form sections within the form. To create a new form field, simply add an entry to the table and connect it to the form section. In the example of the quiz, add an entry for every question and link it to the appropriate form section.
Get Form MetaData Query: This query will return the metadata of your form, using the form ID present in the Forms table. The results will show such data as whether a form field is mandatory or not, the choices present for each question, the column names and types present in the table containing your form data, the form fields and sections, the JSON data, and more.
Get Form Sections Query: This query uses the form ID, present in the Forms table, in order to return all of the form sections present within the form.
For any users who want to access forms/want forms to execute properly, they need to have access to all of the following tables and queries. These include the three tables and two queries shown above, as well as the Tables, Table Columns, and Domains tables within that user's specific environment.
Required Command
Description
-s, --Cinchy Server
Required. The full path to the Cinchy server without the protocol (e.g. cinchy.com/Cinchy).
-h, --https
Flag indicating connections to Cinchy should be over https.
-sso
The full path the the CinchySSO server without the protocol (e.g. cinchy.com/CinchySSO). This is only required if your CinchySSO server is different than /CinchySSO.
-u, --Username
Required. The user id for accessing Cinchy.
-p, --Password
Required. The clear text password (unencrypted) of the specified user.
-c, --CinchyCLI Directory
Required. The path to the Cinchy CLI.
-d, --CinchyCLI Temp Directory
Required. The path to the directory that the CLI can use for storing temporary files to support the sync (e.g. partitioned data).
-e
Required if you are running the CLI via exe instead of dll.
To install Cinchy Meta-Forms you will need:
A deployed Cinchy platform. Note that these instructions are specific to an IIS deployment; for instructions relevant to an Kubernetes deployment please see here.
The Cinchy CLI. Please see here if you do not have this running.
Ensure that the IIS extension "URL Rewrite" is installed on the server hosting IIS. The extension is available here: https://www.iis.net/downloads/microsoft/url-rewrite
The Cinchy Meta-Forms code is hosted on GitHub here. For an IIS deployment, you need to download the Meta-Forms-Data-Experience zip file and the Meta-Forms-App-Experience zip file.
Ensure that you download the latest version.
Create a ‘Cinchy Applets’ folder if it does not exist (eg. C:/Cinchy Applets) and check in the App Experience code.
If you have multiple instances, create a folder that corresponds to the name of your Cinchy instance (eg. C:/CinchyApplets/DXdemo) and place the extracted AApp Experience folder here.
Open your IIS Manager.
Navigate to IIS Connections.
Right Click the Cinchy Server name.
Expand Sites such that “Default Web Site” is visible.
Navigate to the site containing your Cinchy application and select “Add Virtual Directory”.
Name the Alias of this directory “dx”.
Input the path to Cinchy Applets directory in the Physical Path field.
Right click on the meta-forms folder under the dx virtual directory and click Convert to Application.
Update Configurations
1. Locate "\assets\config.json" and input your Cinchy domain as specified below.
Additional Changes
If you have not deployed Cinchy at the root of your domain on IIS, then you will need to also complete the steps below.
Specify the path to your 'meta-forms' application as instructed below.
Locate the "C:\CinchyApplets\<Cinchy Environment>\Meta-Forms-App-Experience\index.html" file and update the base href to the path to your edit-form application on IIS and save.
Navigate to the Meta-Forms-Data-Experience package.
Open "\post-install\post-install-1.sql" and replace the below with your own URLs.
Open an instance of Powershell or similar terminal from within the Meta-Forms-Data-Experience.
Run the below command, using the table as a guide and inputting your own parameters.
Once you have installed the experience, your environment will be populated with these tables and queries:
Forms table
Forms Sections table
Form Fields table
Get Form Metadata query
Get Form Sections Metadata query
Get Form Fields Metadata
Forms Table: This table houses all of the existing forms in your environment. Adding an entry to this table, will add a form to the complete list of forms. The table is used to link form fields and form sections to one specific form, and it connects to the table which contains all of the form responses/data.
Form Sections Table: This table is used to create separation between parts of the form. For instance, when creating a quiz based on compliance, you can use this table to create a section for the technological questions, one for the policy based questions, and one for any possible quiz feedback. A new form section can be created by adding a new entry to this table. The form sections need to be connected to the form created in the Forms table.
Form Fields Table: This table is used to create all of the possible data entry fields associated with the form sections within the form. To create a new form field, simply add an entry to the table and connect it to the form section. In the example of the quiz, add an entry for every question and link it to the appropriate form section.
Get Form MetaData Query: This query will return the metadata of your form, using the form ID present in the Forms table. The results will show such data as whether a form field is mandatory or not, the choices present for each question, the column names and types present in the table containing your form data, the form fields and sections, the JSON data, and more.
Get Form Sections Query: This query uses the form ID, present in the Forms table, in order to return all of the form sections present within the form.
For any users who want to access forms/want forms to execute properly, they need to have access to all of the following tables and queries. These include the three tables and two queries shown above, as well as the Tables, Table Columns, and Domains tables within that user's specific environment.
Required Command
Description
-s, --Cinchy Server
Required. The full path to the Cinchy server without the protocol (e.g. cinchy.com/Cinchy).
-h, --https
Flag indicating connections to Cinchy should be over https.
-sso
The full path the the CinchySSO server without the protocol (e.g. cinchy.com/CinchySSO). This is only required if your CinchySSO server is different than /CinchySSO.
-u, --Username
Required. The user id for accessing Cinchy.
-p, --Password
Required. The clear text password (unencrypted) of the specified user.
-c, --CinchyCLI Directory
Required. The path to the Cinchy CLI.
-d, --CinchyCLI Temp Directory
Required. The path to the directory that the CLI can use for storing temporary files to support the sync (e.g. partitioned data).
-e
Required if you are running the CLI via exe instead of dll.
