Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

With embedded forms, you can display emakin forms in easily integrate Emakin forms into other applications in using an HTML iframe <iframe>. Emakin uses responsive layout to automatically fit in frame size.Embedded views requires Emakin’s responsive design ensures that the form automatically adjusts to fit the frame size, providing a smooth and consistent user experience across different devices and screen sizes.

To access embedded forms, you can choose between a valid authentication method or allow anonymous access, depending of on your choicesecurity requirements.

Anonymous Access

You can use anonymous access with API Keys to fill out Anonymous access allows users to interact with forms or generate reports in other applications without forcing user to login emakin. needing to log in to Emakin. This can be achieved by using API Keys, providing a seamless and frictionless experience for users who do not require authentication.

Info

Test Mode

Anonymous access requires Please note that anonymous access is only available for processes in an "Active" state. When If you try attempt to use anonymous access while a process is 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.

    Image Removed
  • 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.

...

"Test" mode, Emakin will silently ignore the operation, ensuring that test processes are not unintentionally exposed.

Initiating a New Process Anonymously

To enable anonymous access for initiating a new process, follow these steps:

  • Enable Anonymous Access: Ensure that anonymous access is enabled for the process you want to initiate or share. This setting allows the process to be accessed without requiring user authentication.

    Image Added
  • Generate an API Key: Create an API Key with the "login" scope and any other necessary scopes. Be cautious and select only the mandatory scopes, as allowing anonymous access can increase the risk to your system.

  • Update the Process Link: Copy the initiation link of the process. Replace the # character in the URL with ?, then append the generated API Key as a parameter at the end of the address.

The updated URL should look similar to the following example, with the "apiKey" parameter added:

Code Block
languagehtml
https://mydomain.emakin.com/app/?/initiate/55....6b/c2...18/08...c8&apiKey=58ea0f3d.....90b984be905a 

Sharing a

...

Screen with Anonymous Access

To share a screen view anonymously, follow these steps:

  • Enable Anonymous Access: First, ensure that anonymous access is enabled for the screen you wish to share. This setting allows users to view the screen without needing to log in.

  • Generate a API key with an API Key: Create an API Key with the "login" scope and any other required scopes.  Please It’s important to 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.

...

  • necessary scopes, as granting anonymous access can increase the system’s vulnerability.

  • Update the Screen Link: Copy the screen's URL. Replace the # character in the address with ?, then append the generated API Key as a parameter at the end of the URL.

The updated URL should look similar to the following example, with the "apiKey" parameter included:

Code Block
https://mydomain.emakin.com/app/?/report/55....c8&apiKey=58ea0f3d.....90b984be905a

Authenticated Access

You To secure access, you can also generate authentication tokens with rest api service using the GetToken method from the REST API service for a specific user identity. After Once the token is generated add token into address as , include it as an "auth" parameter . Generated in the URL.

Please note that these authentication tokens are limited to configured based valid only for a configured time period and they can get expired. Please always will expire after that. It is essential to generate new tokens as long as it's whenever 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.ensure that they are not stored on disk or hardcoded in your application.

The updated URL with the "auth" parameter should look similar to the following example:

Code Block
languagehtml
https://mydomain.emakin.com/app/?/report/55....c8&auth=41A....114

Embedding a Form

You can easily embed emakin Emakin forms in using a basic HTML IFrame tag like below; <iframe> tag, as shown in the example below:

Example:

Code Block
languagehtml
<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 "a returnUrl" parameter in the query string , to redirect the user the to another address after they have completed the form is completed. 

Example:

Code Block
languagehtml
<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>

...

For some forms, the height of the interface can may change dynamically. When If you want the IFrame size to change adjust automatically according to the form's content, size changes can be applied dynamically with you can use an additional javascript libraryJavaScript library to apply these size changes dynamically.

Code Block
languagehtml
<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>
Note

Unlike other examples, please pay attention to the fact that the ID is assigned make sure to assign an ID to the IFrame element that you want to monitor, as this is essential for tracking and dynamically adjusting its size.

Sending the Culture Parameter

...