With embedded forms you can display emakin forms in other applications in HTML iframe. Emakin uses responsive layout to automatically fit in frame size.
Embedded views requires a valid authentication method depending of your choice.
Anonymous Access
You can use anonymous access with API Keys to fill out forms or generate reports in other applications without forcing user to login emakin.
Test Mode
Anonymous access requires processes in "Active" state. When you try to use anonymous access while process in test mode emakin silently ignores operation.
Initiating of a new process anonymously
Please follow these steps to enable anonymous access.
Enable Anonymous Access of process to initiate a new process or share screen as a view anonymously.
Generate a API Key with "login" and other required scopes. Please only select the mandatory scopes because of anonymous access may put system at in risk.
Copy link of initiate process link and replace '#' character with '?' and add generated API Key parameter to end of address.
Updated address link should be similar like to following address with "apiKey" parameter added.
https://mydomain.emakin.com/app/?/initiate/55....6b/c2...18/08...c8&apiKey=58ea0f3d.....90b984be905a
Sharing a screen anonymous access
Enable anonymous access of screen
Generate a API key with "login" and other required scopes. Please only select the mandatory scopes because of anonymous access may put system at in risk.
Copy address of screen and replace '#' character with '?' and add generated API key parameter to end of address.
Updated address link should be similar like to following address with "apiKey" parameter added.
https://mydomain.emakin.com/app/?/report/55....c8&apiKey=58ea0f3d.....90b984be905a
Authenticated Access
You can also generate authentication tokens with rest api service GetToken method for specific user identity. After token is generated add token into address as "auth" parameter. Generated authentication tokens are limited to configured based time period and they can get expired. Please always generate new tokens as long as it's needed, and do not store in any place like disk or code.
Updated address link should be similar like to following address with "auth" parameter is added.
https://mydomain.emakin.com/app/?/report/55....c8&auth=41A....114
Sending the Culture Parameter
When embedding forms, you may sometimes need them to display in a specific culture or locale, which determines the language, date formats, and other region-specific settings. This can be particularly useful in applications serving a global audience or in situations where the user’s culture is known and you want to provide a seamless experience.
How to Send the Culture Parameter
To specify a culture when embedding a form, you can include the culture
parameter in the embedding URL. The culture parameter should be a valid IETF language tag, such as en-US
for English (United States) or fr-FR
for French (France).
<iframe src="https://mydomain.emakin.com/app/?/initiate/55..c8&apiKey=58ea0f3d.....90b984be905a&culture=en-US" width="100%" height="600px"></iframe>
In this example, the form will be displayed in the English (United States) culture.
Embedding Form
You can embed emakin forms in a basic HTML IFrame tag like below;
Example:
<html> <body> Hello! <iframe src="https://mydomain.emakin.com/app/?/initiate/55..c8&apiKey=58ea0f3d.....90b984be905a" width="100%" height="300" frameborder="0"></iframe> </body> </html>
Return Address
You can specify "returnUrl" parameter in the query string, to redirect user the another address after the form is completed.
Example:
<html> <body> Hello! <iframe src="https://mydomain.emakin.com/app/?/initiate/55..c8&apiKey=58ea0f3d.....90b984be905a&returnUrl=http://localhost" width="100%" height="300" frameborder="0"></iframe> </body> </html>
IFrame Size
For some forms, the height of the interface can change dynamically. When you want the IFrame size to change automatically according to the form, size changes can be applied dynamically with an additional javascript library.
<html> <body> <iframe id="frame" src="https://mydomain.emakin.com/app/?/initiate/55..c8&apiKey=58ea0f3d.....90b984be905a&returnUrl=http://localhost" width="100%" height="300" frameborder="0"></iframe> <script src="https://static.emakin.com/r/IFrameResizer/JS?c=en-US"></script> <script>iFrameResize({ minHeight:300 }, '#frame')</script> </body>
Unlike other examples, please pay attention to the fact that the ID is assigned to the IFrame element that you want to monitor.