Skip to content

Commit

Permalink
changed Attributes to Key Value Configurations where appropriate.
Browse files Browse the repository at this point in the history
  • Loading branch information
TracyRagan committed Jul 20, 2020
1 parent b45ee8f commit 66a8b8d
Show file tree
Hide file tree
Showing 4 changed files with 17 additions and 17 deletions.
8 changes: 4 additions & 4 deletions content/en/userguide/concepts/1 DeployHub Basic Concepts.md
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,7 @@ An _Application_ has the following properties:
| modifier | The _User_ or _Group_ who last modified it. |
| ctime | The date/time it was created. |
| mtime | The date/time it was last modified. |
| attributes | An Array of Strings, keyed by Attribute Name. |
| KV Configurations | Key Value Pairs for managing associative arrays. |

### _Release_ Object

Expand Down Expand Up @@ -110,7 +110,7 @@ A _Component_ Object has the following properties:
| modifier | The User who last modified this _Component_. |
| ctime | The date/time the _Component_ was created. |
| mtime | The date/time the _Component_ was last modified. |
| attributes | Array of Strings, keyed by Attribute Name. |
| Key Value Configurations | Key Value Pairs for managing associative arrays. |

### _Component_ and _Application_ Relationships

Expand Down Expand Up @@ -149,7 +149,7 @@ The _Credential_ Object has the following properties:
| modifier | The _User_ or _Group_ who last modified this _Credential_. |
| ctime | The date/time the _Credential_ was created. |
| mtime | The date/time the _Credential_ was last modified. |
| kind | _Credential_ use. |
| Type | _Credential_ use. |

## _Data Source_ Objects

Expand Down Expand Up @@ -275,7 +275,7 @@ The _Endpoint_ object has the following properties:
| modifier | The _User_ or _Group_ who last modified it. |
| ctime | The date/time it was created. |
| mtime | The date/time it was last modified. |
| attributes | Array of Strings, keyed by Attribute Name. |
| Key Value Configurations | Key Value Pairs for managing associative arrays. |

## _Notifier_ Objects

Expand Down
6 changes: 3 additions & 3 deletions content/en/userguide/dmscript/DMScript-SetAtt.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,14 @@ description: >
Assings or replaces attributes for a specified object.
---

_Setatt_ assigns or replaces attributes for a specified object. Attributes are held against _Applications_, _Components_, _Environments_, _Endpoints_, and _Repositories_. _setatt_ allows new values to be stored against such objects or for existing values to be replaced.
_Setatt_ assigns or replaces Key Value Pairs for a specified object. Key Value Pairs are held against _Applications_, _Components_, _Environments_, _Endpoints_, and _Repositories_. _setatt_ allows new values to be stored against such objects or for existing values to be replaced.

_setatt_ takes two mandatory named parameters:

| Parameter| Description |
| --- | ---|
| object | The object to update. This must be a DeployHub object that is either already on the stack or retrieved from another object or from one of the object retrieval _Functions_ (e.g.: get_Environment_ etc). |
| attributes | An array of name/value pairs to set as attributes for the specified object. In the attributes array, the key is the name of the attribute and the value is its value. |
| attributes | An array of Key Value Pairs to set as attributes for the specified object. In the Value Pair array, the key is the name of the Key Value Pair and the value is its value. |

**Example:**

Expand All @@ -35,4 +35,4 @@ set atts = {
setatt(object: ${Application.parent},attributes: $atts);
```

If this is attached to a post-deployment action then whenever an _Application Version_ is deployed, the details of the deployment are stored as attributes against the base _Application_.
If this is attached to a post-deployment action then whenever an _Application Version_ is deployed, the details of the deployment are stored as Key Value Pairs against the base _Application_.
2 changes: 1 addition & 1 deletion content/en/userguide/dmscript/DMScript-modify.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,6 @@ _modify_ takes a variable number of named parameters:
| outfile | The name of the file to which the modified file is written. The original input file is left unchanged. This parameter is optional – if not specified then the changes are written back to the original input file. |
| serverspecific | A Boolean value (true/false). If set to true then a copy of the modified file is created for each _Endpoint_ in the current _Endpoint_ set. If set to false - or not specified – then the same changed file is sent to each _Endpoint_ in the current _Endpoint_ set. |

NOTE: When running modify with serverspecific set to true, an implicit _Endpoint_ loop is performed and the modify operation is performed for each _Endpoint_ in the current _Endpoint_ set. You can therefore substitute _Endpoint_-specific attributes or use _Endpoint_ properties (such as ${server.hostname}).
NOTE: When running modify with server specific set to true, an implicit _Endpoint_ loop is performed and the modify operation is performed for each _Endpoint_ in the current _Endpoint_ set. You can therefore substitute _Endpoint_-specific attributes or use _Endpoint_ properties (such as ${server.hostname}).

A copy of the modified file is made for each _Endpoint_. It is only during a subsequent deployment operation (either implicitly or with a call to _transfer_) that these modified files are transferred to their appropriate _Endpoint_.
18 changes: 9 additions & 9 deletions content/en/userguide/reusable/Attributes.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
### Attributes
### Key Value Configurations

Attributes are environment variables that need to be assigned to the _Object_.
Key Value Configurations are Value Pairs for managing associative arrays assigned to the _Object_.

Attributes can be assigned at multiple levels, from the Global _Domain_ down to an individual _Component_ and have a "scope." Lower level Objects can override a higher level Object. Below is the order in which Attributes can be overridden:
Key Value Pairs can be assigned at multiple levels, from the Global _Domain_ down to an individual _Component_ and have a "scope." Lower level Objects can override a higher level Object. Below is the order in which Key Value Pairs can be overridden:

| Object | Description |
| --- | --- |
| **Global** | Contains all Environment variables and any "additional attributes" set by the user when running that task. |
| **Environment** | Overrides any Global variables during a deployment. |
| **Application** | Overrides the _Environment_ variables during a deployment. |
| **Endpoint** | Overrides the _Application_ variables during a deployment. |
| **Component** | Overrides the _Application_ variables during a deployed.
| **Global** | Contains all Environment variables and any "additional Key Value Pairs" set by the user when running that task. |
| **Environment** | Overrides any Global Key Value Pairs during a deployment. |
| **Application** | Overrides the _Environment_ Key Value Pairsduring a deployment. |
| **Endpoint** | Overrides the _Application_ Key Value Pairs during a deployment. |
| **Component** | Overrides the _Application_ Key Value Pairs during a deployed.

Attributes can be given any Name and a Value. Use +Add to add Attributes to the table. Use Save to confirm. Use the checkbox to Delete or Edit an Attribute.
Key Value Pairs can be given any Name and a Value. Use +Add to add Key Value Pairs to the table. Use Save to confirm. Use the checkbox to Delete or Edit a Key Value Pair.

0 comments on commit 66a8b8d

Please sign in to comment.