Prompt Structures

Use the Prompt structures to specify the prompts in the getPromptElements Methods of the ReportEditingService Service.

Prompt structures:

PromptsObjectModel Structure

Use the PromptsObjectModel structure to specify the object model of the prompt.

The PromptsObjectModel structure is used in the getPromptElements() Method.

PromptsObjectModel Structure Fields

Fields Description

String name

Specifies the name of the prompt.

String description

Specifies the description of the prompt.

String scope

Specifies the scope of the prompt.

String subjectArea

Specifies the subject area of the prompt.

String layout

Specifies the layout of the prompt.

PromptCollectionRunTimeInfo runTimeInfo

Specifies the run time information of the prompt collection.

PromptStepObjectModel promptStepObj

Specifies the object model of the prompt state.

PromptCollectionRunTimeInfo Structure

Use the PromptCollectionRunTimeInfo structure to specify the run time information of the prompt collection.

The PromptCollectionRunTimeInfo structure is used in the getPromptElements() Method.

PromptCollectionRunTimeInfo Structure Fields

Fields Description

String collectionID

Specifies the collection ID of the prompt.

String viewStatePath

Specifies the view state path of the prompt.

Int currentStep

Specifies the current step of the prompt.

Boolean reloadInline

Specifies whether to reload the prompt inline (true) or not (false).

Boolean supportAutoComplete

Specifies whether the prompt auto completes (true) or not (false).

Boolean showReturnLink

Specifies whether the prompt displays a return link (true) or not (false).

String currentAction

Specifies the current action of the prompt.

PromptStepObjectModel Structure

Use the PromptStepObjectModel structure to specify the step object model of the prompt.

The PromptStepObjectModel structure is used in the getPromptElements() Method.

PromptStepObjectModel Structure Fields

Fields Description

String title

Specifies the title of the prompt.

String instruction

Specifies the instruction of the prompt.

String buttonsPosition

Specifies the position of the button in the prompt.

String labelPosition

Specifies the position of the label in the prompt.

String wrapLabelText

Specifies the wrap label text in the prompt.

String customWidthUsage

Specifies custom width usage of the prompt.

String customWidthWidth

Specifies custom width of the prompt.

String setWidthToAllPrompts

Specifies whether width applies to all prompts.

Boolean autoApplyPrompt

Specifies whether the prompt is applied automatically (true) or not (false).

Boolean showResetButton

Specifies whether the prompt displays a Reset button (true) or not (false).

PromptStepRunTimeInfo runTimeInfo (nillable)

Specifies the run time information for the prompt step. This can be null.

IndividualPromptObjectModel[] promptObj

Species an array of prompt object models.

PromptStepRunTimeInfo Structure

Use the PromptStepRunTimeInfo structure to specify the step run time information of the prompt.

The PromptStepRunTimeInfo structure is used in the getPromptElements() Method.

PromptStepRunTimeInfo Structure Fields

Fields Description

Boolean applyToAllSteps

Specifies whether the prompt applies to all steps (true) or not (false).

Boolean autoApplyPrompt

Specifies whether the prompt is applied automatically (true) or not (false).

Boolean showResetButton

Specifies whether the prompt displays the Reset button(true) or not (false).

Int remaininglRequiredPromptsOnSubsequentSteps

Specifies the required prompts on subsequent steps.

Int firstPromptStartIndex

Specifies the index of the first prompt.

IndividualPromptObjectModel Structure

Use the IndividualPromptObjectModel structure to specify the prompt object model of the prompt.

The IndividualPromptObjectModel structure is used in the getPromptElements() Method.

IndividualPromptObjectModel Structure Fields

Fields Description

String label

Specifies the label of the prompt.

String description

Specifies the description of the prompt.

String type

Specifies the type of prompt.

String subjectArea

Specifies the subject area of the prompt.

Boolean placedOnNewColumn

Specifies whether the prompt is applied on a new column (true) or not (false).

Boolean required

Specifies whether the prompt is required (true) or not (false).

String formulaExprString

Specifies the formula expression of the prompt.

String promptUIControlType

Specifies the user interface control type of the prompt.

String promptOperator

Specifies the prompt operator.

