Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

This document provides the structure and examples for creating deeplinks to integrate our software with your application. This functionality is currently in development and will be available in version 2.8.0 of Glex Energy. We assume you are familiar with the concept of deeplinks.

Structure

Base URL

glex://
This is the base URL for all deeplinks in our system.

Function

importProspect?

This is the function that will be executed. Currently, this is the only function available.

File Parameters

shapefile=”file path” (required) main file with .shp extension

...

attachmentfile=”file path” (optional) file to attach (documents, data or images) supports multiple formats

Multiple Prospects

Separate different prospects using semicolons ;

Parameters for Each Prospect

Separate different file parameters using ampersands &

Examples

These examples demonstrate the commands that need to be executed to utilize the deeplinking functionality

One Prospect

glex://importProspect?shapefile=PathShpFile1&datafile=PathExcelFile1&attachmentfile=PathRepFile1

Multiple Prospects (3 prospects at the same time)

glex://importProspect?shapefile=PathShpFile1&datafile=PathExcelFile1&attachmentfile=PathRepFile1;shapefile=PathShpFile2&attachmentfile=PathRepFile2;shapefile=PathShpFile3&datafile=PathExcelFile3

Real Paths Example

Using real paths, it would look something like this:

glex://importProspect?shapefile=C:\Users\Glex\Desktop\DeepLinking\TestingFiles\shape\Jordugle.shp&datafile=C:\Users\Glex\Desktop\DeepLinking\TestingFiles\skjema\Hornugle_prospect_data.xlsx&attachmentfile=C:\Users\Glex\Desktop\DeepLinking\TestingFiles\alpha.ppr;shapefile=C:\Users\Glex\Desktop\DeepLinking\TestingFiles\shape\Hornugle.shp&attachmentfile=C:\Users\Glex\Desktop\DeepLinking\TestingFiles\alpha.ppr

Notes

  • Ensure that all file paths are correctly formatted and accessible.

  • The order of the parameters (shapefile, datafile, attachmentfile) within a single prospect does not matter, but each parameter should be present if needed for that prospect.

  • When specifying multiple prospects, use semicolons (;) to separate them.

...