Status Manager

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

StageNow - 2.8

Overview

The Status Manager (StatusMgr) offers a mechanism for setting notifications to be displayed while MX is processing the XML stream.

Main Functionality

  • Add, remove or replace a notification
  • Specify a header, footer and/or body for a notification
  • Specify the Android Action and/or Class about which to send a notification
  • Specify the MIME type relating to a notification
  • Specify a string to identify the source of a notification
  • Apply a filter and/or ID to narrow the display of notifications
  • Display a notification when:
    • A process has completed
    • A process has reached a specified percentage of completion

Request Action

Used to specify the action to take for status requests.

Parm Name: RequestAction

Option Name Description Note Requires
1 Add/Replace Status Request Adds a new (or replaces an existing) status request with the current one.

MX: 5.0+

2 Remove Status Request Removes the specified status request.

MX: 5.0+

3 Notify Status Causes the notification status to be displayed.

MX: 5.0+

Notify Action

Used to specify the nofitication action to take for status requests.

Parm Name: NotifyAction

Option Name Description Note Requires
0 Do nothing This value (or the absence of this parm from the XML) will cause no change to the setting; any previously selected setting will be retained.

MX: 5.0+

1 Notify Status Performs a notification action.

MX: 5.0+

Request Status Filter

Used to specify an optional ID number for the status being requested.

Parm value input rules:

  • Integer with at least 1 digit

Shown if: The Request Action is neither "Do Nothing" nor "Notify Status"

Parm Name: RequestFilter

Requires:

  • MX: 5.0+

Request Status Filter

Used to specify an optional filter for the status being requested.

Shown if: The Request Action is not "Do Nothing"

Parm Name: RequestFilter

Option Name Description Note Requires
0 Request ALL Status

MX: +

1 Request Completion Status

MX: +

MIME Type

Used to specify an optional MIME type, which signals the format of a document.

Parm value input rules:

  • String with at least 1 character

Shown if: The Request Action is "Add/Replace Status Request" or "Remove State Request"

Parm Name: MimeType

Requires:

  • MX: 5.0+

Action Name

Used to specify the Action Name of the Android package about which to send the status notification.

Parm value input rules:

  • String with at least 1 character

Shown if: The Request Action is "Add/Replace Status Request" or "Remove State Request"

Parm Name: ActionName

Requires:

  • MX: 5.0+

Package Name

Used to specify the package name of the Android package about which to send the status notification.

Parm value input rules:

  • String with at least 1 character

Shown if: The Request Action is "Add/Replace Status Request" or "Remove State Request"

Parm Name: PackageName

Requires:

  • MX: 5.0+

Class Name

Used to specify the class name of the Android package about which to send the status notification.

Parm value input rules:

  • String with a minimum of 1 character

Shown if: The Request Action is "Add/Replace Status Request" or "Remove State Request"

Parm Name: ClassName

Requires:

  • MX: 5.0+

Source ID

Used to specify an identifier string of a status notification.

Parm value input rules:

  • String with at least 1 character

Shown if: The Status Request Action is "Notify Status"

Parm Name: NotifySourceId

Requires:

  • MX: 5.0+

Notify State

Used to specify the action to take for status requests.

Shown if: The Status Request Action is "Notify Status"

Parm Name: NotifyState

Option Name Description Note Requires
0 None

MX: 4.4+

1 Inprogress Returns the progress as a percentage.

MX: 4.4+

3 Complete Sends a notification when complete.

MX: 4.4+

Notify Body

Used to specify text to send in the status notification.

Parm value input rules:

  • String from 1-100 characters

Shown if: The Status Request Action is "Notify Status"

Parm Name: NotifyBody

Requires:

  • MX: 5.0+

Notify Percent

Used to specify an optional value to send in the status notification that indicates the "percentage complete" of the action.

Parm value input rules:

  • Integer from -1 to 100

Shown if: The Status Request Action is "Notify Status"

Parm Name: NotifyPercent

Requires:

  • MX: 5.0+

Notify Header

Used to specify optional text to send as the header of the status notification.

Parm value input rules:

  • String with at least 1 character, if used

Shown if: The Status Request Action is "Notify Status"

Parm Name: NotifyHeader

Requires:

  • MX: 5.0+

Used to specify optional text to send as the footer of the status notification.

Parm value input rules:

  • String with at least 1 character, if used

Shown if: The Status Request Action is "Notify Status"

Parm Name: NotifyFooter

Requires:

  • MX: 5.0+