String customWidthUsage

Specifies the custom width usage of the prompt.

String customWidthWidth

Specifies the custom width of the prompt.

String setPromptVariableType

Specifies the prompt variable type of the prompt.

String setVariableName

Specifies the variable name of the prompt.

IndividualPromptRunTimeInfoLimitedByInfo limitedByInfo

Specifies the limited by information of a prompt.

IndividualPromptRunTimeInfo runTimeInfo

Specifies the run time information of a prompt.

IndividualPromptRunTimeInfoLimitedByInfo Structure

Use the IndividualPromptRunTimeInfoLimitedByInfo structure to specify the run time limited information of the prompt.

The IndividualPromptRunTimeInfoLimitedByInfo structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoLimitedByInfo Structure Fields

Fields Description

String limitedByType

Specifies whether the prompt is limited by other prompt types, such as none, allPrompts, and specificPrompts.

Boolean isLimitedByNotApplied

Specifies whether constraint is applied to the prompt (true) or not (false).

IndividualPromptRunTimeInfoLimitedByPromptRefGroups specificPrompts

Specifies prompts that limit this prompt.

IndividualPromptRunTimeInfo Structure

Use the IndividualPromptRunTimeInfo structure to specify the run time information of the prompt.

The IndividualPromptRunTimeInfo structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfo Structure Fields

Fields Description

Int promptID

Specifies the prompt ID.

Boolean allowUserTypeValues

Specifies whether the user is allowed to type the values of the prompt (true) or not (false).

Boolean allowAutoComplete

Specifies whether the prompt auto completes (true) or not (false).

Boolean multiSelect

Specifies whether the prompt allows multiple selections (true) or not (false).

String showSearch

Specifies to show the search of the prompt.

IndividualPromptRunTimeInfoDataType dataType

Specifies the data type information of a prompt. For more information, see IndividualPromptRunTimeInfoDataType Structure.

IndividualPromptRunTimeInfoCurrentValues currentValues

Specifies the current values of a prompt. For more information, see IndividualPromptRunTimeInfoCurrentValues Structure.

IndividualPromptRunTimeInfoAvailableOptions availableOptions

Specifies the available options for a prompt. For more information, see IndividualPromptRunTimeInfoAvailableOptions Structure.

IndividualPromptRunTimeInfoAdditionalAttributes attributes

Specifies the additional attributes of a prompt. For more information, see IndividualPromptRunTimeInfoDataTypeHierarchyInfo Structure.

IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo Structure

Use the IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo structure to specify the SQL information of the hierarchy level of the display column of the prompt.

The IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo Structure Fields

Fields Description

String displayFormula

Specifies the display formula of the prompt.

String sqlFormula

Specifies the SQL formula of the prompt.

String dataType

Specifies the data type of the prompt.

String category

Specifies the category of the prompt.

String primaryType

Specifies the primary type of the prompt.

Boolean nullable

Specifies whether the prompt displays a nullable value (true) or not (false).

Boolean isMeasure

If set to TRUE, the prompt displays a measure. If set to FALSE, the prompt displays an attribute.

String aggType

Specifies the aggregate type of the prompt.

String aggRule

Species the aggregate rule of the prompt.

IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo Structure

Use the IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo structure to specify the level information of a prompt based on a hierarchy column.

The IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo Structure Fields

Fields Description

String levelID

Specifies the level ID of the prompt.

String displayName

Specifies the display name of the prompt.

String displayFormula

Specifies the display formula of the prompt.

String sqlFormula

Specifies the SQL formula of the prompt.

Boolean isDoubleColumn

Specifies whether the prompt displays a double column (true) or not (false).

IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo keyColumnInfo

Specifies the SQL information of the hierarchy level of the key column of the prompt if the prompt column is a hierarchy level.

IndividualPromptRunTimeInfoDataTypeHierarchyLevelSQLInfo displayColumnInfo

Specifies the SQL information of the hierarchy level of the display column of the prompt if the prompt column is a hierarchy level.

IndividualPromptRunTimeInfoDataTypeHierarchyLevels Structure

Use the IndividualPromptRunTimeInfoDataTypeHierarchyLevels structure to specify the levels of a prompt based on a hierarchy column.

