---
alias: user-guide-automation-task-secsgem-maprequested
tags:
- automation tasks
description: "This documentation details a task for handling map data requests from equipment, managing inputs and outputs for seamless communication"
---

# Map Requested (S12F3 + S12F15)

![1562150204114](images/mapdownload-lg.svg)

When activated, the `Map Requested` task will handle `S12F3` (Map Setup) and `S12F15` (Map Data Requested) SECS/GEM messages from the equipment.

![Map Requested (S12F3 + S12F15) (Screenshot shows: mapDataUpdated, materialld, Novae, Nor)](./images/maprequested_01.png)

## Inputs

| Name           | Data Type | Description                                                  |
| -------------- | --------- | ------------------------------------------------------------ |
| mapDataUpdated | `Object`  | Result map data to send to equipment                         |
| Enable/Disable | `Boolean` | Enable/Disable listeners for specific mapping SECS/GEM messages |

## Outputs

| Name           | Data Type | Description                                      |
| -------------- | --------- | ------------------------------------------------ |
| materialId     | `String`  | Material identified by the equipment             |
| idType         | `Integer` | materialId type                                  |
| mapFormat      | `Integer` | Map format requested                             |
| notchLocation  | `Integer` | Location of Notch                                |
| frameRotation  | `Integer` | Rotation of the Frame                            |
| originLocation | `Integer` | Location of the Origin                           |
| processAxis    | `Integer` | Axis to process                                  |
| binCode        | `String`  | Bin codes requested                              |
| nullBinCode    | `String`  | Null bin codes                                   |
| mapData        | `Object`  | Object with entire representation of the request |
| Success        | `Boolean` | Triggered when the task is executed with success |
| Error          | `Error`   | Triggered when the task failed for some reason   |

## Settings

On the `General` tab, you have the usual settings and the following settings:

| Name                               | Data Type | Values                                                       | Default      | Description                                                  |
| ---------------------------------- | --------- | ------------------------------------------------------------ | ------------ | ------------------------------------------------------------ |
| Auto Enable Events Handling        | `Boolean` |                                                              | `true`       | Automatically enable listeners for expected messages at start-up |
| Timeout                            | `Integer` |                                                              | 10 (minutes) | Maximum amount of time allowed to keep the map data          |
| Reference Points Data Type         | `Enum`    | `A`, `BI`, `BO`, `F4`, `F8`, `I1`, `I2`, `I4`, `I8`, `L`, `U1`, `U2`, `U4`, `U8` | `I4`         | Data type to use for `RPSEL` field                           |
| X Dies Data Type                   | `Enum`    | `A`, `BI`, `BO`, `F4`, `F8`, `I1`, `I2`, `I4`, `I8`, `L`, `U1`, `U2`, `U4`, `U8` | `U4`         | Data type to use for `XDIES` field                           |
| Y Dies Data Type                   | `Enum`    | `A`, `BI`, `BO`, `F4`, `F8`, `I1`, `I2`, `I4`, `I8`, `L`, `U1`, `U2`, `U4`, `U8` | `U4`         | Data type to use for `YDIES` field                           |
| Row Count Data Type                | `Enum`    | `A`, `BI`, `BO`, `F4`, `F8`, `I1`, `I2`, `I4`, `I8`, `L`, `U1`, `U2`, `U4`, `U8` | `U4`         | Data type to use for `ROWCT` field                           |
| Column Count Data Type             | `Enum`    | `A`, `BI`, `BO`, `F4`, `F8`, `I1`, `I2`, `I4`, `I8`, `L`, `U1`, `U2`, `U4`, `U8` | `U4`         | Data type to use for `COLCT` field                           |
| Process Die Count Data Type        | `Enum`    | `A`, `BI`, `BO`, `F4`, `F8`, `I1`, `I2`, `I4`, `I8`, `L`, `U1`, `U2`, `U4`, `U8` | `U4`         | Data type to use for `PRDCT` field                           |
| Bin Code Equivalent Data Type      | `Enum`    | `A`, `BI`, `BO`, `F4`, `F8`, `I1`, `I2`, `I4`, `I8`, `L`, `U1`, `U2`, `U4`, `U8` | `A`          | Data type to use for `CBEQU` field                           |
| Null Bin Code Equivalent Data Type | `Enum`    | `A`, `BI`, `BO`, `F4`, `F8`, `I1`, `I2`, `I4`, `I8`, `L`, `U1`, `U2`, `U4`, `U8` | `A`          | Data type to use for `NULBC` field                           |
| Message Length Data Type           | `Enum`    | `A`, `BI`, `BO`, `F4`, `F8`, `I1`, `I2`, `I4`, `I8`, `L`, `U1`, `U2`, `U4`, `U8` | `U4`         | Data type to use for `MLCL` field                            |
| Message Type for Map Request       | `Enum`    | `S12F15`                                                     | `S12F15`     | Expected Map Data Request message                            |
| Starting Position Data Type        | `Enum`    | `A`, `BI`, `BO`, `F4`, `F8`, `I1`, `I2`, `I4`, `I8`, `L`, `U1`, `U2`, `U4`, `U8` | `I4`         | Data type to use for `STRP` field                            |
| Bin List Format Data Type          | `Enum`    | `A`, `L`                                                     | `A`          | Data type to use for `BINLT` field                           |

![Screenshot showing a settings page with options for bin list format data type.](./images/maprequested_02.png)

## Behavior

In this task you choose a driver when dropping it into the workflow (if you have more than one driver associated with the controller).

When equipment issues an `S12F3`, the outputs are emitted and the task waits for the `mapDataUpdated` input to be filled with the data of the map. The expected structure is similar to the following example:

```json
{
 "materialId": "123",
 "referencePoints": [ [1, 2], [3, 4] ],
 "unitsOfMeasurement": "test",
 "xDies": 0,
 "yDies": 1,
 "rowCount": 36,
 "colCount": 39,
 "processDieCount": 1404,
 "binCode": "1234",
 "nullBinCode": "",
 "mapString": "1111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X1111111111111111111XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX1111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X11111111111111111111111111111111111111X1111111111111111111",
 "startingPosition": [11, 22],
 "mapArray": [
  "aaa",
  "bbb",
  "ccc"
 ]
}
```

The reply to the equipment is then issued with the corresponding fields accoding to the standard.

When the `S12F15` for the same `materialId` is received the same object is used to send the rest of the information required by the equipment.

## Remarks

{% include-markdown 'includes/pages/automation_zones_note.md' %}