hc-conversionserver
Advanced tools
* Conversion Queue for multiple simultaneous CAD conversion jobs. * Multiple connected conversion queue machines can all pull jobs from the same queue. * S3 Storage option with direct S3 upload via tokens. * Support for ZIP upload and shattered workflo
To quickly test out the conversion server with the provided front-end follow the steps below:
A simple demo application that uses the API directly and which can be used for testing the conversion server locally and exploring the REST API usage can be found here: Basic Demo Github Link
A more comprehensive demo that aims to demonstrate a more realistic use-case, includes user and project management and accesses the conversion server server-side can be found here: Advanced Demo Github Link
{
"hc-conversionserver": {
"mongodbURI": "mongodb://localhost:27017/conversions",
"temppath": "c:/temp/conversionservertemp",
"port": "3001",
"runQueue": true,
"runServer": true,
"useS3": false,
"queue": {
"converterpath": "C:/HOOPS_Communicator_2022_SP1/authoring/converter/bin/win64",
"converterlicense": "",
"maxConversions": 4,
"ip": "localhost",
"polling": false
},
"server": {
"listen": true
},
"s3": {
"region": "us-west-2",
"bucket": "mybucket"
}
}
}
The conversion server requires a running mongoDB session. If you are planning to run multiple connected conversion server instances, you need to provide a common database session to all of those. We recommend MongoDB Atlas for that purpose. For more information see the links below. After the database is running you need to provide the connection string in the mongodbURI field. For security reasons it is recommended that you omit the username and password (if any) and instead provide those in the environment variables "DB_USERNAME" and "DB_PASSWORD".
[MongoDB Local Install] (https://www.mongodb.com/try/download/community)
[MongoDB Atlas] (https://www.mongodb.com/atlas/database)
Create a folder for temporary data for the conversion server and provide the path in the temppath field.
Specify desired port. The conversion server is meant to run behind a firewall and should not be accessible from the web directly but you need to still ensure that the port is accessible if the conversion server runs on a different machine from the main application.
Set runQueue to true if you want to run the conversion queue on this machine. As long as the machines running the conversion queue are sharing the same database session, and storage you can run an unlimited number of machines in parallel.
Set runServer to true if you want to run the conversion server Rest API frontend on this machine. The frontend provides the REST API endpoints for the conversion queue. There should only be one REST API frontend for a network of conversion queue machines.
If you enabled the conversion queue (runQueue:true) you need to provide the path to the directory containing the converter executable of the HOOPS Communicator package/installation. You also need to provide a valid license for HOOPS Communicator.
If the conversion queue is running on a different machine from the server you need to specify the accessible ip address of the queue here. If the ip field is left blank the conversion queue will automatically query the IP address of the machine it is currently running on. This is useful when the queue is started via a scaling server like AWS beanstock.
By default the conversion server will assign conversion jobs to all registered conversion queue servers based on their available capacity. If polling is set to true the conversion queue will poll for a newly available job every few seconds. In this case a conversion queue server does not need to be registered with the conversion server.
If you are running the conversion server as a node module and use the API directly you can optionally turn off the REST API endpoints. In this case your code needs to handle file uploads and other actions.
If you are planning to use S3 for storaging the converted models you need to set the useS3 field to true and provide a valid AWS region and S3 bucket name. You also need to make sure AWS_SECRET_ACCESS_KEY and AWS_ACCESS_KEY_ID is set, either via environment variables or throug a config file. (see AWS Credentials). If you are using a network of multiple conversion queue instances, you need to specify the same bucket/region for all of them. If you are not using S3, the system will fall back to storing the conversion data locally in the directory provided by temppath.
Run the application with the following command:
npx hc-conversionserver
npm install hc-conversionserver
Follow steps 2 - 12 from above. If you already have a default/config.json file in your application just add the "hc-conversionserver" section to it.
In the startup module of your application, add the following code to initialize the conversion server:
const conversionserver = require('hc-conversionserver');
conversionserver.start();
(todo)
Uploads a new CAD file and places it on the conversion queue.
let form = new FormData();
form.append('file', fs.createReadStream("myfile.stp"));
let res = await fetch(conversionServerURI + '/api/upload', { method: 'POST', body: form,headers: {'CS-API-Arg': JSON.stringify({webhook:"http://localhost:3000/api/webhook"})}});
let data = await res.json();
CS-API-Arg:
{
webhook: "http://localhost:3000/api/webhook",
startPath: "micro_engine/_micro engine.CATProduct",
conversionCommandLine:["--output_scs","","--output_png","","background_color","0,0,0","--output_step",""],
itemid: "c79dd99e-cbbd-4b6d-ba43-15986b1adc14",
processShattered:false,
skipConversion:false,
}
webhook - The ip address to call when the conversion is complete. If not provided polling is required to check the conversion status.
startPath - If a zip file is uploaded this is the relative path within the zip file to the main assembly file.
conversionCommandLine - The command line arguments to pass to converter. This will replace the default command line that exports scs and png files (on a white background).
itemid - If an existing itemid is provided, the uploaded file will be stored alongside the original file and no conversion will be performed.
processShattered - If set to true, a shattered version of the CAD assembly will be generated.
skipConversion - If set to true, the uploaded file will not be converted.
ID of newly created item
{"itemid":"c79dd99e-cbbd-4b6d-ba43-15986b1adc14"}
Retrieves data about a conversion item.
let res = await fetch(conversionServerURI + '/api/data/c79dd99e-cbbd-4b6d-ba43-15986b1adc14');
As specified in URL string:
Information about the requested item.
{
name: "landinggearmainshaftwithpmi_fullpmi.catpart",
startPath: "",
conversionState: "SUCCESS",
updated: "2022-05-29T12:52:02.787Z",
created: "2022-05-29T12:51:55.697Z",
webhook: "http://localhost:3000/api/webhook",
files: [
"landinggearmainshaftwithpmi_fullpmi.catpart.png",
"landinggearmainshaftwithpmi_fullpmi.catpart.scs",
],
}
Retrieves a file from the conversion server.
let res = await fetch(conversionServerURI + '/api/file/c79dd99e-cbbd-4b6d-ba43-15986b1adc14/scs');
let buffer = await res.arrayBuffer();
...
As specified in URL string:
Binary Data
Retrieves the file that was uploaded to the conversion server.
let res = await fetch(conversionServerURI + '/api/original/c79dd99e-cbbd-4b6d-ba43-15986b1adc14');
let buffer = await res.arrayBuffer();
...
As specified in URL string:
Binary Data
Reconverts an existing conversion item.
let res = await fetch(conversionServerURI + '/api/reconvert/c79dd99e-cbbd-4b6d-ba43-15986b1adc1', { method: 'put', headers: {'CS-API-Arg': JSON.stringify({conversionCommandLine:["--output_step",""] })}});
...
As specified in URL string:
CS-API-Arg:
{
startPath: "micro_engine/_micro engine.CATProduct",
conversionCommandLine:["--output_scs","","--output_png","","background_color","0,0,0","--output_step",""],
processShattered: false,
}
startPath - If a zip file is uploaded this is the relative path within the zip file to the main assembly file.
conversionCommandLine - The command line arguments to pass to converter. This will replace the default command line that exports scs and png files (on a white background).
processShattered - If set to true, a shattered version of the CAD assembly will be generated.
NONE
Deletes a conversion item including all converted data.
let res = await fetch(conversionServerURI + '/api/delete/c79dd99e-cbbd-4b6d-ba43-15986b1adc1', { method: 'put'});
...
As specified in URL string:
NONE
Retrieves a list of all conversion items available on the conversion server.
let res = await fetch(conversionServerURI + '/api/items');
...
NONE
JSON Array of available conversion items and all their data.
Retrieves the time any of the items on the conversion server were last updated (or deleted).
let res = await fetch(conversionServerURI + '/api/items');
...
NONE
JSON containing last updated time
{lastUpdated: '2022-05-29T14:27:03.001Z'}
Retrieves an upload token for directly uploading a file to S3 storage. After receiving the token and uploading the file directly from the client, api/reconvert should be called to start the conversion process.
let res = await fetch(conversionServerURI + '/api/uploadToken', {headers: {'CS-API-Arg': JSON.stringify({webhook:"http://localhost:3000/api/webhook"})}});
CS-API-Arg:
{
webhook: "http://localhost:3000/api/webhook"
}
webhook - The ip address to call when the conversion is complete. If not provided polling is required to check the conversion status.
JSON containing signed request URL and itemid
{ token: signedRequestURLforS3, itemid: c79dd99e-cbbd-4b6d-ba43-15986b1adc14 };
Retrieves a download token for directly downloading a file from S3 storage.
let res = await fetch(conversionServerURI + '/api/downloadToken/c79dd99e-cbbd-4b6d-ba43-15986b1adc1/scs');
As specified in URL string:
JSON containing signed request URL
{ token: signedRequestURLforS3 };
Retrieves a shattered part for a conversion item converted with the processShattered argument.
let res = await fetch(conversionServerURI + '/api/shattered/c79dd99e-cbbd-4b6d-ba43-15986b1adc14/part.scs');
let buffer = await res.arrayBuffer();
...
As specified in URL string:
Binary Data
Retrieves the shattered XML file for a conversion item converted with the processShattered argument.
let res = await fetch(conversionServerURI + '/api/shatteredXML/c79dd99e-cbbd-4b6d-ba43-15986b1adc14');
let shatteredData = await res.text();
...
As specified in URL string:
XML data
FAQs
* Conversion Queue for multiple simultaneous CAD conversion jobs. * Multiple connected conversion queue machines can all pull jobs from the same queue. * S3 Storage option with direct S3 upload via tokens. * Support for ZIP upload and shattered workflo
The npm package hc-conversionserver receives a total of 0 weekly downloads. As such, hc-conversionserver popularity was classified as not popular.
We found that hc-conversionserver demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
The Linux Foundation is warning open source developers that compliance with global sanctions is mandatory, highlighting legal risks and restrictions on contributions.
Security News
Maven Central now validates Sigstore signatures, making it easier for developers to verify the provenance of Java packages.
Security News
CISOs are racing to adopt AI for cybersecurity, but hurdles in budgets and governance may leave some falling behind in the fight against cyber threats.