The IndividualPromptRunTimeInfoDataTypeHierarchyLevels structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoDataTypeHierarchyLevels Structure Fields

Fields Description

IndividualPromptRunTimeInfoDataTypeHierarchyLevelInfo [] levelInfo

Specifies an array of level information of a prompt based on a hierarchy column.

IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels Structure

Use the IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels structure to specify the metadata/formula information of a prompt based on a hierarchy column.

The IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels Structure Fields

Fields Description

String subjectArea

Specifies the subject area of the prompt.

String dimensionID

Specifies the dimension of the prompt.

String tableName

Specifies the table name of the prompt.

String hierarchyID

Specifies the hierarchy ID of the prompt.

String displayName

Specifies the display name of the prompt.

String tableDisplayName

Specifies the display name of a table in the prompt.

String hierarchyDisplayName

Specifies the hierarchy display name of the prompt.

String sqlFormulaIn2Parts

Specifies the two part SQL formula of the prompt.

String sqlFormulaDisplaySubjectAreaPart

Specifies the subject area part of the SQL formula.

IndividualPromptRunTimeInfoDataTypeHierarchyLevels levels

Specifies the levels of a prompt based on a hierarchy column.

IndividualPromptRunTimeInfoDataTypeHierarchyInfo Structure

Use the IndividualPromptRunTimeInfoDataTypeHierarchyInfo structure to specify the hierarchy information of a prompt based on a hierarchy column.

The IndividualPromptRunTimeInfoDataTypeHierarchyInfo structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoDataTypeHierarchyInfo Structure Fields

Fields Description

String hierarchyID

Specifies the hierarchy ID of the prompt.

String dimensionID

Specifies the dimension ID of the prompt.

String tableName

Specifies the table name of the prompt.

IndividualPromptRunTimeInfoDataTypeHierarchyFormulaLevels formulaLevels

Specifies the metadata/formula information for a prompt based on a hierarchy column.

IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo Structure

Use the IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo structure to specify the information of a prompt based on a double column.

The IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo Structure Fields

Fields Description

String codeColumnFormula

Specifies the code column formula of the prompt.

String codeColumnCategory

Specifies the code column category of the prompt.

String codeColumnPrimaryType

Specifies the code of the column primary type of the prompt.

String codeColumnDBPrimaryType

Specifies the code of the database primary type of the prompt.

Boolean enableDoubleColumnInput

Specifies whether the prompt enables input in a double column (true) or not (false).

String codeColumnLabel (nillable)

Specifies the label of the code column for the prompt.

Boolean selectedByCodeValue

Specifies whether the prompt input is in code value (true) or not (false).

IndividualPromptRunTimeInfoDataType Structure

Use the IndividualPromptRunTimeInfoDataType structure to specify the data type information of a prompt.

The IndividualPromptRunTimeInfoDataType structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoDataType Structure Fields

Fields Description

String subjectArea

Specifies the subject area for the prompt.

String displayColumnFormula

Specifies the column formula for the prompt.

String displayColumnCategory

Specifies the column category for the prompt.

String displayColumnPrimaryType

Specifies the column primary type for the prompt.

String displayColumnDBPrimaryType

Specifies the column data base primary type for the prompt.

Boolean isMeasureColumn

If set to TRUE, the report column is a measure. If set to FALSE, the report column is an attribute.

String displayTimeZone

Specifies the time zone for the prompt.

Int dataTimeZoneOffset

Specifies the data time zone offset for the prompt.

Int displayToDataOffset

Specifies the data offset for the prompt.

String promptSourceDataType

Specifies the source data type for the prompt display column.

Boolean isHierarchy

Specifies whether the prompt column is a hierarchy column (true) or not (false).

IndividualPromptRunTimeInfoDataTypeHierarchyInfo hierarchyInfo (nillable)

Specifies the hierarchy information of a prompt based on a hierarchy column. This argument can be null.

Boolean isDoubleColumnInput

Specifies whether the prompt input is in a double column (true) or not (false).

IndividualPromptRunTimeInfoDataTypeDoubleColumnInfo codeColumnInfo (nillable)

