Collaborative Document Editing Custom Variables

There are a number of system variables that must be set prior to using Collaborative Document Editing. These variables will be described in detail in this section These system variables are also dependent, so the order in which they are placed in the custom variables file is important. The correct order of the variable declarations is given below:

bp.Vars.DocumentServer = "onlyoffice.bplogix.net";
bp.Vars.DocumentServerScheme = "http";
bp.Vars.DocServiceAPI = string.Format("{0}://{1}/web-apps/apps/api/documents/api.js", Vars.DocumentServerScheme , bp.Vars.DocumentServer);
bp.Vars.DocServicePreloader = string.Format("{0}://{1}/web-apps/apps/api/documents/cache-scripts.html",
    bp.Vars.DocumentServerScheme , Vars.DocumentServer);
bp.Vars.DocServiceConverter = string.Format("{0}://{1}/ConvertService.ashx",
    bp.Vars.DocumentServerScheme, Vars.DocumentServer);

The individual variables are listed below.

Link

This variable must be added to the custom vars file prior to using Collaborative Document Editing. In nearly all cases, you'll use the default value displayed in the example below. When this flag is set to false, Process Director will disable Collaborative Document Editing.

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    //Disable Collaborative Document Editing
    bp.Vars.fEnableOnlyOffice = true;
}

Link

This variable must be added to the custom vars file prior to using Collaborative Document Editing. In nearly all cases, you'll use the default value displayed in the example below.

If the OnlyOffice Collaborative Editing component is enabled on a client server you must specify the name or IP address of the client server using this variable.

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    //Set the editing server
    bp.Vars.DocumentServer = "onlyoffice.bplogix.net";
}

Link

This variable must be added to the custom vars file prior to using Collaborative Document Editing. In nearly all cases, you'll use the default value displayed in the example below.

If the OnlyOffice Collaborative Editing component is installed on a client server you must specify the HTTP server scheme of the client server using this variable. The server scheme may be either "http" or "https".

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    //Set the Collaborative Editing server scheme to http
    bp.Vars.DocumentServerScheme = "http";
}

Link

This variable must be added to the custom vars file prior to using Collaborative Document Editing. In nearly all cases, you'll use the default value displayed in the example below.

If the OnlyOffice Collaborative Editing component is installed on a client server you must specify the location of the JavaScript API file for the component.

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    //Set the Collaborative Editing API location
    bp.Vars.DocServiceAPI = string.Format("{0}://{1}/web-apps/apps/api/documents/api.js",
        bp.Vars.DocumentServerScheme , Vars.DocumentServer);
}

Link

This variable must be added to the custom vars file prior to using Collaborative Document Editing. In nearly all cases, you'll use the default value displayed in the example below.

If the OnlyOffice Collaborative Editing component is installed on a client server you must specify the location of the HTML preloader file for the component.

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    //Set the Collaborative Editing preloader location
    bp.Vars.DocServicePreloader = string.Format("{0}://{1}/web-apps/apps/api/documents/cache-scripts.html",
        bp.Vars.DocumentServerScheme , Vars.DocumentServer);
}

Link

This variable must be added to the custom vars file prior to using Collaborative Document Editing. In nearly all cases, you'll use the default value displayed in the example below.

If the OnlyOffice Collaborative Editing component is installed on a client server you must specify the location of the ASHX converter file for the component.

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    //Set the Collaborative Editing converter location
    bp.Vars.DocServiceConverter = string.Format("{0}://{1}/ConvertService.ashx",
        bp.Vars.DocumentServerScheme , Vars.DocumentServer);
}

Link

This variable will enable database Datasources to appear in the Datasource Type dropdown on the cloud on managed servers for non-managed users. It will still prevent any access to a BPL Azure SQL Datasource.

Example

public override void SetSystemVars(BPLogix.WorkflowDirector.SDK.bp bp)
{
    // Enable database Datasources for non-managed users on Managed Servers
    bp.Vars.ManagedServerBlockDSNDatabases = false;
}