> For the complete documentation index, see [llms.txt](https://docs.spectralink.net/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.spectralink.net/amie-essentials/using-the-platform/batch-configuration.md). # Batch configuration The Batch configuration tool is used by SAM to bulk provision SIP service requirements, the PTT display name, and Groups. Settings loaded through the .csv file will override any enterprise/group level settings. Two CSV templates, one without a group example and one with, are available from the Batch Configuration area. Click either template to download. The .csv file is designed to be used when deploying a number of new smartphones in a new installation or when expanding an existing installation. It sets values at the Device level only. To remove them, you would have to access each phone in SAM singly and delete each one manually. The CSV parser expects the format as presented in the .csv file template with the following rules: * Field names may not be changed or altered. * The MAC address field is first and mandatory. * You can optionally set the Owner info, which is meant to be used for a convenient SAM-only identifier when displayed in the Device List. * The devices can be associated to existing or new groups by setting a Group name. Multiple Group names can be set, separated by semi-colon “;”. * If a field has no intended value, leave it blank or remove the entire column. SAM does not overwrite a value if the cell is blank. * Any values supplied in this file will take precedence over values you’ve already entered at the Enterprise or Group levels. These values are set at the Device level. Two template batch files are provided---the basic one if you do not deploy group settings and the group one if you do. The following settings may be configured. The MAC address and one other field are required, at a minimum. | | | | ------------------------------ | -------------------------------------------------- | | **MAC address** | \[found on box label or in phone settings] | | Device info 1-4 | \[phone user name and other info] | | Group name(s) | \[SAM Group name list separated by a semi-colon ;] | | SIP extension number | phone sip1\_extension string | | SIP username | phone sip1\_username string | | SIP password | phone sip1\_password string | | SIP secondary extension number | phone sip2\_extension string | | SIP secondary username | phone sip2\_username string | | SIP secondary password | phone sip2\_password string | | PTT caller ID | slnkptt username string | {% hint style="info" %} **Batch file examples** Two batch .csv files are available online. Refer to them for examples of how to configure the batch files for your facility. {% endhint %} ### MAC address List the MAC address of each Versity phone you will be deploying. The MAC address may be found on the packaging box, on the label underneath the battery, or by opening the Settings app and navigating to System > About phone > Status. **Entry criteria** | | | | ------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | | **Type** | Text field MAC addresses contain letters and numbers separated by colons Case insensitive; for example: 00:90:a3:c6:ef:ab or 00:90:AB:cd:DD:12 | | **Default** | none | | **Unique?** | Yes. Every smartphone has a different MAC address | | **Required?** | Yes | | **Level** | Device | | **Notes** | See above | ### Device info 1-4 Device info is the name that displays in the Device List in SAM. **Entry criteria** | | | | ------------- | --------------- | | **Type** | Text field | | **Default** | none | | **Unique?** | Not necessarily | | **Required?** | No | | **Level** | Device | | **Notes** | See above | ### Group name You may assign each smartphone to a Group. By naming a Group here, SAM will create a Group by that name. **Entry criteria** | | | | ------------- | ---------- | | **Type** | Text field | | **Default** | none | | **Unique?** | No | | **Required?** | No | | **Level** | Device | | **Notes** | See above | ### SIP extension number This is the unique number assigned to each smartphone. The user part of the SIP Address of Record (for example, *1002*) or the user and the host part of the registration SIP URI (for example, *<1002@Spectralink.com>*). This field is required and must be populated in order to achieve successful SIP registration. {% hint style="info" %} **Using the secondary SIP fields** The secondary fields are for use with Registration 2. They are optional. If not using the secondary fields, delete the secondary columns from the csv file. {% endhint %} **Entry criteria** | | | | ------------- | ----------------------------------------------- | | **Type** | Text field | | **Default** | none | | **Unique?** | Yes. Every smartphone has a different extension | | **Required?** | Yes | | **Level** | Device | | **Notes** | See above | ### SIP username SIP digest authentication User ID to be used for SIP registration. For many call servers this will be the same as the Extension Number, though some call servers offer the ability to have a Username that is unique from the Extension Number. **Entry criteria** | | | | ------------- | -------------------------------------------------- | | **Type** | Text field | | **Default** | none | | **Unique?** | Yes. Every smartphone has a different SIP username | | **Required?** | No | | **Level** | Device | | **Notes** | See above | ### SIP password The SIP digest authentication password to be used for SIP registration. **Entry criteria** | | | | ------------- | ---------- | | **Type** | Text field | | **Default** | none | | **Unique?** | Yes | | **Required?** | No | | **Level** | Device | | **Notes** | See above | ### SIP secondary… If using a secondary registration, enter the information using the same entry criteria as for the first registration. ### PTT caller ID You can specify a caller ID for PTT broadcasts. This could be entered by device or by group. **Entry criteria** | | | | ------------- | --------------- | | **Type** | Text field | | **Default** | none | | **Unique?** | Not necessarily | | **Required?** | No | | **Level** | Device or Group | | **Notes** | See above | ## Steps for Creating the .csv File 1. Either download a template from SAM or create a new spreadsheet in Excel®, following the guidelines and examples above and in the provided templates. 2. Add one row for each phone with its specific information. 3. Save as a .csv file. ## Upload .csv to SAM 1. Open SAM and click the **Batch Configuration** icon in the sidebar. 2. Click **Browse Batch Files**, navigate the file system to the CSV file you created, select it and click **Open**. After you upload the .csv file to SAM, any previously approved phones included in the CSV will get updated on their next heartbeat. Any phones not already approved or unknown to SAM will get updated after they have been approved and send a heartbeat. This could occur on the normal heartbeat interval, when an inactive smartphone becomes active, or when a smartphone boots up. ## Editing and Re-using the .csv You can use the same .csv to add a new device or edit the settings for an existing device. Simply add a row for the new device or change the value(s) for the existing device(s) and re-upload. {% hint style="info" %} **Tracking unused or spare phones in your fleet** To help administrators keep track of unused or spare phones in their fleet, the Batch Configuration page now includes a table of devices whose MAC addresses have been uploaded in a CSV configuration file but have not yet been presented to SAM via SAM Client configuration. {% endhint %} {% hint style="info" %} **The .csv file is not able to DELETE an existing device or value** The .csv file is not able to delete an existing device or value. You can only add a device or change a value to a different non-blank value. See Re-Deploying Devices for more information on how to de-commission devices. {% endhint %} --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation by asking a question. Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters: ``` GET https://docs.spectralink.net/amie-essentials/using-the-platform/batch-configuration.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.