Specifies the code column information of a prompt based on a double column. This argument can be null.

IndividualPromptRunTimeInfoSingleValueType Structure

Use the IndividualPromptRunTimeInfoSingleValueType structure to specify a single value for the prompt.

The IndividualPromptRunTimeInfoSingleValueType structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoSingleValueType Structure Fields

Fields Description

String eType

Specifies the type of value in the structure. For example, SQL, customGroup, hierarchyLevels and so on.

String caption

Specifies the caption of the prompt.

String codeValue

Specifies the code value of the prompt.

IndividualPromptRunTimeInfoValuesType Structure

Use the IndividualPromptRunTimeInfoValuesType structure to specify all values that are used by the prompt.

The IndividualPromptRunTimeInfoValuesType structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoValuesType Structure Fields

Fields Description

IndividualPromptRunTimeInfoSingleValueType[] value

Specifies an array of single values for the prompt.

IndividualPromptRunTimeInfoCurrentValues Structure

Use the IndividualPromptRunTimeInfoCurrentValues structure to specify the current values of a prompt.

The IndividualPromptRunTimeInfoCurrentValues structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoCurrentValues Structure Fields

Fields Description

String currentOperator

Specifies the current operator of the prompt.

Boolean emptyAsAllChoices

Specifies whether an empty prompt defaults to all choices (true) or not (false).

IndividualPromptRunTimeInfoValuesType values

Specifies the values for the prompt.

IndividualPromptRunTimeInfoAvailableOptions Structure

Use the IndividualPromptRunTimeInfoAvailableOptions structure to specify the available options of a prompt.

The IndividualPromptRunTimeInfoAvailableOptions structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoAvailableOptions Structure Fields

Fields Description

Int numOptionsPerPage

Specifies the number of options per page.

Int currentPageInOptions

Specifies current page number.

Boolean moreOptions

Specifies whether the prompt consists of more options (true) or not (false).

Boolean includeAllChoices

Specifies whether the prompt include all choices (true) or not (false).

Boolean needToPopulateDropDown

Specifies whether the prompt requires you to populate the drop down (true) or not (false).

String valueTablePromptSourceType

Specifies the source type for the prompt.

String sql

Specifies the SQL for the prompt.

String runTimeCodeAndDisplayValueFormatStr

Specifies the format string for the values of the prompt.

String filterXmlString (nillable)

Specifies the xml filter of the prompt.

IndividualPromptRunTimeInfoValuesType groupPaths (nillable)

Specifies the values of the groups that are used by the prompt. This argument can be null.

IndividualPromptRunTimeInfoValuesType populatedOptions (nillable)

Specifies the populated values that are used by the prompt. This argument can be null.

IndividualPromptRunTimeInfoDataTypeHierarchyInfo Structure

Use the IndividualPromptRunTimeInfoDataTypeHierarchyInfo structure to specify the additional attributes of a prompt.

The IndividualPromptRunTimeInfoDataTypeHierarchyInfo structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoDataTypeHierarchyInfo Structure Fields

Fields Description

Int opMinNumValues

Specifies the minimum number of values in the prompt.

Int opMaxNumValues

Specifies the maximum number of values in the prompt.

IndividualPromptRunTimeInfoLimitedByPromptReference Structure

Use the IndividualPromptRunTimeInfoLimitedByPromptReference structure to specify prompts that limit this prompt.

The IndividualPromptRunTimeInfoLimitedByPromptReference structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoLimitedByPromptReference Structure Fields

Fields Description

Int promptID

Specifies the identifier of the prompt.

String formulaExprString

Specifies the formula expression of the prompt.

IndividualPromptRunTimeInfoLimitedByPromptRefGroups Structure

Use the IndividualPromptRunTimeInfoLimitedByPromptRefGroups structure to specify prompts that limit the groups of this prompt.

The IndividualPromptRunTimeInfoLimitedByPromptRefGroups structure is used in the getPromptElements() Method.

IndividualPromptRunTimeInfoLimitedByPromptRefGroups Structure Fields

Fields Description

IndividualPromptRunTimeInfoLimitedByPromptReference[] limitByPrompt

Specifies an array of prompts that limit this prompt.