https://github.com/datalogic/emm-intent

Configurable intents to be copied from Scan2Deploy
https://github.com/datalogic/emm-intent

Last synced: 20 days ago
JSON representation

Configurable intents to be copied from Scan2Deploy

• Host: GitHub
• URL: https://github.com/datalogic/emm-intent
• Owner: datalogic
• Created: 2023-09-08T17:53:14.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2023-09-13T22:28:18.000Z (over 1 year ago)
• Last Synced: 2023-09-14T12:30:48.727Z (over 1 year ago)
• Size: 3.91 KB
• Stars: 0
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# emm-intent

Configurable intents to be copied from Scan2Deploy Studio

## Format

The required properties for EMM entries are:

 * `displayName`: Label displayed to the user for copy selection

 * `intent`: Structured intent for EMM (see [Configuring intents](#configuring-intents))

Example:

```diff

{

  "version": X.X,

  "emms": {

     ...

-    "existingEmm": {}

+    "existingEmm": {},

+    "newEmm": {

+      "displayName": "New EMM",

+      "intent": " ... "

+    }

  }

}

```

### Configuring intents

There are two placeholders that can be used to define where the corresponding data should be injected into the intent.

 * `%encoding%`: Will be replaced with the current encoding version selected in Studio

 * `%data%`: Will be replaced with the encrypted barcode data generated by Studio

**Note: if a double quote is required within the final output of the intent, a single backslash will need to be used to escape the quote (e.g. `"example intent \"surrounded by escaped quotes\""`)**

#### Example

Given the following:

 * intent definition: "intent --encoding %encoding% --data %data%"

 * Studio barcode version: "v3"

 * Studio barcode data: "T3yYK0x8dt"

Resulting intent: 

`intent --encoding v3 --data T3yYK0x8dt`

## Submitting changes

To modify the emm-intents.json file, follow these steps:

1. Create new branch

2. Make modifications

3. Submit pull request

Pull requests will be reviewed by a code owner, and if approved, will be allowed to merge.