DriveWorks

This plugin enables the shortcode driveworks_embed, to quickly embed either a DriveWorks Project or DriveApp into any content.
It uses pre-written <a href="https://webapi.driveworkslive.com/help/client/" rel="nofollow ugc">DriveWorks Client SDK</a> functions to automatically create a client, login, start a Specification / DriveApp and render the Form.
<blockquote>
Note: this plugin requires an external <a href="https://docs.driveworkspro.com/Topic/IntegrationThemeLive" rel="nofollow ugc">DriveWorks Live Integration Server</a> to be configured and running, which allows connections from your WordPress domain.
</blockquote>
To embed a Form, simply provide the following:
<ul>
<li>server_url – The URL of your Integration Theme server. Used to load the client library, and create a client connection.</li>
<li>group_alias – The alias of the Group to connect to.</li>
<li>Either:
<ul>
<li>project_name – The name of the Project to render</li>
<li>drive_app_alias – The name of the DriveApp to render</li>
</ul>
</li>
</ul>
Optionally provide:
<ul>
<li>ping_interval – The interval (in seconds) at which the server is automatically sent a request. Useful to keep a session alive without manual interaction. Disable by setting to <code>0</code>, or excluding this setting.</li>
<li>height – The height of the container that Form is rendered into, including the unit. Useful if the Form does not have a natural height. Examples: <code>800px</code>, <code>10em</code>, <code>75vh</code>.</li>
</ul>
Examples
Render a Project:
<pre><code>[driveworks_embed server_url="https://api.my-server.com" group_alias="MyGroupAlias" project_name="MyProject"]
</code></pre>
Render a DriveApp, with a fixed height, that pings every 60 seconds:
<pre><code>[driveworks_embed server_url="https://api.my-server.com" group_alias="MyGroupAlias" drive_app_alias="MyDriveApp" height="700px" ping_interval="60"]
</code></pre>
How it works?
The shortcode is replaced with the markup required to embed and render a DriveWorks Form.
A pre-written script using standard methods from the <a href="https://webapi.driveworkslive.com/help/client/" rel="nofollow ugc">DriveWorks Live Client SDK</a>, running on your own server, performs a login and renders the configured Form.
The script will not send any credentials during login, so a default user must be specified in DriveWorksConfigUser.xml. 
If a default user is not set server-side, the connection will not be authorized.
It is important to ensure that your DriveWorks Integration Theme server is running correctly. 
You can check this by accessing the configured server_url in a browser.
Clear warnings will be shown if any errors are made in the config or during connection.
For alternative examples on how to render a DriveWorks Form, see our public <a href="https://webapi.driveworkslive.com/home.html" rel="nofollow ugc">Client SDK Examples</a> and our <a href="https://github.com/driveworks" rel="nofollow ugc">Official GitHub</a>.

DriveWorks Shortcode – Form Embed

Use shortcodes to embed DriveWorks Projects or DriveApps.

Add a WordPress block (Gutenberg editor) to easily embed DriveWorks Projects and DriveApps.
It uses pre-written <a href="https://webapi.driveworkslive.com/help/client/" rel="nofollow ugc">DriveWorks Client SDK</a> functions to automatically create a client, login, start a Specification / DriveApp and render the Form.
<blockquote>
Note: these blocks require an external <a href="https://docs.driveworkspro.com/Topic/IntegrationThemeLive" rel="nofollow ugc">DriveWorks Live Integration Server</a> to be configured and running, which allows connections from your WordPress domain.
</blockquote>
To embed DriveWorks content, simply provide the following in the settings of each block:
<ul>
<li>Server Url – The URL of your Integration Theme server. Used to load the client library, and create a client connection.</li>
<li>Group Alias – The alias of the Group to connect to.</li>
<li>Type – The type of content to render (Project or DriveApp).</li>
<li>Project Name OR DriveApp Alias – The name of the Project / alias of the DriveApp to render (depending on type selected).</li>
</ul>
Optionally you can also set:
<ul>
<li>Ping Interval – The interval (in seconds) at which the server is automatically sent a request. Useful to keep a session alive without manual interaction. Disable this feature by setting the interval to <code>0</code> seconds, or a blank value (the default).</li>
<li>Height – The height of the container that Form is rendered into. Useful if the Form does not have a natural height.</li>
<li>Form Complete Message – The message shown when a Form is completed. This overrides the default message.</li>
<li>Form Cancelled Message – The message shown when a Form is cancelled. This overrides the default message.</li>
<li>On Complete – The page to redirect to upon Specification completion, declare <code>restart</code> to start a new Specification.</li>
<li>On Cancel – The page to redirect to upon Specification cancellation, declare <code>restart</code> to start a new Specification.</li>
</ul>
How it works?
This block outputs the markup required to connect to your DriveWorks Live instance and render Forms.
A pre-written script using standard methods from the <a href="https://webapi.driveworkslive.com/help/client/" rel="nofollow ugc">DriveWorks Live Client SDK</a>, running on your own server, performs a login and renders the configured Form.
The script will not send any credentials during login, so a default user must be specified in DriveWorksConfigUser.xml. 
If a default user is not set server-side, the connection will not be authorized.
It is important to ensure that your DriveWorks Integration Theme server is running correctly. 
You can check this by accessing the configured server url directly in a browser.
Clear warnings will be shown if any errors are made in the config or during connection.
For alternative examples on how to render a DriveWorks Form, see our public <a href="https://webapi.driveworkslive.com/home.html" rel="nofollow ugc">Client SDK Examples</a> and our <a href="https://github.com/driveworks" rel="nofollow ugc">Official GitHub</a>.

DriveWorks Block – Form Embed

Use Gutenberg blocks to quickly embed DriveWorks Projects and DriveApps.

DriveWorks Shortcode – Form Embed vs DriveWorks Block – Form Embed