Deploying Meta-Reports
This page details everything you will need to install and deploy Meta-Reports

Table of Contents

Prerequisites

  • Prior to deploying Meta-Reports in Cinchy, please 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​
  • Prior to deploying Meta-Reports in Cinchy, the Cinchy CLI package needs to be set up on your environment. The CLI package contains the engine with which all the components of a Data Experience package (e.g., tables, queries, views, formatting rules, etc) can be installed on another Cinchy environment.
Note: This setup is only required when Deploying Cinchy on IIS. In Kubernetes deployments, Meta-Reports is available out of the box.

1. Setting up the Cinchy CLI package

Please complete the following, only if the Cinchy CLI package is not set up on your Cinchy environment.
To get access to the Cinchy CLI package:
1. Log onto cinchy.net using assigned credentials
Note: If unable to login to the above site, please contact Cinchy support ([email protected])
2. From the My Network page, open the Versions table
Tip: Bookmark this table for quick and easy access for future needs
3. Select the β€˜Distributed Worker’ View
4. Locate and download the most recent version of the CLI package
5. Once downloaded, extract the zip file and place the CLI folder into any drive
Suggestion: place the CLI folder into the C: drive as the folder path will be used in future steps

2. Downloading the Release Package

  1. 1.
    ​Click here to access the environment where the Meta-Reports release package is hosted and download the latest package.
  2. 2.
    The release package for Meta-Forms and Meta-Reports consists of two components that make up the experience:
    1. 1.
      The App Experience (aX): Angular package to be hosted on IIS.
    2. 2.
      The Data Experience (dX): Data model to be installed in Cinchy.
  3. 3.
    Download and install these packages.

3. Deploying an App Experience

This section will walk through setting up an App Experience through the Internet Information Services (IIS) connection Manager in the target Cinchy environment. If you are interested in exploring the Angular source code for this App Experience, please click here.

3.1 Host Applet on IIS

1. On your C: drive, create a β€˜Cinchy Applets' folder if it does not exist (eg. C:/Cinchy Applets).
2. Place the extracted App-Experience folder/code here.
Tip: We suggest renaming this folder to 'meta-reports'
3. If you have multiple instances, then create a folder that corresponds to the name of your Cinchy instance (eg. C:/CinchyApplets/DXdemo) and place the extracted folder there.
4. Locate and open the IIS Manager.
5. Navigate to your server (DESKTOP) and click the arrow to expand.
6. Right click on Application Pools and then Add Application Pool.
7. Name your Application Pool 'meta-forms' and select the .NET CLR version as 'no managed code'.
8. Expand Sites, and Default Web Site should be visible.
9. Navigate to the site containing your Cinchy application and select Add Virtual Directory.
8. Name the Alias of this directory 'dx'.
9. Input the path to 'Cinchy Applets' directory in the Physical Path field.
10. Once your dx virtual directory is added, expand it and you will see your app experience folder appear under it.
11. Right click on your app experience folder and click Convert to Application.

3.2 Update Configurations

1. In your app experience folder, locate '\assets\config.json' and input your Cinchy domain as specified below.
Note: clientId will vary depending on the experience you are deploying. redirectUri will also end in the name you have given your app experience folder.
Optional 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.
1. Specify the path to your application as instructed below.
2. Locate the 'C:\CinchyApplets\<Cinchy Environment>\<Your Experience's App Experience Folder>\index.html' file and update the base href to the path to your edit-form application on IIS and save.

4. Deploying a Data Experience

Once the app experience setup is complete, the data experience needs to be installed, which will set up the data model in your target environment to support the experience and enable its usage. If you are interested in exploring the data model source code, please click here.
If you wish to explore how the data experience package was created, please feel free to review the below:

4.1 Install the Data Experience

1. Navigate to your extracted Data-Experience folder.
2. Navigate and open '\post-install\post-install-1.sql' and replace the value on line 3 with the URL of you Cinchy domain (i.e. https://<Cinchy Domain>) and save.
3. Open PowerShell in administrator mode by clicking on File > Open Windows Powershell > Administrator Mode
4. Once PowerShell is loaded, navigate to your Data Experience folder by typing the command cd followed by its file path.
Note: to get the file path, from your Data Experience folder, click in the red box indicated below, and copy. Be sure to add single quotation marks (') around any portion of the path that has spaces.
Example: C:\Users\AppData\Local\Temp\'Temp1_Meta-Forms-Package v1.1.1'\'Meta-Forms-Package v1.1.1'\'Meta-Forms-Data-Experience 2.6.1'
5. In Powerhsell, enter the command: '.\CinchyDXD install', and you will be presented with the information below:
The table shown below are the values required for installing the data experience package.
Required Command
Description
-s, --Cinchy Server
Required. The full path to the Cinchy server without the protocol (e.g. cinchy.com/Cinchy).
-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).
-ps, --Post Install Scripts
Required. The path to a directory with one or more CQL scripts to be executed once the install is complete. **Only for Meta-Forms and Meta-Reports.**
-h, --https
Flag indicating connections to Cinchy should be over https.
6. Once the command is populated with environment specific parameters, run the command: .\CinchyDXD install -s β€œ<Cinchy Server>” -u β€œ<Username>” -p β€œ<Password>” -c β€œ<Cinchy CLI Directory>β€œ -d β€œ<Cinchy CLI Temp Directory>β€œ -h -ps "<Path Data-Experience Folder>\post-install"
7. After the command is finished running, log into the Cinchy environment that meta-forms has been installed into and verify that the following tables and queries are there:
  • Saved Reports
  • Reports
  • Widgets
  • Styles
  • Report Experience
  • Get Chart Meta Data Queries