Extends

• ArchBaseCoreObjectWithId

Members

additionalProperties :boolean

If this schema is configured a custom JSON type, this specifies whether assigning an object to the custom JSON type that has additional properties in it that are not defined on the custom JSON type is valid or not. For example, if a custom JSON type had properties A and B defined on it and an object was assigned to it that had a property named C, this determines whether that assignment should be allowed or not.

allowableValues :Array.<any>

The allowable values that can be assigned. Allowable values are similar to enums in that they let you specify a certain set of values that are valid to assign.

dataTypeId :string

Returns the data type identifier associated with this schema.

description :string

The schema description that describes this schema. Description strings will be displayed to flow authors in Architect and cannot be more than 256 characters long.

readonly displayTypeName :string

Returns the display type name string 'ArchDataTypeJsonCustomSchema'.

readonly id :string

The identifier string for this object.

Inherited From:

• ArchBaseCoreObjectWithId#id

readonly idMayBeBlank :string

Returns whether or not the id property may be blank or undefined for this object. For example, the returned settings from ArchMenu#settingsMenu will have a blank identifier along with the settings returned from ArchMenu#settingsSpeechRec. Note that this is an extremely rare case.

Inherited From:

• ArchBaseCoreObjectWithId#idMayBeBlank

See:

• ArchBaseCoreObjectWithId#id

readonly isArchBaseCoreObject :boolean

Returns true indicating that this is an ArchBaseCoreObject instance.

Inherited From:

• ArchBaseCoreObject#isArchBaseCoreObject

readonly isArchDataTypeJsonCustomSchema :boolean

Returns true indicating that this is an ArchDataTypeJsonCustomProperty instance.

readonly isCollection :boolean

Returns whether this schema is a collection data type or not. The data type for a schema is set when it is created and cannot be changed.

isRequired :boolean

Whether the property is required to have a value assigned to it to be valid.

readonly logStr :string

A string suitable for logging that contains information about this custom schema.

Overrides:

• ArchBaseCoreObjectWithId#logStr

readonly logStrTypeOnly :string

This is a string suitable for logging information about this object where it's just the object's type. This is normally used when logging errors that occur in constructor parameter checking because the scripting object isn't set up and the normal logging str contents wouldn't be set up.

Inherited From:

• ArchBaseObject#logStrTypeOnly

maxItems :number

If this schema is configured to be a collection data type, this specifies the maximum number of items allowed in a collection value to be valid. Remember that Architect itself enforces a maximum of 2000 items for a collection value. You can clear maxItems by setting the property to null or undefined.

maxLength :number

If this schema is configured to be a String data type, this specifies the minimum string length required for a String value assigned to this property to be valid. Remember that Architect itself enforces a maximum of 32000 characters for a String value.

maxValue :number

The minimum numeric value lets you customize the minimum value allowed.

maxValueInclusive :boolean

Whether the maximum value specified on this property should be treated as inclusive or not. If the maximum value on a property is 100 and maxValueInclusive is true, valid values for this property are <= 100 vs. if maxValueInclusive is false, then valid values for this property are < 100.

minItems :number

If this schema is configured to be a collection data type, this specifies the minimum number of items required in a collection value to be valid. Remember that Architect itself enforces a maximum of 2000 items for a collection value. You can clear minItems by setting the property to null or undefined.

minLength :number

If this schema is configured to be a String data type, this specifies the minimum string length required for a String value assigned to this property to be valid. Remember that Architect itself enforces a maximum of 32000 characters for a String value.

minValue :number

The minimum numeric value lets you customize the minimum value allowed.

minValueInclusive :boolean

Whether the minimum value specified on this property should be treated as inclusive or not. If the minimum value on a property is 10 and minValueInclusive is true, valid values for this property are >= 10 vs. if minValueInclusive is false, then valid values for this property are > 10.

name :string

The schema name that describes this schema. Name strings will be displayed to flow authors in Architect and cannot be more than 128 characters long.

properties :Array.<ArchDataTypeJsonCustomSchema>

Returns the properties configured on this custom schema as custom schema objects.

Methods

addProperty(name, dataTypeId, descriptionopt) → {ArchDataTypeJsonCustomSchema}

Adds a property with a given name to a custom schema.

Parameters:

Name	Type	Attributes	Description
name	string
dataTypeId	string
description	string	<optional>

Returns:

ArchDataTypeJsonCustomSchema

isFilterMatch(archFilterObject) → {boolean}

Returns whether or not this Architect Scripting object is a match for the supplied ArchFilterObject instance.

Parameters:

Name	Type	Description
archFilterObject	ArchFilterObject	the object filter to use to determine if it's a match.

Returns:

boolean

Inherited From:

• ArchBaseObject#isFilterMatch

