package cli
- Alphabetic
- By Inheritance
- cli
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
type
Action = Kleisli[IO, AppConfig, Unit]
The dynamics program runs "actions"
- case class ActionConfig(action: String = "", payloadFile: Option[String] = scala.None, pprint: Boolean = false) extends Product with Serializable
-
type
ActionSelector = (AppConfig, DynamicsContext) ⇒ Option[Action]
Select an action to run or return None.
-
class
AddSolutionComponentArgs extends Object
See: https://msdn.microsoft.com/en-us/library/mt593057.aspx
See: https://msdn.microsoft.com/en-us/library/mt593057.aspx
See: https://msdn.microsoft.com/en-us/library/gg328546.aspx#bkmk_componenttype
- Annotations
- @ScalaJSDefined() @RawJSType()
-
trait
AddSolutionComponentResponse extends Object
- Annotations
- @ScalaJSDefined() @RawJSType()
- case class AppConfig(common: CommonConfig = ..., solution: SolutionConfig = ..., export: ExportConfig = ..., update: UpdateConfig = ..., etl: ETLConfig = ..., workflow: WorkflowConfig = ..., plugin: PluginConfig = ..., importdata: ImportConfig = ..., webResource: WebResourceConfig = ..., metadata: MetadataConfig = ..., sdkMessage: SDKMessageConfig = ..., test: TestConfig = ..., systemjob: SystemJobConfig = SystemJobConfig.apply(), action: ActionConfig = ..., settings: SettingsConfig = ..., appModule: AppModuleConfig = ..., token: TokenConfig = ..., user: UserConfig = ..., themes: ThemesConfig = ..., deduplication: DeduplicationConfig = ...) extends Product with Serializable
- case class AppModuleConfig(roleName: Seq[String] = scala.collection.immutable.Nil, change: Option[String] = scala.None, appName: Option[String] = scala.None) extends Product with Serializable
- class ApplicationActions extends AnyRef
- class AsyncOperationsCommand extends AnyRef
-
trait
CLIApplication extends AnyRef
A simple cake to bundle together a data structure for capturing CLI parameters and a CLI parser that can parse parameters.
-
class
ChangeWorkflowStatus extends Object
- Annotations
- @ScalaJSDefined() @RawJSType()
- case class CommonConfig(lcid: Int = 1033, debug: Boolean = false, loggerLevel: Option[String] = scala.Some.apply[String]("error"), quiet: Boolean = false, verbose: Boolean = false, verbosity: Int = 0, crmConfigFile: Option[String] = scala.None, officeConfigFile: Option[String] = scala.None, outputDir: String = "./", outputFile: Option[String] = scala.None, logFile: String = "dynamicscli.log", noclobber: Boolean = false, numRetries: Int = 5, retryPolicy: String = "backoff", pauseBetween: FiniteDuration = ..., command: String = "", subcommand: String = "", filter: Seq[String] = scala.collection.immutable.Nil, connectInfo: ConnectionInfo = null, createDirectories: Boolean = true, tableFormat: String = "ramac", fields: Option[Seq[String]] = scala.None, requestTimeOutInMillis: Option[Int] = scala.None, concurrency: Int = 4, batchSize: Int = 10, batch: Boolean = false, metadataCacheFile: Option[String] = scala.None, ignoreMetadataCache: Boolean = false, actionSelector: Option[ActionSelector] = ..., impersonate: Option[String] = scala.None) extends Product with Serializable
-
trait
Context[F[_]] extends AnyRef
Context for running commands.
-
trait
CustomerAddress extends Object
- Annotations
- @RawJSType() @native()
- class DeduplicationActions extends AnyRef
- case class DeduplicationConfig(identifiers: Seq[String] = scala.collection.immutable.Nil) extends Product with Serializable
-
trait
DynamicsContext extends Context[IO]
Dynamics context.
- case class ETLConfig(name: String = "", paramsFile: Option[String] = scala.None, dataInputFile: String = "", verbosity: Int = 0, take: Option[Long] = scala.None, drop: Option[Long] = scala.None, maxPageSize: Option[Int] = scala.None, cliParameters: Map[String, String] = ..., dryRun: Boolean = false, query: Option[String] = scala.None, queryFile: Option[String] = scala.None, connectionUrl: Option[String] = scala.None, connectionFile: Option[String] = scala.None) extends Product with Serializable
- case class EnityReference(entity: String, id: String) extends Product with Serializable
- class EntityActions extends LazyLogger
-
abstract
class
EntityProcessor extends AnyRef
Processes CRM entities.
Processes CRM entities. All remote action is delayed until the returned effect is run.
Add flexible ways to managed errors and return values
- case class ExportConfig(entity: String = "", filter: Option[String] = scala.None, select: Seq[String] = scala.collection.immutable.Nil, orderBy: Seq[String] = scala.collection.immutable.Nil, top: Option[Int] = scala.None, skip: Option[Int] = scala.None, includeCount: Boolean = false, raw: Boolean = false, fetchXml: Option[String] = scala.None, maxPageSize: Option[Int] = scala.None, includeFormattedValues: Boolean = false, query: String = "", queries: Map[String, String] = ..., queryFile: Option[String] = scala.None, wrap: Boolean = false, repeat: Boolean = false, repeatDelay: Int = 60, header: Boolean = true, useFunction: Boolean = false) extends Product with Serializable
-
class
ExportSolution extends Object
- Annotations
- @ScalaJSDefined() @RawJSType()
-
trait
ExportSolutionResponse extends Object
- Annotations
- @RawJSType() @native()
-
trait
GraphContext extends Context[IO]
Graph client.
-
trait
HTTPContext extends Context[IO]
General HTTP context that is not dynamics specific.
- case class ImportConfig(uploadFilename: Seq[String] = scala.collection.immutable.Nil, importMapNoClobber: Boolean = false, importDataInputFile: String = "", mapName: String = "", importDataName: Option[String] = scala.None, importDataPollingInterval: Int = 60, importDataEnableDuplicateDetection: Boolean = false, importDataCreate: Boolean = true, importDataDeleteJobName: String = "", importDataDeleteImportId: String = "", importDataDeleteRecurrencePattern: Option[String] = scala.None, importDataDeleteStartTime: Option[String] = scala.None, importDataDeleteQueryJson: Option[String] = scala.None, importDataResumeImportId: String = "", importDataResumeImportFileId: String = "", recordsOwnerId: Option[String] = scala.None) extends Product with Serializable
- class ImportDataActions extends AnyRef
- class ImportMapActions extends LazyLogger
-
class
LoadAddressesActions extends AnyRef
Loading addresses requires that the input is json with all the attributes set.
Loading addresses requires that the input is json with all the attributes set. The only requirement is that parentid is sets in the input data source and it should be remove, along with any other non-modelled attributes using the etl CLI parameters.
- class MetadataActions extends AnyRef
- case class MetadataConfig(includeGlobal: Boolean = true, includeLocal: Boolean = true) extends Product with Serializable
- class OptionSetsActions extends LazyLogger
-
trait
OrganizationJS extends Object
- Annotations
- @RawJSType() @native()
- class PluginActions extends AnyRef
- case class PluginConfig(source: Option[String] = scala.None, watch: Boolean = false) extends Product with Serializable
- class PublisherActions extends AnyRef
-
trait
Rename extends Object
Rename a field from source to target.
Rename a field from source to target.
- Annotations
- @ScalaJSDefined() @RawJSType()
- case class SDKMessageConfig(id: String = "") extends Product with Serializable
-
trait
SDKMessageProcessingStep extends Object
- Annotations
- @RawJSType() @native()
- class SDKMessageProcessingStepsActions extends LazyLogger
-
class
SettingsActions extends LazyLogger
Perform a post on an undocumented API to set an org's settings.
Perform a post on an undocumented API to set an org's settings. You will need to prepare a config file in the specific format to post as the body.
- case class SettingsConfig(settingsFile: Option[String] = scala.None, entityList: Seq[String] = scala.collection.immutable.Nil, name: Option[String] = scala.None) extends Product with Serializable
- class SolutionActions extends LazyLogger
- case class SolutionConfig(solutionUploadFile: String = null, solutionName: String = null, solutionExportManaged: Boolean = false, solutionJsonConfigFile: Option[String] = scala.None, solutionPublishWorkflows: Boolean = true) extends Product with Serializable
-
trait
SolutionJS extends Object
- Annotations
- @RawJSType() @native()
-
trait
StandardCLIApplication extends CLIApplication
Standard operations for a basic CLI.
- case class SystemJobConfig() extends Product with Serializable
- class TestCommand extends AnyRef
- case class TestConfig(testArg: Option[String] = scala.None) extends Product with Serializable
- class ThemeActions extends AnyRef
- case class ThemesConfig(source: Option[String] = scala.None, target: Option[String] = scala.None, webresourceName: Option[String] = scala.None, mergeFile: Option[String] = scala.None) extends Product with Serializable
- class TokenActions extends LazyLogger
- case class TokenConfig(tokenOutputFile: String = "crm-token.json", refreshIntervalInMinutes: Int = 55) extends Product with Serializable
-
class
UpdateActions extends AnyRef
Can run a generic upsert operation but requires data in a specific format.
Can run a generic upsert operation but requires data in a specific format. The format is a sequence of json objects that are ready for an update post. The payload should contain the id to be updated. If it's present but not yet an id, it will be used for an upsert operation. Some advanced processing of individual attributes is available to help make updates easier e.g. lookups and newline expands.
- case class UpdateConfig(inputFile: String = "", upsert: Boolean = false, entity: String = "", pk: Option[String] = scala.Some.apply[String]("id"), upsertPreventCreate: Boolean = true, upsertPreventUpdate: Boolean = false, renames: Seq[(String, String)] = scala.collection.immutable.Nil, keeps: Seq[String] = scala.collection.immutable.Nil, drops: Seq[String] = scala.collection.immutable.Nil, drop: Option[Int] = scala.None, take: Option[Int] = scala.None, updateTransform: Transform[Object, Object] = ..., configFile: Option[String] = scala.None, config: Option[UpdateProcessingConfig] = scala.None, query: Option[String] = scala.None, skipIfNull: Boolean = true, source: Option[String] = scala.None, target: Option[String] = scala.None, value: Option[String] = scala.None) extends Product with Serializable
-
trait
UpdateProcessingConfig extends Object
Configuration for performing an update.
Configuration for performing an update.
- Annotations
- @ScalaJSDefined() @RawJSType()
- class UpdateProcessor extends AnyRef
- case class UserConfig(userid: Option[String] = scala.None, roleNames: Seq[String] = scala.collection.immutable.Nil, userQuery: Option[String] = scala.None) extends Product with Serializable
- class UsersActions extends UsersDAO
- trait UsersDAO extends AnyRef
- case class WebResourceConfig(webResourceDumpRawOutputFile: String = null, webResourceDownloadStripPrefix: Boolean = false, webResourceUploadSource: Seq[String] = scala.collection.immutable.Nil, webResourceUploadPrefix: Option[String] = scala.None, webResourceUploadSolution: String = "Default", webResourceUploadPublish: Boolean = true, webResourceUploadNoclobber: Boolean = false, webResourceUploadRegister: Boolean = true, webResourceUploadType: Option[String] = scala.None, webResourceUploadWatch: Boolean = false, webResourceUploadWatchIgnore: Seq[String] = scala.collection.immutable.Nil, webResourceDeleteNameRegex: Seq[String] = scala.collection.immutable.Nil, webResourceDeletePublish: Boolean = true) extends Product with Serializable
- class WebResourcesCommand extends AnyRef
- class WhoAmIActions extends AnyRef
-
class
WorkflowActions extends AnyRef
https://msdn.microsoft.com/en-us/library/mt622427.aspx
- case class WorkflowConfig(workflowODataQuery: Option[String] = scala.None, workflowPkName: String = "", workflowBatch: Boolean = false, workflowCache: Boolean = false, workflowCacheFilename: Option[String] = scala.None, activate: Boolean = true, workflowIds: Seq[String] = scala.collection.immutable.Nil, workflowNames: Seq[String] = scala.collection.immutable.Nil, workflowActivateFilterName: Option[String] = scala.None) extends Product with Serializable
-
trait
WorkflowJson extends Object
- Annotations
- @ScalaJSDefined() @RawJSType()
Value Members
-
def
NoArgAction(block: ⇒ Unit): Action
An action that does need the arguments.
-
val
defaultCrmConfigFile: String
Default connection config resource.
- def doNothing1[A]: (A) ⇒ IO[Unit]
-
def
isDefined(a: Any): Boolean
Must not be null or js.undefined.
- object Action
- object ActionConfig extends Serializable
- object AppConfig extends Serializable
- object AppModuleConfig extends Serializable
-
object
BuildInfo extends Product with Serializable
This object was generated by sbt-buildinfo.
- object CSVStringifyX
- object CommandLine
- object CommonConfig extends Serializable
- object DeduplicationActions
- object DeduplicationConfig extends Serializable
- object DynamicsContext
- object ETLConfig extends Serializable
- object ExportConfig extends Serializable
- object GraphContext
- object HTTPContext
- object ImportConfig extends Serializable
- object ImportDataActions
- object ImportMapActions
- object ImportMapUtils
- object Listings
- object Main
- object MainHelpers extends LazyLogger
- object MetadataActions
- object MetadataConfig extends Serializable
- object OptionSetsActions
- object PluginActions
- object PluginConfig extends Serializable
- object SDKMessageConfig extends Serializable
- object SDKMessageProcessingStepsActions
- object SettingsActions
- object SettingsConfig extends Serializable
-
object
ShortHash extends Object
- Annotations
- @native() @JSImport( "shorthash" , JSImport.Namespace )
- object SolutionActions
- object SolutionConfig extends Serializable
- object SystemJobConfig extends Serializable
- object TestConfig extends Serializable
- object ThemeActions
- object ThemesConfig extends Serializable
- object TokenConfig extends Serializable
- object UpdateActions
- object UpdateConfig extends Serializable
- object UserConfig extends Serializable
- object WebResource
- object WebResourceConfig extends Serializable
- object WorkflowActions
- object WorkflowConfig extends Serializable
- object WorkflowStateCode
- object WorkflowStatusCode
-
object
contextdefaults
Utilities for creating contexts.
-
object
metadata
Metadata objects retrieveable from the CRM server.
Metadata objects retrieveable from the CRM server. Metadata is converted to a scala-first format.
Procesing only grabs the user localized versions of localized strings.
TODO: Allow language selection on localized strings.