Configure and use DC Local Server Mode

This article will explain how to work with DC Local Server Mode. Read how to configure it, use it in any command-line interface, and process DC Jobs using DC Local Server Mode.

Configure DC Local Server Mode


You can find the configuration files here:

    plauti/dclocalserver

The server usually works with the system user.
You can find the files in the 'Root' directory. If you change the running user, follow the 'User' directory to find the files.

Windows - Root

    c:\Windows\System32\config\systemprofile\plauti\dclocal_server

Windows - User

    c:\Users\username\plauti\dclocal_server

Linux - Root

    /root/plauti/dclocal_server

Linux - User

    /home/username/plauti/dclocal_server

Before you use DC Local Server Mode with a new Org, you need to change some settings in the properties file, located in:

    config/application.properties

Set batch profile

The batch profile setting determines how many resources DC Local will take up on your machine. The higher you set this, the quicker the jobs get processed. When set to 'High', DC Local will take up the maximum amount of resources to run jobs. If you have multiple processes running on your server, pick a lower setting. 



Set the environment

To establish a connection, DC Local needs to know which environment it will work with: Production or Sandbox. The default setting is Production. Make sure that the environment mentioned in the file matches your Salesforce environment.

You can also set the environment to Custom so you can only log into the server through a custom URL. In that case, also set a custom domain to use for logging in.



Set an email address

Optionally set one or more email addresses to receive information when something goes wrong. Separate them with commas.

See below for an example of the configuration file where the environment has been set to Sandbox and two email addresses to receive information have been set. Lines with a '#' in front of them are commented out. Make sure to remove the '#' to activate the setting.

    # Plauti DC Local configuration file

logging.level.root=INFO
logging.level.com.plauti.dcl=DEBUG");
dcl.sf.namespace=dupcheck

# Low | Medium | High
dcl.batch-profile=Medium

# Salesforce Org Type; PRODUCTION, SANDBOX or CUSTOM

dcl.service-mode.environment=SANDBOX
#dcl.service-mode.custom-domain=https://testcompany.my.salesforce.com
dcl.service-mode.email-list=john.smith@plauti.com, jane.doe@plauti.com

Use DC Local Server Mode

Step 1 Connect your Salesforce Org to DC Local

1.1 Log into your Salesforce Org on any device.
1.2 On the device where you installed DC Local Server Mode, open any command-line interface.

To start DC Local, type in the following command:

Windows:

    net start dclocal

Linux:

    sudo service dclocalserver start
1.3 Open the log file. You can find it in:

    logs/app.log/spring.log
1.4 Look up the verification URL in the log file. Navigate to the URL. 
1.5 The connection page will ask you for a verification code. Find the code in the log file. Enter it on the page and click 'Connect'.
1.6 Salesforce asks you to allow access to Duplicate Check. Click 'Allow'.
1.7 You are connected.

You can stop DC Local using the following commands:

Windows

    net stop dclocal

Linux

    sudo service dclocalserver stop
Once you have authenticated yourself, you can restart the service without new authentication. If you want to log in as a new user, delete the file 'console-app-session.pla', restart the server, and follow the steps above again.
You have 10 minutes to establish a connection. The DC Local server times out if no connection has been established after 10 minutes. You will receive an email notification about this if you have set an email address. Restart the server and connect again.

You can check the status of the DC Local server by doing the following:



Windows

Go to Services.

Linux

    sudo service dclocalserver status

Step 2 Send a job to the DC Local server

2.1 Start the DC Local server.
2.2 Go to the DC Job page and click 'Add New Job'.
2.3 Enter the job details and click 'DC Local'.
2.4 Optionally check the progress in the spring.log file.
2.5 The job will be sent back to your Org after it completes. Find it there to process the results.
 

Having trouble?

Our support agents are ready to help you !