The Processor Service is located in “<SDKRoot>/Server.Processor” folder.


To configure the server, locate the “VoxelFarmProcessor.exe.config” file and open it with a text editor.


Under the <appSettings> node, you will find a series of key/value pairs that are used to configure the service. The following table describes these settings:


Key

Description

Example

ScrapFolder

A directory for temporary files. Should be in a hard drive with sufficient space

<add key="ScrapFolder" value="G:\work\scrap\" />

PythonFolder

A directory where the python libraries are located.

<add key="PythonFolder" value="G:\work\tools\PythonLibs" />

TemplateFolder

A directory where the templates are located.

<add key="TemplateFolder" value="G:\templates" />

UpdateTools

If it is “0” updates are disabled. If it is “1” updates are enabled.

<add key="UpdateTools" value="0" />

ToolsFolder

A directory where all the tools for processing entities are located. This value will be used only if updates are enabled, in other case we use the processor service folder as tools location.

<add key="ToolsFolder" value="G:\work\tools" />

ReportWebServer

The URL to a web server to get the metadata when processing reports.

<add key="ReportWebServer" value="http://localhost:58697" />

ReportContentServerAddr

The IP address of a Content Server to get data when processing reports.

<add key="ReportContentServerAddr" value="127.0.0.1" />

ReportContentServerPort

A numeric value for the TCP/IP port used to get data from the Content Server when processing reports.

<add key="ReportContentServerPort" value="3333" />

ReportContentServerSSL

It specifies if the connection with the Content Server will be secure or not. If the value  is “1” SSL will be used.

<add key="ReportContentServerSSL" value="0" />

ServiceName

The source identifier to use in Windows event logs.

<add key="ServiceName" value="VF_proc" />

EventLogName

The log name to use with Windows event logs. An entry will be created in the Event Viewer under  “Applications and Services Logs” for logging information.

<add key="EventLogName" value="VF_Logs" />

aws_region

Used only in AWS. Contains the AWS region identifier.

<add key="aws_region" value="us-west-2" />

aws_dynamo_region

Used only in AWS. Contains the AWS region identifier for the database service (dynamo). If it is omitted aws_region will be used in place.

<add key="aws_dynamo_region" value="us-west-2" />

aws_sqs_region

Used only in AWS. Contains the AWS region identifier for queue service (SQS). If it is omitted aws_region will be used in place.

<add key="aws_sqs_region" value="us-west-2" />

aws_s3_region

Used only in AWS. Contains the AWS region identifier for storage service (S3). If it is omitted aws_region will be used in place.

<add key="aws_s3_region" value="us-west-2" />

aws_sns_region

Used only in AWS. Contains the AWS region identifier for notification service (SNS). If it is omitted aws_region will be used in place.

<add key="aws_sns_region" value="us-west-2" />

aws_bucket_name

Used only in AWS. The name of the S3 bucket that will be used for storage.

<add key="aws_bucket_name" value="com.voxelfarm.vfcloud.0.0.0.0" />

aws_table_name

Used only in AWS. The name of the table in Dynamo that will store all key/values for the spatial entity metadata.

<add key="aws_table_name" value="VFCLOUD001_ENTITIES" />

aws_table_name

Used only in AWS. Name of the Queue in Amazon’s SQS that will be used by Voxel Farm services to talk to each other.

<add key="aws_queue_name" value="ProcessQueue.fifo" />

aws_sns_topic

Used only in AWS. A SNS topic that will be used for services to send notifications.

<add key="aws_sns_topic" value="arn:aws:sns:us-west-2:457155399432:vfcloud_events" />

aws_sns_endpoint

Used only in AWS. A SNS endpoint, allowing this instance to receive notifications. This should be a URL that is served by this instance.

<add key="aws_sns_endpoint" value="http://<THIS_IP>/events.ashx" />

aws_sns_protocol

Used only in AWS. Specifies which protocol will be used for SNS.

<add key="aws_sns_protocol" value="http" />

azure_storage_connection_string

Use only in Azure. Contains the security connection string for Azure Storage.

<add key="azure_storage_connection_string" value="<YourConnectionString>" />

azure_container_name

Used only in Azure. Specifies the container name to be used for blob storage.

<add key="azure_container_name" value="com-voxelfarm-vfcloud" />

azure_table_name

Used only in Azure. Contains the name of the table that will store all key/values for the spatial entity metadata.

<add key="azure_table_name" value="VFCLOUD001ENTITIES" />

azure_queue_name

Used only in Azure. The name of the queue that will be used by Voxel Farm Cloud services to talk to each other.

<add key="azure_queue_name" value="process-queue-fifo" />

azure_servicebus_connection_string

Used only in Azure. Connection String for the Azure service bus.

<add key="azure_servicebus_connection_string" value="" />

azure_servicebus_topic

Used only in Azure. Topic name for service bus.

<add key="azure_servicebus_topic" value="events" />

azure_servicebus_subscription

Used only in Azure. Contains the service bus subscription identifier. Use “process”.

<add key="azure_servicebus_subscription" value="process" />

file_folder

Used only in FILES. Specifies the folder path to be used for blob storage.

<add key="file_folder" value="Z:\files" />

file_folder_db

Used only in FILES. Specifies the folder path to be used for metadata storage.

<add key="file_folder_db" value="Z:\db" />

storage_provider

Selects which platform should be used for storage. Possible values area “AWS”, “AZURE” and “FILES”

<add key="storage_provider" value="AWS" />

database_provider

Selects which platform should be used for storage. Possible values area “AWS”, “AZURE” and “FILES”

<add key="database_provider" value="AWS" />

queue_provider

Selects which platform should be used for the application queue. Possible values area “AWS”, “AZURE” and “FILES”

<add key="queue_provider" value="AWS" />

message_provider

Selects which platform should be used for notifications. Possible values area “AWS”, “AZURE” and “FILES”

<add key="message_provider" value="AWS" />

singularity_provider

Selects which platform should be used for the singularity tables. Possible values area “AWS”, “AZURE” and “FILES”

<add key="singularity_provider" value="FILES"/>

singularity_folder

Used only in FILES. Specifies the folder path to be used for singularity storage.

<add key="singularity_folder" value="D:\files_db\singularity"/>

azure_table_singularity

Used only in Azure. Contains the name of the table that will store all key/values for singularities.

<add key="azure_table_singularity" value="VFCLOUD001SINGULARITIES" />

aws_table_singularity

Used only in AWS. Contains the name of the table that will store all key/values for singularities.

<add key="aws_table_singularity" value="VFCLOUD001_SINGULARITIES"/>


To register the Processor Services as a Windows service, run the following command line:


installutil.exe VoxelFarmProcessor.exe

 

The Processor Service should appear listed as a Windows Service: