im refmode
sets the sharing behavior for content
Synopsis
im refmode [--refmode=[reuse|share] [shareID=value] [[no]useDefault] [--hostname=server] [--port=number] [--password=password] [--user=name] [(-?|--usage)] [(-F file|--selectionFile=file)] [(-N|--no)] [(-Y|--yes)] [--[no]batch] [--cwd=directory] [--forceConfirm=[yes|no]] [(-g|--gui)] [--quiet] [--settingsUI=[gui|default]] [--status=[none|gui|default]] node id...
Description
im refmode allows you to set or change the reference mode on individual or multiple nodes in a segment.
Options
This command takes the universal options available to all
im commands, as well as some general options. See the
options reference page for descriptions.
• --refmode=[reuse|share]
allows you to specify the reference mode for content. Selecting --share creates a share relationship while --reuse removes one if it exists on a node. The available reference modes explained:
Share: When the author changes their content you will automatically see the changes reflected in your document.
Reuse: If the author changes content, the content will be branched and a copy of the changes is created. The reuser becomes the author of the new shared item. When this option is specified, neither --shareID nor --useDefault can be specified.
• --shareID=value
When this option is specified, the reference mode does not need to be defined. Share is assumed. The selected item follows the significant field edits happening on the item specified with this option.
Recommendations for using the im refmode command with the --refmode and --shareID options
Using the --shareID option may cause indirect cyclic relations on Shares/Shared By relationship fields. For example, consider nodes 1, 2, 3 and 4, in which, node 1 is in Author reference mode and nodes 2, 3, and 4 are created by copying node 1 in Reuse reference mode. Improper usage of --shareID value in the im refmode --refmode=share command may result in cyclic relations, such as node 2 Shares node 3, node 3 Shares node 4, and node 4 in turn Shares node 2, which is a cyclic relation.
To avoid cyclic relationships, you must consider the following recommendations while specifying a value for the --shareID option:
▪ It is recommended to use the --useDefault option instead of using the --shareID option.
▪ Do not use any item as shareID that is already in the Share reference mode.
▪ Try to restrict shareID to the Author reference mode item only.
▪ If Reuse reference mode item is used as shareID, avoid toggling reference mode of that item to Share.
• --[no]useDefault
specifies to use the ID of the originating node from where the you want to change was branched. When --useDefault is specified, --shareID is ignored. When --[no]useDefault is specified, --shareID is required. Default is --nouseDefault.
• node id...
the node ID(s) of the content you want to change. Use a space separated list to specify more than one issue ID, for example, 240 241 242.
See Also