dpxfileExecute (Command)

Scenario: Administration
Support: full-sdk

The dpxfileExecute command executes DIGIPASS export file (DPX)–related administrative operations.

Table: dpxfileExecute commands (SOAP administration)
Command	Description
DPXFILECMD_IMPORT_FILE	Processes DPX data that has been previously uploaded from a DIGIPASS export file (DPX) via an upload command (see DPXFILECMD_IMPORT_FILE). The DPX should be uploaded first using one of the supported upload commands: dpxfileuploadmime dpxfileuploaddime dpxfileuploadmtom
DPXFILECMD_QUERY_STATUS	Returns the current status of a server task that has been previously started via the DPXFILECMD_IMPORT_FILE command (see DPXFILECMD_QUERY_STATUS).
DPXFILECMD_STOP_IMPORT	Stops a server task to import DPX data that has been previously started via the DPXFILECM_IMPORT_FILE command (see DPXFILECMD_STOP_IMPORT).

Parameters

Table: dpxfileExecute input parameters
Parameter name	Data type	Description
sessionID	String	The session identifier of the current administrative session. The logon command returns this identifier after a successful logon (see logon (Command)).
cmd	DPXFileCmdIDEnum	The operation to be executed. See Table: dpxfileExecute commands (SOAP administration).
attributeSet	DPXFileAttributeSet	A set containing zero or more attribute fields.

Table: dpxfileExecute output parameters
Parameter name	Data type	Description
results	DPXFileResults	Result structure containing return and status codes and a list of zero or more result attribute fields.

The following field attributes are available for the operations of this command:

Table: dpxfileExecute field attributes
Attribute name	Data type	Description
DPXFILEFLD_ACTIVE	Boolean	The initial state of the authenticator to be imported
DPXFILEFLD_APPL_LIST	String	Comma-separated list of authenticator application names and associated types to be imported from the uploaded DPX. Each application is listed in the following format: app_name:app_type
DPXFILEFLD_APPLS_FAILED	Unsigned Integer	The total number of authenticator application import failures.
DPXFILEFLD_APPLS_IMPORTED	Unsigned Integer	The total number of authenticator instances already imported.
DPXFILEFLD_APPLS_READ	Unsigned Integer	The total number of authenticator instances already handled.
DPXFILEFLD_CACHE_ID	String	Unique identifier of an already uploaded DPX.
DPXFILEFLD_DIRECT_ASSIGN_ONLY	Boolean	Indicates if the authenticator to be imported should be reserved for direct assignment only.
DPXFILEFLD_DOMAIN	String	The domain the authenticators have to be imported to.
DPXFILEFLD_DP_TOTAL	Integer	The total number of authenticators.
DPXFILEFLD_DPX_FILE_KEY	String	The transport key of the DPX to be uploaded.
DPXFILEFLD_DPX_FILE_NAME	String	The filename of the DPX to be uploaded.
DPXFILEFLD_ORGANIZATIONAL_UNIT	String	The organizational unit the authenticator have to be imported to.
DPXFILEFLD_RETURN_ERROR	Boolean	If specified, any errors encountered will be returned in addition to import statistics.
DPXFILEFLD_SYNCHRONISE	String	Indicates if the existing authenticators should be upgraded with activation codes from this new DPX. Possible values: yes no
DPXFILEFLD_SCHEDULE	Boolean
DPXFILEFLD_SCHEDULE_NOTIFY	String

DPXFILECMD_IMPORT_FILE

This command processes DPX data that has been previously uploaded from a DIGIPASS export file (DPX) via one of the following upload commands:

The following attributes can be specified in the attributeSet input parameter of this command:

Table: DPXFILECMD_IMPORT_FILE (Supported input attributes)
Attribute name	Optional?
DPXFILEFLD_ACTIVE	Mandatory
DPXFILEFLD_APPL_LIST	Mandatory
DPXFILEFLD_CACHE_ID	Mandatory
DPXFILEFLD_DIRECT_ASSIGN_ONLY	Optional
DPXFILEFLD_DOMAIN	Mandatory
DPXFILEFLD_ORGANIZATIONAL_UNIT	Optional
DPXFILEFLD_SCHED_NOTIFY	Optional
DPXFILEFLD_SCHEDULE	Optional
DPXFILEFLD_SYNCHRONISE	Optional

This command returns no result attributes.

DPXFILECMD_QUERY_STATUS

Only the DPXFILEFLD_CACHE_ID attribute can be specified in the DPX attribute set input parameter of this command. This attribute is mandatory.