logError(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true.

Parameters:

Name	Type	Description
errorStr	string	the error string to log.

Inherited From:

• ArchBaseObject#logError

logErrorAndThrow(errorStr)

Logs an error to the logging service with a log header from this object's logStr property value when ArchLogging#logErrors is true and then throws the string in the errorStr parameter.

Parameters:

Name	Type	Description
errorStr	string	the error string to log. This should be a non-blank string.

Throws:

• Throws the submitted error string.

Inherited From:

• ArchBaseObject#logErrorAndThrow

logNote(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotes is true.

Parameters:

Name	Type	Description
noteStr	string	the note string to log. This should be a non-blank string.

Inherited From:

• ArchBaseObject#logNote

logNoteVerbose(noteStr)

Logs a note to the logging service with a log header from this object's logStr property value when ArchLogging#logNotesVerbose is true.

Parameters:

Name	Type	Description
noteStr	string	the note string to log. This should be a non-blank string.

Inherited From:

• ArchBaseObject#logNoteVerbose

logWarning(warningStr)

Logs a warning to the logging service with a log header from this object's logStr property value when ArchLogging#logWarnings is true.

Parameters:

Name	Type	Description
warningStr	string	the warning string to log. This should be a non-blank string.

Inherited From:

• ArchBaseObject#logWarning

traverse(callbackFunction, traverseFilteropt) → {number}

This method iterates over this object and ArchBaseCoreObject instances within it. For each object it will call the ArchBaseObject#isFilterMatch method with a filter and call the supplied callback function if isMatch returns true. The callback will be passed an ArchTraverseInfo with details about the match such as the match object itself along with current contextual information such as the object hierarchy for the match object relative to the object on which this traverse call is being made.

The traverse filter is one which you can create by calling ArchFactoryFilters#createFilterObject and then add desired clauses or clause containers to it. If not specified, this function will use a default filter.

Here is an example that does a simple flow traversal using the default filter and logs information about objects in the callback from the traverse object that's passed back:

archInboundCallFlow.traverse(function(traverseInfo) {
   archLogging.logNote('  Object     : ' + traverseInfo.matchObject.logStr);
   archLogging.logNote('    Hierarchy: ' + traverseInfo.context.hierarchyStr);
});

This might be enough for most uses and you can check various aspects about the object in the callback such as "is this an Architect action?" by seeing if traverseInfo.matchObject.isArchBaseAction is true. You can specify a filter for the traversal code to use as well and only have it call your callback when the object's ArchBaseCoreObject#isFilterMatch method returns true for the filter. Here's an example that creates a filter for callbacks on any type of transfer action, any decision action or objects whose name property case insensitively matches the word 'foo'. While this could all be done with one property callback clause the example will use multiple clauses for the sake of simplicity:

const myTraverseFilter = filterFactory.createFilterObject(archEnums.FILTER_CONTAINER_OPERATORS.or);
myTraverseFilter.addClausePropertyValueEquals('isArchBaseActionTransfer', true);
myTraverseFilter.addClausePropertyValueEquals('isArchActionDecision',     true);
myTraverseFilter.addClausePropertyCallback('name', function(propValue, archContainingObject, propName) {
      // We fully spelled out the function signature above but archContainingObject and propName are
      // not needed in this case.  The archContainingObject is the object that contains the
      // property and propName is the property name itself.  We pass in propName because the same
      // function could be used for multiple property callback clauses.
      // Remember to return a boolean true, false or undefined from ths callback.  :)
      return propValue && propValue.toLowerCase() === 'foo';
});
archTask.traverse(function(traverseContext) {
   // You will only be called back here for ArchBaseCoreObject instances that
   // have the isArchBaseActionTransfer or isArchActionDecision property values equal to true.
}, myTraverseFilter);

If you supply a filter with no clauses, this tells the traverse method to call the supplied callback function for every ArchBaseCoreObject it traverses.

If you want traversal itself to stop after a callback, simply return boolean false from the callback function you supply to the traverse call.

The traverse method does not process deprecated property names such as orgId, orgName or languageSettings. Additionally it does not traverse in to properties that would "jump out" of the current traversal. An example of this would be if the code was traversing an ArchActionJumpToMenu action that it would not start traversing in to the menu that it jumps to. Another example would be a ArchActionChangeState action where it would not traverse in to the target state of the action. This also means traversal does not traverse in to the ArchBaseValue#flowLevelDefault property.

And lastly, as Scripting evolves over time with new versions, you can expect to get callbacks for new object types such as new actions or new properties on objects. As such, it's important not to assume any particular order in callbacks to keep code most compatible with traversal callbacks. Or if you use inequality checks in filter clauses remember that new "stuff" may satisfy an inequality check which may or may not be anticipated in your logic.

Note: This traverse method is a helper method and is very handy for iterating over Architect Scripting objects and their properties in a generic fashion with filtering capabilities. Obviously you can write your own custom traversal code if this implementation doesn't cut it for some reason. :)

This function returns the number of times it called the callback function.

Parameters:

Name	Type	Attributes	Default	Description
callbackFunction	callbackTraverseInfo			the callback function to call for objects that match the traverse filter.
traverseFilter	ArchFilterObject	<optional>	ArchFactoryFilters#createFilterTraverseDefault	the filter to use when performing the traversal to determine which ArchBaseCoreObject instances you wish to be called back for. If no filter is specified, this function will call ArchFactoryFilters#createFilterTraverseDefault and use that traversal default filter. The wantArchBaseValues parameter on that call is set to true.

Returns:

number

Inherited From:

• ArchBaseCoreObject#traverse