Show / Hide Table of Contents

Class CRMScriptEntity

CRM Scripts - stored in the ejScript table, including source code.

Carrier object for CRMScriptEntity. Services for the CRMScriptEntity Carrier is available from the CRMScript Agent.
Syntax
[DataContract(Namespace = "http://www.superoffice.net/ws/crm/NetServer/11.7.0.0")]
public class CRMScriptEntity : Carrier
Examples

Get CRMScriptEntity 123 using the agent:

using SuperOffice;
using SuperOffice.CRM.Services;

using (SoSession mySession = SoSession.Authenticate("user", "pass"))
{
   var agent = new CRMScriptAgent();
   var cRMScriptEntity = agent.GetCRMScriptEntity( 123 );
}

Find all CRMScriptEntity, get related items using archive agent.

var archive = new ArchiveAgent();
var rows = archive.GetArchiveListByColumns2("Ejscripts", "...", null, "getAllRows eq 1", null, 0, 100 );

Constructors

CRMScriptEntity()

Default constructor

Declaration
public CRMScriptEntity()
See Also
ICRMScriptAgent

Properties

AccessKey

Access key used to run this script on the customer pages

Declaration
[DataMember]
public virtual string AccessKey { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

BlockedVerbs

The verbs that are blocked when calling a ejscript over HTTP

Declaration
[DataMember]
public virtual EjScriptVerb BlockedVerbs { get; set; }
Property Value
Type Description
EjScriptVerb
See Also
ICRMScriptAgent

Description

Optional description of what this script is used for.

Declaration
[DataMember]
public virtual string Description { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

EjscriptId

Primary key

Declaration
[DataMember]
public virtual int EjscriptId { get; set; }
Property Value
Type Description
int
See Also
ICRMScriptAgent

HierarchyId

The script is inside this hierarchy folder

Declaration
[DataMember]
public virtual int HierarchyId { get; set; }
Property Value
Type Description
int
See Also
ICRMScriptAgent

HtmlOutput

True if this script will return HTML output

Declaration
[DataMember]
public virtual short HtmlOutput { get; set; }
Property Value
Type Description
short
See Also
ICRMScriptAgent

IncludeId

A unique name used for including this script in another

Declaration
[DataMember]
public virtual string IncludeId { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

Includes

The unique ids of all depencies of this script (all resolved includes)

Declaration
[DataMember]
public virtual int[] Includes { get; set; }
Property Value
Type Description
int[]
See Also
ICRMScriptAgent

Name

A description of this script

Declaration
[DataMember]
public virtual string Name { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

Registered

Registered when in UTC.

Declaration
[DataMember]
public virtual DateTime Registered { get; set; }
Property Value
Type Description
DateTime
See Also
ICRMScriptAgent

RegisteredAssociateId

Registered by whom

Declaration
[DataMember]
public virtual int RegisteredAssociateId { get; set; }
Property Value
Type Description
int
See Also
ICRMScriptAgent

ScriptType

The type/language of this script

Declaration
[DataMember]
public virtual ScriptType ScriptType { get; set; }
Property Value
Type Description
ScriptType
See Also
ICRMScriptAgent

Source

The script

Declaration
[DataMember]
public virtual string Source { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

SourceCode

Contains the source code of the script

Declaration
[DataMember]
public virtual string SourceCode { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

SourceMaps

The source maps for this script

Declaration
[DataMember]
public virtual CRMScriptSourceMap[] SourceMaps { get; set; }
Property Value
Type Description
CRMScriptSourceMap[]
See Also
ICRMScriptAgent

UniqueIdentifier

Global unique identifier, accross customers/tenants

Declaration
[DataMember]
public virtual string UniqueIdentifier { get; set; }
Property Value
Type Description
string
See Also
ICRMScriptAgent

Updated

Last updated when in UTC.

Declaration
[DataMember]
public virtual DateTime Updated { get; set; }
Property Value
Type Description
DateTime
See Also
ICRMScriptAgent

UpdatedAssociateId

Last updated by whom

Declaration
[DataMember]
public virtual int UpdatedAssociateId { get; set; }
Property Value
Type Description
int
See Also
ICRMScriptAgent

ValidationResult

The result of a validation of a TypeScript when saving

Declaration
[DataMember]
public virtual CRMScriptResult ValidationResult { get; set; }
Property Value
Type Description
CRMScriptResult
See Also
ICRMScriptAgent

Methods

ToString()

Returns the carrier contents as a formatted string.

Declaration
public override string ToString()
Returns
Type Description
string

The carrier contents.

See Also
ICRMScriptAgent

ToString(string)

Returns the carrier contents as a formatted string, useful for debugging. Each line in the output is prefixed with the input value.

Declaration
public string ToString(string prefix)
Parameters
Type Name Description
string prefix

The line prefix (typically used for indenting)

Returns
Type Description
string

The carrier contents.

See Also
ICRMScriptAgent

See Also

ICRMScriptAgent
© SuperOffice. All rights reserved.
SuperOffice |  Community |  Release Notes |  Privacy |  Site feedback |  Search Docs |  About Docs |  Contribute |  Back to top