Batch

Note: To display only the features present on a particular device, select one or more filters from the SmartDocs bar below.

Overview

The Batch setting is used to execute one Profile (which may contain any number of settings) from within another Profile. This can be viewed as sort of a subroutine call. In StageNow, a Batch setting is used internally (without explicit reference by the staging administrator) to generate bar codes and NFC tags and to implement execution of the Deployment Section read from a Deployment Server.

A Batch setting also can be used explicitly by a staging administrator to leverage the functionality of one Profile from within another Profile. This could be used to create reusable 'components' as Profiles that could then be used from other Profiles by embedding or referencing them from a Batch setting. For example, one staging administrator may create and test a Profile, demonstrate and prove that it provides some functionality. This Profile could then be exported as XML or saved as Binary (e.g. for programming into an NFG tag). The Profile (as XML or Binary) could then be embedded into a Batch setting. That Batch setting could then be used (via Re-use Saved Setting) by a staging administrator in another Profile to perform the entire functionality of the embedded Profile at the point in the created Profile where the Batch setting is placed. The staging administrator using the Batch setting would have no visibility to the Profile that is embedded in that Batch setting but would nonetheless be able to exploit the functionality of that embedded Profile.

A Batch setting also can refer to a file in the device file system that contains a Profile (as either XML or binary) instead of embedding the Profile into the Batch setting. Such usage would require the 'batch file' (the file containing the Profile) to be present in the device file system before the Batch setting that references it is executed in order for the proper result to occur. Such a 'batch file' might be transferred to the device using a File setting or through some other 'out of band' method. The Deployment Section functionality of StageNow is implemented internally and automatically using a combination of File and Batch settings without the need for the staging administrator to explicitly create either a File setting or a Batch setting. But a staging administrator COULD use such settings to construct more advanced or customized staging deployment scenarios.

Main Functionality

  • Process a file in the device file system that contains a Profile
  • Process a Profile that is embedded within the Batch setting
  • Process Profiles that are XML or binary
  • Process Profiles that are optionally encrypted

Batch File Type

Specify the type of file to be processed.

Parm Name: BatchFileType

Option Name Description Note Requires
1 XML File The batch file is encoded as XML.

MX: +

2 Binary File The batch file is encoded as binary.

MX: +

Batch File Access

Specify whether the batch file will be available on the device file system or embedded in the XML.

Parm Name: BatchFileAccessMethod

Option Name Description Note Requires
2 File in Device File System When choosing **Device File System**, enter a path and file name on the device where the XML or binary file to be processed will be located.

MX: 4.3+

3 File Embedded in XML When choosing **Embedded in XML**, select an XML or binary file in the workstation file system. This file is encoded and placed into the Batch setting.

MX: 4.3+

File Path

Enter a path and file name on the device where the XML or binary file to be processed will be located.

Shown if: File Access method is file system

Parm Name: XmlFilePathAndName

Requires:

  • MX: 4.3+

Security Password

Provide the security password (empty = none) to decrypt the binary batch file.

Shown if: Batch File Type is "Binary" and Require Encodings is "Checked"

Parm Name: BinFilePassword

Requires:

  • MX: 4.3+

File Data

Select an XML or binary file in the workstation file system. This file is encoded and placed into the Batch setting.

Shown if: File Access method is embedded in XML

Parm Name: XmlFileData

Requires:

  • MX: 4.3+

Require Specific Encodings

Specify the type of file to be processed.

Shown if: Batch File Type is "Binary"

Parm Name: BinFileRequireEncodings

Option Name Description Note Requires
0 false Binary file does not require encoding.

MX: 4.3+

1 true Binary file requires to be encoded.

MX: 4.3+

Require Opaque

Cannot be examined; only the StageNow Client can decrypt with a private key.

Shown if: Batch File Type is "Binary" and Require Encodings checkbox is checked

Parm Name: RequireOpaque

Option Name Description Note Requires
0 false

MX: 4.3+

1 true Cannot be examined, only the StageNow Client can decrypt with a private key.

MX: 4.3+

Require Immutable

Cannot be modifed, but anyone can decrypt with a public key. Not supported in StageNow V2.0.

Shown if: File Access method is "Batch File Type" and Bin File Require Encodings checkbox is checked

Parm Name: RequireImmutable

Option Name Description Note Requires
0 false

MX: 4.3+

1 true Cannot be modifed, but anyone can decrypt with a public key. Future, not supported in StageNow V2.0.

MX: 4.3+

Require Private

Determines whether private encryption is required.

Shown if: Batch File Type is "Binary" and Require Encodings checkbox is checked

Parm Name: RequirePrivate

Option Name Description Note Requires
0 false

MX: 4.3+

1 true Sets private encryption to be required.

MX: 4.3+